fishbad.blogg.se - Plantuml sequence diagram online

Name: str children: List items_number: intĬlass Ĭlass sequence diagram is particularly helpful in identifying the requirements of a system including all the functionalities. If you like tools related with PlantUML, you may also be interested in this lucsorel/plantuml-file-loader project:Ī webpack loader which converts PlantUML files into images during the webpack processing (useful to include PlantUML diagrams in your slides with RevealJS or RemarkJS). To generate image files, use the PlantUML runtime, a docker image of the runtime (see think/plantuml) or of a server (see the CLI documentation below)

generated and hosted along other code documentation (better option: generated documentation should not be versioned with the codebase).

versioned along your code with a unit-test ensuring its consistency (see the test_py2puml.py's test_py2puml_model_on_py2uml_domain example).

Py2puml outputs diagrams in PlantUML syntax, which can be:

Parsing abstract syntax trees to detect the instance attributes defined in _init_ constructors The detection of composition relationships relies on type annotations only, assigned values or expressions are never evaluated to prevent unwanted side-effects

composition and inheritance relationships (between your domain classes only, for documentation sake).

static class attributes and dataclass fields.

Inspection and type annotations to detect: Featuresįrom a given path corresponding to a folder containing Python code, py2puml processes each file as a module and generates a PlantUML script of its classe-like definitions using: Some parsing features are available only since Python 3.8 (like ast.get_source_segment). Py2puml internally uses code inspection (also called reflexion in other programming languages) and abstract tree parsing to retrieve relevant information. Py2puml produces a class diagram PlantUML script representing classes properties (static and instance attributes) and their relations (composition and inheritance relationships). Generate PlantUML class diagrams to document your Python application.