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‑приложений с помощью диаграмм классов.

Начало работы с 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 можно интегрировать в ваш процесс документирования, чтобы автоматически генерировать актуальные диаграммы.