给定模块，如何找到 python 包元数据信息

Question

我正在尝试检索给定模块名称的 python 包的元数据信息。

我可以使用 importlib-metadata 来检索信息，但在某些情况下，顶级模块名称与包名称不同。

示例：

>>> importlib_metadata.metadata('zmq')['License']
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "c:\Users\xxxxx\AppData\Local\Programs\Python\Python37\Lib\site-packages\importlib_metadata\__init__.py", line 499, in metadata
    return Distribution.from_name(distribution_name).metadata
  File "c:\Users\xxxxx\AppData\Local\Programs\Python\Python37\Lib\site-packages\importlib_metadata\__init__.py", line 187, in from_name
    raise PackageNotFoundError(name)
importlib_metadata.PackageNotFoundError: zmq


>>> importlib_metadata.metadata('pyzmq')['License']
'LGPL+BSD'

Answer 1

我相信类似以下的方法应该有效：

#!/usr/bin/env python3

import importlib.util
import pathlib

import importlib_metadata

def get_distribution(file_name):
    result = None
    for distribution in importlib_metadata.distributions():
        try:
            relative = (
                pathlib.Path(file_name)
                .relative_to(distribution.locate_file(''))
            )
        except ValueError:
            pass
        else:
            if relative in distribution.files:
                result = distribution
    return result

def alpha():
    file_name = importlib.util.find_spec('easy_install').origin
    distribution = get_distribution(file_name)
    print("alpha", distribution.metadata['Name'])

def bravo():
    file_name = importlib_metadata.__file__
    distribution = get_distribution(file_name)
    print("bravo", distribution.metadata['Name'])

if __name__ == '__main__':
    alpha()
    bravo()

---

更新（2021 年 2 月）：

由于importlib_metadata 中新添加的packages_distributions() 函数，这看起来会变得更容易：

• https://importlib-metadata.readthedocs.io/en/stable/using.html#package-distributions
• https://github.com/python/importlib_metadata/pull/287/files

Answer 2

我相信，这里有一个功能可以满足您的需求。它的效率不是很高，因为它必须枚举所有已安装的包分发并读取每个包的顶级模块列表——然而，我相信这是最好的。 （当然，你也可以缓存一个顶级模块名到包名的字典映射。）

from importlib.metadata import Distribution, distributions
from pathlib import Path
from typing import *

def get_pkg_distribution(top_level_module: str) -> Optional[Distribution]:
    pkg_path = Path(__file__).parent
    for dist in distributions():
        package_namespaces = (dist.read_text("top_level.txt") or "").splitlines()
        if top_level_module in package_namespaces:
            return dist
    return None

# Get the package metadata for the current package. Note, `__package__` is actually the name of the top-level module!
pkg_metadata = dict(get_pkg_distribution(__package__).metadata.items())
__version__ = pkg_metadata["Version"]