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