Python - 创建egg文件描述和长描述有什么用

Question

我正在创建一个 egg 文件，并且我能够成功地做到这一点。但是，我在 description 和 long_description 中提供的值是不可见的。

setup.py

description = "desc"
long_description = "lond desc"
setup(
    name="abc",
    version="0.2",
    packages=find_packages(),
    description=description,
    long_description=long_description,
    author='Gaurang Shah',
    author_email='gaurang.shah@abc.com'

)

构建脚本

rm -rf build dist dataplaform.egg-info
python setup.py bdist_egg

安装软件包后，当我运行以下命令时。我什么都没看到？

import abc
abc.__doc__

Answer 1

您会在pip show abc 或PyPI repository 上看到description 和/或long_description。基本上在引用 Python 项目 abc的地方。

当您键入 import abc; print(abc.__doc__) 时，您指的是 Python *包（或模块）abc，巧合已通过安装发行版（在本例为同名项目abc 的bdist_egg)。

不过，Python 项目和 Python 包并不是一回事。混淆来自这样一个事实，即 Python 项目几乎总是包含一个同名的*包，因此两者可以互换使用，造成极大的混淆。请参阅beautifulsoup4 了解一个著名的反例。

在您的情况下，abc.__doc__ 实际上是指您的abc/__init__.py（或最终是*abc.py）的文档字符串。