python - 如何确定 PyPI 包中可用的模块

Question

给定一个 PyPI 包名称，例如PyYAML，如何以编程方式确定包（分发包）中可以导入的可用模块？

细节

我不是特别感兴趣PyYAML，它只是一个流行的 PyPI 包的一个很好的例子，它的包名（PyYAML）与它的主模块名（yaml）不同，这样你就不能轻易地从包名中猜出模块名。

我已经看到其他听起来像这样但不同的问题的答案，可能是因为命名冲突

• 包意味着一个允许模块集合的python结构
• 包表示“分发包”，一个包含 Python 包、模块和其他用于分发版本的资源文件的存档文件。

我的问题是关于分发包和其中的模块之间的关系。

可能的解决方案空间

看起来他们可能富有成果的领域（但我还没有成功）是：

• 该pydoc.help函数（显示为helpbuilt-in ）在调用时输出所有可用模块的完整列表help('modules')。这显示了尚未导入但可能已导入的模块。它以人类可读的形式输出到标准输出，我一直无法弄清楚代码是如何 枚举模块的 。pydoc
  • 我可以想象调用它，收集模块列表，以编程方式使用 pip 将新的分发包安装到 virtualenv 中，再次调用它并区分结果。
• 使用 pip 以编程方式安装分发包，以便
  • 遍历 python 路径的元素以查找模块

标签： pythonmodulesetuptoolspypipython-packaging

Answer 1

我的项目johnnydep正好提供了这个功能：

$ johnnydep --fields=import_names PyYAML
name    import_names
------  --------------
PyYAML  yaml

请注意，有些发行版导出多个顶级名称，有些发行版根本不导出，并且发行版名称（与pip install命令一起使用）和包名称（与import语句一起使用）之间不一定有任何明显的关系 - 尽管它是匹配它们的通用约定。

例如，流行的项目setuptools公开了三个顶级名称：

$ johnnydep --fields=import_names setuptools 
name        import_names
----------  ---------------------------------------
setuptools  easy_install, pkg_resources, setuptools

API 使用是通过属性访问：

>>> from johnnydep.lib import JohnnyDist
>>> jdist = JohnnyDist("setuptools")
>>> jdist.import_names
['easy_install', 'pkg_resources', 'setuptools']

如果您有兴趣了解子模块名称，而不是顶级名称，则可以使用 stdlib pkgutil，例如：

>>> import pkgutil, requests
>>> [name for finder, name, ispkg in pkgutil.walk_packages(requests.__path__)]
['__version__',
 '_internal_utils',
 'adapters',
 'api',
 'auth',
 'certs',
 'compat',
 'cookies',
 'exceptions',
 'help',
 'hooks',
 'models',
 'packages',
 'sessions',
 'status_codes',
 'structures',
 'utils']