sphinx.pycode.ModuleAnalyzer

class documentation

class ModuleAnalyzer: (source)

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.
Class Variable	`cache`	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
Instance Variable	`_analyzed`	Undocumented

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

Undocumented

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

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

Undocumented

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

@classmethod
def for_module(cls, modname): (source) ¶

Undocumented

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

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

Undocumented

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

@staticmethod
def get_module_source(modname): (source) ¶

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[str\|None, str\|None]`	Undocumented

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

Undocumented

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

def analyze(self): (source) ¶

Analyze the source code.

def find_attr_docs(self): (source) ¶

Find class and module-level attributes and their documentation.

Returns
`dict[tuple[str, str], list[str]]`	Undocumented

def find_tags(self): (source) ¶

Find class, function and method definitions and their location.

Returns
`dict[str, tuple[str, int, int]]`	Undocumented

cache: dict[tuple[str, str], Any] = (source) ¶

Undocumented

annotations = (source) ¶

Undocumented

attr_docs = (source) ¶

Undocumented

code = (source) ¶

Undocumented

finals = (source) ¶

Undocumented

modname = (source) ¶

Undocumented

overloads = (source) ¶

Undocumented

srcname = (source) ¶

Undocumented

tagorder = (source) ¶

Undocumented

tags = (source) ¶

Undocumented

_analyzed: bool = (source) ¶

Undocumented