mypy.stubdoc.DocStringParser

class documentation

class DocStringParser: (source)

View In Hierarchy

Parse function signatures in documentation.
Method __init__ Undocumented
Method add​_token Process next token from the token stream.
Method get​_signatures Return sorted copy of the list of signatures found so far.
Method reset Undocumented
Instance Variable accumulator Undocumented
Instance Variable arg​_default Undocumented
Instance Variable arg​_name Undocumented
Instance Variable arg​_type Undocumented
Instance Variable args Undocumented
Instance Variable found Undocumented
Instance Variable function​_name Undocumented
Instance Variable ret​_type Undocumented
Instance Variable signatures Undocumented
Instance Variable state Undocumented
def __init__(self, function_name): (source)

Undocumented

Parameters
function​_name:strUndocumented
def add_token(self, token): (source)
Process next token from the token stream.
Parameters
token:tokenize.TokenInfoUndocumented
def get_signatures(self): (source)
Return sorted copy of the list of signatures found so far.
Returns
List[FunctionSig]Undocumented
def reset(self): (source)

Undocumented

accumulator: str = (source)

Undocumented

arg_default: Optional[str] = (source)

Undocumented

arg_name: str = (source)

Undocumented

arg_type: Optional[str] = (source)

Undocumented

args: list = (source)

Undocumented

found: bool = (source)

Undocumented

function_name = (source)

Undocumented

ret_type: str = (source)

Undocumented

signatures: List[FunctionSig] = (source)

Undocumented

state = (source)

Undocumented