code_tokenize

Fast tokenization and structural analysis of any programming language

View the Project on GitHub cedricrupb/code_tokenize


Fast tokenization and structural analysis of any programming language in Python

Programminng Language Processing (PLP) brings the capabilities of modern NLP systems to the world of programming languages. To achieve high performance PLP systems, existing methods often take advantage of the fully defined nature of programminng languages. Especially the syntactical structure can be exploited to gain knowledge about programs.

code.tokenize provides easy access to the syntactic structure of a program. The tokenizer converts a program into a sequence of program tokens ready for further end-to-end processing. By relating each token to an AST node, it is possible to extend the program representation easily with further syntactic information.

Installation

The package is tested under Python 3. It can be installed via:

pip install code-tokenize

Usage

code.tokenize can tokenize nearly any program code in a few lines of code:

import code_tokenize as ctok

# Python
ctok.tokenize(
    '''
        def my_func():
            print("Hello World")
    ''',
lang = "python")

# Output: [def, my_func, (, ), :, #NEWLINE#, ...]

# Java
ctok.tokenize(
    '''
        public static void main(String[] args){
          System.out.println("Hello World");
        }
    ''',
lang = "java", 
syntax_error = "ignore")

# Output: [public, static, void, main, (, String, [, ], args), {, System, ...]

# JavaScript
ctok.tokenize(
    '''
        alert("Hello World");
    ''',
lang = "javascript", 
syntax_error = "ignore")

# Output: [alert, (, "Hello World", ), ;]


Supported languages

code.tokenize employs tree-sitter as a backend. Therefore, in principal, any language supported by tree-sitter is also supported by a tokenizer in code.tokenize.

For some languages, this library supports additional features that are not directly supported by tree-sitter. Therefore, we distinguish between three language classes and support the following language identifier:

Languages in the native class support all features of this library and are extensively tested. advanced languages are tested but do not support the full feature set. Languages of the basic class are not tested and only support the feature set of the backend. They can still be used for tokenization and AST parsing.

Release history

Project Info

The goal of this project is to provide developer in the programming language processing community with easy access to program tokenization and AST parsing. This is currently developed as a helper library for internal research projects. Therefore, it will only be updated as needed.

Feel free to open an issue if anything unexpected happens.

Distributed under the MIT license. See LICENSE for more information.

We thank the developer of tree-sitter library. Without tree-sitter this project would not be possible.