setup.cfg: Document that description-file can contain more than one file
This commit is contained in:
parent
3605030c9b
commit
8474f2901b
|
@ -285,6 +285,7 @@ One extra field not present in PEP 345 is supported:
|
|||
|
||||
description-file
|
||||
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*
|
||||
|
||||
|
||||
|
|
|
@ -163,21 +163,18 @@ class Config:
|
|||
"mutually exclusive")
|
||||
raise PackagingOptionError(msg)
|
||||
|
||||
if isinstance(value, list):
|
||||
filenames = value
|
||||
else:
|
||||
filenames = value.split()
|
||||
filenames = value.split()
|
||||
|
||||
# concatenate each files
|
||||
value = ''
|
||||
# concatenate all files
|
||||
value = []
|
||||
for filename in filenames:
|
||||
# will raise if file not found
|
||||
with open(filename) as description_file:
|
||||
value += description_file.read().strip() + '\n'
|
||||
value.append(description_file.read().strip())
|
||||
# add filename as a required file
|
||||
if filename not in metadata.requires_files:
|
||||
metadata.requires_files.append(filename)
|
||||
value = value.strip()
|
||||
value = '\n'.join(value).strip()
|
||||
key = 'description'
|
||||
|
||||
if metadata.is_metadata_field(key):
|
||||
|
|
|
@ -327,7 +327,7 @@ class ConfigTestCase(support.TempdirManager,
|
|||
self.assertIn('could not import setup_hook', logs[0])
|
||||
|
||||
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('README2', 'yeah')
|
||||
os.mkdir('src')
|
||||
|
|
Loading…
Reference in New Issue