1. Produkte
  2.   Diagramm
  3.   Python
  4.   Py2pUML
 
  

Kostenlose Python-Bibliothek zum Erstellen & Verwalten von Visio-Diagrammen

Open-Source-Visio-Python-Bibliothek ermöglicht Entwicklern, Klassendiagramme in PlantUML-Syntax zu erzeugen und bietet eine visuelle Darstellung von Python-Codebasen.

Was ist die Py2pUML-Bibliothek?

Im modernen Softwareentwicklungsumfeld ist das Verstehen und Dokumentieren der Code‑Struktur entscheidend für Wartbarkeit und Zusammenarbeit. Die Py2pUML‑Bibliothek ist ein Open‑Source‑Tool, das Entwicklern hilft, automatisch UML‑Klassendiagramme aus Python‑Code zu erzeugen. Diese Diagramme stellen Klassenbeziehungen, Attribute und Abhängigkeiten visuell dar und erleichtern das Erfassen der Architektur eines Projekts. Die Bibliothek unterstützt das Erzeugen von UML‑Diagrammen für Python‑Projekte, visualisiert Klassenhierarchien und -beziehungen, verbessert die Projektdokumentation, steigert die Team‑Zusammenarbeit, indem sie die Analyse der Code‑Struktur vereinfacht, und vieles mehr. Um potenzielle Nebenwirkungen zu vermeiden, wertet py2puml bei der Erkennung von Kompositionsbeziehungen zugewiesene Werte oder Ausdrücke nicht aus. Diese Design‑Entscheidung gewährleistet die Sicherheit und Integrität des Code‑Analyse‑Prozesses.

Py2pUML ist eine Open-Source-Python-Bibliothek, die automatisch UML-Diagramme aus Python-Code generiert. UML-Diagramme sind ein Standard, um die Struktur und das Design eines Softwaresystems, einschließlich Klassen, Beziehungen und Abhängigkeiten, zu visualisieren. Traditionell war das Erstellen dieser Diagramme ein manueller und zeitaufwändiger Prozess. Py2pUML vereinfacht dies, indem es Python-Code analysiert und UML-Diagramme im PlantUML-Format erzeugt, die dann in visuelle Diagramme gerendert werden können. Derzeit kann py2puml komplexe Typ-Hinweise mit mehreren Ebenen von Generics nicht effektiv verarbeiten. Diese Einschränkung wird anerkannt, und zukünftige Verbesserungen werden in Betracht gezogen. Durch die Berücksichtigung dieser Aspekte dient py2puml als wertvolles Werkzeug für Entwickler, die die Architektur ihrer Python-Anwendungen durch Klassendiagramme dokumentieren und visualisieren möchten.

Previous Next

Erste Schritte mit Py2pUML

Der empfohlene Weg, die Py2pUML-Bibliothek zu installieren, ist die Verwendung von PyPI. Bitte verwenden Sie den folgenden Befehl für eine reibungslose Installation.

Py2pUML-Bibliothek über PyPI installieren

pip install py2puml

Py2pUML-Bibliothek mit Poetry installieren

poetry add py2puml

UML-Diagramm aus Python-Modul erzeugen

Die Open-Source-Bibliothek Py2pUML bietet vollständige Funktionalität, die es Softwareentwicklern ermöglicht, ein PlantUML-Klassendiagramm für jedes Python‑Modul zu erzeugen. Durch die Nutzung von Pythons Inspektionsfähigkeiten und Typannotationen identifiziert py2puml sowohl statische Klassenattribute als auch Dataclass‑Felder. Dies stellt sicher, dass die erzeugten Diagramme die Struktur und Eigenschaften der Klassen im Code‑Bestand genau wiedergeben. Hier ist ein einfaches Beispiel, das zeigt, wie Softwareentwickler ein PlantUML‑Klassendiagramm für ein Python‑Modul generieren können.

Wie erstellt man ein PlantUML Klassendiagramm für ein Python‑Modul?

from py2puml.py2puml import py2puml

# Generate PlantUML content
puml_content = py2puml('path/to/your/module', 'module_name')

# Output the PlantUML content to the terminal
print(''.join(puml_content))

# Write the PlantUML content to a file
with open('module_name.puml', 'w') as puml_file:
    puml_file.writelines(puml_content)

Klassen- und Beziehungserkennung

Entwickler können Py2pUML in eine Flask- oder Django-Webanwendung integrieren, um einen UML-Generierungsservice bereitzustellen. Es analysiert Python‑Code und erzeugt UML‑Diagramme, ohne dass manuelle Eingaben erforderlich sind. Es identifiziert Klassen, Attribute, Methoden und Beziehungen, wodurch es einfach wird, die Struktur Ihres Codes zu visualisieren. Diese API ermöglicht es Benutzern, ein Python‑Modul hochzuladen und ein UML‑Klassendiagramm als herunterladbare .puml‑Datei zu erhalten. Betrachten Sie das folgende Codebeispiel; die Bibliothek erzeugt die PlantUML‑Ausgabe, die Informationen über die Klassen und deren Beziehungen enthält.

Wie erzeugt man die PlantUML‑Ausgabe aus Python‑Code?

class Engine:
    def start(self):
        print("Engine started")

class Car:
    def __init__(self, engine: Engine):
        self.engine = engine

    def drive(self):
        self.engine.start()
        print("Car is moving")

# Py2pUML will generate the following PlantUML output:

@startuml
class Engine {
    + start()
}

class Car {
    - engine: Engine
    + drive()
}

Car --> Engine
@enduml

#This diagram shows that Car has a dependency on Engine.

Code-Anpassung & Benutzerfreundlichkeit

Die Py2pUML-Bibliothek ist so konzipiert, dass sie einfach und unkompliziert ist. Sie erfordert minimale Einrichtung und kann problemlos in Ihren Entwicklungsworkflow integriert werden. Als Open-Source-Bibliothek kann Py2pUML an spezifische Projektanforderungen angepasst werden. Entwickler können das Repository forken, den Code ändern und zur Weiterentwicklung beitragen. Es ist sehr einfach, den Quellcode an Ihre Bedürfnisse anzupassen. Zum Beispiel könnten Sie Unterstützung für das Erkennen und Visualisieren abstrakter Klassen hinzufügen.

Verbesserung der Code-Dokumentation

UML-Diagramme sind eine ausgezeichnete Möglichkeit, Ihren Code zu dokumentieren. Sie bieten eine klare und prägnante Darstellung der Systemarchitektur, wodurch es für andere Entwickler (oder Ihr zukünftiges Ich) einfacher wird, zu verstehen, wie der Code funktioniert. Py2pUML kann in Ihren Dokumentations-Workflow integriert werden, um automatisch aktuelle Diagramme zu erzeugen.

 Deutsch