Pyreverse: PlantUML support + coloring (from PR #4521)

.pre-commit-config.yaml

@@ -13,7 +13,7 @@ repos:
     rev: v1.4
     hooks:
       - id: autoflake
-        exclude: &fixtures tests/functional/|tests/input|tests/extensions/data|tests/regrtest_data/|tests/data/
+        exclude: &fixtures tests/functional/|tests/input|tests(/.*)*/data|tests/regrtest_data/
         args:
           - --in-place
           - --remove-all-unused-imports
@@ -60,7 +60,7 @@ repos:
             "--load-plugins=pylint.extensions.docparams",
           ]
         # disabled plugins: pylint.extensions.mccabe
-        exclude: tests/functional/|tests/input|tests/extensions/data|tests/regrtest_data/|tests/data/|doc/
+        exclude: tests/functional/|tests/input|tests/regrtest_data/|tests(/.*)*/data/|doc/
       - id: fix-documentation
         name: Fix documentation
         entry: python3 -m script.fix_documentation
@@ -78,7 +78,7 @@ repos:
         args: []
         require_serial: true
         additional_dependencies: ["types-pkg_resources==0.1.3", "types-toml==0.1.3"]
-        exclude: tests/functional/|tests/input|tests/extensions/data|tests/regrtest_data/|tests/data/|doc/|bin/
+        exclude: tests/functional/|tests/input|tests(/.*)*/data|tests/regrtest_data/|tests/data/|tests(/.*)+/conftest.py|doc/|bin/
   - repo: https://github.com/pre-commit/mirrors-prettier
     rev: v2.3.1
     hooks:

ChangeLog

@@ -9,6 +9,14 @@ Release date: TBA
 ..
   Put new features and bugfixes here and also in 'doc/whatsnew/2.9.rst'
 
+* Add PlantUML as possible output format for ``pyreverse`` and the ``--import-graph`` option
+
+  Closes #4498
+
+* Added ``--colorized`` option to ``pyreverse`` to visualize modules/packages of the same parent package.
+
+  Closes #4488
+
 * Add type annotations to pyreverse dot files
 
   Closes #1548

doc/whatsnew/2.9.rst

@@ -49,6 +49,10 @@ New checkers
 Other Changes
 =============
 
+* Add support for PlantUML output to pyreverse
+
+* Add colorized output for pyreverse
+
 * Add type annotations to pyreverse dot files
 
 * Pylint's tags are now the standard form ``vX.Y.Z`` and not ``pylint-X.Y.Z`` anymore.
@@ -73,6 +77,8 @@ Other Changes
 
 * ``ignore-paths`` configuration directive has been added. Defined regex patterns are matched against file path.
 
+* ``pyreverse`` now supports automatic coloring of package and class diagrams for .dot files by passing the ``--colorized`` option.
+
 * Added handling of floating point values when parsing configuration from pyproject.toml
 
 * Fix false positive ``useless-type-doc`` on ignored argument using ``pylint.extensions.docparams`` when a function

pylint/checkers/imports.py

@@ -37,6 +37,7 @@
 # Copyright (c) 2021 yushao2 <[email protected]>
 # Copyright (c) 2021 Marc Mueller <[email protected]>
 # Copyright (c) 2021 Matus Valo <[email protected]>
+# Copyright (c) 2021 Andreas Finkler <[email protected]>
 # Copyright (c) 2021 Andrew Howe <[email protected]>
 
 # Licensed under the GPL: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
@@ -60,8 +61,13 @@
     node_ignores_exception,
 )
 from pylint.exceptions import EmptyReportError
-from pylint.graph import DotBackend, get_cycles
 from pylint.interfaces import IAstroidChecker
+from pylint.pyreverse.printer import (
+    EdgeType,
+    Layout,
+    NodeType,
+    get_printer_for_filetype,
+)
 from pylint.reporters.ureports.nodes import Paragraph, VerbatimText, VNode
 from pylint.utils import IsortDriver, get_global_option
 
@@ -191,30 +197,74 @@ def _repr_tree_defs(data, indent_str=None):
     return "\n".join(lines)
 
 
-def _dependencies_graph(filename: str, dep_info: Dict[str, List[str]]) -> str:
+def _dependencies_graph(filename: str, dep_info: Dict[str, List[str]]) -> None:
     """write dependencies as a dot (graphviz) file"""
     done = {}
-    printer = DotBackend(os.path.splitext(os.path.basename(filename))[0], rankdir="LR")
-    printer.emit('URL="." node[shape="box"]')
+    printer = get_printer_for_filetype(filename)(
+        os.path.splitext(os.path.basename(filename))[0], layout=Layout.LEFT_TO_RIGHT
+    )
     for modname, dependencies in sorted(dep_info.items()):
         done[modname] = 1
-        printer.emit_node(modname)
+        printer.emit_node(modname, type_=NodeType.PACKAGE)
         for depmodname in dependencies:
             if depmodname not in done:
                 done[depmodname] = 1
-                printer.emit_node(depmodname)
+                printer.emit_node(depmodname, type_=NodeType.PACKAGE)
     for depmodname, dependencies in sorted(dep_info.items()):
         for modname in dependencies:
-            printer.emit_edge(modname, depmodname)
-    return printer.generate(filename)
+            printer.emit_edge(modname, depmodname, type_=EdgeType.USES)
+    printer.generate(filename)
 
 
 def _make_graph(filename: str, dep_info: Dict[str, List[str]], sect: VNode, gtype: str):
     """generate a dependencies graph and add some information about it in the
     report's section
     """
-    outputfile = _dependencies_graph(filename, dep_info)
-    sect.append(Paragraph(f"{gtype}imports graph has been written to {outputfile}"))
+    _dependencies_graph(filename, dep_info)
+    sect.append(Paragraph(f"{gtype}imports graph has been written to {filename}"))
+
+
+def get_cycles(graph_dict, vertices=None):
+    """given a dictionary representing an ordered graph (i.e. key are vertices
+    and values is a list of destination vertices representing edges), return a
+    list of detected cycles
+    """
+    if not graph_dict:
+        return ()
+    result = []
+    if vertices is None:
+        vertices = graph_dict.keys()
+    for vertice in vertices:
+        _get_cycles(graph_dict, [], set(), result, vertice)
+    return result
+
+
+def _get_cycles(graph_dict, path, visited, result, vertice):
+    """recursive function doing the real work for get_cycles"""
+    if vertice in path:
+        cycle = [vertice]
+        for node in path[::-1]:
+            if node == vertice:
+                break
+            cycle.insert(0, node)
+        # make a canonical representation
+        start_from = min(cycle)
+        index = cycle.index(start_from)
+        cycle = cycle[index:] + cycle[0:index]
+        # append it to result if not already in
+        if cycle not in result:
+            result.append(cycle)
+        return
+    path.append(vertice)
+    try:
+        for node in graph_dict[vertice]:
+            # don't check already visited nodes again
+            if node not in visited:
+                _get_cycles(graph_dict, path, visited, result, node)
+                visited.add(node)
+    except KeyError:
+        pass
+    path.pop()
 
 
 # the import checker itself ###################################################