pylint.pyreverse.diadefslib.DefaultDiadefGenerator

class documentation

class DefaultDiadefGenerator(LocalsVisitor, DiaDefGenerator): (source)

View In Hierarchy

Generate minimum diagram definition for the project : * a package diagram including project's modules * a class diagram including project's classes

Method __init__ Common Diagram Handler initialization.
Method leave_project Leave the pyreverse.utils.Project node.
Method visit_classdef Visit an astroid.Class node.
Method visit_importfrom Visit astroid.ImportFrom and catch modules for package diagram.
Method visit_module Visit an astroid.Module node.
Method visit_project Visit a pyreverse.utils.Project node.
Instance Variable classdiagram Undocumented
Instance Variable pkgdiagram Undocumented

Inherited from LocalsVisitor:

Method get_callbacks Get callbacks from handler for the visited node.
Method visit Launch the visit starting from the given node.
Instance Variable _cache Undocumented
Instance Variable _visited Undocumented

Inherited from DiaDefGenerator (via LocalsVisitor):

Method add_class Visit one class and add it to diagram.
Method extract_classes Extract recursively classes related to klass_node.
Method get_ancestors Return ancestor nodes of a class node.
Method get_associated Return associated nodes of a class node.
Method get_title Get title for objects.
Method show_node True if builtins and not show_builtins.
Instance Variable anc_level Undocumented
Instance Variable association_level Undocumented
Instance Variable config Undocumented
Instance Variable linker Undocumented
Instance Variable module_names Undocumented
Method _get_levels Help function for search levels.
Method _set_default_options Set different default options with _default dictionary.
Method _set_option Activate some options if not explicitly deactivated.
def __init__(self, linker: Linker, handler: DiadefsHandler): (source)
overrides pylint.pyreverse.utils.LocalsVisitor.__init__

Common Diagram Handler initialization.

def leave_project(self, _: Project) -> Any: (source)

Leave the pyreverse.utils.Project node. return the generated diagram definition

def visit_classdef(self, node: nodes.ClassDef): (source)

Visit an astroid.Class node. add this class to the class diagram definition

def visit_importfrom(self, node: nodes.ImportFrom): (source)

Visit astroid.ImportFrom and catch modules for package diagram.

def visit_module(self, node: nodes.Module): (source)

Visit an astroid.Module node. add this class to the package diagram definition

def visit_project(self, node: Project): (source)

Visit a pyreverse.utils.Project node. create a diagram definition for packages

classdiagram = (source)
overrides pylint.pyreverse.diadefslib.DiaDefGenerator.classdiagram

Undocumented

pkgdiagram: PackageDiagram|None = (source)

Undocumented