Python - Создание яичного файла с использованием описания и длинного описания

Question

Я создаю файл яйца, и я могу сделать это успешно. Однако значение, которое я указал в описании и 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

Вы увидите description и / или long_description в pip show abc или в PyPI-репозитории . В основном в местах, которые ссылаются на проект Python abc.

Когда вы набираете import abc; print(abc.__doc__), вы ссылаетесь на пакет верхнего уровня Python (или модуль) abc что по совпадению стало доступным благодаря установке дистрибутива (в данном случае bdist_egg) проекта с таким же именем abc.

Проекты Python и пакеты Pythonне то же самое, хотя. Путаница возникает из-за того факта, что почти всегда проект Python содержит один пакет верхнего уровня с одинаковым именем, и поэтому оба используются взаимозаменяемо для большой путаницы. См. beautifulsoup4 для примера известного счетчика.

В вашем случае abc.__doc__ на самом деле относится к строке документации вашего abc/__init__.py (или в конечном итоге к верхнему уровню * 1029). *).