Python – создание файла яйца, для чего используется описание и длинное описание

Я создаю файл яйца, и я могу сделать это успешно. Однако значение, которое я указал в описании и длинном_описании, не отображается.

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='[email protected]'

)

Скрипт сборки

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

После установки пакета, когда я запускаю следующую команду. я ничего не вижу?

import abc
abc.__doc__

python setup.py egg
person Gaurang Shah    schedule 30.09.2019    source источник

Ответы (1)


arrow_upward
0
arrow_downward

Вы увидите 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 (или, в конечном итоге, на верхний уровень abc.py).

person sinoroc    schedule 01.10.2019
comment
@Gaurang ответил на твой вопрос? - person sinoroc; 26.12.2019