Visualiserung / UML-Diagramme

[hf-kklein]

Die Anforderung an die UML-Diagramme sind:

• [ ] Die Diagramme sollen mindestens teilweise automatisiert erstellt werden um Schiefständen zwischen Doku und Code-Realität vorzubeugen.
• [ ] Die Diagramme sollen die lowerCamelCase Nomenklatur verwenden.
• [ ] Die Diagramme sollen 1:[0-n] Kardinalitäten sauber abbilden können.
• [ ] Die Diagramme sollen vollständig aber nicht unübersichtlich sein.

Dieses Ticket dient dazu, unsere bisherigen Versuche mit ihren jeweiligen Vor- und Nachteilen zu dokumentieren.

[hf-krechan]

Pyreverse and Graphviz

Requirements

• pylint: pip install pylint
• graphviz
  • macOS: brew install graphviz

How to

// create .dot file
pyreverse src/bo4e/bo
// draw uml diagram
dot -Tpng classes.dot -o bo4e-uml.png

Man kann damit verschiedene Formate erstellen

dot -Kdot -Tpng classes.dot -o bo4e-uml-dot.png
dot -Kneato -Tpng classes.dot -o bo4e-uml-neato.png
dot -Ktwopi -Tpng classes.dot -o bo4e-uml-twopi.png
dot -Kcirco -Tpng classes.dot -o bo4e-uml-twopi.png
dot -Ktwopi -Tpng classes.dot -o bo4e-uml-twopi.png
dot -Kcirco -Tpng classes.dot -o bo4e-uml-circo.png
dot -Kfdp -Tpng classes.dot -o bo4e-uml-fdp.png
dot -Kosage -Tpng classes.dot -o bo4e-uml-osage.png
dot -Kpatchwork -Tpng classes.dot -o bo4e-uml-patchwork.png
dot -Ksfdp -Tpng classes.dot -o bo4e-uml-sfdp.png

Diese sehen unterschiedlich gut aus

Results

circo

dot

fdp

neato

osage

patchwork

sfdp

twopi

Probleme

• Aktuell werden die Klassen und ihre entsprechenden Schemata in dem UML abgebildet.
• Die Komponenten sind bei dem Befehl nicht dabei. Führt man den Befehl pyreverse src/bo4e/ an, so sollten auch die COMs und ENUMs Teil des Diagramms sein.

Resumé

✅ Die Diagramme sollen mindestens teilweise automatisiert erstellt werden um Schiefständen zwischen Doku und Code-Realität vorzubeugen. ✅ Die Diagramme sollen die lowerCamelCase Nomenklatur verwenden. ❌ Die Diagramme sollen 1:[0-n] Kardinalitäten sauber abbilden können. ❌ Die Diagramme sollen vollständig aber nicht unübersichtlich sein.

[hf-kklein]

@snsttr die json-schemas liegen auch alle im git (also außerhalb von sphinx) https://github.com/bo4e/BO4E-python/tree/main/json_schemas/bo

[hf-kklein]

For the record: I also tried gituml: https://plantuml.atug.com/svg/nLDDJyCm3BtdLrZY0eZr1qnJ9H1IB-mqE5TfwgvXIr8bALC7_7UyDcND-13Y09NQEiyljf_ZY2rt3gxr6WlZuPa1FLnNbg_HOaMltWUiPxYI-rP527tHHeZ6Mfr2hHgXGkeIAokT7vOczrtJcwxXrcDljjgZtQCKjKQRVqprkN-I-8bRoOcasIjZ6JfHSwoyCyKZRZmiNcQZPZPglvpDKhWnzrq3yx6go4VIqKk5v8wx4R5MlGZY13MHyrZ8mKcbJs8DudvC3reZVbYuKJpHZttuIilaF4w2kSQYg8-flstwh_OEcfcO3k5ArAZuVunYNqQkkSA_7SUWU3AK0nBw4iBbJGUBXJ9bkyKq9HFEbrV6YbgM5q30sIstcnNop29gQXybcknCalTBFWTXjETIEqW_fuI28gB0WqQeZ3dyCYIXD4Cb51raqZyixs2tsoLhIMUoJOHHx0q0

https://gituml.com/ztree_scratchpad also I do have a paid account but the problems described above are testable/reproducable with the free version, too.

[lord-haffi]

Does it have to be in one diagram? 'Cause with pyreverse you can define the scope so I think it should be possible to make several little UML diagram which could easily be placed inside the docs with the extension sphinx.ext.graphviz.

[hf-kklein]

Does it have to be in one diagram?

no. one diagram per business object is just fine.