使用 poetry 来更优雅的管理 python 包

Poetry 是一个 Python 依赖管理和打包工具，简化了 Python 项目的依赖管理、构建和发布过程。

FastAPI、Httpx、Pylint 等等项目也正在使用它做依赖管理。

它主要特点有：

• 依赖管理：自动处理项目依赖，包括解析和锁定版本。

• 虚拟环境管理：自动创建和管理项目的虚拟环境。

• 构建和打包：简化项目的构建和打包过程。

• 发布：轻松将项目发布到 PyPI。

• 脚本运行：可以定义和运行项目相关的脚本。

poetry 提供了一系列覆盖整个开发流程的命令，这些命令使用也很简单：

依赖管理方式

使用 new 或 init 初始化了项目之后，会在项目目录下生成 pyproject.toml 。Poetry 使用 pyproject.toml 文件来管理项目配置和依赖。

使用 install 或 add 添加了依赖库后，会生成 poetry.lock 文件。同时依赖会自动添加到 pyproject.toml 中。

name = "my-project"version = "0.1.0"description = "A sample Python project"authors = ["Your Name you@example.com"][tool.poetry.dependencies]python = "^3.9"requests = "^2.25.1"[tool.poetry.dev-dependencies]pytest = "^6.2.3"

发布依赖到仓库

使用 build 命令可以方便的构建出 tar.gz 或 wheel 包。

配置私有仓库的地址：

poetry config repositories.foo https://bar.com/simple # 配置仓库地址
poetry config http-basic.foo username password  # 配置仓库的认证
poetry publish -r foo

根据 poetry config -h 的指引

PS：但是在这边通过配置用户名和密码到系统中的时候，经常出现这个异常：

Unable to retrieve the password for poetry-repository-foo from the key ring

因此使用了另外一种 publish 方式：

poetry config repositories.foo https://bar.com/simple # 配置仓库地址
poetry publish  -r pack1 -u username -p password

注意

• 需要有一个包名与你的 package 一致。

例如 package 名设置的 pack-111，那么在项目路径下，必须有一个 python 包 的文件夹，命名为 pack_111。否则在 build 的时候会报错：

No file/folder found for package pack-111

可以参考 fastapi 的目录结构：

总结

Poetry 的优势在于它提供了一个统一的工具来处理 Python 项目的整个生命周期，从依赖管理到打包和发布。它的依赖解析器非常强大，能够有效地处理复杂的依赖关系。此外，Poetry 还提供了一个直观的命令行界面，使得项目管理变得更加简单。

对于团队协作和项目部署来说，Poetry 的依赖锁定功能（通过 poetry.lock 文件）特别有用，因为它确保了所有环境中使用相同版本的依赖。

作者：麦麦麦造

链接：https://juejin.cn/post/7406355689075294247