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

Should pip include Project-URLs in show output without verbose mode #11138

Open
1 task done
q0w opened this issue May 22, 2022 · 3 comments
Open
1 task done

Should pip include Project-URLs in show output without verbose mode #11138

q0w opened this issue May 22, 2022 · 3 comments
Labels
C: list/show 'pip list' or 'pip show' type: feature request Request for a new feature

Comments

@q0w
Copy link
Contributor

q0w commented May 22, 2022

What's the problem this feature will solve?

In #10827 @jwodder and @wimglenn suggest including Project-URLs in pip show short output. However, one test explicitly checks if the show output stays short

def test_pip_show_is_short(script: PipTestEnvironment) -> None:
"""
Test that pip show stays short
"""
result = script.pip("show", "pip")
lines = result.stdout.splitlines()
assert len(lines) <= 10

Describe the solution you'd like

Where should pip show Project-URLs?

Alternative Solutions

Leave in the verbose output.

Additional context

Code of Conduct

@q0w q0w added S: needs triage Issues/PRs that need to be triaged type: feature request Request for a new feature labels May 22, 2022
@uranusjr
Copy link
Member

The commit that added this test simply mentioned increasing coverage. So I’m inclined to think the intention was to test something, not that there was a hard rule pip show must be very short. By that reasoning, it should be OK to simply add Project-URL to normal pip show and change the test.

ce868f9

@q0w
Copy link
Contributor Author

q0w commented May 23, 2022

How it should be?

Project-URLs:
 Source, https://github.com/pypa/pip.git
 Documentation, ....
 Changelog, ...

or every line starts with Project-URL: ?

@sbidoul
Copy link
Member

sbidoul commented May 23, 2022

How it should be?

We should emphasize readability for humans and insist this format should not be parsed by tools.

For tool-oriented output there will be the json metadata format. See for instance #11097

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' type: feature request Request for a new feature
Projects
None yet
Development

No branches or pull requests

4 participants