簡體   English   中英

"如何在 setup.py 中指定多個作者\/電子郵件"

[英]How to specify multiple author(s) / email(s) in setup.py

據我所知, setuptools不支持使用字符串列表來指定多個作者。 您最好的選擇是將作者列在一個字符串中:

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

我不確定PyPI是否驗證了author_email字段,因此您可能會遇到問題。 無論如何,我建議您將這些限制為單個作者,並在文檔或說明中提及所有貢獻者。

[編輯]一些消息來源:

實際上,這已被注冊為錯誤 ,但似乎沒有實現對多個作者的支持。 是另一種解決方案。 以下是如何為具有多位作者的項目提供聯系電子郵件的想法。

我有點只是抄襲@ modocache的答案,以防你需要一些細節。

在這個答案中,我將引用一個python3.6版本的FOO-PYTHON-ENV\\Lib\\distutils\\dist.py文件

重申一下,您不能在author字段中使用列表。 原因如下:

Spoiler:屬於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

考慮使用flit<\/strong><\/a>來構建包,因為這個構建系統支持多個作者和維護者。 將此元數據存儲在pyproject.toml<\/code><\/a>中,如下所示:

[build-system]
requires = ["flit_core >=3.2,<4"]
build-backend = "flit_core.buildapi"

[project]
...
authors = [
    {name = "First1 Last1", email = "name1@foo.bar"},
    {name = "First2 Last2", email = "name2@foo.bar"},
]
maintainers = [
    {name = "First1 Last1", email = "name1@foo.bar"},
    {name = "First2 Last2", email = "name2@foo.bar"},
]

暫無
暫無

聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.

 
粵ICP備18138465號  © 2020-2024 STACKOOM.COM