sphinx.pycode.parser.DefinitionFinder

class documentation

class DefinitionFinder(TokenProcessor):

View In Hierarchy

Python source code parser to detect location of functions, classes and methods.
Method __init__ Undocumented
Method add​_definition Add a location of definition.
Method finalize​_block Finalize definition block.
Method parse Parse the code to obtain location of definitions.
Method parse​_definition Parse AST of definition.
Instance Variable context Undocumented
Instance Variable decorator Undocumented
Instance Variable definitions Undocumented
Instance Variable indents Undocumented

Inherited from TokenProcessor:

Method fetch​_token Fetch the next token from source code.
Method fetch​_until Fetch tokens until specified token appeared.
Method get​_line Returns specified line.
Instance Variable buffers Undocumented
Instance Variable current Undocumented
Instance Variable previous Undocumented
Instance Variable tokens Undocumented
def __init__(self, lines):
overrides sphinx.pycode.parser.TokenProcessor.__init__

Undocumented

Parameters
lines:List[str]Undocumented
def add_definition(self, name, entry):
Add a location of definition.
Parameters
name:strUndocumented
entry:Tuple[str, int, int]Undocumented
def finalize_block(self):
Finalize definition block.
def parse(self):
Parse the code to obtain location of definitions.
def parse_definition(self, typ):
Parse AST of definition.
Parameters
typ:strUndocumented
context: List[str] =

Undocumented

decorator =

Undocumented

definitions: Dict[str, Tuple[str, int, int]] =

Undocumented

indents: List =

Undocumented