مكتبة بايثون مجانية لإنشاء وإدارة مخططات Visio
مكتبة بايثون Visio مفتوحة المصدر تسمح للمطورين بإنشاء مخططات الفئات بصيغة PlantUML، وتوفر تمثيلًا بصريًا لقاعدة شفرة بايثون.
ما هي مكتبة Py2pUML؟
في تطوير البرمجيات الحديث، يُعدّ فهم وتوثيق بنية الشيفرة أمرًا حاسمًا للصيانة والتعاون. مكتبة Py2pUML هي أداة مفتوحة المصدر تساعد المطورين على إنشاء مخططات فئات UML تلقائيًا من كود بايثون. تمثّل هذه المخططات العلاقات بين الفئات والخصائص والاعتمادات بصريًا، مما يسهل استيعاب بنية المشروع. تدعم المكتبة إنشاء مخططات UML لمشاريع بايثون، وتصور تسلسل الفئات وعلاقاتها، وتعزيز توثيق المشروع، وتحسين تعاون الفريق من خلال تبسيط تحليل بنية الشيفرة، وما إلى ذلك. لتجنب الآثار الجانبية المحتملة، لا تقوم py2puml بتقييم القيم أو التعبيرات المعينة أثناء اكتشاف علاقات التركيب. يضمن هذا الاختيار التصميمي سلامة عملية تحليل الشيفرة ونزاهتها.
Py2pUML هي مكتبة بايثون مفتوحة المصدر صممت لتوليد مخططات UML تلقائيًا من كود بايثون. تُعد مخططات UML طريقة قياسية لتصور بنية وتصميم نظام برمجي، بما في ذلك الفئات والعلاقات والاعتمادات. تقليديًا، كان إنشاء هذه المخططات عملية يدوية تستغرق وقتًا طويلاً. يبسط Py2pUML ذلك عن طريق تحليل كود بايثون وإنتاج مخططات UML بصيغة PlantUML، والتي يمكن بعد ذلك تحويلها إلى مخططات بصرية. حاليًا، قد لا يتعامل py2puml بفعالية مع تلميحات النوع المعقدة ذات مستويات متعددة من الأنواع العامة. تم الاعتراف بهذه القيود، وتُنظر في تحسينات مستقبلية. من خلال معالجة هذه الاعتبارات، يُعد py2puml أداة قيمة للمطورين الذين يسعون لتوثيق وتصور بنية تطبيقاتهم بايثون عبر مخططات الفئات.
البدء مع Py2pUML
الطريقة الموصى بها لتثبيت مكتبة Py2pUML هي استخدام PyPI. يرجى استخدام الأمر التالي لتثبيت سلس.
تثبيت مكتبة Py2pUML عبر PyPI
pip install py2pumlتثبيت مكتبة Py2pUML باستخدام Poetry
poetry add py2pumlإنشاء مخطط UML من وحدة بايثون
توفر مكتبة Py2pUML المفتوحة المصدر وظائف كاملة تمكّن مطوري البرمجيات من إنشاء مخطط فئة PlantUML لأي وحدة بايثون. باستخدام قدرات الفحص في بايثون وتعليقات النوع، يحدد py2puml كلًا من سمات الفئة الثابتة وحقول dataclass. يضمن ذلك أن المخططات المولدة تعكس بدقة بنية وخصائص الفئات داخل قاعدة الشيفرة. إليك مثال أساسي يوضح كيف يمكن لمطوري البرمجيات إنشاء مخطط فئة PlantUML لوحدة بايثون.
كيف تُنشئ مخطط فئة PlantUML لوحدة بايثون؟
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. يقوم بتحليل شفرة بايثون وإنشاء مخططات UML دون الحاجة إلى إدخال يدوي. يحدد الفئات والسمات والطرق والعلاقات، مما يجعل من السهل تصور بنية الشيفرة الخاصة بك. تسمح هذه الواجهة البرمجية للمستخدمين بتحميل وحدة بايثون والحصول على مخطط فئة UML كملف .puml قابل للتنزيل. انظر المثال البرمجي التالي، ستقوم المكتبة بإنشاء مخرجات PlantUML التي ستحتوي على معلومات حول الفئات وعلاقاتها.
كيف تُولّد مخرجات PlantUML من كود بايثون؟
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 في سير عمل التوثيق الخاص بك لتوليد مخططات محدثة تلقائيًا.
