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: str): (source)

Undocumented

def add_token(self, token: tokenize.TokenInfo): (source)

Process next token from the token stream.

def get_signatures(self) -> list[FunctionSig]: (source)

Return sorted copy of the list of signatures found so far.

def reset(self): (source)

Undocumented

accumulator: str = (source)

Undocumented

arg_default: str|None = (source)

Undocumented

arg_name: str = (source)

Undocumented

arg_type: str|None = (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