Python Poetry 使用教程

Python Poetry 使用教程

poetry简化Python包的打包与依赖关系管理工作而设计的一种解决方案或工具项目地址:https://gitcode.com/gh_mirrors/po/poetry

1. 项目目录结构及介绍

Python Poetry 是一个现代化的包管理和依赖关系解决工具。其仓库的目录结构通常包括以下部分：

.
├── pyproject.toml      # 项目配置文件，定义包信息及依赖
└── poetry.lock         # 锁定文件，记录具体依赖版本

• pyproject.toml: 这是项目的核心配置文件，它包含了项目元数据（如作者、版本等）以及依赖关系。使用 Poetry 的一大特点就是通过这个文件来管理项目依赖。
• poetry.lock: 这个文件存储了所有依赖的确切版本，确保在不同环境中能复现相同的依赖环境。

2. 项目的启动文件介绍

虽然 poetry 不直接涉及项目的启动文件，但通常情况下，Python 项目的主入口点是 main.py 或 app.py 文件。例如，如果你的项目有一个名为 src 的源代码目录，那么启动文件可能位于 src/main.py。要运行项目，可以先将项目添加到虚拟环境中，然后执行该文件，如下：

poetry install       # 安装项目及其依赖
python src/main.py   # 在安装了依赖的环境下运行主程序

请注意，实际的启动文件路径取决于你的项目设置。

3. 项目的配置文件介绍

主要的配置文件是 pyproject.toml。下面是一个基本的示例，展示了如何在这个文件中定义项目信息和依赖：

[tool.poetry]
name = "your-project-name"
version = "0.1.0"
description = "A brief description of your project"

[tool.poetry.authors]
author1 <>
author2 <>

[tool.poetry.dependencies]
python = "^3.8"
requests = "^2.25.1"
numpy = "^1.19.3"

[tool.poetry.dev-dependencies]
pytest = "^6.2.2"
black = "^21.11b0"

• [tool.poetry] 部分用来设定项目的基本信息，如名称、版本和描述。
• [tool.poetry.authors] 可以列出项目作者。
• [tool.poetry.dependencies] 列出项目运行所需的生产环境依赖。
• [tool.poetry.dev-dependencies] 列出开发时使用的额外依赖。

此外，poetry 允许你在 pyproject.toml 中配置更多高级选项，如环境变量、脚本和其他特定于工具的设置。更多信息可在官方文档中查阅：https://python-poetry.org/docs/pyproject/

poetry简化Python包的打包与依赖关系管理工作而设计的一种解决方案或工具项目地址:https://gitcode.com/gh_mirrors/po/poetry