TypeDocGrammar
Auto-generated documentation for mypy_boto3_builder.parsers.docstring_parser.type_doc_grammar module.
Pyparsing grammar for argument type doc lines.
- mypy-boto3-builder / Modules / Mypy Boto3 Builder / Parsers / Docstring Parser / TypeDocGrammar
TypeDocGrammar
class TypeDocGrammar():
Grammar to parse boto3 docs syntax.
EOL ::= ["\r"] "\n" 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
@staticmethod
def disable_packrat() -> None:
Disable packrat boost.
TypeDocGrammar.enable_packrat
@staticmethod
def enable_packrat() -> None:
Enable packrat boost.
TypeDocGrammar.fail_action
@classmethod
def fail_action(
_input_string: str,
_chr_index: int,
_source: ParserElement,
error: BaseException,
) -> None:
Check for input end.
TypeDocGrammar.reset
@classmethod
def reset() -> None:
Reset call stack and packrat.