終于可以擺脫 Pipenv 這坑貨了
大家好,我是明哥。
之前在介紹一些管理 Python 虛擬環(huán)境的工具時(shí),比如 pipenv,virtualenv 等,總有讀者留言,希望我整一期 poetry 的。
在接觸 poetry 之前,我以為 pipenv 已經(jīng)是我心目中最理想的虛擬環(huán)境工具,直到 19年 看過(guò)@李輝 的一篇文章(http://greyli.com/do-not-use-pipenv/)才讓我開(kāi)始動(dòng)搖,原來(lái)一直輕量使用的我,一直沒(méi)有感覺(jué)到 pipenv 的各種問(wèn)題,咱也不知道經(jīng)過(guò)這幾年的發(fā)展,pipenv 是否有所改進(jìn)?不過(guò)我想對(duì)于曾經(jīng) "深受其害" 的用戶來(lái)說(shuō),可能早就投入了 poetry 的懷抱。
廢話不多說(shuō),直接上干貨。
# 1. 安裝 poetry
poetry提供多種安裝方式,個(gè)人推薦從以下2種方式中選擇:
方式一:(推薦)使用在線腳本進(jìn)行安裝,是最為推薦的安裝方式
- $ curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python
方式二:(pip) 官方不建議這么做,因?yàn)橛锌赡軙?huì)造成依賴沖突,可以考慮用 pipx 或 pipsi
- $ pip install --user poetry
安裝后,可以使用如下命令檢測(cè)是否可用
- $ poetry --version
- Poetry version 1.1.4
# 2. 創(chuàng)建項(xiàng)目
如果你是在一個(gè)已有的項(xiàng)目里使用 Poetry,你只需要執(zhí)行 poetry init 命令來(lái)創(chuàng)建一個(gè) pyproject.toml 文件:
- $ poetry init
而如果是新建 一個(gè)項(xiàng)目,可以使用這個(gè)命令
- $ poetry new demo-priject
運(yùn)行完后,在當(dāng)前目錄下就會(huì)多一個(gè) demo-project 的目錄,這個(gè)目錄下的文件結(jié)構(gòu)如下
- $ tree demo-priject
- demo-priject
- ├── README.rst
- ├── demo_priject
- │ └── __init__.py
- ├── pyproject.toml
- └── tests
- ├── __init__.py
- └── test_demo_priject.py
如果要把項(xiàng)目代碼放入到 src 目錄下,在創(chuàng)建項(xiàng)目時(shí),可以加上 --src 參數(shù)。
# 3. 創(chuàng)建虛擬環(huán)境
使用 poetry install 命令創(chuàng)建虛擬環(huán)境(確保當(dāng)前目錄有 pyproject.toml 文件):
- $ poetry install
這個(gè)命令會(huì)讀取 pyproject.toml 中的所有依賴(包括開(kāi)發(fā)依賴)并安裝,如果不想安裝開(kāi)發(fā)依賴,可以附加 --no-dev 選項(xiàng)。如果項(xiàng)目根目錄有 poetry.lock 文件,會(huì)安裝這個(gè)文件中列出的鎖定版本的依賴。如果執(zhí)行 add/remove 命令的時(shí)候沒(méi)有檢測(cè)到虛擬環(huán)境,也會(huì)為當(dāng)前目錄自動(dòng)創(chuàng)建虛擬環(huán)境。
# 4. 使用虛擬環(huán)境
創(chuàng)建虛擬環(huán)境后,如果想要在虛擬環(huán)境下執(zhí)行命令,比如去執(zhí)行腳本,去使用 pip list 等等。
可以在項(xiàng)目目錄下,使用如下命令
- $ poetry run <commands>
比如我查看該虛擬環(huán)境中安裝了哪些包
- $ poetry run pip list
再比如我想在該虛擬環(huán)境下執(zhí)行 app.py
- $ poetry run python app.py
每次在虛擬環(huán)境下做點(diǎn)啥事,命令前面都要加上 poetry run,有點(diǎn)太麻煩了。
這時(shí)可以使用下面這條命令,直接激活當(dāng)前的虛擬環(huán)境
- $ poetry shell
# 5. 包的管理
安裝包
- $ poetry add <pkg>
添加 --dev 參數(shù)可以指定為開(kāi)發(fā)依賴
- $ poetry add pytest --dev
查看所有安裝的依賴包
- $ poetry show
加上 --tree 可以查看他們的依賴關(guān)系
- $ poetry show --tree
加上 --outdated 可以查看可以更新的依賴
- $ poetry show --outdated
如果要更新依賴可以執(zhí)行這個(gè)命令
- # 更新全部
- $ poetry update
- # 更新某個(gè)依賴
- $ poetry update foo
想卸載某個(gè)包,用這個(gè)命令
- $ poetry remove foo
# 6. 常用配置
Poetry 的配置存儲(chǔ)在單獨(dú)的文件中,比 Pipenv 設(shè)置環(huán)境變量的方式要方便一點(diǎn)。配置通過(guò) poetry config 命令設(shè)置,比如下面的命令可以寫(xiě)入 PyPI 的賬號(hào)密碼信息:
- $ poetry config http-basic.pypi username password
下面的命令設(shè)置在項(xiàng)目?jī)?nèi)創(chuàng)建虛擬環(huán)境文件夾:
- $ poetry config settings.virtualenvs.in-project true
另一個(gè)常用的配置是設(shè)置 PyPI 鏡像源,以使用豆瓣提供的 PyPI 鏡像源為例,你需要在 pyproject.toml 文件里加入這部分內(nèi)容:
- [[tool.poetry.source]]
- name = "douban"
- url = "https://pypi.doubanio.com/simple/"