TypeDocGrammar

Auto-generated documentation for mypy_boto3_builder.parsers.docstring_parser.type_doc_grammar module.

Pyparsing grammar for argument type doc lines.

TypeDocGrammar

[find in source code]

class TypeDocGrammar():
EOL ::= ["

"] " " SOL ::= LINE_START line ::= [^EOL]+ EOL word ::= alphanums + "_" indented_block ::= INDENT (line_indented | any_line) line_indented ::= any_line indented_block type_definition ::= ":type" [^:]+ ":" [^EOL]+ rtype_definition ::= ":rtype:" [^EOL]+ returns_definition ::= (":returns:" | ":return:") [^EOL]+ param_definition ::= ":param" [^:]+ ":" [^EOL]+ EOL [indented_block] response_structure ::= "Response Structure" line [indented_block] typed_dict_key_line ::= "-" "" word "" "(" word ")" "--" [^EOL]+ + EOL type_line ::= "-" "(" word ")" "--" [^EOL]+ + EOL any_line ::= typed_dict_key_line | type_line | line

TypeDocGrammar.disable_packrat

[find in source code]

@staticmethod
def disable_packrat() -> None:

TypeDocGrammar.enable_packrat

[find in source code]

@staticmethod
def enable_packrat() -> None:

TypeDocGrammar.fail_action

[find in source code]

@classmethod
def fail_action(
    _input_string: str,
    _chr_index: int,
    _source: str,
    error: BaseException,
) -> None:

TypeDocGrammar.reset

[find in source code]

@classmethod
def reset() -> None: