License_files improvements by cdce8p · Pull Request #2620 · pypa/setuptools

cdce8p · 2021-03-28T13:02:34Z

Summary of changes

Add support for glob patterns in license_file and license_files options.
Add default patterns if neither is specified to match behavior of bdist_wheel.
https://wheel.readthedocs.io/en/stable/user_guide.html#including-license-files-in-the-generated-wheel-file
Added deprecation warning if license_file file is used. license_files is a full replacement.
Added additional documentation for the license_files option.

The implementation is similar to the one used by wheel: wheel/bdist_wheel.py

Closes #2616

Pull Request Checklist

Changes have tests
News fragment added in changelog.d/.
(See documentation for details)

jaraco · 2021-04-03T17:18:04Z

docs/references/keywords.rst

+    A list of glob patterns for license related files that should be included.
+    If neither ``license_file`` nor ``license_files`` is specified, this option
+    defaults to ``LICEN[CS]E*``, ``COPYING*``, ``NOTICE*``, and ``AUTHORS*``.
+    Any ``exclude`` specified in ``MANIFEST.in`` will overwrite it.


In my experience, MANIFEST.in only affects the sdist. Can you confirm that exclude in MANIFEST.in with LICENSE present has the same effect as not specifying a license on older Setuptools?

I'm not exactly sure what you mean. AFAIK the change itself will only the sdist command. bdist_wheel will use the license_file and license_files fields or the default patterns. Therefore it's probably not wise to exclude a license file in the MANIFEST.in to begin with. But in case you only care about the source dist, any exclude does have president over a matched license file. There are two existing test cases that cover it.
I'm going to remove the last sentence, since it's probably more confusing than helpful especially to beginners.

setuptools/setuptools/tests/test_egg_info.py

Lines 637 to 655 in 7432981

({

'setup.cfg': DALS("""

[metadata]

license_files = LICENSE

"""),

'MANIFEST.in': "exclude LICENSE",

'LICENSE': "Test license"

}, [], ['LICENSE']), # license file is manually excluded

({

'setup.cfg': DALS("""

[metadata]

license_files =

LICENSE-ABC

LICENSE-XYZ

"""),

'MANIFEST.in': "exclude LICENSE-XYZ",

'LICENSE-ABC': "ABC license",

'LICENSE-XYZ': "XYZ license"

}, ['LICENSE-ABC'], ['LICENSE-XYZ']), # subset is manually excluded

setuptools/command/sdist.py

setuptools/tests/test_egg_info.py

setuptools/tests/test_virtualenv.py

jaraco

Nice work. Thorough and clean. Just a couple of nitpicks or requests for additional information, but it's basically ready to go.

cdce8p · 2021-04-03T19:44:02Z

Thanks for the review! I did a rebase to get rid of the test fix and pushed a small commit to address the comments: 608c376

As a side note here, I was thinking about if it would be possible to do these steps even earlier. PEP 639, currently still a draft but quite far along, would add the License-File (multiple) field to the package metadata, Link. To support that use case, the pattern matching for license files probably needs to happen during the egg-info command. What is your opinion regarding this? Could you give my a pointer on how to best approach it?

jaraco · 2021-04-03T20:11:41Z

What is your opinion regarding this? Could you give my a pointer on how to best approach it?

I'm in favor of exposing the license text(s) in metadata. I don't have any active context on such an effort. I don't even know where license files are presented currently.

I'd start out by filing a bug and describe the problem and start exploring possible solutions. I'd use that forum to examine the code and current behavior and devise a transition to a solution that meets the need. I'd identify projects and people that would be affected by such a change and gather their feedback.

pypa#2620

See: pypa/setuptools#2620

Closes borgbackup#6727 See: pypa/setuptools#2620

See: pypa/setuptools#2620

See pypa/setuptools#2620

As of setuptools v56.0.0, the `license_file` entry is deprecated, raising `SetuptoolsDeprecationWarning` during the `packaging` step. Refs: pypa/setuptools#2620 Signed-off-by: Mike Fiedler <miketheman@gmail.com>

