sphinx.pycode.ModuleAnalyzer

class documentation

class ModuleAnalyzer:

Undocumented

Class Method	`for_egg`	Undocumented
Class Method	`for_file`	Undocumented
Class Method	`for_module`	Undocumented
Class Method	`for_string`	Undocumented
Static Method	`get_module_source`	Try to find the source code for a module.
Method	`__init__`	Undocumented
Method	`analyze`	Analyze the source code.
Method	`find_attr_docs`	Find class and module-level attributes and their documentation.
Method	`find_tags`	Find class, function and method definitions and their location.
Method	`parse`	Parse the source code.
Class Variable	`cache`	Undocumented
Instance Variable	`_analyzed`	Undocumented
Instance Variable	`annotations`	Undocumented
Instance Variable	`attr_docs`	Undocumented
Instance Variable	`code`	Undocumented
Instance Variable	`finals`	Undocumented
Instance Variable	`modname`	Undocumented
Instance Variable	`overloads`	Undocumented
Instance Variable	`srcname`	Undocumented
Instance Variable	`tagorder`	Undocumented
Instance Variable	`tags`	Undocumented

@classmethod
def for_egg(cls, filename, modname):

Undocumented

Parameters
filename:`str`	Undocumented
modname:`str`	Undocumented
Returns
`ModuleAnalyzer`	Undocumented

@classmethod
def for_file(cls, filename, modname):

Undocumented

Parameters
filename:`str`	Undocumented
modname:`str`	Undocumented
Returns
`ModuleAnalyzer`	Undocumented

@classmethod
def for_module(cls, modname):

Undocumented

Parameters
modname:`str`	Undocumented
Returns
`ModuleAnalyzer`	Undocumented

@classmethod
def for_string(cls, string, modname, srcname='<string>'):

Undocumented

Parameters
string:`str`	Undocumented
modname:`str`	Undocumented
srcname:`str`	Undocumented
Returns
`ModuleAnalyzer`	Undocumented

@staticmethod
def get_module_source(modname):

Try to find the source code for a module.

Returns ('filename', 'source'). One of it can be None if no filename or source found

Parameters
modname:`str`	Undocumented
Returns
`Tuple[Optional[str], Optional[str]]`	Undocumented

def __init__(self, source, modname, srcname):

Undocumented

Parameters
source:`IO`	Undocumented
modname:`str`	Undocumented
srcname:`str`	Undocumented

def analyze(self):

Analyze the source code.

def find_attr_docs(self):

Find class and module-level attributes and their documentation.

Returns
`Dict[Tuple[str, str], List[str]]`	Undocumented

def find_tags(self):

Find class, function and method definitions and their location.

Returns
`Dict[str, Tuple[str, int, int]]`	Undocumented

def parse(self):

Parse the source code.

cache: Dict[Tuple[str, str], Any] =

Undocumented

_analyzed: bool =

Undocumented

annotations =

Undocumented

attr_docs =

Undocumented

code =

Undocumented

finals =

Undocumented

modname =

Undocumented

overloads =

Undocumented

srcname =

Undocumented

tagorder =

Undocumented

tags =

Undocumented