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.

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

Migrate pip show's Requires field to Requires-Dist #7989

Open
xavfernandez opened this issue Apr 6, 2020 · 6 comments
Open

Migrate pip show's Requires field to Requires-Dist #7989

xavfernandez opened this issue Apr 6, 2020 · 6 comments
Labels
C: list/show 'pip list' or 'pip show' state: needs discussion This needs some more discussion type: enhancement Improvements to functionality

Comments

@xavfernandez
Copy link
Member

xavfernandez commented Apr 6, 2020

Prefer Requires-Dist to Requires to match PEP-0354 metadata.

This would require a transition period to not break user expectation: we might want to expose the same information in both Requires & Requires-Dist for a few pip version.

Originally posted by @sbidoul in #7967

@triage-new-issues triage-new-issues bot added the S: needs triage Issues/PRs that need to be triaged label Apr 6, 2020
@xavfernandez xavfernandez added C: list/show 'pip list' or 'pip show' type: enhancement Improvements to functionality labels Apr 6, 2020
@triage-new-issues triage-new-issues bot removed the S: needs triage Issues/PRs that need to be triaged label Apr 6, 2020
@sbidoul
Copy link
Member

sbidoul commented Apr 6, 2020

Note my remark was more in the context of json exports than the current pip show output.

@xavfernandez xavfernandez added the state: needs discussion This needs some more discussion label Apr 6, 2020
@xavfernandez
Copy link
Member Author

Note my remark was more in the context of json exports than the current pip show output.

Sorry I misinterpreted your comment.

I think the "default/legacy" output & "json" one should share the same headers to ease switching from one to the other, meaning that if we want to use Requires-Dist, we'd want to use it in both our format.

@sbidoul
Copy link
Member

sbidoul commented Apr 6, 2020

Also do we want to harmonize json output across commands? pip list has a json option with lowercase keys, for instance.

@uranusjr
Copy link
Member

uranusjr commented Apr 6, 2020

Lower-casing sounds like a good idea. Metadata keys are case insensitive (RFC 5322), so it makes sense to me that the JSON equivalent has a clear case canonicalisation rule.

@xavfernandez
Copy link
Member Author

Lower-case is also fine for me in json output.

But if we put requires-dist as a key in the json output, it would make sense to also have it spelled Requires-Dist in the "default" output (and not simply Requires).

@sbidoul
Copy link
Member

sbidoul commented Apr 19, 2020

Linking to #8008 for the discussion on the json format.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C: list/show 'pip list' or 'pip show' state: needs discussion This needs some more discussion type: enhancement Improvements to functionality
Projects
None yet
Development

No branches or pull requests

3 participants