1. Produtos
  2.   Diagrama
  3.   Python
  4.   Py2pUML
 
  

Biblioteca Python Gratuita para Criar e Gerenciar Diagramas Visio

Biblioteca Python Visio de Código Aberto permite que desenvolvedores gerem diagramas de classes em sintaxe PlantUML, fornecendo uma representação visual de bases de código Python.

O que é a Biblioteca Py2pUML?

Na engenharia de software moderna, compreender e documentar a estrutura do código é crucial para a manutenção e colaboração. A biblioteca Py2pUML é uma ferramenta de código aberto que ajuda os desenvolvedores a gerar automaticamente diagramas de classes UML a partir de código Python. Esses diagramas representam visualmente as relações entre classes, atributos e dependências, facilitando a compreensão da arquitetura de um projeto. A biblioteca suporta a geração de diagramas UML para projetos Python, visualiza hierarquias e relacionamentos de classes, aprimora a documentação do projeto, melhora a colaboração da equipe ao simplificar a análise da estrutura do código, entre outros. Para evitar efeitos colaterais potenciais, o py2puml não avalia valores ou expressões atribuídas durante a detecção de relacionamentos de composição. Essa escolha de design garante a segurança e a integridade do processo de análise de código.

Py2pUML é uma biblioteca Python de código aberto projetada para gerar automaticamente diagramas UML a partir de código Python. Diagramas UML são uma forma padrão de visualizar a estrutura e o design de um sistema de software, incluindo classes, relacionamentos e dependências. Tradicionalmente, criar esses diagramas tem sido um processo manual e demorado. Py2pUML simplifica isso ao analisar o código Python e produzir diagramas UML no formato PlantUML, que podem então ser renderizados em diagramas visuais. Atualmente, o py2puml pode não lidar efetivamente com dicas de tipo complexas com múltiplos níveis de genéricos. Essa limitação é reconhecida, e melhorias futuras são consideradas. Ao abordar essas considerações, o py2puml serve como uma ferramenta valiosa para desenvolvedores que buscam documentar e visualizar a arquitetura de suas aplicações Python através de diagramas de classes.

Previous Next

Começando com Py2pUML

A forma recomendada de instalar a biblioteca Py2pUML é usando o PyPI. Por favor, use o comando a seguir para uma instalação tranquila.

Instalar a Biblioteca Py2pUML via pypi

pip install py2puml

Instalar a Biblioteca Py2pUML usando Poetry

poetry add py2puml

Gerar Diagrama UML a partir de Módulo Python

A biblioteca de código aberto Py2pUML forneceu funcionalidade completa que permite aos desenvolvedores de software gerar um diagrama de classes PlantUML para qualquer módulo Python. Utilizando os recursos de inspeção do Python e anotações de tipo, o py2puml identifica tanto atributos de classe estáticos quanto campos de dataclass. Isso garante que os diagramas gerados reflitam com precisão a estrutura e as propriedades das classes dentro da base de código. Aqui está um exemplo básico que demonstra como os desenvolvedores de software podem gerar um diagrama de classes PlantUML para um módulo Python.

Como gerar um diagrama de classes PlantUML para um módulo 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)

Detecção de Classes e Relacionamentos

Os desenvolvedores podem integrar o Py2pUML em um aplicativo web Flask ou Django para oferecer um serviço de geração de UML. Ele analisa o código Python e gera diagramas UML sem exigir entrada manual. Identifica classes, atributos, métodos e relacionamentos, facilitando a visualização da estrutura do seu código. Esta API permite que os usuários enviem um módulo Python e recebam um diagrama de classes UML como um arquivo .puml baixável. Considere o exemplo de código a seguir; a biblioteca gerará a saída PlantUML, que conterá informações sobre as classes e seus relacionamentos.

Como gerar a saída PlantUML a partir de um código 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.

Personalização de Código e Facilidade de Uso

A biblioteca Py2pUML foi projetada para ser simples e direta. Ela requer configuração mínima e pode ser integrada ao seu fluxo de trabalho de desenvolvimento com facilidade. Como uma biblioteca de código aberto, o Py2pUML pode ser customizada para atender a requisitos específicos do projeto. Os desenvolvedores podem fazer fork do repositório, modificar o código e contribuir para o seu desenvolvimento. É muito fácil modificar o código-fonte para atender às suas necessidades. Por exemplo, você poderia adicionar suporte para detectar e visualizar classes abstratas.

Melhorando a Documentação de Código

Diagramas UML são uma excelente forma de documentar seu código. Eles fornecem uma representação clara e concisa da arquitetura do sistema, facilitando a compreensão de como o código funciona por outros desenvolvedores (ou por você no futuro). O Py2pUML pode ser integrado ao seu fluxo de trabalho de documentação para gerar automaticamente diagramas atualizados.

 Português