* chore: update codebase for modern python We're on Python 3.7 and higher, so we can clean up any artifacts left from previously-supported Python eras. Most of the heavy lifting was done with `pyupgrade` followed by unused improts removal (thanks to `flake8` check) Refs: https://pypi.org/project/pyupgrade/ Closes #203 Signed-off-by: Mike Fiedler <miketheman@gmail.com> * refactor: replace `os.path`/`glob` with `pathlib` Since Python 3.4, `pathlib` provides a nicer interface to manipulate paths, removing the need to split and reassemble strings. The addition of `pytest.param(..., id=fn.name)` is to set the test name output to a human-friendly string in the event of failure or `--verbose` Signed-off-by: Mike Fiedler <miketheman@gmail.com> * chore: replace deprecated setuptools entry As of setuptools v56.0.0, the `license_file` entry is deprecated, raising `SetuptoolsDeprecationWarning` during the `packaging` step. Refs: pypa/setuptools#2620 Signed-off-by: Mike Fiedler <miketheman@gmail.com>

See pypa/setuptools#2620

Fix the following warning: ``` /usr/lib/python3.10/site-packages/setuptools/config/setupcfg.py:459: SetuptoolsDeprecationWarning: The license_file parameter is deprecated, use license_files instead. warnings.warn(msg, warning_class) ``` Ref: pypa/setuptools#2620

In setuptools-56.0.0¹ license_file was changed to license_files. The former causes a deprecation warning. ¹ pypa/setuptools#2620 https://setuptools.pypa.io/en/latest/history.html?highlight=license_files#v56-0-0

cdce8p changed the title ~~License files improments~~ License_files improvments Mar 28, 2021

cdce8p changed the title ~~License_files improvments~~ License_files improvements Mar 28, 2021

cdce8p force-pushed the license-files-improments branch 3 times, most recently from 4f3fc2e to 7432981 Compare March 28, 2021 15:52

cdce8p marked this pull request as draft March 28, 2021 23:32

cdce8p marked this pull request as ready for review March 28, 2021 23:34

jaraco reviewed Apr 3, 2021

View reviewed changes

setuptools/command/sdist.py Show resolved Hide resolved

jaraco reviewed Apr 3, 2021

View reviewed changes

setuptools/tests/test_egg_info.py Outdated Show resolved Hide resolved

jaraco reviewed Apr 3, 2021

View reviewed changes

setuptools/tests/test_virtualenv.py Show resolved Hide resolved

jaraco approved these changes Apr 3, 2021

View reviewed changes

cdce8p added 5 commits April 3, 2021 21:13

license_files - Add support for glob patterns + add default patterns

749b974

Add documentation + changelog entries

91e7956

Additional test cases

1da769c

Change deprecation warning

0f34639

Small changes

608c376

cdce8p force-pushed the license-files-improments branch from 7432981 to 608c376 Compare April 3, 2021 19:34

jaraco merged commit ee6a5ff into pypa:main Apr 3, 2021

cdce8p deleted the license-files-improments branch April 3, 2021 20:20

hugovk mentioned this pull request Apr 10, 2021

Standardise on license_files, omit when possible? asottile/setup-cfg-fmt#73

Closed

PhilipVinc mentioned this pull request May 13, 2021

Installation of plum-dispath as a requirement via setup.py beartype/plum#8

Closed

hugovk mentioned this pull request May 18, 2021

Docs: Use license_files instead of license_file #2676

Merged

cdce8p mentioned this pull request Jul 6, 2021

Align license_files globs with data_files globs #2720

Open

hofaflo mentioned this pull request Aug 15, 2021

LICENSE not included in sdist cbrnr/sleepecg#13

Closed

janosh mentioned this pull request Aug 28, 2021

Fix pip license error + add pip install command to readme GAM-team/GAM#1419

Merged

hroncok pushed a commit to hroncok/setuptools that referenced this pull request Jan 12, 2022

license_files - Add support for glob patterns + add default patterns

