Python 虛擬環境管理庫 - Poetry
簡介
Poetry 是 Python 中的依賴管理和打包工具，它允許你聲明項目所依賴的庫，并為你管理它們。
相比于 Pipev，我覺得 poetry 更加清爽，顯示更友好一些，雖然它的打包發布我們一般不使用，但是其他的虛擬環境管理也是非常方便的。
安裝
- pip install poetry
在控制臺執行 poetry -V 命令查看版本
升級
- poetry self update
poetry 配置
在使用 poetry 之前我們先進行一些設置，主要是調整一下虛擬環境的安裝位置
設置項
cache-dir
Type: string
緩存目錄配置，使用 poetry 安裝的包源文件都會緩存到這個目錄。以下是系統默認目錄：
- macOS: ~/Library/Caches/pypoetry
- Windows: C:\Users
\AppData\Local\pypoetry\Cache - Unix: ~/.cache/pypoetry
installer.parallel
Type: boolean
此配置會被忽略
virtualenvs.create
Type: boolean
默認為true，如果當前工程的虛擬環境不存在，就創建一個
virtualenvs.in-project
Type: boolean
- None：poetry 會在系統特定目錄創建一個.venv目錄，由下面的 path 參數指定
- true： poetry 會在項目根目錄創建一個.venv目錄，我推薦這種方式，在項目根目錄創建虛擬環境，這樣就算移動目錄位置也不影響虛擬環境的使用
- false： poetry 將會忽略已存在的.venv目錄
在 Pipev 中如果想把虛擬環境安裝在當前工程根目錄下，則需要通過配置環境變量 PIPENV_VENV_IN_PROJECT
virtualenvs.path
Type: string
默認是{cache-dir}/virtualenvs，虛擬環境創建的目錄，如果上面的 in-project 為 true，此配置就無效
配置命令
查看所有配置
- poetry config --list
查詢單個配置
- poetry config virtualenvs.path
添加或者更新配置
- poetry config virtualenvs.in-project true
刪除配置
- poetry config virtualenvs.path --unset
基本使用
初始化工程
創建新工程
- poetry new poetry-demo
已存在的工程
- cd pre-existing-project
- poetry init
創建成功后將得到如下目錄：
- poetry-demo-
- ├── pyproject.toml
- ├── README.rst
- ├── poetry_demo
- │ └── __init__.py
- └── tests
- ├── __init__.py
- └── test_poetry_demo.py
pyproject.toml會是一個非常重要的文件，包含了工程的配置和依賴庫信息，其初始內容如下：
- [tool.poetry]
- name = "poetry-demo"
- version = "0.1.0"
- description = ""
- authors = ["xingxingzaixian <beixia1989@163.com>"]
- [tool.poetry.dependencies]
- python = "^3.7"
- [tool.poetry.dev-dependencies]
- pytest = "^5.2"
- [build-system]
- requires = ["poetry-core>=1.0.0"]
- build-backend = "poetry.core.masonry.api"
指定虛擬環境的 pypi 源
- [[tool.poetry.source]]
- name = "custom"
- url = "https://pypi.tuna.tsinghua.edu.cn/simple"
- default = true
pyproject.toml 文件配置介紹
tool.poetry
- name
項目名稱，必選
- version
項目版本號，默認0.1.0，必選
- description
項目描述，必選
- license
開源協議
- authors
作者，這是一個列表，至少需要包含一個作者信息，必選
- maintainers
維護者
- readme
README文件
- homepage
項目首頁地址
基本命令
new
- # 創建新項目
- poetry new project
init
- # 初始化已存在的項目
- poetry init project
可選項：
- --name: 名稱.
- --description: 描述.
- --author: 作者.
- --python: Python 版本.
- --dependency: 要使用版本約束的包. 格式應該為 foo:1.0.0.
- --dev-dependency: 開發需求
install
- poetry install
install 命令從當前項目讀取 pyproject.toml 文件中的依賴性并安裝它們。
如果當前目錄中有poetry.lock文件，它將使用其中的確切版本，而不是解析它們。這確保使用庫的每個人都將獲得相同版本的依賴項。如果沒有poetry.lock文件，poetry將在依賴項解析后創建一個。
update
升級安裝包
add
- poetry add requests # ==> pip install requests
- poetry add requests@^2.20.0 # 安裝大于2.20.0版本的包
- poetry add "requests=2.20.0" # ==> pip install requests==2.20.0
- poetry add "uvicorn[standard]" # ==> pip install uvicorn[standard]
- # 從 git 倉庫安裝
- poetry add git+https://github.com/sdispater/pendulum.git
- poetry add git+ssh://git@github.com/sdispater/pendulum.git
- poetry add git+https://github.com/sdispater/pendulum.git#develop
- poetry add git+https://github.com/sdispater/pendulum.git#2.0.5
- # 從本地文件安裝
- poetry add ./my-package/
- poetry add ../my-package/dist/my-package-0.1.0.tar.gz
- poetry add ../my-package/dist/my_package-0.1.0.whl
安裝依賴庫并添加到 pyproject.toml，如果沒有指定版本約束，就安裝最新版本
remove
- poetry remove
刪除已經安裝的依賴包
show
- # 顯示已經安裝的包和版本號
- poetry show
- # 顯示非開發環境的安裝包
- poetry show --no-dev
- # 顯示依賴包的層級關系
- poetry show --tree
- # 顯示已安裝包的當前版本和最新版本
- poetry show -l
- # 顯示可更新的包
- poetry show -o
run
這個命令也是一個比較重要的命令，可以讓我們不進入虛擬環境就執行虛擬環境內的命令
- # 查詢虛擬環境內的 Python 版本
- poetry run python -V
- # 執行虛擬環境內的腳本
- poetry run python test.py
除了以上可以直接執行python命令外，我們還可以配置自定義的腳本命令，在 pyproject.toml 文件中配置 [tool.poetry.scripts]，例如配置：
- [tool.poetry.scripts]
- test = "python test.py"
- serve = "python run.py"
可以執行以下命令：
- poetry run serve
shell
- # 進入虛擬環境內
- poetry shell
check
- # 檢查 pyproject.toml 配置是否正確
- poetry check
search
- # 查詢包
- poetry search requests
export
- # 將依賴包導出為 requirements.txt 格式，導出文件名為 requirements.txt
- poetry export -f requirements.txt --output requirements.txt
env
- # 使用指定環境的python
- poetry env use /full/path/to/python
- # 如果python在環境變量中，可以使用一下方式指定
- poetry env use python3.7
- # 顯示當前虛擬環境信息
- poetry env info
- # 僅顯示虛擬環境的路徑
- poetry env info --path
- # 顯示當前工程的所有虛擬環境列表
- poetry env list
- # 顯示當前工程的虛擬環境絕對路徑
- poetry env list --full-path
- # 刪除虛擬環境
- poetry env remove /full/path/to/python
- poetry env remove python3.7
cache
- # 查看緩存列表
- poetry cache list
- # 清除指定的緩存
- poetry cache clear <cache>
- # 清除所有緩存
- poetry cache clear --all
依賴包的版本關系
在 poetry 中支持類似 webpack 里面的版本關系，例如 ^2.3.0、~2.3.0，這是什么對應關系呢
