以簡(jiǎn)潔高效(指編程較為高效, 而不是運(yùn)行速度)出名的Python, 在包依賴(lài)問(wèn)題上有時(shí)候讓人撓頭.
一些新手復(fù)制了Github上的項(xiàng)目準(zhǔn)備運(yùn)行, 很多時(shí)候會(huì)在包依賴(lài)這一步上卡個(gè)半天.(這里推薦新手最好在基于Linux的系統(tǒng)或者M(jìn)ac上, 一些包[比如Scrapy的Win32相關(guān)依賴(lài)]可能無(wú)法直接通過(guò)包管理工具安裝, 會(huì)讓新手從入門(mén)到放棄). 其他涉及到項(xiàng)目需要到其他機(jī)器部署時(shí), 也會(huì)遇到包依賴(lài)問(wèn)題.
# 這可能是部署過(guò)程中最常見(jiàn)的錯(cuò)誤
ModuleNotFoundError: No Module named 'XXX'
通過(guò)pip輸出依賴(lài)
pip freeze > requirements.txt
這個(gè)命令可能是很多同學(xué)用來(lái)輸出依賴(lài)的命令, 但它輸出的是當(dāng)前環(huán)境下(
筆者默認(rèn)你使用的是Python的虛擬環(huán)境)的所有包, 也就是輸出當(dāng)前你安裝的全部非Python標(biāo)準(zhǔn)庫(kù)包)
筆者在自己終端上試了一下, 輸出的文件如下: (這里暴露了我沒(méi)有按項(xiàng)目建虛擬環(huán)境的爛習(xí)慣(逃)
# 省略N個(gè)庫(kù)
....
Django==1.11.8
django-mongonaut==0.2.21
docopt==0.6.2
Flask==0.10.1
Flask-Bootstrap==3.0.3.1
Flask-Login==0.3.1
Flask-Mail==0.9.0
Flask-Migrate==1.1.0
Flask-Moment==0.2.1
Flask-PageDown==0.1.4
Flask-Script==0.6.6
Flask-SQLAlchemy==1.0
Flask-WTF==0.9.4
ForgeryPy==0.1
html5lib==1.0b3
hyperlink==17.3.1
idna==2.6
incremental==17.5.0
itsdangerous==0.23
Jinja2==2.7.1
lxml==4.1.1
Mako==0.9.1
Markdown==2.3.1
MarkupSafe==0.18
mongoengine==0.9.0
numpy==1.14.0
pandas==0.22.0
parsel==1.3.1
pdfkit==0.6.1
pipreqs==0.4.9
pyasn1==0.4.2
pyasn1-modules==0.2.1
pycparser==2.18
PyDispatcher==2.0.5
pymongo==2.8
PyMySQL==0.7.9
pyOpenSSL==17.5.0
python-dateutil==2.6.1
pytz==2017.3
queuelib==1.4.2
requests==2.18.4
requests-file==1.4.3
scrape==0.9.12
Scrapy==1.5.0
...
# 省略N+1個(gè)庫(kù)
對(duì)于按項(xiàng)目建環(huán)境的同學(xué), 這種輸出方式是沒(méi)有多大問(wèn)題的
只要部署的時(shí)候在終端鍵入pip install -r requirements.txt
就可以安裝好依賴(lài)了, 但是對(duì)于沒(méi)有嚴(yán)格區(qū)分項(xiàng)目環(huán)境的同學(xué), 一次性安裝了其他的包, 并不是一個(gè)好的解決方案.
通過(guò)pipreqs庫(kù)輸出依賴(lài)
如這個(gè)庫(kù)的名稱(chēng)所示, 就是為了方便管理依賴(lài)而生.
與pip直接導(dǎo)出全部不同, pipreqs只導(dǎo)出指定項(xiàng)目下Python文件import的庫(kù)
用法如下
# 安裝
pip install pipreqs
# 切換到項(xiàng)目目錄
# 輸出requirements.txt到項(xiàng)目根目錄下
pipreqs --use-local ./
這里我切換到一個(gè)Django項(xiàng)目目錄下, 打開(kāi)requirements.txt, 內(nèi)容是:
pandas==0.22.0
django_debug_toolbar.egg==info
mongoengine==0.9.0
Django==1.11.8
瞬間清爽不少.
通過(guò)Pipenv管理依賴(lài)
Pipenv, 匯集了Pip,Pipfile和Virtualenv的功能贡耽,是一個(gè)強(qiáng)大的命令行工具价认。
這里展示最簡(jiǎn)單的用法
-
pip install pipenv
安裝好庫(kù). - 切換到項(xiàng)目根目錄
- 終端鍵入
Pipenv install
如果你尚未建立
requirements.txt
那么將會(huì)得到一個(gè)空白的Pipfile
文本文件, 此時(shí)我們?cè)诿钚兄惺褂?code>pipenv install 包名, 會(huì)在Pipefile寫(xiě)入對(duì)應(yīng)包信息, 之后用戶(hù)要安裝依賴(lài)時(shí), 使用pipenv install
即可.
如果你已經(jīng)建立, 終端上會(huì)輸出以下信息:
requirements.txt found, instead of Pipfile! Converting…
Warning: Your Pipfile now contains pinned versions, if your requirements.txt did.
We recommend updating your Pipfile to specify the "*" version, instead.
...
上面的輸出意思是: 找到了requirements.txt, 但不是Pipfile, 正在轉(zhuǎn)換...
Pipefile現(xiàn)在將包含固定版本信息, 如果你的requirements.txt中已包含.
我們推薦升級(jí)你的Pipefile到指定版本...
輸出Pipenv文件, 得到以下內(nèi)容:
[[source]]
url = "https://pypi.org/simple"
verify_ssl = true
name = "pypi"
[packages]
mongoengine = "==0.9.0"
"django-debug-toolbar.egg" = "==info"
django = "==1.11.8"
pandas = "==0.22.0"
[dev-packages]
[requires]
python_version = "3.6"
可以清楚的看到整個(gè)文件結(jié)構(gòu), 第一個(gè)是[source]是安裝庫(kù)所在源, 第二個(gè)是依賴(lài)庫(kù)的信息, 第三個(gè)是當(dāng)你開(kāi)發(fā)環(huán)境所需要的包, 最后一個(gè)是Python版本.
當(dāng)你需要區(qū)分開(kāi)發(fā)環(huán)境和正式版本發(fā)布環(huán)境時(shí), 可以使用以下命令:
pipenv install --dev 包名
如果正式版本發(fā)布時(shí), 鍵入Pipenv install
, 將不會(huì)安裝dev標(biāo)記的包
除非其他開(kāi)發(fā)人員鍵入Pipenv install -dev
, 才會(huì)安裝所有包.
微信公眾號(hào):程序員的碎碎念