490a2b2

pypa#2620

sbrudenell mentioned this pull request May 31, 2022

use license_files instead of the deprecated license_file asottile/setup-cfg-fmt#142

Closed

sergeyklay added a commit to sergeyklay/gstore that referenced this pull request Jun 13, 2022

Use license_files instead of license_file

8506fba

See: pypa/setuptools#2620

sergeyklay added a commit to sergeyklay/gstore that referenced this pull request Jun 13, 2022

Use license_files instead of license_file

6911029

See: pypa/setuptools#2620

sergeyklay added a commit to sergeyklay/borg that referenced this pull request Jun 13, 2022

Use license_files instead of license_file

928d292

Closes borgbackup#6727 See: pypa/setuptools#2620

sergeyklay mentioned this pull request Jun 13, 2022

Use license_files instead of license_file borgbackup/borg#6772

Merged

sergeyklay added a commit to sergeyklay/gstore that referenced this pull request Jun 13, 2022

Use license_files instead of license_file

14a74d5

See: pypa/setuptools#2620

akx added a commit to python-babel/babel that referenced this pull request Jun 16, 2022

setup.cfg: switch to metadata.license_files

5f8c0f0

See pypa/setuptools#2620

akx added a commit to python-babel/babel that referenced this pull request Jun 16, 2022

setup.cfg: switch to metadata.license_files

0ab05bc

See pypa/setuptools#2620

timobrembeck added a commit to digitalfabrik/integreat-cms that referenced this pull request Jul 18, 2022

Use license_files instead of license_file setup.cfg

afea664

See pypa/setuptools#2620

timobrembeck added a commit to digitalfabrik/integreat-cms that referenced this pull request Jul 18, 2022

Use license_files instead of license_file setup.cfg

40dc974

See pypa/setuptools#2620

felixonmars mentioned this pull request Aug 29, 2022

Use license_files instead of license_file tox-dev/filelock#164

Closed

thatlittleboy mentioned this pull request Sep 30, 2022

chore: fix license_file is deprecated warning thatlittleboy/lgtm-db#44

Merged

larrybradley mentioned this pull request Oct 27, 2022

Use license_files instead of deprecated license_file in setup astropy/astropy#13924

Merged

10 tasks

tmzullinger mentioned this pull request Mar 7, 2023

Setuptools deprecations rpm-software-management/rpmlint#1017

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

License_files improvements#2620

License_files improvements#2620
jaraco merged 5 commits intopypa:mainfrom
cdce8p:license-files-improments

cdce8p commented Mar 28, 2021 •

edited

Loading

Uh oh!

jaraco Apr 3, 2021

Uh oh!

cdce8p Apr 3, 2021

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jaraco left a comment

Uh oh!

cdce8p commented Apr 3, 2021

Uh oh!

jaraco commented Apr 3, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	({
	'setup.cfg': DALS("""
	[metadata]
	license_files = LICENSE
	"""),
	'MANIFEST.in': "exclude LICENSE",
	'LICENSE': "Test license"
	}, [], ['LICENSE']), # license file is manually excluded
	({
	'setup.cfg': DALS("""
	[metadata]
	license_files =
	LICENSE-ABC
	LICENSE-XYZ
	"""),
	'MANIFEST.in': "exclude LICENSE-XYZ",
	'LICENSE-ABC': "ABC license",
	'LICENSE-XYZ': "XYZ license"
	}, ['LICENSE-ABC'], ['LICENSE-XYZ']), # subset is manually excluded

Uh oh!

Conversation

cdce8p commented Mar 28, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary of changes

Pull Request Checklist

Uh oh!

jaraco Apr 3, 2021

Choose a reason for hiding this comment

Uh oh!

cdce8p Apr 3, 2021

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jaraco left a comment

Choose a reason for hiding this comment

Uh oh!

cdce8p commented Apr 3, 2021

Uh oh!

jaraco commented Apr 3, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

cdce8p commented Mar 28, 2021 •

edited

Loading