1. Продукти
  2.   Диаграма
  3.   Python
  4.   Py2pUML
 
  

Безплатна Python библиотека за създаване и управление на Visio диаграми

Отворен код Visio Python библиотека позволява на разработчиците да генерират класови диаграми в синтаксис PlantUML, предоставяйки визуално представяне на Python кодови бази.

Какво е библиотеката Py2pUML?

В съвременното софтуерно развитие разбирането и документирането на структурата на кода е от съществено значение за поддръжката и сътрудничеството. Библиотеката Py2pUML е отворен код инструмент, който помага на разработчиците автоматично да генерират UML класови диаграми от Python код. Тези диаграми визуално представят връзките между класовете, атрибутите и зависимостите, което улеснява разбирането на архитектурата на проекта. Библиотеката поддържа генериране на UML диаграми за Python проекти, визуализиране на йерархии и връзки между класовете, подобряване на документацията на проекта, повишаване на екипната колаборация чрез опростяване на анализа на структурата на кода и др. За да се избегнат потенциални странични ефекти, py2puml не оценява зададени стойности или изрази по време на откриване на композиционни връзки. Това решение осигурява безопасността и целостта на процеса на анализ на кода.

Py2pUML е отворена Python библиотека, създадена за автоматично генериране на UML диаграми от Python код. UML диаграмите са стандартен начин за визуализиране на структурата и дизайна на софтуерна система, включително класове, връзки и зависимости. Традиционно създаването на тези диаграми е било ръчен и времеемък процес. Py2pUML опростява това, като анализира Python кода и произвежда UML диаграми във формат PlantUML, които след това могат да бъдат визуализирани. В момента py2puml може да не обработва сложни типови подсказки с множество нива на дженерики ефективно. Това ограничение е признато и се обмислят бъдещи подобрения. Като се вземат предвид тези съображения, py2puml служи като ценен инструмент за разработчиците, които искат да документират и визуализират архитектурата на своите Python приложения чрез класови диаграми.

Previous Next

Започване с Py2pUML

Препоръчителният начин за инсталиране на библиотеката Py2pUML е чрез PyPI. Моля, използвайте следната команда за гладка инсталация.

Инсталирайте библиотеката Py2pUML чрез PyPI

pip install py2puml

Инсталирайте библиотеката Py2pUML чрез Poetry

poetry add py2puml

Генериране на UML диаграма от Python модул

Отвореният код Py2pUML библиотека предоставя пълна функционалност, позволяваща на софтуерните разработчици да генерират класова диаграма PlantUML за всеки Python модул. Използвайки възможностите за инспекция на Python и типови анотации, py2puml идентифицира както статичните атрибути на класовете, така и полетата на dataclass. Това гарантира, че генерираните диаграми точно отразяват структурата и свойствата на класовете в кода. Ето прост пример, който демонстрира как софтуерните разработчици могат да генерират класова диаграма PlantUML за Python модул.

Как да генерирам PlantUML класова диаграма за Python модул?

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)

Откриване на класове и връзки

Разработчиците могат да интегрират Py2pUML в уеб приложение Flask или Django, за да предоставят услуга за генериране на UML. Той анализира Python код и генерира UML диаграми без нужда от ръчен вход. Идентифицира класове, атрибути, методи и връзки, което улеснява визуализирането на структурата на вашия код. Това API позволява на потребителите да качат Python модул и да получат UML класова диаграма като изтегляем .puml файл. Разгледайте следния пример с код, библиотеката ще генерира PlantUML изход, който ще съдържа информация за класовете и техните взаимоотношения.

Как да генерирам PlantUML изход от Python код?

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.

Персонализиране на кода & Лесна употреба

Библиотеката Py2pUML е проектирана да бъде проста и директна. Тя изисква минимална настройка и може лесно да се интегрира във вашия процес на разработка. Като библиотека с отворен код, Py2pUML може да бъде персонализирана, за да отговаря на специфични изисквания на проекта. Разработчиците могат да клонират хранилището, да променят кода и да допринесат за неговото развитие. Много е лесно да се модифицира изходният код, за да отговаря на вашите нужди. Например, можете да добавите поддръжка за откриване и визуализиране на абстрактни класове.

Подобряване на документацията на кода

UML диаграмите са отличен начин за документиране на вашия код. Те предоставят ясно и сбито представяне на архитектурата на системата, което улеснява другите разработчици (или вашето бъдещо аз) да разберат как работи кодът. Py2pUML може да се интегрира във вашия процес на документиране, за да генерира автоматично актуални диаграми.

 Български