pylint.pyreverse.diadefslib.DiaDefGenerator

class documentation

class DiaDefGenerator: (source)

Known subclasses: pylint.pyreverse.diadefslib.ClassDiadefGenerator, pylint.pyreverse.diadefslib.DefaultDiadefGenerator

View In Hierarchy

Handle diagram generation options.

Method __init__ Common Diagram Handler initialization.
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 classdiagram 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)
overridden in pylint.pyreverse.diadefslib.DefaultDiadefGenerator

Common Diagram Handler initialization.

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

Visit one class and add it to diagram.

def extract_classes(self, klass_node: nodes.ClassDef, anc_level: int, association_level: int): (source)

Extract recursively classes related to klass_node.

def get_ancestors(self, node: nodes.ClassDef, level: int) -> Generator[nodes.ClassDef, None, None]: (source)

Return ancestor nodes of a class node.

def get_associated(self, klass_node: nodes.ClassDef, level: int) -> Generator[nodes.ClassDef, None, None]: (source)

Return associated nodes of a class node.

def get_title(self, node: nodes.ClassDef) -> str: (source)

Get title for objects.

def show_node(self, node: nodes.ClassDef) -> bool: (source)

True if builtins and not show_builtins.

anc_level = (source)

Undocumented

association_level = (source)

Undocumented

classdiagram: ClassDiagram = (source)
overridden in pylint.pyreverse.diadefslib.ClassDiadefGenerator, pylint.pyreverse.diadefslib.DefaultDiadefGenerator

Undocumented

config = (source)

Undocumented

linker = (source)

Undocumented

module_names = (source)

Undocumented

def _get_levels(self) -> tuple[int, int]: (source)

Help function for search levels.

def _set_default_options(self): (source)

Set different default options with _default dictionary.

def _set_option(self, option: bool|None) -> bool: (source)

Activate some options if not explicitly deactivated.