1. Các sản phẩm
  2.   Biểu đồ
  3.   Python
  4.   Py2pUML
 
  

Thư viện Python miễn phí để tạo & quản lý sơ đồ Visio

Thư viện Python Visio nguồn mở cho phép các nhà phát triển tạo sơ đồ lớp bằng cú pháp PlantUML, cung cấp một biểu diễn trực quan của các cơ sở mã Python.

Thư viện Py2pUML là gì?

Trong phát triển phần mềm hiện đại, việc hiểu và tài liệu hoá cấu trúc mã là rất quan trọng đối với khả năng bảo trì và hợp tác. Thư viện Py2pUML là một công cụ mã nguồn mở giúp các nhà phát triển tự động tạo sơ đồ lớp UML từ mã Python. Những sơ đồ này trực quan biểu diễn các mối quan hệ lớp, thuộc tính và phụ thuộc, giúp dễ dàng nắm bắt kiến trúc của dự án. Thư viện hỗ trợ tạo sơ đồ UML cho các dự án Python, trực quan hoá cây lớp và các mối quan hệ, nâng cao tài liệu dự án, cải thiện sự hợp tác của nhóm bằng cách đơn giản hoá việc phân tích cấu trúc mã, và nhiều hơn nữa. Để tránh các tác dụng phụ tiềm tàng, py2puml không đánh giá các giá trị hoặc biểu thức được gán trong quá trình phát hiện các mối quan hệ hợp thành. Lựa chọn thiết kế này đảm bảo an toàn và tính toàn vẹn của quá trình phân tích mã.

Py2pUML là một thư viện Python mã nguồn mở được thiết kế để tự động tạo ra các sơ đồ UML từ mã Python. Các sơ đồ UML là cách tiêu chuẩn để hình dung cấu trúc và thiết kế của một hệ thống phần mềm, bao gồm các lớp, mối quan hệ và phụ thuộc. Truyền thống, việc tạo các sơ đồ này là một quá trình thủ công và tốn thời gian. Py2pUML đơn giản hoá việc này bằng cách phân tích mã Python và tạo ra các sơ đồ UML ở định dạng PlantUML, sau đó có thể được chuyển đổi thành các sơ đồ trực quan. Hiện tại, py2puml có thể chưa xử lý tốt các gợi ý kiểu phức tạp với nhiều cấp độ generic. Giới hạn này đã được công nhận, và các cải tiến trong tương lai đang được xem xét. Bằng cách giải quyết những cân nhắc này, py2puml trở thành một công cụ hữu ích cho các nhà phát triển muốn tài liệu hoá và hình dung kiến trúc của các ứng dụng Python thông qua các sơ đồ lớp.

Previous Next

Bắt đầu với Py2pUML

Cách khuyến nghị để cài đặt thư viện Py2pUML là sử dụng pypi. Vui lòng sử dụng lệnh sau để cài đặt một cách suôn sẻ.

Cài đặt thư viện Py2pUML qua PyPI

pip install py2puml

Cài đặt thư viện Py2pUML bằng Poetry

poetry add py2puml

Tạo sơ đồ UML từ mô-đun Python

Thư viện mã nguồn mở Py2pUML đã cung cấp đầy đủ chức năng cho phép các nhà phát triển phần mềm tạo sơ đồ lớp PlantUML cho bất kỳ mô-đun Python nào. Sử dụng khả năng kiểm tra của Python và các chú thích kiểu, py2puml xác định cả thuộc tính lớp tĩnh và các trường dataclass. Điều này đảm bảo rằng các sơ đồ được tạo ra phản ánh chính xác cấu trúc và thuộc tính của các lớp trong cơ sở mã. Dưới đây là một ví dụ cơ bản minh họa cách các nhà phát triển phần mềm có thể tạo sơ đồ lớp PlantUML cho một mô-đun Python.

Làm thế nào để tạo sơ đồ lớp PlantUML cho một mô-đun 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)

Phát hiện lớp và quan hệ

Các nhà phát triển có thể tích hợp Py2pUML vào ứng dụng web Flask hoặc Django để cung cấp dịch vụ tạo UML. Nó phân tích mã Python và tạo ra các sơ đồ UML mà không cần nhập liệu thủ công. Nó xác định các lớp, thuộc tính, phương thức và mối quan hệ, giúp dễ dàng hình dung cấu trúc của mã nguồn. API này cho phép người dùng tải lên một mô-đun Python và nhận được sơ đồ lớp UML dưới dạng tệp .puml có thể tải xuống. Xem ví dụ mã dưới đây, thư viện sẽ tạo ra đầu ra PlantUML, chứa thông tin về các lớp và mối quan hệ của chúng.

Làm thế nào để tạo đầu ra PlantUML từ mã 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.

Tùy chỉnh mã & Dễ sử dụng

Thư viện Py2pUML được thiết kế đơn giản và dễ hiểu. Nó yêu cầu thiết lập tối thiểu và có thể được tích hợp vào quy trình phát triển của bạn một cách dễ dàng. Là một thư viện mã nguồn mở, Py2pUML có thể được tùy chỉnh để đáp ứng các yêu cầu dự án cụ thể. Các nhà phát triển có thể fork kho lưu trữ, sửa đổi mã và đóng góp vào quá trình phát triển của nó. Việc sửa đổi mã nguồn để phù hợp với nhu cầu của bạn rất dễ dàng. Ví dụ, bạn có thể thêm hỗ trợ phát hiện và trực quan hoá các lớp trừu tượng.

Cải thiện tài liệu mã nguồn

Các sơ đồ UML là một cách tuyệt vời để tài liệu hoá mã của bạn. Chúng cung cấp một biểu diễn rõ ràng và ngắn gọn về kiến trúc của hệ thống, giúp các nhà phát triển khác (hoặc bản thân bạn trong tương lai) dễ dàng hiểu cách mã hoạt động. Py2pUML có thể được tích hợp vào quy trình tài liệu hoá của bạn để tự động tạo ra các sơ đồ luôn cập nhật.

 Tiếng Việt