python - 为什么我有 Description-Content-Type : UNKNOWN

Question

我最近在我的 .egg-info/PKG-INFO 中发现了一个新的元数据:Description-Content-Type。

当我运行时:

python setup.py egg_info

我得到:

Description-Content-Type: UNKNOWN

例如，我怎么知道我使用的是 Markdown (text/markdown)？

Answer 1

元数据字段 Description-Content-Type 是在 setuptools v36.4 中引入的(2017 年 9 月)。它在 Core Metadata v2.1 中可用.

您可以在 setup.py 中使用此元数据来指定包的内容类型 Description .

经典的用法是在long_description中填上你项目的README文件。然后，您可以使用 long_description_content_type 参数来设置内容类型。

项目的详细描述显示在 PyPi 中。 (Python 包索引)。您可以阅读 PyPA 文章:“Including your README in your package’s metadata ”。

这是一个例子:

import io

from setuptools import setup


def read(filename):
    with io.open(filename, mode="r", encoding='utf-8') as fd:
        return fd.read()


setup(
    name="YourProject",
    version='1.2.3',

    description="One line description of your project",
    long_description=read("README.rst"),
    long_description_content_type='text/x-rst',

    ...
)

您可以选择其中一种内容类型:

• “text/plain”:用于简单文本(例如:“README”或“README.txt”)，
• “text/x-rst”:用于重组文本(例如:“README.rst”)，或
• “text/markdown”:用于 Markdown(例如:“README.md”)。

注意:最近才支持 Markdown(您需要 setuptools >= 38.6)。

此外，您可以使用 twine检查你的包的详细描述(一旦构建了可分发的)。例如:

twine check dist/*