pydocspec.visitors.PrintVisitor

class documentation

class PrintVisitor(ApiObjectVisitor): (source)

View In Hierarchy

Visit objects and print each object with the defined format string. Available substitutions are:

  • "{obj_type}" (colored)
  • "{obj_name}"
  • "{obj_docstring}"
  • "{obj_lineno}"
  • "{obj_filename}"

The default format string is: ":{obj_lineno} - {obj_type}: {obj_name}"

Usage::
module: pydocspec.Module module.walk(PrintVisitor())
Method __init__ Undocumented
Method unknown_departure Undocumented
Method unknown_visit Undocumented
Instance Variable colorize Undocumented
Instance Variable formatstr Undocumented
Constant _COLOR_MAP Undocumented

Inherited from _ApiObjectVisitorGetChildren (via ApiObjectVisitor):

Class Method get_children Undocumented
def __init__(self, formatstr=':{obj_lineno} - {obj_type}: {obj_name}', colorize=True): (source)

Undocumented

Parameters
formatstr:strUndocumented
colorize:boolUndocumented
def unknown_departure(self, ob): (source)

Undocumented

Parameters
ob:pydocspec.ApiObjectUndocumented
def unknown_visit(self, ob): (source)

Undocumented

Parameters
ob:pydocspec.ApiObjectUndocumented
colorize = (source)

Undocumented

formatstr = (source)

Undocumented

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

Undocumented

Value
{'Module': 'magenta',
 'Class': 'cyan',
 'Function': 'yellow',
 'Variable': 'blue',
 'Indirection': 'dark_blue'}