pylint.pyreverse.writer.DiagramWriter

class documentation

class DiagramWriter: (source)

View In Hierarchy

Base class for writing project diagrams.

Method __init__ Undocumented
Method get_class_properties Get label and shape for classes.
Method get_package_properties Get label and shape for packages.
Method get_shape_color Get shape color.
Method save Write to disk.
Method set_printer Set printer.
Method write Write files for <project> according to <diadefs>.
Method write_classes Write a class diagram.
Method write_packages Write a package diagram.
Instance Variable available_colors Undocumented
Instance Variable config Undocumented
Instance Variable depth Undocumented
Instance Variable file_name Undocumented
Instance Variable printer Undocumented
Instance Variable printer_class Undocumented
Instance Variable used_colors Undocumented
def __init__(self, config: argparse.Namespace): (source)

Undocumented

def get_class_properties(self, obj: ClassEntity) -> NodeProperties: (source)

Get label and shape for classes.

def get_package_properties(self, obj: PackageEntity) -> NodeProperties: (source)

Get label and shape for packages.

def get_shape_color(self, obj: DiagramEntity) -> str: (source)

Get shape color.

def save(self): (source)

Write to disk.

def set_printer(self, file_name: str, basename: str): (source)

Set printer.

def write(self, diadefs: Iterable[ClassDiagram|PackageDiagram]): (source)

Write files for <project> according to <diadefs>.

def write_classes(self, diagram: ClassDiagram): (source)

Write a class diagram.

def write_packages(self, diagram: PackageDiagram): (source)

Write a package diagram.

available_colors = (source)

Undocumented

config = (source)

Undocumented

depth = (source)

Undocumented

file_name = (source)

Undocumented

printer = (source)

Undocumented

printer_class = (source)

Undocumented

used_colors: dict[str, str] = (source)

Undocumented