Python 之包管理 poetry

官方文档：python-poetry.org/docs/

poetry 是一个 Python 虚拟环境和依赖管理的工具。poetry 和 pipenv 类似，另外还提供了打包和发布的功能。

poetry 安装

poetry提供多种安装方式，个人推荐从以下2种方式中选择：

方式一：（推荐）

$ curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python

方式二：（pip）

$ pip install --user poetry

安装完成之后，将脚本路径添加到 环境变量中，添加完成之后，可在终端输入命令： poetry –version 来确认是否安装配置完成。

工程初始化

新工程

如果当前还没有创建工程，可以使用poetry新建工程：

输入poetry new来创建一个项目脚手架，包括基本结构、pyproject.toml文件。

$ poetry new poetry-demo

这时候，会创建一个包含如下内容的工程

poetry-demo
├── pyproject.toml  # 使用此文件管理依赖列表和项目的各种meta信息，用来替代 Pipfile、requirements.txt、setup.py、setup.cfg、MANIFEST.in 等等各种配置文件
├── README.rst
├── poetry_demo     # 项目目录
│ └── __init__.py
└── tests           # 测试模块.
├── __init__.py
└── test_poetry_demo.py

已有工程

在已有的项目使用poetry，只需要执行 poetry init 命令来创建一个pyproject.toml文件

$ poetry init

这时候，它会让你输入包名称、版本号等信息，你可以选择输入，也可以选择按下ENTER键使用默认值，完成以后，pyproject.toml如以下格式：

name = "poetry-demo"
version = "0.1.0"
description = ""
authors = ["lepeng"]

[tool.poetry.dependencies]
python = "*"

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

依赖包管理

安装依赖包: poetry install

可以使用install命令直接解析并安装 pyproject.toml 的依赖包

$ poetry install

将依赖包添加到pyproject.toml文件中，同时安装它们: poetry add

$ poetry add numpy

还可以，通过添加配置参数–dev来区分不同环境下的依赖包。

• poetry add flask：安装最新稳定版本的flask
• poetry add pytest –dev: 指定为开发依赖，会写到pyproject.toml中的[tool.poetry.dev-dependencies]区域
• poetry add flask=2.22.0: 指定具体的版本
• poetry install: 安装pyproject.toml文件中的全部依赖
• poetry install –no-dev：只安装非development环境的依赖，一般部署时使用
  

更新所有锁定版本的依赖包: poetry update

$ poetry update

更新指定依赖包

$ poetry update numpy

卸载依赖包: poetry remove

$ poetry remove numpy

查看可以更新的依赖: poetry show

$ poetry show –outdated

查看项目安装的依赖: poetry show

$ poetry show

树形结构查看项目安装的依赖

$ poetry show -t

导出包为 requirements.txt

$ poetry export –output requirements.txt

执行python命令 poetry run

$ poetry run python -V 主要用来执行python命令，会将run之后的命令放到python环境执行。
$ poetry run python app.py 运行Python脚本

将python文件打包 poetry build

主要用来将python文件打包，打包之后的产物有两种包的格式：sdist是源码格式；wheel是编译之后的格式。

$ poetry build

将用build命令打包完成的产物上传到PyPI上: poetry publish

配置正确的账号和用户名，这样才可以正常上传

$ poetry config http-basic.pypi username password
$ poetry publish

假如你们公司有自己的私有仓库，则可以通过如下方式上传：
先配置私有仓库的信息，然后再上传

$ poetry config repositories.foo https://foo.bar/simple/
$ poetry config http-basic.foo username password
$ poetry publish -r my-repository

虚拟环境管理

创建虚拟环境

创建虚拟环境有2种方式：

方式1：

如果在配置文件中配置了virtualenvs.create=true，执行 poetry install 或 poetry add 时会检查是否有虚拟环境，否则会自动创建。

这里一个问题就是：如果系统中既有Python2又有Python3，且项目既支持Python2也支持Python3，那poetry会优先使用Python2。

方式2：利用 poetry env use 创建

指定创建虚拟环境时使用的Python解释器版本
$ poetry env use python3.7

激活虚拟环境
$ poetry shell

查看虚拟环境信息
$ poetry env info

显示虚拟环境列表
$ poetry env list

显示虚拟环境绝对路径
$ poetry env list –full-path

删除虚拟环境
$ poetry env remove python3.7

查看python版本
$ poetry run python -V

poetry config 配置文件: config.toml

poetry提供了全局config配置和特定项目的config配置。

• windows下的全局config配置文件：C:\Users\fenglepeng\AppData\Roaming\pypoetry\config.toml
• macOS下的全局config配置文件：/Users/fenglepeng/Library/Application Support/pypoetry/config.toml

目前poetry支持的参数有：

name	注释
cache-dir	poetry使用的缓存目录的路径默认值: macOS: ~/Library/Caches/pypoetry Windows: C:\Users\Appdata\Local\pypoetry\Cache Unix: ~/.cache/pypoetry
virtualenvs.create	默认值为true，如果执行 poetry install/poetry add时没有虚拟环境，就自动创建一个虚拟环境，设置为false的话，当虚拟环境不存在时，会将包安装到系统环境** **
virtualenvs.in-project	默认值为false，设置为true的话，会在当前项目目录下创建虚拟环境
virtualenvs.path	虚拟环境的路径，默认路径 {cache-dir}\virtualenvs
repositories.	设置新的备用存储库，具体的参数待确定

也可以使用 poetry config 命令： poetry config ，key就是表格内的参数名，value就是参数要配置的值。

本地参数配置

可以在poetry config后加 -local来配置当前项目。

poetry config virtualenvs.create false –local

执行后，当前项目在执行poetry install/poetry add时如果没有虚拟环境的话就会直接安装到系统路径上。

执行后，会在当前项目生成poetry.toml文件，全局配置config.toml文件不受影响：

全局配置

poetry config virtualenvs.create false

这里只是示范使用，virtualenvs.create这个参数其实基本不用修改，保留原值就好。

重置配置

poetry config的 -unset就是用来重置配置的，如果是重置全局配置：

poetry config virtualenvs.create –unset

如果是重置项目配置：

poetry config virtualenvs.create –local –unset

查看项目下的poetry.toml文件，可以看到值被重置了。

列出当前配置

列出当前项目的配置可以使用: poetry config –list

这里需要注意，列出配置时，包括了全局和本地的配置，本地的配置会覆盖全局的参数：

举例：virtualenvs.create全局为true，本地为false，那这里 virtualenvs.create=false

什么时候使用 ‘poetry.lock’, 什么时候不使用?

先说结论: 多数人以及要发布模块到 pypi 的人不需要 poetry.lock; 通过 Version Control 进行协作的开发团队以及对他机部署环境要求非常严格的人则需要放入 poetry.lock.

poetry.lock 的意义在于, 它会彻底 “锁死” 项目依赖的版本, 比如我们在 pyproject.toml 中要求的依赖版本是 requests = “^2.24.0”, 那么哪怕 requests 的作者后面发布了 2.24.1, 使用 poetry.lock 安装时仍会选择安装 2.24.0 版本. 因此, poetry.lock 帮助我们彻底杜绝因依赖的版本的微小变化而产生的任何不确定性.

补充说明:

• 如需使用 poetry.lock, 请将它伴随项目一起打包发布, 在执行 poetry install 时它会优先查找 lock 文件.
• 你可以通过 poetry update 来更新所有依赖到最新版本, 同时 poetry.lock 也会锁定到新的依赖版本.
• 当 pyproject.toml 中所列的依赖与 poetry.lock 不匹配时, poetry install 会中断并提示该错误.