Python Polylith 项目教程

Python Polylith 项目教程

python-polylith Tooling support for the Polylith Architecture in Python. 项目地址: https://gitcode.com/gh_mirrors/py/python-polylith

1. 项目的目录结构及介绍

Python Polylith 项目的目录结构如下：

python-polylith/
├── bases/
│   └── polylith/
├── components/
│   └── polylith/
├── development/
├── projects/
├── test/
├── flake8/
├── gitignore
├── CODE-OF-CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── mypy.ini
├── poetry.lock
├── poetry.toml
├── pyproject.toml
└── workspace.toml

目录结构介绍

• bases/: 包含项目的基础代码，这些代码是项目中所有组件共享的基础部分。
• components/: 包含项目的组件代码，每个组件都是一个独立的模块，可以被多个项目复用。
• development/: 包含开发环境相关的配置和代码。
• projects/: 包含项目的具体实现，通常是微服务或应用的代码。
• test/: 包含项目的测试代码。
• flake8/: 包含 Flake8 的配置文件，用于代码风格检查。
• gitignore: Git 的忽略文件配置。
• CODE-OF-CONDUCT.md: 项目的行为准则。
• CONTRIBUTING.md: 项目的贡献指南。
• LICENSE: 项目的开源许可证。
• README.md: 项目的介绍文档。
• mypy.ini: Mypy 的配置文件，用于静态类型检查。
• poetry.lock: Poetry 的锁定文件，用于版本控制。
• poetry.toml: Poetry 的配置文件。
• pyproject.toml: Python 项目的配置文件。
• workspace.toml: 工作区的配置文件。

2. 项目的启动文件介绍

在 Python Polylith 项目中，启动文件通常位于 projects/ 目录下，具体文件名和路径可能因项目而异。以下是一个典型的启动文件示例：

# projects/my_project/main.py

from bases.polylith import Base
from components.polylith import Component

def main():
    base = Base()
    component = Component()
    base.run()
    component.run()

if __name__ == "__main__":
    main()

启动文件介绍

• main.py: 这是项目的启动文件，通常包含 main() 函数，负责初始化和运行项目的基础和组件。
• Base: 从 bases/polylith 目录中导入的基础类，用于初始化项目的基础部分。
• Component: 从 components/polylith 目录中导入的组件类，用于初始化项目的组件部分。

3. 项目的配置文件介绍

Python Polylith 项目中有多个配置文件，以下是主要的配置文件及其介绍：

pyproject.toml

[tool.poetry]
name = "python-polylith"
version = "0.1.0"
description = "Tooling support for the Polylith Architecture in Python"
authors = ["David Vujic <david.vujic@gmail.com>"]
license = "MIT"

[tool.poetry.dependencies]
python = "^3.8"

[tool.poetry.dev-dependencies]
pytest = "^6.2"

[build-system]
requires = ["poetry-core>=1.0.0"]
build-backend = "poetry.core.masonry.api"

配置文件介绍

• pyproject.toml: 这是 Python 项目的核心配置文件，包含了项目的元数据、依赖项、构建系统等信息。
  • [tool.poetry]: 定义了项目的名称、版本、描述、作者和许可证。
  • [tool.poetry.dependencies]: 定义了项目的依赖项，例如 Python 版本。
  • [tool.poetry.dev-dependencies]: 定义了开发环境的依赖项，例如测试框架 pytest。
  • [build-system]: 定义了构建系统的要求和后端。

workspace.toml

[workspace]
name = "python-polylith"
version = "0.1.0"
description = "Tooling support for the Polylith Architecture in Python"
authors = ["David Vujic <david.vujic@gmail.com>"]
license = "MIT"

[workspace.dependencies]
python = "^3.8"

[workspace.dev-dependencies]
pytest = "^6.2"

配置文件介绍

• workspace.toml: 这是工作区的配置文件，类似于 pyproject.toml，但专门用于工作区的配置。
  • [workspace]: 定义了工作区的名称、版本、描述、作者和许可证。
  • [workspace.dependencies]: 定义了工作区的依赖项，例如 Python 版本。
  • [workspace.dev-dependencies]: 定义了开发环境的依赖项，例如测试框架 pytest。

通过以上配置文件，可以有效地管理和配置 Python Polylith 项目。

python-polylith Tooling support for the Polylith Architecture in Python. 项目地址: https://gitcode.com/gh_mirrors/py/python-polylith