pylint.pyreverse.utils

module documentation
(source)

Generic classes/functions for pyreverse core/extensions.

Class FilterMixIn Filter nodes according to a mode and nodes' visibility.
Class LocalsVisitor Visit a project by traversing the locals dictionary.
Function check_graphviz_availability Check if the ``dot`` command is available on the machine.
Function check_if_graphviz_supports_format Check if the ``dot`` command supports the requested output format.
Function get_annotation Return the annotation for `node`.
Function get_annotation_label Undocumented
Function get_default_options Read config file and return list of options.
Function get_visibility Return the visibility from a name: public, protected, private or special.
Function infer_node Return a set containing the node annotation if it exists otherwise return a set of the inferred types using the NodeNG.infer method.
Function insert_default_options Insert default options to sys.argv.
Function is_exception Undocumented
Function is_interface Undocumented
Constant MODES Undocumented
Constant PRIVATE Undocumented
Constant PROTECTED Undocumented
Constant RCFILE Undocumented
Constant SPECIAL Undocumented
Constant VIS_MOD Undocumented
Constant _PRIVATE Undocumented
Constant _PROTECTED Undocumented
Constant _SPECIAL Undocumented
Type Alias _CallbackT Undocumented
Type Alias _CallbackTupleT Undocumented
def check_graphviz_availability(): (source)

Check if the ``dot`` command is available on the machine. This is needed if image output is desired and ``dot`` is used to convert from *.dot or *.gv into the final output format.

def check_if_graphviz_supports_format(output_format: str): (source)

Check if the ``dot`` command supports the requested output format. This is needed if image output is desired and ``dot`` is used to convert from *.gv into the final output format.

def get_annotation(node: nodes.AssignAttr|nodes.AssignName) -> (nodes.Name|nodes.Subscript)|None: (source)

Return the annotation for `node`.

def get_annotation_label(ann: nodes.Name|nodes.NodeNG) -> str: (source)

Undocumented

def get_default_options() -> list[str]: (source)

Read config file and return list of options.

def get_visibility(name: str) -> str: (source)

Return the visibility from a name: public, protected, private or special.

def infer_node(node: nodes.AssignAttr|nodes.AssignName) -> set[InferenceResult]: (source)

Return a set containing the node annotation if it exists otherwise return a set of the inferred types using the NodeNG.infer method.

def insert_default_options(): (source)

Insert default options to sys.argv.

def is_exception(node: nodes.ClassDef) -> bool: (source)

Undocumented

def is_interface(node: nodes.ClassDef) -> bool: (source)

Undocumented

MODES = (source)

Undocumented

Value
{'ALL': 0,
 'PUB_ONLY': (_SPECIAL+_PROTECTED)+_PRIVATE,
 'SPECIAL': _SPECIAL,
 'OTHER': _PROTECTED+_PRIVATE}
PRIVATE = (source)

Undocumented

Value
re.compile(r'^__(_*[^\W_])+_?$')
PROTECTED = (source)

Undocumented

Value
re.compile(r'^_\w*$')
RCFILE: str = (source)

Undocumented

Value
'.pyreverserc'
SPECIAL = (source)

Undocumented

Value
re.compile(r'^__([^\W_]_*)+__$')
VIS_MOD = (source)

Undocumented

Value
{'special': _SPECIAL, 'protected': _PROTECTED, 'private': _PRIVATE, 'public': 0}
_PRIVATE: int = (source)

Undocumented

Value
8
_PROTECTED: int = (source)

Undocumented

Value
4
_SPECIAL: int = (source)

Undocumented

Value
2
_CallbackT = (source)

Undocumented

Value
Callable[[nodes.NodeNG],
         Union[Tuple[ClassDiagram], Tuple[PackageDiagram, ClassDiagram], None]]
_CallbackTupleT = (source)

Undocumented

Value
Tuple[Optional[_CallbackT], Optional[_CallbackT]]