​

Python环境管理Poetry的使用

Poetry 是 Python 中依赖管理和打包的工具。他可以管理项目中的第三包的依赖（安装/更新）。T同时也提供了一个锁定文件以确保可重复安装，并且可以构建项目以供分发。

poetry的Python版本要求为 3.7+，且是多平台的。

1 安装 (在windows平台下)

1.1 安装Poetry

1
(Invoke-WebRequest -Uri https://install.python-poetry.org -UseBasicParsing).Content | python -

根据官网安装的提示：如果是在Microsoft Store上安装的python，需要将上面的py替换为python，但是我直接安装，提示 py : 无法将“py”项识别为 cmdlet、函数、脚本文件或可运行程序的名称。必须要把py替换为python。

使用 poetry --version 检查版本， 如果提示版本号则安装成功。

1.2 更新Poetry

1
poetry self update

1.3 卸载Poetry

1
(Invoke-WebRequest -Uri https://install.python-poetry.org -UseBasicParsing).Content | python - --uninstall

1.4 配置poetry

poetry 安装后默认的缓存路径个虚拟环境路径在:

C:\Users\<your name>\AppData\Local\pypoetry\Cache 为了不占用C盘空间，修改默认的虚拟环境的目录。

1
2
# 此处直接修改 cache-dir 就会修改 cache-dir 和 virtualenvs.path 的路径
poetry config cache-dir D:\\poetry_enev

通过 poetry config --list 查看已经修改成功

取消之前的修改：

1
poetry config cache-dir --unset

2 使用poetry创建一个新项目

2.1 直接使用poetry 创建项目

1
poetry new project_name

自动创建一个project_name的文件件，项目名称也叫做project_name。

2.2 添加python依赖

1
2
# 在pyproject.toml 同目录下
poetry add numpy

安装的包和版本都会在 pyproject.toml 中

1
2
3
[tool.poetry.dependencies]
python = "^3.9"
numpy = "^1.24.2"

2.3 运行项目或者文件

1
poetry run python run.py

3 在现有项目中使用poetry

3.1 在某个目录下 使用poetry init

1
poetry init

使用这种交互式的方式创建项目，根据选项设置完成之后，在对应的目录下同样会生成 pyproject.toml 文件。

3.2 添加依赖和运行项目和==使用poetry创建一个新项目==与一致。

4 拿到一个使用poetry管理依赖的新项目

4.1 在pyproject.toml同目录下

1
poetry install

4.2 如果要将依赖跟新到最新版本

1
poetry update

Tips: 使用poetry时会生成 poetry.lock，此文件推荐上传到git版本控制中，

5 手动管理依赖

5.1 在 pyproject.toml文件同目录下，进入虚拟环境

1
poetry shell

使用此命令，进入当前的项目虚拟环境，接下来就像平常使用python一样了。

5.2 退出

1
2
deactivate 
# 或者直接退出 这个是shell

6 管理环境

6.1 获取当前的虚拟环境的基本信息

1
poetry env info

6.2 切换虚拟环境

1
poetry env use 具体的环境的python可执行文件路径

6.3 删除环境

1
poetry env remove

7 在Pycharm中配置poetry环境

一般拿到一个含有poetry环境的项目，使用pycharm打开，会自动识别poetry解释器。如果没有识别 需要手动添加，如下所示：

  • 基础解释器：选择对应虚拟环境的Python可执行文件。

  • Poetry可执行文件，选择安装在本地的Poetry可执行文件。

配置完毕，打开pycharm底部导航栏控制台，即可显示当前虚拟环境前缀，接下来就可以操作就按照正常的流程执行了。

8 更改poetry的pypi源

通常国内下载一些包比较慢，这时我们可以更新poetry的源来使用国内的镜像。默认的情况下poetry使用的是pypi来下载包.

1
2
3
4
5
6
7
8
9
10
11
# --default 设置为默认源
# 阿里源：
# poetry source add ali https://mirrors.aliyun.com/pypi/simple/ --default
# -- default 已经弃用，建议使用以下方式
# --priority=default 将源设置为默认源
poetry source add --priority=default tsinghua https://mirrors.tuna.tsinghua.edu.cn/pypi/web/simple/

# 腾讯源：
poetry source add tencent https://mirrors.cloud.tencent.com/pypi/simple/ 
# 清华源：
poetry source add  tsinghua  https://mirrors.tuna.tsinghua.edu.cn/pypi/web/simple/

设置源以后，在pyproject.toml会有如下显示：

1
2
3
4
[[tool.poetry.source]]
name = "tsinghua"
url = "https://mirrors.tuna.tsinghua.edu.cn/pypi/web/simple/"
priority = "default"

删除源

1
poetry source remove 源的名字

9 总结

一般情况下我们使用poetry管理项目，无非就是两种情况：新建项目，可以使用poetry new 项目名称, 或者是在旧的项目上使用poetry，那么就是用poetry init 使用交互式初始化一个项目。

平常安装依赖或者是更新依赖 就使用 poetry add/update 依赖名。