python pkg_resources模块简介

模块简介

英文使用文档

常用函数介绍（陆续更新）

pkg_resources.require(env=None, installer=None)
该函数负责返回对应包所需的所有依赖包，如：

import pkg_resources
pkg_resources.require('torch')

[torch 1.7.0+cu92 (/usr/local/lib/python3.6/dist-packages),
 numpy 1.19.4 (/usr/local/lib/python3.6/dist-packages),
 typing-extensions 3.6.6 (/usr/local/lib/python3.6/dist-packages),
 future 0.17.1 (/usr/local/lib/python3.6/dist-packages),
 dataclasses 0.8 (/usr/local/lib/python3.6/dist-packages)]

当未安装该模块，或者该模块要求的版本不对时，则会报错。

pkg_resources.parse_requirements(file)
该函数可以解析file中的每一条要求，每一行转换为pkg_resources.Requirement类并进行进一步处理。
通常的处理形式为调用每一行对应的name和specifier属性。前者代表需要包的名称，后者代表版本。
使用示例如下：

from pathlib import Path
import pkg_resources #此为管理安装包信息相关模块

file='/userhome/yolov5-t/requirements.txt'

for x in pkg_resources.parse_requirements(Path(file).open()):
    print(x.name)
    print(x.specifier)
Cython

matplotlib
>=3.2.2
numpy
>=1.18.5
opencv-python
>=4.1.2
Pillow
......

yolov5项目中使用的检查requirements文件的范式程序为：

def check_requirements(file='requirements.txt', exclude=()):
    # Check installed dependencies meet requirements
    import pkg_resources #此为管理安装包信息相关模块
    
    requirements = [f'{x.name}{x.specifier}' for x in pkg_resources.parse_requirements(Path(file).open())
                    if x.name not in exclude]
    pkg_resources.require(requirements)  #判断已经安装的包是否符合要求