如何一鍵理清大型Python項目依賴樹

更新時間：2022年06月10日 10:45:03 作者：??Python編程學習圈????

這篇文章主要介紹了如何一鍵理清大型Python項目依賴樹，文章圍繞主題相關資料展開詳細的內容介紹，感興趣的小伙伴可以參考一下

1.安裝

你只需要在你的環(huán)境中輸入以下命令就能安裝 pipdeptree：

pip?install?pipdeptree

已通過測試的Python版本：2.7，3.5，3.6，3.7，3.8，3.9.

2.用法和示例

pip freeze 和 pipdeptree 最大的區(qū)別如下：

# pip freeze 的顯示
$ pip freeze
Flask==0.10.1
itsdangerous==0.24
Jinja2==2.11.2
-e git+git@github.com:naiquevin/lookupy.git@cdbe30c160e1c29802df75e145ea4ad903c05386#egg=Lookupy
MarkupSafe==0.22
pipdeptree @?file:///private/tmp/pipdeptree-2.0.0b1-py3-none-any.whl
Werkzeug==0.11.2

可見，pip freeze 最多只能顯示一個依賴的列表，而在 pipdeptree ，每個模塊的依賴關系能夠非常直觀地展示出來：

$ pipdeptree
Warning!!! Possibly conflicting dependencies found:
* Jinja2==2.11.2
?- MarkupSafe [required: >=0.23, installed:?0.22]
------------------------------------------------------------------------
Flask==0.10.1
??- itsdangerous [required: >=0.21, installed:?0.24]
??- Jinja2 [required: >=2.4, installed:?2.11.2]
????- MarkupSafe [required: >=0.23, installed:?0.22]
??- Werkzeug [required: >=0.7, installed:?0.11.2]
Lookupy==0.1
pipdeptree==2.0.0b1
??- pip [required: >=6.0.0, installed:?20.1.1]
setuptools==47.1.1
wheel==0.34.2

請注意這個 Warning，提示了你哪些模塊會造成其依賴的模塊版本發(fā)生沖突，這是非常有用的提示，很多時候問題就出現(xiàn)在這里。

不僅如此，如果存在循環(huán)性依賴，比如：

CircularDependencyA => CircularDependencyB => CircularDependencyA

它會進行如下提示：

$ pipdeptree --exclude pip,pipdeptree,setuptools,wheel
Warning!!! Cyclic dependencies found:
- CircularDependencyA => CircularDependencyB => CircularDependencyA
- CircularDependencyB => CircularDependencyA => CircularDependencyB
------------------------------------------------------------------------
wsgiref==0.1.2
argparse==1.2.1

如果你想生成 requirements.txt，可以這么做：

$ pipdeptree -f | tee locked-requirements.txt
Flask==0.10.1
??itsdangerous==0.24
??Jinja2==2.11.2
????MarkupSafe==0.23
??Werkzeug==0.11.2
gnureadline==8.0.0
-e git+git@github.com:naiquevin/lookupy.git@cdbe30c160e1c29802df75e145ea4ad903c05386#egg=Lookupy
pipdeptree @ file:///private/tmp/pipdeptree-2.0.0b1-py3-none-any.whl
??pip==20.1.1
setuptools==47.1.1
wheel==0.34.2

在確認沒有沖突的依賴項后，甚至可以將其“鎖定”，其中所有包都將固定到其當前安裝的版本：

$?pipdeptree -f | sed?'s/ //g'?| sort -u > locked-requirements.txt

3. 可視化依賴樹

為了能夠可視化展示依賴樹，我們需要安裝GraphViz。安裝完成后輸入以下命令：

pipdeptree --graph-output png > dependencies.png

# pipdeptree --graph-output dot > dependencies.dot
# pipdeptree --graph-output pdf > dependencies.pdf
# pipdeptree --graph-output svg > dependencies.svg

支持四種格式的輸出，這里png的輸出效果如下：