別再用 Requirements.txt 來管理依賴了
在我第一次用到 requirements.txt 時(shí),是在一個(gè)虛擬環(huán)境中,我使用 pip freeze > requirements.txt 就把項(xiàng)目中的依賴項(xiàng)導(dǎo)出到了 txt 文件中,然后上傳到 GitHub,別人在使用該項(xiàng)目時(shí)可以使用 pip install -r requirements.txt 就可以了,很方便不是嗎。
不過,這樣管理依賴的方式也并不完美。
比如說,我這個(gè)項(xiàng)目就依賴一個(gè) Django,結(jié)果導(dǎo)出的 requirements.txt 卻有這么多:
pip freeze
asgiref==3.5.0
backports.zoneinfo==0.2.1
Django==4.0.1
sqlparse==0.4.2
~/tmp ?
也就是說,你安裝依賴項(xiàng) A ,它恰好有 B 作為子依賴項(xiàng),B 又依賴 C。有時(shí)候你只是測試目的或者為了一個(gè)小 demo 也使用 pip 安裝了一些包,那么這些依賴也會在 pip freeze 的列表中。
一段時(shí)間后,你在 requirements.txt 中看到的是 A、B、C、D、E、F、G、H,你并不知道直接或間接安裝了哪些依賴項(xiàng),因此現(xiàn)在更新甚至刪除 F 成為一個(gè)問題,你必須搜索才能知道 F 是作為子依賴項(xiàng)安裝的。最終會留下陳舊的依賴項(xiàng)并堆積垃圾或花費(fèi)大量時(shí)間進(jìn)行搜索并刪除所有未使用的內(nèi)容。
如何解決這個(gè)問題呢?
那就是用 pip-tools,具體方法如下:
1、安裝
首先,我們來創(chuàng)建一個(gè)虛擬環(huán)境,然后使用 pip 安裝 pip-tools:
python3 -m venv venv
source venv/bin/activate
pip install pip-tools
2、創(chuàng)建 requirements.in 文件
現(xiàn)在,我們需要創(chuàng)建一個(gè) requirements.in 文件,并且只包含項(xiàng)目的直接依賴項(xiàng)。每次您想要更新或包含依賴項(xiàng)時(shí),都必須先修改 requirements.in 。它與 requirements.txt 的區(qū)別也很明顯,那就是只包含直接依賴的庫,也可以指定版本:
3、編譯 requirements.in
pip-compile requirements.in 可以直接生成 requirements.txt,但是你會發(fā)現(xiàn)這個(gè) requirements.txt 跟 pip freeze 生成的有很大不同,你可以看到某個(gè)包是通過那個(gè)包引入的,依賴關(guān)系一目了然:
就這樣,之前提到的問題已經(jīng)不存在了,你擁有了管理依賴所需的所有信息。
4、額外功能
除此之外,pip-tools 還提供了其他有用的功能:
1、升級包。
以 Django 為例:
pip-compile --upgrade-package django
這將自動更新您的 requirements.txt 文件,包括依賴項(xiàng)的修改。
2、同步包
為了使 virtualenv 與當(dāng)前的 requirements.txt 文件同步,您可以簡單地運(yùn)行以下命令:
pip-sync -a requirements.txt
這將先詢問,當(dāng)你輸入 y 時(shí),會在虛擬環(huán)境中安裝、升級或卸載,最終與 requirements.txt 文件包含的包保持一致。
有關(guān) pip-tools 的更多詳細(xì)信息,請參閱其文檔[1]。