使用pipreqs更新requirements.txt时mysqlclient被替换为MySQL-python的问题

问题原因 #

mysqlclient作为MySQL-python的分支，兼容其API，代码中通常仍用import MySQLdb来导入。而pipreqs的包映射规则会把MySQLdb这个导入名关联到旧的MySQL-python包，而非mysqlclient，最终导致生成requirements.txt时替换错误。

解决方案 #

1. 自定义pipreqs的包映射规则

创建一个自定义映射文件（比如pipreqs_mapping.json），指定MySQLdb对应的包为mysqlclient：

{
  "MySQLdb": "mysqlclient"
}

运行pipreqs时指定该映射文件：

pipreqs --force --mapping pipreqs_mapping.json .

2. 手动保护关键依赖

在requirements.txt中给mysqlclient条目添加特殊注释，让pipreqs跳过修改该条目：

# pipreqs: ignore
mysqlclient==2.1.1

注意：该功能需要pipreqs版本≥0.4.11，版本过低请先升级：

pip install --upgrade pipreqs

3. 更换更精准的依赖扫描工具

pipreqs在处理兼容包时容易出错，可以改用pip-tools或pdm这类工具管理依赖：

• 使用pip-tools：
  先编写requirements.in，手动指定mysqlclient：

  mysqlclient==2.1.1
  

  再生成锁定版本的requirements.txt：

  pip-compile requirements.in
  

• 使用pdm：
  初始化项目后添加依赖：

  pdm add mysqlclient==2.1.1
  

  pdm会自动维护pyproject.toml和pdm.lock，确保依赖识别准确。

4. 代码中添加提示注释

在代码的MySQLdb导入语句附近添加注释，明确告诉pipreqs对应的包名：

# pipreqs: package=mysqlclient
import MySQLdb

pipreqs扫描时会优先使用注释指定的包名生成依赖。

内容的提问来源于stack exchange，提问作者Wannabe-Coder