如何同步setup.py/install_requires与Pipfile/packages？实现Pipfile复用前者依赖

我来分享几个实用的方案，帮你解决两份依赖配置重复维护的麻烦——毕竟手动同步不仅费时间，还容易出错对吧？

这是最简单的方法，不需要修改任何代码，直接用Pipenv的内置功能就能搞定：

1. 先确保你的setup.py里已经正确定义了install_requires，比如：

   from setuptools import setup
   
   setup(
       name="your-project",
       version="0.1.0",
       install_requires=[
           "requests>=2.25.1",
           "numpy>=1.21.0",
       ],
   )
   

2. 打开终端，在项目根目录运行命令：

   pipenv install --requirements setup.py
   

3. 跑完这个命令后，你会发现Pipfile的[packages]部分已经自动同步了setup.py里的所有依赖，连Pipfile.lock也会一起更新。之后如果setup.py的依赖有变动，再跑一遍这个命令就行。

如果你的项目还有开发依赖（比如pytest、flake8这类），可以用类似的命令同步到Pipfile的[dev-packages]：

pipenv install --dev --requirements setup.py

如果不想每次手动跑命令，你可以写个简单的Python脚本，让依赖自动同步：

1. 先把setup.py里的依赖抽成一个单独的变量，方便脚本读取：

   # setup.py
   REQUIRED_PACKAGES = [
       "requests>=2.25.1",
       "numpy>=1.21.0",
   ]
   
   setup(
       name="your-project",
       version="0.1.0",
       install_requires=REQUIRED_PACKAGES,
   )
   

2. 创建一个同步脚本（比如sync_deps.py），用toml库来读写Pipfile：

   import toml
   import sys
   # 把当前目录加入Python路径，这样能导入setup.py里的变量
   sys.path.insert(0, '.')
   from setup import REQUIRED_PACKAGES
   
   # 读取Pipfile内容
   pipfile = toml.load('Pipfile')
   # 将依赖转换为Pipfile需要的格式：包名作为键，版本约束作为值
   pipfile['packages'] = {pkg.split('>=')[0]: pkg for pkg in REQUIRED_PACKAGES}
   # 把更新后的内容写回Pipfile
   with open('Pipfile', 'w') as f:
       toml.dump(pipfile, f)
   

3. 先安装依赖库toml：

   pip install toml
   

4. 运行脚本就能自动同步了：

   python sync_deps.py
   

你还可以把这个脚本加到项目的pre-commit钩子或者CI流程里，实现完全自动化的依赖同步。

现在很多Python项目已经开始用setup.cfg代替setup.py来管理配置，这样依赖只需要维护一份，更清晰：

1. 创建setup.cfg文件，把依赖写在这里：

   [metadata]
   name = your-project
   version = 0.1.0
   
   [options]
   install_requires =
       requests>=2.25.1
       numpy>=1.21.0
   

2. 简化setup.py，让它读取setup.cfg的配置：

   from setuptools import setup
   
   setup()
   

3. 之后同样用Pipenv的命令同步依赖到Pipfile：

   pipenv install --requirements setup.cfg
   

这种方式不仅能让Pipenv复用依赖，还能让其他工具（比如pip、tox）也共享同一份配置，非常适合长期维护的项目。

• 用--requirements参数同步时，Pipenv会覆盖Pipfile里已有的同包配置，如果你的Pipfile里有特殊设置（比如指定了私有源），记得提前备份或者手动调整。
• 如果你用的是setup.cfg，开发依赖可以写在options.extras_require里，然后用pipenv install --dev --requirements setup.cfg同步。

内容的提问来源于stack exchange，提问作者Rotareti