Jak określić wielu autorów / adresów e-mail w setup.py


83

Napisaliśmy małe opakowanie do aplikacji na Twitterze i opublikowaliśmy te informacje pod adresem http://pypi.python.org . Ale setup.py zawierał tylko jedno pole do określenia adresu e-mail / nazwiska autora. Jak określić wielu współpracowników / listę e-mailową w następujących polach, ponieważ chcielibyśmy, aby ten pakiet był wymieniony pod naszymi nazwami, podobnie jak w http://rubygems.org .

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

1
Czy akceptują e-maile oddzielone przecinkami lub średnikami?
heltonbiker

Odpowiedzi:


84

O ile wiem, setuptoolsnie obsługuje używania listy ciągów w celu określenia wielu autorów. Najlepiej jest wymienić autorów w jednym ciągu:

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

Nie jestem pewien, czy PyPI sprawdza poprawność author_emailpola, więc możesz mieć problemy z tym polem. W każdym razie radziłbym ograniczyć je do jednego autora i wymienić wszystkich współtwórców w dokumentacji lub opisie.

[Edytuj] Niektóre źródła:

Fakt ten został zarejestrowany jako błąd , ale wygląda na to, że obsługa wielu autorów nie została zaimplementowana. Oto alternatywne rozwiązanie. Oto pomysł, jak podać kontaktowy adres e-mail dla projektu z wieloma autorami.


1
+1 dla edycji i powiązanych linków ... Dyskusja w błędzie jest naprawdę interesująca, ale smutne jest, że nie znaleziono konsensusu i że PEP 345 wciąż nie mówi o najlepszych praktykach i wielu autorach
Stefano

1

W pewnym sensie po prostu łamię odpowiedź @ modocache, na wypadek gdybyś chciał poznać szczegóły.

W tej odpowiedzi będę odnosić się do wersji FOO-PYTHON-ENV\Lib\distutils\dist.pypliku python3.6

Aby powtórzyć, nie możesz użyć listy w authorpolu. Dlatego:

Spoiler: DistributionMetadataPowodem są dwie metody należące do tej klasy -

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

Oto gdzie napotkasz błąd, jeśli spróbujesz umieścić listę w authorpolu:

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)...*#

& Oto cała sprawa:

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
Korzystając z naszej strony potwierdzasz, że przeczytałeś(-aś) i rozumiesz nasze zasady używania plików cookie i zasady ochrony prywatności.
Licensed under cc by-sa 3.0 with attribution required.