编写生成 `requirements.txt` 文件的 Python 脚本

像风一样自由2020

已于 2024-08-13 11:30:32 修改

阅读量506

点赞数 3

分类专栏： python 文章标签： python 开发语言

于 2024-08-13 11:29:10 首次发布

本文链接：https://blog.csdn.net/weixin_37647148/article/details/141159323

版权

python 专栏收录该内容

37 篇文章 3 订阅

订阅专栏

编写生成 `requirements.txt` 文件的 Python 脚本

要编写一个生成 requirements.txt 文件的 Python 脚本，可以通过分析当前环境中已安装的 Python 包，或者从指定的 Python 脚本文件中解析出所需的依赖包。以下是一个简单的 Python 脚本，用于生成 requirements.txt 文件。

方案1(旧版)：基于已安装的包生成 `requirements.txt`

这个方法将列出当前 Python 环境中所有已安装的包，并将它们写入 requirements.txt 文件。

import pkg_resources

def generate_requirements(output_file='requirements.txt'):
    # 获取当前环境中的所有已安装的包及其版本号
    installed_packages = pkg_resources.working_set
    requirements = sorted(["{}=={}".format(i.key, i.version) for i in installed_packages])

    # 将包信息写入 requirements.txt 文件
    with open(output_file, 'w') as f:
        for req in requirements:
            f.write(req + '\n')
    
    print(f"Requirements have been generated and saved to {output_file}.")

if __name__ == "__main__":
    generate_requirements()

** 适用于生成基于当前环境的 requirements.txt 文件，只需运行脚本即可。

pkg_resources 已被标记为过时（deprecated），推荐使用 importlib.metadata 或者 pip 模块来替代它。我们可以通过使用 pip 模块来获取当前环境中的已安装包并生成 requirements.txt 文件。下面是改进后的脚本：

方案2(新版)：

使用 `pip` 模块生成 `requirements.txt`

import subprocess

def generate_requirements(output_file='requirements.txt'):
    # 使用 pip freeze 获取当前环境中的已安装包及其版本号
    result = subprocess.run(['pip', 'freeze'], stdout=subprocess.PIPE)
    requirements = result.stdout.decode('utf-8').splitlines()

    # 将包信息写入 requirements.txt 文件
    with open(output_file, 'w') as f:
        for req in requirements:
            f.write(req + '\n')
    
    print(f"Requirements have been generated and saved to {output_file}.")

if __name__ == "__main__":
    generate_requirements()

使用说明

这个脚本使用 pip freeze 命令获取当前 Python 环境中的所有已安装包及其版本信息。
然后将这些信息写入到 requirements.txt 文件中。

改进后的优点

该方法避免了使用已弃用的 pkg_resources，使用更现代的 pip 工具，符合最新的最佳实践。
兼容性强，适用于大多数环境，并且直接使用了 Python 官方推荐的工具。

运行方式

直接运行上述脚本即可生成 requirements.txt 文件，不会再出现 DeprecationWarning 警告。

更好的方案：

更好的方案，可以避免使用 subprocess 调用外部命令，而是直接使用 Python 官方库 importlib.metadata（适用于 Python 3.8 及更高版本）来获取已安装的包信息。这种方法更加简洁，也没有调用外部命令的开销。

方案3(最佳版)：

使用 `importlib.metadata` 生成 `requirements.txt`

import importlib.metadata
import sys

def generate_requirements(output_file='requirements.txt'):
    # 获取当前环境中的所有已安装包及其版本号
    packages = importlib.metadata.distributions()
    requirements = sorted(f"{package.metadata['Name']}=={package.version}" for package in packages)

    # 将包信息写入 requirements.txt 文件
    with open(output_file, 'w') as f:
        for req in requirements:
            f.write(req + '\n')

    print(f"Requirements have been generated and saved to {output_file}.")

if __name__ == "__main__":
    if sys.version_info < (3, 8):
        print("This script requires Python 3.8 or higher.")
    else:
        generate_requirements()