py2puml 项目推荐

py2puml 项目推荐

py2puml Generate PlantUML class diagrams to document your Python application. 项目地址: https://gitcode.com/gh_mirrors/py/py2puml

项目基础介绍和主要编程语言

py2puml 是一个用于生成 PlantUML 类图的 Python 开源项目。它通过解析 Python 代码，自动生成类图的 PlantUML 脚本，帮助开发者更好地理解和文档化 Python 应用程序的结构。该项目的主要编程语言是 Python。

项目核心功能

py2puml 的核心功能包括：

1. 自动生成 PlantUML 类图：通过代码解析，py2puml 能够自动生成 Python 应用程序的类图，展示类、属性、方法及其关系。
2. 支持多种数据结构：项目能够处理静态类属性、dataclass 字段、namedtuples 成员、枚举成员等数据结构。
3. 检测类关系：py2puml 能够检测类之间的组合和继承关系，并将其反映在生成的类图中。
4. 依赖于类型注解：项目依赖于 Python 的类型注解来检测类之间的关系，确保生成的类图准确无误。
5. 支持多种输出方式：生成的 PlantUML 脚本可以与代码一起版本控制，也可以作为独立文档生成。

项目最近更新的功能

py2puml 最近的更新包括：

1. 版本 0.9.1：改进了 0.7.2 版本，增加了当前工作目录到 sys.path 的开头，以解决项目被检查时模块路径的解析问题。修复了 README.md 页面上的 PlantUML 标志链接。
2. 版本 0.9.0：增加了在 init.py 文件中定义的类到 plantuml 输出中。用 ruff 格式化工具替换了 yapf。
3. 版本 0.8.1：将嵌套命名空间的组装委托给 PlantUML 二进制文件，该文件原生支持此功能。
4. 版本 0.8.0：增加了对联合类型的支持，并引入了 GitHub Actions（预提交钩子 + 自动化测试）。
5. 版本 0.7.2：将当前工作目录添加到导入路径，使 py2puml 在任何目录或原生虚拟环境中都能正常工作（非 poetry 管理的环境）。

这些更新进一步增强了 py2puml 的功能和稳定性，使其成为文档化 Python 应用程序结构的强大工具。

py2puml Generate PlantUML class diagrams to document your Python application. 项目地址: https://gitcode.com/gh_mirrors/py/py2puml