Leabharlann Python Saor chun Scéimeanna Visio a Chruthú & a Bhainistiú

Ag tosú le Py2pUML

Is é an bealach molta chun leabharlann Py2pUML a shuiteáil ná úsáid a bhaint as pypi. Úsáid an t-ordú seo a leanas le haghaidh suiteála réidh.

pip install py2puml

poetry add py2puml

Gin Diagrams UML ó Mhodúl Python

Tá an leabharlann oscailte Py2pUML soláthair feidhmiúlacht iomlán ag cumasú forbróirí bogearraí chun diagram rang PlantUML a ghiniúint do aon mhodúl Python. Ag baint úsáide as cumais iniúchta Python agus anótálacha cineáil, aithníonn py2puml idir aicmeanna tréithneacha statach agus réimsí dataclass. Cinntíonn sé seo go léiríonn na léaráidí ginte go cruinn struchtúr agus airíonna na ranganna laistigh den bhunachar cód. Seo sampla bunúsach a thaispeánann conas is féidir le forbróirí bogearraí diagram rang PlantUML a ghiniúint do mhodúl 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)

Brath Aicme agus Caidreamh

Is féidir le forbróirí Py2pUML a chomhtháthú i bhfeidhmchlár Gréasáin Flask nó Django chun seirbhís ghiniúint UML a sholáthar. Déanann sé an cód Python a anailísiú agus cruthaíonn sé léaráidí UML gan ionchur láimhe a éileamh. Aithníonn sé ranganna, tréithneacha, modhanna, agus caidrimh, rud a fhágann go bhfuil sé éasca struchtúr do chód a fheiceáil. Ligeann an API seo d'úsáideoirí modúl Python a uasluchtú agus diagram rang UML a fháil mar chomhad .puml iníosaithe. Breathnaigh ar an sampla cód thíos, cruthóidh an leabharlann an t-aschur PlantUML, a bheidh ina bhfuil faisnéis faoi na ranganna agus a gcaidreamh.

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.

Saincheapadh Cód & Éascaíocht Úsáide

Tá leabharlann Py2pUML deartha chun a bheith simplí agus díreach. Éilíonn sé socrú íosta agus is féidir é a chomhtháthú le do shruth oibre forbartha go héasca. Mar leabharlann foinse oscailte, is féidir Py2pUML a shaincheapadh chun freastal ar riachtanais shonracha an tionscadail. Is féidir le forbróirí an stór a fhorcáil, an cód a mhodhnú, agus cur le a fhorbairt. Tá sé an-éasca an cód foinse a mhodhnú chun freastal ar do chuid riachtanas. Mar shampla, d'fhéadfá tacaíocht a chur leis chun ranganna áibí a bhrath agus a thaispeáint.

Feabhsú Doiciméadú Cód

Is bealach den scoth iad léaráidí UML chun do chód a cháiliú. Soláthraíonn siad léiriú soiléir agus beacht ar ailtireacht an chórais, rud a fhágann go bhfuil sé níos éasca do fhorbróirí eile (nó d'údar amach anseo) an cód a thuiscint. Is féidir Py2pUML a chomhtháthú le do shruth oibre doiciméadaithe chun léaráidí cothrom le dáta a ghiniúint go huathoibríoch.