pylint.pyreverse.printer.Printer

class documentation

class Printer(ABC): (source)

Known subclasses: pylint.pyreverse.dot_printer.DotPrinter, pylint.pyreverse.mermaidjs_printer.MermaidJSPrinter, pylint.pyreverse.plantuml_printer.PlantUmlPrinter, pylint.pyreverse.vcg_printer.VCGPrinter

View In Hierarchy

Base class defining the interface for a printer.

Method __init__ Undocumented
Method emit Undocumented
Method emit_edge Create an edge from one node to another to display relationships.
Method emit_node Create a new node.
Method generate Generate and save the final outputfile.
Instance Variable layout Undocumented
Instance Variable lines Undocumented
Instance Variable title Undocumented
Instance Variable use_automatic_namespace Undocumented
Static Method _get_method_arguments Undocumented
Method _close_graph Emit the lines needed to properly close the graph.
Method _dec_indent Decrement indentation.
Method _inc_indent Increment indentation.
Method _open_graph Emit the header lines, i.e. all boilerplate code that defines things like layout etc.
Instance Variable _indent Undocumented
def __init__(self, title: str, layout: Layout|None = None, use_automatic_namespace: bool|None = None): (source)
overridden in pylint.pyreverse.dot_printer.DotPrinter

Undocumented

def emit(self, line: str, force_newline: bool|None = True): (source)

Undocumented

@abstractmethod
def emit_edge(self, from_node: str, to_node: str, type_: EdgeType, label: str|None = None): (source)
overridden in pylint.pyreverse.dot_printer.DotPrinter, pylint.pyreverse.mermaidjs_printer.MermaidJSPrinter, pylint.pyreverse.plantuml_printer.PlantUmlPrinter, pylint.pyreverse.vcg_printer.VCGPrinter

Create an edge from one node to another to display relationships.

@abstractmethod
def emit_node(self, name: str, type_: NodeType, properties: NodeProperties|None = None): (source)
overridden in pylint.pyreverse.dot_printer.DotPrinter, pylint.pyreverse.mermaidjs_printer.MermaidJSPrinter, pylint.pyreverse.plantuml_printer.PlantUmlPrinter, pylint.pyreverse.vcg_printer.VCGPrinter

Create a new node. Nodes can be classes, packages, participants etc.

def generate(self, outputfile: str): (source)
overridden in pylint.pyreverse.dot_printer.DotPrinter

Generate and save the final outputfile.

layout = (source)

Undocumented

lines: list[str] = (source)

Undocumented

title: str = (source)

Undocumented

use_automatic_namespace = (source)

Undocumented

@staticmethod
def _get_method_arguments(method: nodes.FunctionDef) -> list[str]: (source)

Undocumented

@abstractmethod
def _close_graph(self): (source)
overridden in pylint.pyreverse.dot_printer.DotPrinter, pylint.pyreverse.mermaidjs_printer.MermaidJSPrinter, pylint.pyreverse.plantuml_printer.PlantUmlPrinter, pylint.pyreverse.vcg_printer.VCGPrinter

Emit the lines needed to properly close the graph.

def _dec_indent(self): (source)

Decrement indentation.

def _inc_indent(self): (source)

Increment indentation.

@abstractmethod
def _open_graph(self): (source)
overridden in pylint.pyreverse.dot_printer.DotPrinter, pylint.pyreverse.mermaidjs_printer.MermaidJSPrinter, pylint.pyreverse.plantuml_printer.PlantUmlPrinter, pylint.pyreverse.vcg_printer.VCGPrinter

Emit the header lines, i.e. all boilerplate code that defines things like layout etc.

_indent = (source)

Undocumented