From 3544de73b3662a27fac14d8eb9f5c841668d66de Mon Sep 17 00:00:00 2001 From: Marc Mueller <30130371+cdce8p@users.noreply.github.com> Date: Sat, 17 Apr 2021 20:48:12 +0200 Subject: [PATCH 1/9] Add License-File field to package metadata --- changelog.d/2645.change.rst | 4 +++ setuptools/command/egg_info.py | 9 +++++- setuptools/command/sdist.py | 46 ------------------------------- setuptools/config.py | 5 ++++ setuptools/dist.py | 37 +++++++++++++++++++++++-- setuptools/tests/test_egg_info.py | 29 +++++++++++++++++++ setuptools/tests/test_manifest.py | 1 - 7 files changed, 81 insertions(+), 50 deletions(-) create mode 100644 changelog.d/2645.change.rst diff --git a/changelog.d/2645.change.rst b/changelog.d/2645.change.rst new file mode 100644 index 0000000000..b22385c1b7 --- /dev/null +++ b/changelog.d/2645.change.rst @@ -0,0 +1,4 @@ +Added ``License-File`` (multiple) to the output package metadata. +The field will contain the path of a license file, matched by the +``license_file`` (deprecated) and ``license_files`` options, +relative to ``.dist-info``. - by :user:`cdce8p` diff --git a/setuptools/command/egg_info.py b/setuptools/command/egg_info.py index 1f120b67d1..26ff9a4cd0 100644 --- a/setuptools/command/egg_info.py +++ b/setuptools/command/egg_info.py @@ -539,6 +539,7 @@ def run(self): if not os.path.exists(self.manifest): self.write_manifest() # it must exist so it'll get in the list self.add_defaults() + self.add_license_files() if os.path.exists(self.template): self.read_template() self.prune_file_list() @@ -575,7 +576,6 @@ def _should_suppress_warning(msg): def add_defaults(self): sdist.add_defaults(self) - self.check_license() self.filelist.append(self.template) self.filelist.append(self.manifest) rcfiles = list(walk_revctrl()) @@ -592,6 +592,13 @@ def add_defaults(self): ei_cmd = self.get_finalized_command('egg_info') self.filelist.graft(ei_cmd.egg_info) + def add_license_files(self): + license_files = self.distribution.metadata.license_files_computed + for lf in license_files: + log.info("adding license file '%s'", lf) + pass + self.filelist.extend(license_files) + def prune_file_list(self): build = self.get_finalized_command('build') base_dir = self.distribution.get_fullname() diff --git a/setuptools/command/sdist.py b/setuptools/command/sdist.py index a6ea814a30..4a014283c8 100644 --- a/setuptools/command/sdist.py +++ b/setuptools/command/sdist.py @@ -4,9 +4,6 @@ import sys import io import contextlib -from glob import iglob - -from setuptools.extern import ordered_set from .py36compat import sdist_add_defaults @@ -190,46 +187,3 @@ def read_manifest(self): continue self.filelist.append(line) manifest.close() - - def check_license(self): - """Checks if license_file' or 'license_files' is configured and adds any - valid paths to 'self.filelist'. - """ - opts = self.distribution.get_option_dict('metadata') - - files = ordered_set.OrderedSet() - try: - license_files = self.distribution.metadata.license_files - except TypeError: - log.warn("warning: 'license_files' option is malformed") - license_files = ordered_set.OrderedSet() - patterns = license_files if isinstance(license_files, ordered_set.OrderedSet) \ - else ordered_set.OrderedSet(license_files) - - if 'license_file' in opts: - log.warn( - "warning: the 'license_file' option is deprecated, " - "use 'license_files' instead") - patterns.append(opts['license_file'][1]) - - if 'license_file' not in opts and 'license_files' not in opts: - # Default patterns match the ones wheel uses - # See https://wheel.readthedocs.io/en/stable/user_guide.html - # -> 'Including license files in the generated wheel file' - patterns = ('LICEN[CS]E*', 'COPYING*', 'NOTICE*', 'AUTHORS*') - - for pattern in patterns: - for path in iglob(pattern): - if path.endswith('~'): - log.debug( - "ignoring license file '%s' as it looks like a backup", - path) - continue - - if path not in files and os.path.isfile(path): - log.info( - "adding license file '%s' (matched pattern '%s')", - path, pattern) - files.add(path) - - self.filelist.extend(sorted(files)) diff --git a/setuptools/config.py b/setuptools/config.py index 4a6cd4694b..44de7cf5f2 100644 --- a/setuptools/config.py +++ b/setuptools/config.py @@ -520,6 +520,11 @@ def parsers(self): 'obsoletes': parse_list, 'classifiers': self._get_parser_compound(parse_file, parse_list), 'license': exclude_files_parser('license'), + 'license_file': self._deprecated_config_handler( + exclude_files_parser('license_file'), + "The license_file parameter is deprecated, " + "use license_files instead.", + DeprecationWarning), 'license_files': parse_list, 'description': parse_file, 'long_description': parse_file, diff --git a/setuptools/dist.py b/setuptools/dist.py index bf3b9461b8..9d7fb7510b 100644 --- a/setuptools/dist.py +++ b/setuptools/dist.py @@ -15,9 +15,10 @@ from distutils.util import strtobool from distutils.debug import DEBUG from distutils.fancy_getopt import translate_longopt +from glob import iglob import itertools import textwrap -from typing import List, Optional, TYPE_CHECKING +from typing import List, Optional, Set, TYPE_CHECKING from collections import defaultdict from email import message_from_file @@ -141,6 +142,8 @@ def read_pkg_file(self, file): self.provides = None self.obsoletes = None + self.license_files_computed = _read_list_from_msg(msg, 'license-file') + def single_line(val): # quick and dirty validation for description pypa/setuptools#1390 @@ -213,6 +216,8 @@ def write_field(key, value): for extra in self.provides_extras: write_field('Provides-Extra', extra) + self._write_list(file, 'License-File', self.license_files_computed) + file.write("\n%s\n\n" % self.get_long_description()) @@ -414,7 +419,9 @@ class Distribution(_Distribution): 'long_description_content_type': lambda: None, 'project_urls': dict, 'provides_extras': ordered_set.OrderedSet, - 'license_files': ordered_set.OrderedSet, + 'license_file': None, + 'license_files': None, + 'license_files_computed': list, } _patched_dist = None @@ -573,6 +580,31 @@ def _clean_req(self, req): req.marker = None return req + def _finalize_license_files(self): + """Compute names of all license files which should be included.""" + files = set() + license_files: Optional[List[str]] = self.metadata.license_files + patterns: Set[str] = set(license_files) if license_files else set() + + license_file: Optional[str] = self.metadata.license_file + if license_file: + patterns.add(license_file) + + if license_files is None and license_file is None: + # Default patterns match the ones wheel uses + # See https://wheel.readthedocs.io/en/stable/user_guide.html + # -> 'Including license files in the generated wheel file' + patterns = ('LICEN[CS]E*', 'COPYING*', 'NOTICE*', 'AUTHORS*') + + for pattern in patterns: + for path in iglob(pattern): + if path.endswith('~'): + continue + if path not in files and os.path.isfile(path): + files.add(path) + + self.metadata.license_files_computed = sorted(files) + # FIXME: 'Distribution._parse_config_files' is too complex (14) def _parse_config_files(self, filenames=None): # noqa: C901 """ @@ -737,6 +769,7 @@ def parse_config_files(self, filenames=None, ignore_option_errors=False): parse_configuration(self, self.command_options, ignore_option_errors=ignore_option_errors) self._finalize_requires() + self._finalize_license_files() def fetch_build_eggs(self, requires): """Resolve pre-setup requirements""" diff --git a/setuptools/tests/test_egg_info.py b/setuptools/tests/test_egg_info.py index d7657a47ff..29fb206234 100644 --- a/setuptools/tests/test_egg_info.py +++ b/setuptools/tests/test_egg_info.py @@ -835,6 +835,35 @@ def test_setup_cfg_license_file_license_files( for lf in excl_licenses: assert sources_lines.count(lf) == 0 + def test_license_file_attr_pkg_info(self, tmpdir_cwd, env): + """All matched license files should have a corresponding License-File.""" + self._create_project() + path.build({ + "setup.cfg": DALS(""" + [metadata] + license_files = + LICENSE* + """), + "LICENSE-ABC": "ABC license", + "LICENSE-XYZ": "XYZ license", + "NOTICE": "not included", + }) + + environment.run_setup_py( + cmd=['egg_info'], + pypath=os.pathsep.join([env.paths['lib'], str(tmpdir_cwd)]) + ) + egg_info_dir = os.path.join('.', 'foo.egg-info') + with open(os.path.join(egg_info_dir, 'PKG-INFO')) as pkginfo_file: + pkg_info_lines = pkginfo_file.read().split('\n') + license_file_lines = [ + line for line in pkg_info_lines if line.startswith('License-File:')] + + # Only 'LICENSE-ABC' and 'LICENSE-XYZ' should have been matched + assert len(license_file_lines) == 2 + assert "License-File: LICENSE-ABC" in license_file_lines + assert "License-File: LICENSE-XYZ" in license_file_lines + def test_metadata_version(self, tmpdir_cwd, env): """Make sure latest metadata version is used by default.""" self._setup_script_with_requires("") diff --git a/setuptools/tests/test_manifest.py b/setuptools/tests/test_manifest.py index 589cefb2c0..82bdb9c643 100644 --- a/setuptools/tests/test_manifest.py +++ b/setuptools/tests/test_manifest.py @@ -55,7 +55,6 @@ def touch(filename): default_files = frozenset(map(make_local_path, [ 'README.rst', 'MANIFEST.in', - 'LICENSE', 'setup.py', 'app.egg-info/PKG-INFO', 'app.egg-info/SOURCES.txt', From b16725ac388b6a0bab6c0ff79d809559589be248 Mon Sep 17 00:00:00 2001 From: Marc Mueller <30130371+cdce8p@users.noreply.github.com> Date: Thu, 20 May 2021 01:24:01 +0200 Subject: [PATCH 2/9] Remove license_files_computed field --- setuptools/command/egg_info.py | 2 +- setuptools/dist.py | 7 +++---- 2 files changed, 4 insertions(+), 5 deletions(-) diff --git a/setuptools/command/egg_info.py b/setuptools/command/egg_info.py index 26ff9a4cd0..67259c7c39 100644 --- a/setuptools/command/egg_info.py +++ b/setuptools/command/egg_info.py @@ -593,7 +593,7 @@ def add_defaults(self): self.filelist.graft(ei_cmd.egg_info) def add_license_files(self): - license_files = self.distribution.metadata.license_files_computed + license_files = self.distribution.metadata.license_files or [] for lf in license_files: log.info("adding license file '%s'", lf) pass diff --git a/setuptools/dist.py b/setuptools/dist.py index 9d7fb7510b..5be83d70b3 100644 --- a/setuptools/dist.py +++ b/setuptools/dist.py @@ -142,7 +142,7 @@ def read_pkg_file(self, file): self.provides = None self.obsoletes = None - self.license_files_computed = _read_list_from_msg(msg, 'license-file') + self.license_files = _read_list_from_msg(msg, 'license-file') def single_line(val): @@ -216,7 +216,7 @@ def write_field(key, value): for extra in self.provides_extras: write_field('Provides-Extra', extra) - self._write_list(file, 'License-File', self.license_files_computed) + self._write_list(file, 'License-File', self.license_files or []) file.write("\n%s\n\n" % self.get_long_description()) @@ -421,7 +421,6 @@ class Distribution(_Distribution): 'provides_extras': ordered_set.OrderedSet, 'license_file': None, 'license_files': None, - 'license_files_computed': list, } _patched_dist = None @@ -603,7 +602,7 @@ def _finalize_license_files(self): if path not in files and os.path.isfile(path): files.add(path) - self.metadata.license_files_computed = sorted(files) + self.metadata.license_files = sorted(files) # FIXME: 'Distribution._parse_config_files' is too complex (14) def _parse_config_files(self, filenames=None): # noqa: C901 From 482e8e7687e3272ca2d0b1d5d73b92c3219f4576 Mon Sep 17 00:00:00 2001 From: Marc Mueller <30130371+cdce8p@users.noreply.github.com> Date: Sat, 17 Apr 2021 21:33:23 +0200 Subject: [PATCH 3/9] Overwrite exlude from MANIFEST with license_files option * needed for 'License-File' metadata, as this is written before MANIFEST is read --- changelog.d/2645.breaking.rst | 3 +++ setuptools/command/egg_info.py | 2 +- setuptools/tests/test_egg_info.py | 11 ++++++----- 3 files changed, 10 insertions(+), 6 deletions(-) create mode 100644 changelog.d/2645.breaking.rst diff --git a/changelog.d/2645.breaking.rst b/changelog.d/2645.breaking.rst new file mode 100644 index 0000000000..b96b492ac2 --- /dev/null +++ b/changelog.d/2645.breaking.rst @@ -0,0 +1,3 @@ +License files excluded via the ``MANIFEST.in`` but matched by either +the ``license_file`` (deprecated) or ``license_files`` options, +will be nevertheless included in the source distribution. - by :user:`cdce8p` diff --git a/setuptools/command/egg_info.py b/setuptools/command/egg_info.py index 67259c7c39..18b81340a7 100644 --- a/setuptools/command/egg_info.py +++ b/setuptools/command/egg_info.py @@ -539,9 +539,9 @@ def run(self): if not os.path.exists(self.manifest): self.write_manifest() # it must exist so it'll get in the list self.add_defaults() - self.add_license_files() if os.path.exists(self.template): self.read_template() + self.add_license_files() self.prune_file_list() self.filelist.sort() self.filelist.remove_duplicates() diff --git a/setuptools/tests/test_egg_info.py b/setuptools/tests/test_egg_info.py index 29fb206234..2821a29585 100644 --- a/setuptools/tests/test_egg_info.py +++ b/setuptools/tests/test_egg_info.py @@ -551,7 +551,7 @@ def test_doesnt_provides_extra(self, tmpdir_cwd, env): """), 'MANIFEST.in': "exclude LICENSE", 'LICENSE': "Test license" - }, False), # license file is manually excluded + }, True), # manifest is overwritten by license_file pytest.param({ 'setup.cfg': DALS(""" [metadata] @@ -647,7 +647,7 @@ def test_setup_cfg_license_file( """), 'MANIFEST.in': "exclude LICENSE", 'LICENSE': "Test license" - }, [], ['LICENSE']), # license file is manually excluded + }, ['LICENSE'], []), # manifest is overwritten by license_files ({ 'setup.cfg': DALS(""" [metadata] @@ -658,7 +658,8 @@ def test_setup_cfg_license_file( 'MANIFEST.in': "exclude LICENSE-XYZ", 'LICENSE-ABC': "ABC license", 'LICENSE-XYZ': "XYZ license" - }, ['LICENSE-ABC'], ['LICENSE-XYZ']), # subset is manually excluded + # manifest is overwritten by license_files + }, ['LICENSE-ABC', 'LICENSE-XYZ'], []), pytest.param({ 'setup.cfg': "", 'LICENSE-ABC': "ABC license", @@ -791,8 +792,8 @@ def test_setup_cfg_license_files( 'LICENSE-ABC': "ABC license", 'LICENSE-PQR': "PQR license", 'LICENSE-XYZ': "XYZ license" - # manually excluded - }, ['LICENSE-XYZ'], ['LICENSE-ABC', 'LICENSE-PQR']), + # manifest is overwritten + }, ['LICENSE-ABC', 'LICENSE-PQR', 'LICENSE-XYZ'], []), pytest.param({ 'setup.cfg': DALS(""" [metadata] From 3d1cce5c6961c2dafc0dc0300c06a0af03e42842 Mon Sep 17 00:00:00 2001 From: Marc Mueller <30130371+cdce8p@users.noreply.github.com> Date: Sat, 22 May 2021 12:23:18 +0200 Subject: [PATCH 4/9] Keep user sorting for license files --- setuptools/dist.py | 14 ++++++++------ setuptools/tests/test_egg_info.py | 26 +++++++++++++++++++++----- 2 files changed, 29 insertions(+), 11 deletions(-) diff --git a/setuptools/dist.py b/setuptools/dist.py index 5be83d70b3..4877d36be2 100644 --- a/setuptools/dist.py +++ b/setuptools/dist.py @@ -581,13 +581,13 @@ def _clean_req(self, req): def _finalize_license_files(self): """Compute names of all license files which should be included.""" - files = set() + files: List[str] = [] license_files: Optional[List[str]] = self.metadata.license_files - patterns: Set[str] = set(license_files) if license_files else set() + patterns: List[str] = license_files if license_files else [] license_file: Optional[str] = self.metadata.license_file - if license_file: - patterns.add(license_file) + if license_file and license_file not in patterns: + patterns.append(license_file) if license_files is None and license_file is None: # Default patterns match the ones wheel uses @@ -596,13 +596,15 @@ def _finalize_license_files(self): patterns = ('LICEN[CS]E*', 'COPYING*', 'NOTICE*', 'AUTHORS*') for pattern in patterns: + files_pattern: Set[str] = set() for path in iglob(pattern): if path.endswith('~'): continue if path not in files and os.path.isfile(path): - files.add(path) + files_pattern.add(path) + files.extend(sorted(files_pattern)) - self.metadata.license_files = sorted(files) + self.metadata.license_files = files # FIXME: 'Distribution._parse_config_files' is too complex (14) def _parse_config_files(self, filenames=None): # noqa: C901 diff --git a/setuptools/tests/test_egg_info.py b/setuptools/tests/test_egg_info.py index 2821a29585..1d98d259f0 100644 --- a/setuptools/tests/test_egg_info.py +++ b/setuptools/tests/test_egg_info.py @@ -689,6 +689,17 @@ def test_setup_cfg_license_file( 'NOTICE-XYZ': "XYZ notice", }, ['LICENSE-ABC'], ['NOTICE-XYZ'], id="no_default_glob_patterns"), + pytest.param({ + 'setup.cfg': DALS(""" + [metadata] + license_files = + LICENSE-ABC + LICENSE* + """), + 'LICENSE-ABC': "ABC license", + }, ['LICENSE-ABC'], [], + id="files_only_added_once", + ), ]) def test_setup_cfg_license_files( self, tmpdir_cwd, env, files, incl_licenses, excl_licenses): @@ -843,11 +854,13 @@ def test_license_file_attr_pkg_info(self, tmpdir_cwd, env): "setup.cfg": DALS(""" [metadata] license_files = + NOTICE* LICENSE* """), "LICENSE-ABC": "ABC license", "LICENSE-XYZ": "XYZ license", - "NOTICE": "not included", + "NOTICE": "included", + "IGNORE": "not include", }) environment.run_setup_py( @@ -860,10 +873,13 @@ def test_license_file_attr_pkg_info(self, tmpdir_cwd, env): license_file_lines = [ line for line in pkg_info_lines if line.startswith('License-File:')] - # Only 'LICENSE-ABC' and 'LICENSE-XYZ' should have been matched - assert len(license_file_lines) == 2 - assert "License-File: LICENSE-ABC" in license_file_lines - assert "License-File: LICENSE-XYZ" in license_file_lines + # Only 'NOTICE', LICENSE-ABC', and 'LICENSE-XYZ' should have been matched + # Also assert that order from license_files is keeped + assert license_file_lines == [ + "License-File: NOTICE", + "License-File: LICENSE-ABC", + "License-File: LICENSE-XYZ", + ] def test_metadata_version(self, tmpdir_cwd, env): """Make sure latest metadata version is used by default.""" From e8d7f8861be6acc6f62057604fc2313b16d16b9f Mon Sep 17 00:00:00 2001 From: Marc Mueller <30130371+cdce8p@users.noreply.github.com> Date: Sat, 22 May 2021 12:32:10 +0200 Subject: [PATCH 5/9] Fix after rebase --- setuptools/dist.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/setuptools/dist.py b/setuptools/dist.py index 4877d36be2..65e6d8b25f 100644 --- a/setuptools/dist.py +++ b/setuptools/dist.py @@ -419,8 +419,8 @@ class Distribution(_Distribution): 'long_description_content_type': lambda: None, 'project_urls': dict, 'provides_extras': ordered_set.OrderedSet, - 'license_file': None, - 'license_files': None, + 'license_file': lambda: None, + 'license_files': lambda: None, } _patched_dist = None From 540a912cce79aa3aed2fcb34c68d4433ad1d096e Mon Sep 17 00:00:00 2001 From: Marc Mueller <30130371+cdce8p@users.noreply.github.com> Date: Sat, 22 May 2021 13:07:28 +0200 Subject: [PATCH 6/9] Remove license_file --- setuptools/dist.py | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/setuptools/dist.py b/setuptools/dist.py index 65e6d8b25f..5b901801d8 100644 --- a/setuptools/dist.py +++ b/setuptools/dist.py @@ -419,7 +419,6 @@ class Distribution(_Distribution): 'long_description_content_type': lambda: None, 'project_urls': dict, 'provides_extras': ordered_set.OrderedSet, - 'license_file': lambda: None, 'license_files': lambda: None, } @@ -585,7 +584,10 @@ def _finalize_license_files(self): license_files: Optional[List[str]] = self.metadata.license_files patterns: List[str] = license_files if license_files else [] - license_file: Optional[str] = self.metadata.license_file + license_file: Optional[str] = None + opts = self.get_option_dict('metadata') + if 'license_file' in opts: + license_file = opts['license_file'][1] if license_file and license_file not in patterns: patterns.append(license_file) From c837956cd9f623815df6b2155efac6e13b5e1f7b Mon Sep 17 00:00:00 2001 From: Marc Mueller <30130371+cdce8p@users.noreply.github.com> Date: Sat, 22 May 2021 13:45:14 +0200 Subject: [PATCH 7/9] Revert removal of license_file --- setuptools/dist.py | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/setuptools/dist.py b/setuptools/dist.py index 5b901801d8..65e6d8b25f 100644 --- a/setuptools/dist.py +++ b/setuptools/dist.py @@ -419,6 +419,7 @@ class Distribution(_Distribution): 'long_description_content_type': lambda: None, 'project_urls': dict, 'provides_extras': ordered_set.OrderedSet, + 'license_file': lambda: None, 'license_files': lambda: None, } @@ -584,10 +585,7 @@ def _finalize_license_files(self): license_files: Optional[List[str]] = self.metadata.license_files patterns: List[str] = license_files if license_files else [] - license_file: Optional[str] = None - opts = self.get_option_dict('metadata') - if 'license_file' in opts: - license_file = opts['license_file'][1] + license_file: Optional[str] = self.metadata.license_file if license_file and license_file not in patterns: patterns.append(license_file) From 4429ffbb700c1838ddf57c47c378bd3c617eb8c3 Mon Sep 17 00:00:00 2001 From: "Jason R. Coombs" Date: Sat, 22 May 2021 18:54:37 -0400 Subject: [PATCH 8/9] Replace for/if/add/extend with generator on patterns. Use unique_everseen to dedupe. --- setuptools/dist.py | 41 ++++++++++++++++++++++++++++++----------- 1 file changed, 30 insertions(+), 11 deletions(-) diff --git a/setuptools/dist.py b/setuptools/dist.py index 65e6d8b25f..067d7f5b2e 100644 --- a/setuptools/dist.py +++ b/setuptools/dist.py @@ -18,7 +18,7 @@ from glob import iglob import itertools import textwrap -from typing import List, Optional, Set, TYPE_CHECKING +from typing import List, Optional, TYPE_CHECKING from collections import defaultdict from email import message_from_file @@ -581,7 +581,6 @@ def _clean_req(self, req): def _finalize_license_files(self): """Compute names of all license files which should be included.""" - files: List[str] = [] license_files: Optional[List[str]] = self.metadata.license_files patterns: List[str] = license_files if license_files else [] @@ -595,16 +594,18 @@ def _finalize_license_files(self): # -> 'Including license files in the generated wheel file' patterns = ('LICEN[CS]E*', 'COPYING*', 'NOTICE*', 'AUTHORS*') - for pattern in patterns: - files_pattern: Set[str] = set() - for path in iglob(pattern): - if path.endswith('~'): - continue - if path not in files and os.path.isfile(path): - files_pattern.add(path) - files.extend(sorted(files_pattern)) + self.metadata.license_files = list( + unique_everseen(self._expand_patterns(patterns))) - self.metadata.license_files = files + @staticmethod + def _expand_patterns(patterns): + return ( + path + for pattern in patterns + for path in iglob(pattern) + if not path.endswith('~') + and os.path.isfile(path) + ) # FIXME: 'Distribution._parse_config_files' is too complex (14) def _parse_config_files(self, filenames=None): # noqa: C901 @@ -1111,3 +1112,21 @@ def handle_display_options(self, option_order): class DistDeprecationWarning(SetuptoolsDeprecationWarning): """Class for warning about deprecations in dist in setuptools. Not ignored by default, unlike DeprecationWarning.""" + + +def unique_everseen(iterable, key=None): + "List unique elements, preserving order. Remember all elements ever seen." + # unique_everseen('AAAABBBCCDAABBB') --> A B C D + # unique_everseen('ABBCcAD', str.lower) --> A B C D + seen = set() + seen_add = seen.add + if key is None: + for element in itertools.filterfalse(seen.__contains__, iterable): + seen_add(element) + yield element + else: + for element in iterable: + k = key(element) + if k not in seen: + seen_add(k) + yield element From acf4807fd651cd94ee646f881733af796b0e30d3 Mon Sep 17 00:00:00 2001 From: Marc Mueller <30130371+cdce8p@users.noreply.github.com> Date: Sun, 23 May 2021 01:51:09 +0200 Subject: [PATCH 9/9] Fix flaky test --- setuptools/tests/test_egg_info.py | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/setuptools/tests/test_egg_info.py b/setuptools/tests/test_egg_info.py index 1d98d259f0..ee07b5a1be 100644 --- a/setuptools/tests/test_egg_info.py +++ b/setuptools/tests/test_egg_info.py @@ -875,11 +875,9 @@ def test_license_file_attr_pkg_info(self, tmpdir_cwd, env): # Only 'NOTICE', LICENSE-ABC', and 'LICENSE-XYZ' should have been matched # Also assert that order from license_files is keeped - assert license_file_lines == [ - "License-File: NOTICE", - "License-File: LICENSE-ABC", - "License-File: LICENSE-XYZ", - ] + assert "License-File: NOTICE" == license_file_lines[0] + assert "License-File: LICENSE-ABC" in license_file_lines[1:] + assert "License-File: LICENSE-XYZ" in license_file_lines[1:] def test_metadata_version(self, tmpdir_cwd, env): """Make sure latest metadata version is used by default."""