如何在setup.py中指定多个作者/电子邮件


82

我们为Twitter应用程序编写了一个小型包装,并将此信息发布到http://pypi.python.org。但是setup.py仅包含一个用于指定作者的电子邮件/姓名的字段。我如何在以下字段中指定多个贡献者/电子邮件列表,因为我们希望此软件包以我们的名字列出,与它在http://rubygems.org中显示的方式非常相似。

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

1
他们接受逗号或分号分隔的电子邮件吗?
heltonbiker 2012年

Answers:


81

据我所知,setuptools不支持使用字符串列表来指定多个作者。最好的选择是在单个字符串中列出作者:

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

我不确定PyPIauthor_email是否会验证该字段,因此您可能会遇到麻烦。无论如何,我建议您将这些作者限制为一个作者,并在文档或说明中提及所有贡献者。

[编辑]一些来源:

实际上,这已被注册为bug,但似乎未实现对多位作者的支持。是一个替代解决方案。是有关如何为具有多个作者的项目提供联系电子邮件的想法。


1
+1为编辑和相关链接...错误中的讨论确实很有趣,但是令人遗憾的是,似乎尚未达成共识,PEP 345仍然没有提及最佳实践和多位作者
Stefano

0

我有点want带@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
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.