Python中Pipreqs自動生成項目依賴清單的實現(xiàn)

更新時間：2026年04月27日 09:23:19 作者：冷炫風刃

本文主要介紹了Python中Pipreqs自動生成項目依賴清單的實現(xiàn),文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習學習吧

pipreqs 生成 requirements.txt 為什么比 pip freeze 更靠譜

因為 pipreqs 只掃描項目源碼中實際 import 的包，不會把全局環(huán)境里裝了但沒用到的包也塞進 requirements.txt。而 pip freeze 是照單全收當前環(huán)境所有已安裝包，尤其在虛擬環(huán)境管理不嚴時，容易混入開發(fā)依賴、臨時調(diào)試工具甚至系統(tǒng)級包。

常見錯誤現(xiàn)象：pip freeze > requirements.txt 導出后部署失敗，報錯說某個包根本沒被項目引用；或者 CI 流水線因多余依賴沖突卡住。

適用場景：新項目初始化、交接給他人、準備 Docker 構建、提交前自查依賴
不適用場景：想導出包括 pytest、black 這類純開發(fā)依賴——pipreqs 默認忽略它們（需額外參數(shù)）
注意：它不解析 setup.py 或 pyproject.toml，只看 Python 源文件里的 import 語句

安裝和基礎命令怎么跑起來

先確保沒和舊版 pipreqs 沖突（老版本有路徑 bug）：

pip install --upgrade pipreqs

進到項目根目錄（含 src/ 或 app.py 等源碼的那層），執(zhí)行：

pipreqs ./

它會自動掃描所有 .py 文件，生成 requirements.txt。如果提示 FileNotFoundError: No such file or directory: 'requirements.txt'，說明文件已存在且被鎖——刪掉再試，或加 --force。

--encoding=utf-8：遇到中文注釋或路徑時報 UnicodeDecodeError 時必加
--diff requirements.txt：對比現(xiàn)有文件，只輸出新增依賴（適合增量更新）
--savepath ./reqs-dev.txt：指定輸出路徑，避免覆蓋主文件

怎么讓 pipreqs 掃描子目錄和識別動態(tài)導入

默認情況下，pipreqs 只掃當前目錄及直接子目錄，遇到 src/mylib/ 或 apps/api/ 這類結構會漏掉。必須顯式指定路徑：

pipreqs ./src ./apps --force

但它無法識別字符串拼接式導入（如 __import__(f"{name}_plugin")）或 importlib.import_module() 動態(tài)加載——這類依賴得手動補進 requirements.txt。

常見坑：Django 項目里 INSTALLED_APPS 列表中的第三方 app（如 'django-crispy-forms'）不會被自動識別，必須人工核對添加
若用 setuptools 的 entry_points 或插件機制，pipreqs 也無能為力
建議搭配 grep -r "import\|from.*import" . --include="*.py" 快速掃一遍可疑模塊名

生成結果不準？先檢查 import 語句寫法

pipreqs 解析的是字面量 import，不是運行時行為。所以這些寫法會導致漏依賴：

import requests as req → 能識別 requests
import mypkg.utils → 只認 mypkg，不會深挖 utils 依賴的其他包
from . import config 或 from ..models import User → 相對導入只影響模塊查找，不引入新第三方包，沒問題
try: import ujson except ImportError: import json → ujson 會被識別，即使實際運行走的是 json

真正容易被忽略的是條件導入 + 第三方包組合，比如 if sys.version_info >= (3, 9): from importlib import resources else: import importlib_resources as resources——pipreqs 會把兩個都列進去，你得自己刪掉不生效的那個。

到此這篇關于Python中Pipreqs自動生成項目依賴清單的實現(xiàn)的文章就介紹到這了,更多相關Python Pipreqs自動生成依賴清單內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: