还在使用 pip 和 setuptools 来进行Python的依赖管理吗?那你就已经落伍了。来看看 Poetry吧,这个依赖管理库为Python带来了全新的体验。
简介
Poetry,是 python-poetry 组织在Github上开源的Python依赖管理工具,项目位于
https://github.com/python-poetry/poetry,目前版本为1.0.9。
Poetry能帮助你声明、管理和安装 Python 依赖,其从 PHP 的 composer 和 Rust 的 cargo 工具,意在替代 Pipenv 等工具。Poetry使用一个配置文件 pyproject.yoml 替代现有的包括 setup.py、requirements.txt、setup.cfg、MANIFEST.in 和 Pipfile 在内的配置文件,并提供了极为丰富的配置语法。同时,Poetry提供了一个更为完善、更为强大的命令行工具,更加方便使用。另外,Poetry使用了更为可靠的依赖解析逻辑,避免了复杂的依赖中容易出现的问题,使得得到的依赖环境更为合理。
安装
Poetry需要Python 2.7和3.4+。安装Poetry,推荐的方式是使用curl下载安装脚本:
curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python
我们也可以使用选项进行preview或特定版本的安装:
python get-poetry.py --version 0.7.0
使用pip进行安装也是可能的,但要注意poetry的依赖所可能带来的依赖冲突。
示例
使用Poetry进行依赖安装十分简单,使用add命令:
可以看到,Poetry使用了lock文件,命令行显示了依赖的安装情况。另外,Poetry也可以进行打包构建,使用build:
Poetry还支持库的发布,可以直接发布到PyPI上:
我们也可以查看当前项目的依赖树,使用show命令,命令行的显示十分清晰:
Poetry使用pyproject.toml进行所有的依赖定义:
[tool.poetry]
name = "my-package"
version = "0.1.0"
description = "The description of the package"
license = "MIT"
authors = [
"Sébastien Eustace "
]
readme = 'README.md' # Markdown files are supported
repository = "https://github.com/python-poetry/poetry"
homepage = "https://github.com/python-poetry/poetry"
keywords = ['packaging', 'poetry']
[tool.poetry.dependencies]
python = "~2.7 || ^3.2" # Compatible python versions must be declared here
toml = "^0.9"
# Dependencies with extras
requests = { version = "^2.13", extras = [ "security" ] }
# Python specific dependencies with prereleases allowed
pathlib2 = { version = "^2.2", python = "~2.7", allow-prereleases = true }
# Git dependencies
cleo = { git = "https://github.com/sdispater/cleo.git", branch = "master" }
# Optional dependencies (extras)
pendulum = { version = "^1.4", optional = true }
[tool.poetry.dev-dependencies]
pytest = "^3.0"
pytest-cov = "^2.4"
[tool.poetry.scripts]
my-script = 'my_package:main'
我们可以看到,toml的第一部分定义了包括名字、作者和版本等描述信息;第二部分则定义了项目的依赖,可以定义包括版本备选、额外选项、git仓库、是否可选等丰富的语法;第三部分定义了项目开发过程中所需的依赖,第四部分则定义了一些方便的脚本入口,可以使用Poetry进行脚本命令的调用。
更多
相比于Pipenv,poetry所实现的依赖解析核心更为有效稳定,尤其在面对复杂依赖中出现的依赖矛盾时更为突出。例如,
pipenv install oslo.utils==1.4.0
会出现依赖冲突错误:
Could not find a version that matches pbr!=0.7,!=2.1.0,<1.0,>=0.6,>=2.0.0
但Poetry却会得到一个合理的依赖冲突解决方案,获得期待的依赖:
poetry add oslo.utils=1.4.0
- Installing pytz (2018.3)
- Installing netifaces (0.10.6)
- Installing netaddr (0.7.19)
- Installing oslo.i18n (2.1.0)
- Installing iso8601 (0.1.12)
- Installing six (1.11.0)
- Installing babel (2.5.3)
- Installing pbr (0.11.1)
- Installing oslo.utils (1.4.0)
总结
Poetry作为一个Python的依赖管理工具,比其他同类型的Python工具更为现代化,其提供了强大的命令行,优秀的依赖解析算法,以及更为便捷和集中的配置管理,使得Python的依赖管理更为方便和人性化。
Poetry目前逐渐被Python开源社区所使用,包括 FastAPI 在内的大型项目已经开始使用Poetry进行依赖管理,Poetry的发展值得更多的关注和期待。