1. Producten
  2.   Diagram
  3.   Python
  4.   Py2pUML
 
  

Gratis Python Bibliotheek om Visio-diagrammen te Maken & Beheren

Open Source Visio Python Bibliotheek stelt ontwikkelaars in staat om klassendiagrammen te genereren in PlantUML-syntaxis, waardoor een visuele weergave van Python-codebases ontstaat.

Wat is de Py2pUML-bibliotheek?

In moderne softwareontwikkeling is het begrijpen en documenteren van de code-structuur cruciaal voor onderhoudbaarheid en samenwerking. De Py2pUML-bibliotheek is een open-source tool die ontwikkelaars helpt automatisch UML-klassendiagrammen te genereren vanuit Python-code. Deze diagrammen geven visueel de relaties tussen klassen, attributen en afhankelijkheden weer, waardoor het makkelijker wordt de architectuur van een project te doorgronden. De bibliotheek ondersteunt het genereren van UML-diagrammen voor Python-projecten, het visualiseren van klasse-hiërarchieën en relaties, het verbeteren van projectdocumentatie, het verbeteren van team-samenwerking door het vereenvoudigen van code-structuuranalyse, enzovoort. Om mogelijke bijwerkingen te vermijden evalueert py2puml geen toegewezen waarden of expressies tijdens het detecteren van compositiere relaties. Deze ontwerpkeuze waarborgt de veiligheid en integriteit van het code-analyseproces.

Py2pUML is een open source Python-bibliotheek die automatisch UML-diagrammen genereert uit Python-code. UML-diagrammen zijn een standaard manier om de structuur en het ontwerp van een softwaresysteem te visualiseren, inclusief klassen, relaties en afhankelijkheden. Traditioneel was het maken van deze diagrammen een handmatig en tijdrovend proces. Py2pUML vereenvoudigt dit door Python-code te parseren en UML-diagrammen te produceren in PlantUML-formaat, die vervolgens kunnen worden gerenderd tot visuele diagrammen. Momenteel kan py2puml complexe typehints met meerdere generieke niveaus niet effectief verwerken. Deze beperking wordt erkend en toekomstige verbeteringen worden overwogen. Door deze overwegingen aan te pakken, dient py2puml als een waardevol hulpmiddel voor ontwikkelaars die de architectuur van hun Python-toepassingen willen documenteren en visualiseren via klassendiagrammen.

Previous Next

Aan de slag met Py2pUML

De aanbevolen manier om de Py2pUML-bibliotheek te installeren is via PyPI. Gebruik alstublieft het volgende commando voor een soepele installatie.

Installeer Py2pUML-bibliotheek via PyPI

pip install py2puml

Installeer Py2pUML-bibliotheek met Poetry

poetry add py2puml

Genereer UML-diagram vanuit Python-module

De open source Py2pUML-bibliotheek biedt volledige functionaliteit waarmee softwareontwikkelaars een PlantUML-klassendiagram kunnen genereren voor elke Python-module. Door gebruik te maken van Python's inspectiecapaciteiten en type‑annotaties, identificeert py2puml zowel statische klasse‑attributen als dataclass‑velden. Dit zorgt ervoor dat de gegenereerde diagrammen nauwkeurig de structuur en eigenschappen van klassen binnen de codebasis weergeven. Hier is een eenvoudig voorbeeld dat laat zien hoe softwareontwikkelaars een PlantUML-klassendiagram kunnen genereren voor een Python-module.

Hoe genereer je een PlantUML klassendiagram voor een Python-module?

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- en relatiedetectie

Ontwikkelaars kunnen Py2pUML integreren in een Flask- of Django-webapp om een UML‑generatieservice te bieden. Het analyseert Python‑code en genereert UML‑diagrammen zonder handmatige invoer. Het identificeert klassen, attributen, methoden en relaties, waardoor het eenvoudig is de structuur van uw code te visualiseren. Deze API stelt gebruikers in staat een Python‑module te uploaden en een UML‑klassendiagram te ontvangen als een downloadbaar .puml‑bestand. Beschouw het volgende code‑voorbeeld; de bibliotheek zal de PlantUML‑output genereren, die informatie bevat over de klassen en hun relaties.

Hoe genereer je de PlantUML-uitvoer uit 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-aanpassing & gebruiksgemak

De Py2pUML-bibliotheek is ontworpen om eenvoudig en rechttoe rechtaan te zijn. Het vereist minimale configuratie en kan moeiteloos in uw ontwikkelworkflow worden geïntegreerd. Als een open‑source bibliotheek kan Py2pUML worden aangepast om te voldoen aan specifieke projectvereisten. Ontwikkelaars kunnen de repository forken, de code wijzigen en bijdragen aan de ontwikkeling. Het is heel gemakkelijk om de broncode aan te passen aan uw behoeften. Bijvoorbeeld, u kunt ondersteuning toevoegen voor het detecteren en visualiseren van abstracte klassen.

Verbeteren van code-documentatie

UML-diagrammen zijn een uitstekende manier om uw code te documenteren. Ze bieden een duidelijke en beknopte weergave van de architectuur van het systeem, waardoor het voor andere ontwikkelaars (of uzelf in de toekomst) gemakkelijker wordt om te begrijpen hoe de code werkt. Py2pUML kan in uw documentatieworkflow worden geïntegreerd om automatisch up-to-date diagrammen te genereren.

 Dutch