我们为 twitter 应用程序编写了一个小包装器,并将此信息发布到http://pypi.python.org。但是 setup.py 只包含一个用于指定电子邮件/作者姓名的字段。我如何为以下字段指定多个贡献者/电子邮件列表,因为我们希望这个包以我们的名字列出,与它在http://rubygems.org中的显示方式非常相似。
author='foo',
author_email='foo.bar@gmail.com',
我们为 twitter 应用程序编写了一个小包装器,并将此信息发布到http://pypi.python.org。但是 setup.py 只包含一个用于指定电子邮件/作者姓名的字段。我如何为以下字段指定多个贡献者/电子邮件列表,因为我们希望这个包以我们的名字列出,与它在http://rubygems.org中的显示方式非常相似。
author='foo',
author_email='foo.bar@gmail.com',
据我所知,setuptools
不支持使用字符串列表来指定多个作者。最好的办法是在一个字符串中列出作者:
author='Foo Bar, Spam Eggs',
author_email='foobar@baz.com, spameggs@joe.org',
我不确定 PyPI 是否验证了该author_email
字段,因此您可能会遇到麻烦。无论如何,我建议您将这些限制为单个作者,并在文档或描述中提及所有贡献者。
实际上,这已被注册为错误,但似乎没有实现对多个作者的支持。这是一个替代解决方案。这是一个关于如何为具有多个作者的项目提供联系电子邮件的想法。
如果您想要一些细节,我有点只是捎带@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
考虑使用flit来构建包,因为这个构建系统支持多个作者和维护者。pyproject.toml
按如下方式存储此元数据:
[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"},
]