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

DudeNr33 · 2021-06-27T10:31:04Z

Steps

Add a ChangeLog entry describing what your PR does.
If it's a new feature or an important bug fix, add a What's New entry in
doc/whatsnew/<current release.rst>.
Write a good description on what the PR does.

Description

This is a rather large PR, so I try my best to summarize the changes.
It solves both #4488 and #4498.
The requested changes from PR #4521 are already included, and PR #4521 can be deleted (the introduction of NamedTuple for better typing was easier to do with the changes already made for the PlantUML support).

So here is an overview what this PR includes:

New Features:
- Optional parameters --colorized and --max-color-depth to automatically color classes/modules of the same package (merged from PR Pyreverse autocolor #4521)
- Implement a PlantUmlPrinter to support output to .puml files.
  Note that automatic conversion to .png or other image formats is not supported yet; specifying "png" as output format will still rely on the Dot backend.
- Positive side effect of refactoring: The various import-graphs provided by the ImportsChecker can now be produced in .vcg and .puml format, not only .dot.
Refactoring:
- Defined a common Printer interface in pylint.pyreverse.printer for the possible backends (Dot, VCG, PlantUML).
  Moved DotBackend and VCGPrinter to printer module.
- YAGNI: remove optional parameters from various methods in the Printer subclasses that were never used by the callers in the codebase, to find a minimal superset of parameters for each method signature.
- Introduce factory function for picking the corresponding Printer or DiagramWriter subclass for the desired output format.
- Remove module pylint.graph as it is no longer needed (DotBackend is replaced by pylint.pyreverse.printer.DotPrinter). Same for pylint.pyreverse.vcgutils.
  Move orphaned get_cycles() function to pylint.checkers.imports, which is (in my opinion) the better place for it anyway.
- Refactor tests:
  - move to own subdirectory
  - split into functional tests and unit tests
  - extract for pyreverse.utils into own test module
- Improve typing by adding type hints and use NamedTuples etc. where appropriate.
- Use a consistent style for defining the dictionaries of the configuration options
- Improve exclude rules in the pre-commit-config.yaml so it does not need to be expanded every time a new data subdirectory or a new conftest.py is added to the tests.

Type of Changes

	Type
✓	✨ New feature
✓	🔨 Refactoring

Related Issue

Closes #4488
Closes #4498

Distinguish modules and packages.

…ibute in VCGPrinter

…=y option

…modules is checked

… test does not work in tox env

…hod ``get_package_properties``. Rename ``get_values`` to ``get_class_properties``. VCGWriter and VCGPrinter thus no longer need special handling.

Add ChangeLog and whatsnew entry

Refactor coloring logic into own Mixin class that can be used for both ``DotWriter`` and ``PlantUmlWriter``

…Printer``

…ing unittest

…hem more readable.

…nt backends into ``printer`` module.

…s, move to own directory

…ately 'wrong' code. Check top level ``conftest.py`` but ignore remaining ones, as this raises mypy errors for duplicate modules.

…nts and introduce proper subclasses for different kinds of diagram entities.

…ass suitable for the given output format

…is also not necessary anymore. The "shape" is now automatically set by the ``Printer`` classes.

…output format (Open-Closed-Principle).

coveralls · 2021-06-27T12:46:27Z

Coverage increased (+0.4%) to 92.447% when pulling 49ba34e on DudeNr33:pyreverse-plantuml into 1e55ae6 on PyCQA:master.

Pierre-Sassoulas

Hey, sorry for the delay before reviewing. There's a lot to review here and I never got a long enough period to do it properly. Could you rebase on the latest main, fix the conflicts, and put the changelog in 2.10 instead of 2.9 first, please ? If there are little changes that could be reviewed as a standalone MR, we could merge them first and that would help with the review time.

DudeNr33 · 2021-07-13T09:25:56Z

Splitting this MR into smaller parts would certainly be possible.
That would probably be:

Refactoring towards the common Printer base class, as prerequisite for the following changes
Introduction of type annotations
Refactoring of tests
Introduction of PlantUMLPrinter and PlantUMLWriter
Introduction of the ColorMixin class

1 & 2 might fit together well into one MR.
In this case I would not rebase this MR, as it would no longer be needed. I don't know if merging the "preparation" MRs into this one would go cleanly.

Pierre-Sassoulas · 2021-07-13T17:43:04Z

Sound great, I don't mind if we open a dozen of new MR and close this one :)

Pierre-Sassoulas · 2021-08-15T17:14:29Z

Closing in favor of #4850

DudeNr33 added 30 commits May 24, 2021 11:17

WIP: automatically color package diagrams in pyreverse

53e99b4

Add command line options --colorized and -max-color-depth.

832202b

Distinguish modules and packages.

Dummy implementation of new methods for VCG writer; ignore style attr…

7010985

…ibute in VCGPrinter

Add simple unit test for colored output

72e2d01

Add test files for colorized output

71d6d29

Apply consistent definition of dictionaries

bc0febf

Fix unittest that also relied on the Config class of another test module

128ea44

Enable coloring of class diagrams without relying on the module-names…

d2763be

…=y option

Modify test data and config so that colorization of standard library …

738e7b9

…modules is checked

Add regression tests for vcg output

36c3688

Merge branch 'master' into pyreverse-autocolor

a32ca13

Delete class inheriting from standard library in test data, since the…

225ef45

… test does not work in tox env

Refactoring: extract logic what attributes to set for packages in met…

e8e898f

…hod ``get_package_properties``. Rename ``get_values`` to ``get_class_properties``. VCGWriter and VCGPrinter thus no longer need special handling.

Add ChangeLog and whatsnew entrAdd ChangeLog and whatsnew entryy

e70c135

Add ChangeLog and whatsnew entry

Merge branch 'master' into pyreverse-autocolor

2dcfdb0

First implementation of PlantUML backend for pyreverse.

ca0e3ec

Implement automatic coloring for PlantUML diagrams.

f8deba0

Refactor coloring logic into own Mixin class that can be used for both ``DotWriter`` and ``PlantUmlWriter``

Stereotypes can now be optionally specified for classes in ``PlantUml…

7b54169

…Printer``

Delete classes.dot file in cleanup fixture that was generated dur…

ec7265b

…ing unittest

Use the qualified name of objects as unique ID for diagrams to make t…

ce98e5f

…hem more readable.

Refactoring: create Printer base class and move logic for differe…

9e7c36d

…nt backends into ``printer`` module.

Refactoring of pyreverse tests - extract common fixtures and function…

9ae5c49

…s, move to own directory

Exclude all 'data' subdirectories under 'tests' for pre-commit hooks

168faeb

Move test file back to where it belongs

a933c2c

Exclude 'data' subdirectories under test, as they may contain deliber…

eb917e3

…ately 'wrong' code. Check top level ``conftest.py`` but ignore remaining ones, as this raises mypy errors for duplicate modules.

Improve typing by replacing dictionaries with NamedTuple, add type hi…

7e0cba8

…nts and introduce proper subclasses for different kinds of diagram entities.

Merge branch 'master' into pyreverse-plantuml

f46a41e

Use factory functions to obtain a Printer or DiagramWriter cl…

db5f507

…ass suitable for the given output format

Emitting the "URL" attribute breaks output for VCG and PlantUML, but …

bb227a1

…is also not necessary anymore. The "shape" is now automatically set by the ``Printer`` classes.

Add changelog and whatsnew entries

7eeaa50

DudeNr33 added 5 commits June 26, 2021 22:46

Fix unit test after removing the URL attribute from import-graph

7375104

Remove dead code

36847b8

Refactor tests and add new ones to increase coverage for new code

7938bf1

Use factory function to get the corresponding writer for the desired …

14cd177

…output format (Open-Closed-Principle).

Fix expected output message

49ba34e

DudeNr33 marked this pull request as ready for review June 27, 2021 12:53

Pierre-Sassoulas added Enhancement ✨ Improvement to a component pyreverse Related to pyreverse component labels Jun 27, 2021

Pierre-Sassoulas requested changes Jul 12, 2021

View reviewed changes

Pierre-Sassoulas added this to the 2.10.0 milestone Jul 12, 2021

DudeNr33 mentioned this pull request Jul 20, 2021

Create common Printer base class for pyreverse and improve typing. #4731

Merged

1 task

Pierre-Sassoulas removed this from the 2.10.0 milestone Jul 25, 2021

Pierre-Sassoulas closed this Aug 15, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

DudeNr33 commented Jun 27, 2021

coveralls commented Jun 27, 2021

Pierre-Sassoulas left a comment

DudeNr33 commented Jul 13, 2021

Pierre-Sassoulas commented Jul 13, 2021

Pierre-Sassoulas commented Aug 15, 2021

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

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

Conversation

DudeNr33 commented Jun 27, 2021

Steps

Description

Type of Changes

Related Issue

coveralls commented Jun 27, 2021

Pierre-Sassoulas left a comment

Choose a reason for hiding this comment

DudeNr33 commented Jul 13, 2021

Pierre-Sassoulas commented Jul 13, 2021

Pierre-Sassoulas commented Aug 15, 2021