mirrors
/
cpython
mirror of https://github.com/python/cpython.git
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

setup.cfg: Document that description-file can contain more than one file

This commit is contained in:
Éric Araujo 2011-06-11 00:21:18 +02:00
parent 3605030c9b
commit 8474f2901b
3 changed files with 7 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
Doc/packaging/setupcfg.rst
View File

@ -285,6 +285,7 @@ One extra field not present in PEP 345 is supported:
description-file description-file
Path to a text file that will be used to fill the ``description`` field. Path to a text file that will be used to fill the ``description`` field.
Multiple values are accepted; they must be separated by whitespace.
``description-file`` and ``description`` are mutually exclusive. *optional* ``description-file`` and ``description`` are mutually exclusive. *optional*

11
Lib/packaging/config.py
View File

@ -163,21 +163,18 @@ def _read_setup_cfg(self, parser, cfg_filename):
"mutually exclusive") "mutually exclusive")
raise PackagingOptionError(msg) raise PackagingOptionError(msg)
if isinstance(value, list):
filenames = value
else:
filenames = value.split() filenames = value.split()
# concatenate each files # concatenate all files
value = '' value = []
for filename in filenames: for filename in filenames:
# will raise if file not found # will raise if file not found
with open(filename) as description_file: with open(filename) as description_file:
value += description_file.read().strip() + '\n' value.append(description_file.read().strip())
# add filename as a required file # add filename as a required file
if filename not in metadata.requires_files: if filename not in metadata.requires_files:
metadata.requires_files.append(filename) metadata.requires_files.append(filename)
value = value.strip() value = '\n'.join(value).strip()
key = 'description' key = 'description'
if metadata.is_metadata_field(key): if metadata.is_metadata_field(key):

2
Lib/packaging/tests/test_config.py
View File

@ -327,7 +327,7 @@ def test_missing_setuphook_warns(self):
self.assertIn('could not import setup_hook', logs[0]) self.assertIn('could not import setup_hook', logs[0])
def test_metadata_requires_description_files_missing(self): def test_metadata_requires_description_files_missing(self):
self.write_setup({'description-file': 'README\n README2'}) self.write_setup({'description-file': 'README README2'})
self.write_file('README', 'yeah') self.write_file('README', 'yeah')
self.write_file('README2', 'yeah') self.write_file('README2', 'yeah')
os.mkdir('src') os.mkdir('src')