Як вказати декількох авторів / електронних листів у setup.py


83

Ми написали невелику обгортку в програму щебетання та опублікували цю інформацію на http://pypi.python.org . Але файл setup.py містив лише одне поле для вказівки електронної пошти / імені автора. Як я можу вказати декількох співавторів / список електронної пошти для наступних полів, оскільки ми хотіли б, щоб цей пакет був перелічений під нашими іменами, дуже схоже на те, як воно відображається на http://rubygems.org .

   author='foo',
   author_email='foo.bar@gmail.com',

1
Чи приймають вони електронні листи, розділені комами чи крапками з комою?
heltonbiker

Відповіді:


84

Наскільки я знаю, setuptoolsне підтримує використання списку рядків для того, щоб вказати декількох авторів. Найкраще поставити авторів у один рядок:

author='Foo Bar, Spam Eggs',
author_email='foobar@baz.com, spameggs@joe.org',

Я не впевнений, що PyPI перевіряє author_emailполе, тому ви можете зіткнутися з цим. У будь-якому випадку, я б рекомендував обмежити їх одним автором і згадати всіх учасників у документації чи описі.

[Редагувати] Деякі джерела:

Насправді це було зареєстровано як помилку , але, схоже, підтримка кількох авторів не реалізована. Ось альтернативне рішення. Ось ідея, як надати контактну електронну адресу для проекту з кількома авторами.


1
+1 за редагування та пов’язані з ним посилання ... Обговорення помилки справді цікаве, але прикро, що, здається, не було знайдено консенсусу і що PEP 345 все ще не говорить про найкращі практики та декількох авторів
Стефано,

1

Я начебто просто відкидаю відповідь @ modocache, на випадок, якщо ви хочете трохи деталей.

Протягом усієї цієї відповіді я буду звертатися до версії FOO-PYTHON-ENV\Lib\distutils\dist.pyфайлу python3.6

Щоб повторити, ви не можете використовувати список у authorполі. Ось чому:

Спойлер: DistributionMetadataПричиною є два методи, що належать до класу -

def _read_field(name):
    value = msg[name]
    if value == 'UNKNOWN':
        return None
    return value

def _read_list(name):
    values = msg.get_all(name, None)
    if values == []:
        return None
    return values

Ось де ви побачите помилку, якщо спробуєте вставити список у authorполе:

class DistributionMetadata:

#*...(R E D A C T E D)...*#

    def read_pkg_file(self, file):
        """Reads the metadata values from a file object."""
    #*...(R E D A C T E D)...*#
        # ####################################
        # Note the usage of _read_field() here
        # ####################################
        self.name = _read_field('name')
        self.version = _read_field('version')
        self.description = _read_field('summary')
        # we are filling author only.
        self.author = _read_field('author')
        self.maintainer = None
        self.author_email = _read_field('author-email')
        self.maintainer_email = None
        self.url = _read_field('home-page')
        self.license = _read_field('license')
    #*...(R E D A C T E D)...*#
        # ###################################
        # Note the usage of _read_list() here
        # ###################################
        self.platforms = _read_list('platform')
        self.classifiers = _read_list('classifier')
    #*...(R E D A C T E D)...*#

& Ось усе:

class DistributionMetadata:
        """Dummy class to hold the distribution meta-data: name, version,
        author, and so forth.
        """

        _METHOD_BASENAMES = ("name", "version", "author", "author_email",
                     "maintainer", "maintainer_email", "url",
                     "license", "description", "long_description",
                     "keywords", "platforms", "fullname", "contact",
                     "contact_email", "classifiers", "download_url",
                     # PEP 314
                     "provides", "requires", "obsoletes",
                     )

    def __init__(self, path=None):
        if path is not None:
            self.read_pkg_file(open(path))
        else:
            self.name = None
            self.version = None
            self.author = None
            self.author_email = None
            self.maintainer = None
            self.maintainer_email = None
            self.url = None
            self.license = None
            self.description = None
            self.long_description = None
            self.keywords = None
            self.platforms = None
            self.classifiers = None
            self.download_url = None
            # PEP 314
            self.provides = None
            self.requires = None
            self.obsoletes = None

    def read_pkg_file(self, file):
        """Reads the metadata values from a file object."""
        msg = message_from_file(file)

        def _read_field(name):
            value = msg[name]
            if value == 'UNKNOWN':
                return None
            return value

        def _read_list(name):
            values = msg.get_all(name, None)
            if values == []:
                return None
            return values

        metadata_version = msg['metadata-version']
        self.name = _read_field('name')
        self.version = _read_field('version')
        self.description = _read_field('summary')
        # we are filling author only.
        self.author = _read_field('author')
        self.maintainer = None
        self.author_email = _read_field('author-email')
        self.maintainer_email = None
        self.url = _read_field('home-page')
        self.license = _read_field('license')

        if 'download-url' in msg:
            self.download_url = _read_field('download-url')
        else:
            self.download_url = None

        self.long_description = _read_field('description')
        self.description = _read_field('summary')

        if 'keywords' in msg:
            self.keywords = _read_field('keywords').split(',')

        self.platforms = _read_list('platform')
        self.classifiers = _read_list('classifier')

        # PEP 314 - these fields only exist in 1.1
        if metadata_version == '1.1':
            self.requires = _read_list('requires')
            self.provides = _read_list('provides')
            self.obsoletes = _read_list('obsoletes')
        else:
            self.requires = None
            self.provides = None
            self.obsoletes = None
Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.