openvariant.annotation package#

Submodules#

openvariant.annotation.annotation module#

Annotation#

A core class to represent the schema which files will be parsed.

class openvariant.annotation.annotation.Annotation(annotation_path: str)[source]#

Bases: object

A representation of the schema that files will be parsed

property annotations: dict#

annotation that will cover Annotation object

Type: dict

property columns: List#

columns that will appear on parsed output files

Type: List

property delimiter: str#

delimiter that annotation will read on files

Type: str

property excludes: dict#

values that will be excluded after the parsing

Type: List

property format: str#

output format that will have parsed files

Type: str

property path: str#

path where annotation file is located

Type: str

property patterns: List[str]#

files patterns that annotation will match

Type: List[str]

property structure: dict#

general structure of Annotation schema

Type: dict

openvariant.annotation.builder module#

Builder#

A core Enum to build a specified Tuple for each annotation.

class openvariant.annotation.builder.Builder(func: str)[source]#

Bases: object

A representation of a function in annotation file

func: str = None#

class openvariant.annotation.builder.DIRNAME[source]#: Bases: object

class openvariant.annotation.builder.FILENAME[source]#: Bases: object

class openvariant.annotation.builder.INTERNAL[source]#: Bases: object

class openvariant.annotation.builder.MAPPING[source]#: Bases: object

class openvariant.annotation.builder.PLUGIN[source]#: Bases: object

class openvariant.annotation.builder.STATIC[source]#: Bases: object

openvariant.annotation.process module#

class openvariant.annotation.process.DIRNAME[source]#: Bases: object

class openvariant.annotation.process.FILENAME[source]#: Bases: object

class openvariant.annotation.process.INTERNAL[source]#: Bases: object

class openvariant.annotation.process.MAPPING[source]#: Bases: object

class openvariant.annotation.process.PLUGIN[source]#: Bases: object

class openvariant.annotation.process.STATIC[source]#: Bases: object

openvariant.variant package

openvariant.find_files package