poetry

poetry

Poetry 帮助你声明、管理和安装 Python 项目的依赖,确保你在任何地方都能使用正确的技术栈。

Poetry 用一个简单的基于 pyproject.toml 的项目格式替代了 setup.pyrequirements.txtsetup.cfgMANIFEST.inPipfile

用法

root@Debian:~# poetry list

Poetry(版本 2.1.3)

用法:
command [选项] [参数]

选项:
-h, --help                 显示给定命令的帮助信息。如果没有给定命令,则显示 list 命令的帮助信息。
-q, --quiet                不输出任何信息。
-V, --version              显示此应用的版本。
    --ansi                 强制显示 ANSI 输出。
    --no-ansi              禁用 ANSI 输出。
-n, --no-interaction       不询问任何交互式问题。
    --no-plugins           禁用插件。
    --no-cache             禁用 Poetry 的源缓存。
-P, --project=PROJECT      指定另一个路径作为项目根目录。所有命令行参数都将相对于当前工作目录解析。
-C, --directory=DIRECTORY  Poetry 命令的工作目录(默认为当前工作目录)。所有命令行参数都将相对于给定目录解析。
-v|vv|vvv, --verbose       增加消息的详细程度:1 为正常输出,2 为更详细输出,3 为调试输出。

可用命令:
about              显示有关 Poetry 的信息。
add                向 pyproject.toml 添加一个新依赖并安装。
build              构建一个包,默认生成 tarball 和 wheel 格式。
check              验证 pyproject.toml 文件的内容及其与 poetry.lock 文件的一致性。
config             管理配置设置。
export             将锁定文件导出为其他格式。    <- >=1.8版本要安装插件: poetry-plugin-export
help               显示命令的帮助信息。
init               在当前目录创建一个基础的 pyproject.toml 文件。
install            安装项目的依赖。
list               列出命令。
lock               锁定项目的依赖。
new                在指定路径创建一个新的 Python 项目。
publish            发布包到远程仓库。
remove             从项目依赖中移除一个包。
run                在适当的环境中运行命令。
search             在远程仓库中搜索包。
show               显示有关包的信息。
sync               根据锁定文件更新项目环境。
update             根据 pyproject.toml 文件更新依赖。
version            显示项目版本,或者在提供有效的提升规则时提升版本。

cache 命令:
cache clear        清除指定名称的 Poetry 缓存。
cache list         列出 Poetry 的缓存。

debug 命令:
debug info         显示调试信息。
debug resolve      调试依赖解析。
debug tags         显示当前活动环境兼容的标签。

env 命令:
env activate       打印激活虚拟环境的命令。
env info           显示当前环境的信息。
env list           列出与当前项目相关联的所有虚拟环境。
env remove         移除与项目相关联的虚拟环境。
env use            激活或创建当前项目的新虚拟环境。

Python 命令:
python install     安装指定的 Python 版本(来自 Python Standalone Builds 项目,实验性功能)。
python list        显示此环境中可用的 Python 版本(实验性功能)。
python remove      移除由 Poetry 管理的指定 Python 版本(实验性功能)。

self 命令:
self add           向 Poetry 的运行时环境添加额外的包。
self install       安装 Poetry 安装所需的锁定包(包括附加包)。
self lock          锁定 Poetry 安装的系统要求。
self remove        从 Poetry 的运行时环境中移除额外的包。
self show          显示 Poetry 的运行时环境中的包。
self show plugins  显示当前安装的插件信息。
self sync          根据 Poetry 安装所需的锁定包同步 Poetry 自身的环境。
self update        更新 Poetry 到最新版本。

source 命令:
source add         为项目添加源配置。
source remove      移除项目的源配置。
source show        显示项目信源的配置信息。

常用命令

查看当前项目的虚拟环境:

poetry env info

插件

执行 poetry export 命令时,提示 The requested command export does not exist.

原因:从 Poetry 版本 1.8 开始,export 命令被移除,并由 poetry-plugin-export 插件取而代之。

pip3 install poetry-plugin-export

这个插件允许将锁定的包导出为各种格式。

注意:目前仅支持 constraints.txtrequirements.txt 格式。

这个插件提供与现有的 Poetry export 命令相同的功能,未来将替代该命令。