pylint.pyreverse.diagrams.PackageDiagram

class documentation

class PackageDiagram(ClassDiagram): (source)

View In Hierarchy

Package diagram handling.

Method add_from_depend Add dependencies created by from-imports.
Method add_object Create a diagram object.
Method extract_relationships Extract relationships between nodes in the diagram.
Method get_module Return a module by its name, looking also for relative imports; raise KeyError if not found.
Method module Return a module by its name, raise KeyError if not found.
Method modules Return all module nodes in the diagram.
Constant TYPE Undocumented

Inherited from ClassDiagram:

Method __init__ Init filter modes.
Method add_relationship Create a relationship.
Method assign_association_relationship Undocumented
Method class_names Return class names if needed in diagram.
Method classe Return a class by its name, raise KeyError if not found.
Method classes Return all class nodes in the diagram.
Method get_attrs Return visible attributes, possibly with class name.
Method get_methods Return visible methods.
Method get_relationship Return a relationship or None.
Method get_relationships Undocumented
Method has_node Return true if the given node is included in the diagram.
Method object_from_node Return the diagram object mapped to node.
Instance Variable objects Undocumented
Instance Variable relationships Undocumented
Instance Variable title Undocumented
Instance Variable _nodes Undocumented

Inherited from Figure (via ClassDiagram):

Instance Variable fig_id Undocumented

Inherited from FilterMixIn (via ClassDiagram, Figure):

Method show_attr Return true if the node should be treated.
Instance Variable __mode Undocumented
def add_from_depend(self, node: nodes.ImportFrom, from_module: str): (source)

Add dependencies created by from-imports.

def add_object(self, title: str, node: nodes.Module): (source)
overrides pylint.pyreverse.diagrams.ClassDiagram.add_object

Create a diagram object.

def extract_relationships(self): (source)
overrides pylint.pyreverse.diagrams.ClassDiagram.extract_relationships

Extract relationships between nodes in the diagram.

def get_module(self, name: str, node: nodes.Module) -> PackageEntity: (source)

Return a module by its name, looking also for relative imports; raise KeyError if not found.

def module(self, name: str) -> PackageEntity: (source)

Return a module by its name, raise KeyError if not found.

def modules(self) -> list[PackageEntity]: (source)

Return all module nodes in the diagram.

TYPE: str = (source)
overrides pylint.pyreverse.diagrams.ClassDiagram.TYPE

Undocumented

Value
'package'