code_annotations.extensions package#

Submodules#

Abstract and base classes to support plugins.

class code_annotations.extensions.base.AnnotationExtension(config, echo)#

Abstract base class that annotation extensions will inherit from.

abstract search(file_handle)#: Search for annotations in the given file.

class code_annotations.extensions.base.SimpleRegexAnnotationExtension(config, echo)#

Abstract base class for languages that have comments which can be reasonably searched using regular expressions.

comment_regex_fmt = "\n {multi_start} # start of the language-specific multi-line comment (ex. /*)\n (?P<comment> # Look for a multiline comment\n [\\d\\D]*? # capture all of the characters...\n )\n {multi_end} # until you find the end of the language-specific multi-line comment (ex. */)\n | # If you don't find any of those...\n (?P<prefixed_comment> # Look for a group of single-line comments\n (?: # Non-capture mode\n {single} # start by finding the single-line comment token (ex. //)\n .* # and capture all characters until the end of the line\n \\n? # followed by an optional carriage return\n \\ * # and some empty space\n )* # multiple times\n )\n "#

search(file_handle)#

Search for annotations in the given file.

Stevedore extension for static annotation searching in Javascript files.

class code_annotations.extensions.javascript.JavascriptAnnotationExtension(config, echo)#

Annotation extension for Javascript source files.

lang_comment_definition = {'multi_end': '\\*/', 'multi_start': '/\\*', 'single': '//'}#

Stevedore extension for static annotation searching in Python files.

class code_annotations.extensions.python.PythonAnnotationExtension(config, echo)#

Annotation extension for Python source files.

lang_comment_definition = {'multi_end': '"""', 'multi_start': '"""', 'single': '\\#'}#

Extensions used in static annotation functionality.