Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

pip show displays License metadata field - switch to License-Expression? #13112

Open
1 task done
befeleme opened this issue Dec 11, 2024 · 2 comments · May be fixed by #13145
Open
1 task done

pip show displays License metadata field - switch to License-Expression? #13112

befeleme opened this issue Dec 11, 2024 · 2 comments · May be fixed by #13145
Labels
C: list/show 'pip list' or 'pip show' resolution: deferred till PR Further discussion will happen when a PR is made type: feature request Request for a new feature

Comments

@befeleme
Copy link

What's the problem this feature will solve?

With PEP 639 accepted, there is a new metadata field to get the license information from: License-Expression.

pip show currently shows the License field contents:

pip/src/pip/_internal/commands/show.py

Line 163 in 947917b

license=metadata.get("License", ""),

Describe the solution you'd like

I think should add the display of License-Expression field and in the long run maybe switch to it entirely. Initially there will be a few packages produced with the new metadata, but in the long run only the License-Expression will remain.
Hence, I'd propose to try to obtain the license information from License-Expression - standardized and validated and fall back to the deprecated unstructured License in case License-Expression isn't found.

Alternative Solutions

What else is possible:

  • do nothing - the deprecated License will be less used in time
  • switch to License-Expression entirely - for majority of existing packages this would mean producing an empty field for months/years to come
  • add License-Expression as a separate field displayed with the package data - this feels redundant, but if that's deemed a better approach, I'm not against.

Additional context

Once agreed upon solution, I can send a patch.

Code of Conduct
@befeleme befeleme added S: needs triage Issues/PRs that need to be triaged type: feature request Request for a new feature labels Dec 11, 2024
@pfmoore
Copy link
Member

pfmoore commented Dec 11, 2024

I agree, in principle. I would suggest we only show License-Expression if metadata version is 2.4 or greater. So the logic should be:

  1. If metadata version >= 2.4 and License-Expression is present: Display License-Expression.
  2. Otherwise, display License.

@ichard26 ichard26 added C: list/show 'pip list' or 'pip show' and removed S: needs triage Issues/PRs that need to be triaged labels Dec 11, 2024
Julian added a commit to python-jsonschema/referencing that referenced this issue Dec 28, 2024
@Julian
Declare license via (the accepted) PEP 639.
0f546ba 
The License field is deprecated, as is the trove classifier.

Note that pip show does not support properly detecting these yet,
but it will.

Refs: https://peps.python.org/pep-0639/
Refs: pypa/pip#13112
Refs: pypa/pip#6677
Julian added a commit to python-jsonschema/jsonschema that referenced this issue Dec 28, 2024
@Julian
Declare license via (the accepted) PEP 639.
f064d44 
The License field is deprecated, as is the trove classifier.

Note that pip show does not support properly detecting these yet,
but it will.

Note also that `pip-licenses` does not support PEP 639 (see
raimon49/pip-licenses#213) the implications of which are that we are
already broken (the `license_check` noxenv fails because of packages
already using the newer standard). This doesn't fix that yet. AFAICT no
tool exists that does this properly yet/now. So let's see... I guess we
reimplement that functionality?!

Refs: https://peps.python.org/pep-0639/
Refs: pypa/pip#13112
Refs: pypa/pip#6677
Julian added a commit to bowtie-json-schema/bowtie that referenced this issue Dec 28, 2024
@Julian
Declare license via (the accepted) PEP 639.
4bcd7d3 
The License field is deprecated, as is the trove classifier.

Note that pip show does not support properly detecting these yet,
but it will.

Refs: https://peps.python.org/pep-0639/
Refs: pypa/pip#13112
Refs: pypa/pip#6677
@ichard26 ichard26 added resolution: deferred till PR Further discussion will happen when a PR is made state: awaiting PR Feature discussed, PR is needed and removed state: awaiting PR Feature discussed, PR is needed labels Dec 29, 2024
@ichard26
Copy link
Member

👍 to @pfmoore's proposed implementation plan. I'd say you're welcome to work on a patch @befeleme! :)

befeleme added a commit to befeleme/pip that referenced this issue Jan 7, 2025
@befeleme
Show License-Expression if present in package metadata
42a2e72 
With Core Metadata 2.4 a new field, License-Expression, has been added.
If it's present, favor it over the deprecated (with PEP 639) legacy
unstructured License field.

Closes: pypa#13112
befeleme added a commit to befeleme/pip that referenced this issue Jan 7, 2025
@befeleme
Show License-Expression if present in package metadata
cc804f4 
With Core Metadata 2.4 a new field, License-Expression, has been added.
If it's present, favor it over the deprecated (with PEP 639) legacy
unstructured License field.

Closes: pypa#13112
@befeleme befeleme linked a pull request Jan 7, 2025 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
C: list/show 'pip list' or 'pip show' resolution: deferred till PR Further discussion will happen when a PR is made type: feature request Request for a new feature
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Show License-Expression if present in package metadata befeleme/pip
3 participants
@pfmoore @befeleme @ichard26