विज़ियो डायग्राम बनाने और प्रबंधित करने के लिए मुफ्त पाइथन लाइब्रेरी

Py2pUML के साथ शुरुआत करना

Py2pUML लाइब्रेरी को स्थापित करने का अनुशंसित तरीका pypi का उपयोग करना है। सुगम स्थापना के लिए कृपया निम्नलिखित कमांड का उपयोग करें।

pip install py2puml

poetry add py2puml

Python मॉड्यूल से UML डायग्राम बनाएं

ओपन सोर्स Py2pUML लाइब्रेरी ने पूरी कार्यक्षमता प्रदान की है जो सॉफ्टवेयर डेवलपर्स को किसी भी Python मॉड्यूल के लिए PlantUML क्लास डायग्राम जनरेट करने में सक्षम बनाती है। Python की इन्स्पेक्शन क्षमताओं और टाइप एनोटेशन का उपयोग करके, py2puml स्थैतिक क्लास एट्रिब्यूट्स और डेटाक्लास फ़ील्ड दोनों की पहचान करता है। यह सुनिश्चित करता है कि जनरेट किए गए डायग्राम कोडबेस में क्लासों की संरचना और गुणों को सटीक रूप से दर्शाते हैं। यहाँ एक बुनियादी उदाहरण है जो दर्शाता है कि सॉफ्टवेयर डेवलपर्स कैसे Python मॉड्यूल के लिए 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 जेनरेशन सेवा प्रदान कर सकते हैं। यह Python कोड का विश्लेषण करता है और मैन्युअल इनपुट की आवश्यकता के बिना UML डायग्राम जनरेट करता है। यह क्लास, एट्रिब्यूट, मेथड और रिलेशनशिप की पहचान करता है, जिससे आपके कोड की संरचना को विज़ुअलाइज़ करना आसान हो जाता है। यह API उपयोगकर्ताओं को एक Python मॉड्यूल अपलोड करने और डाउनलोडेबल .puml फ़ाइल के रूप में UML क्लास डायग्राम प्राप्त करने की अनुमति देती है। नीचे दिए गए कोड उदाहरण पर विचार करें, लाइब्रेरी 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 को आपके दस्तावेज़ीकरण कार्यप्रवाह में एकीकृत किया जा सकता है ताकि स्वचालित रूप से अद्यतन डायग्राम उत्पन्न किए जा सकें।