Add json formatting option to pip show #7967

deveshks · 2020-04-02T23:00:04Z

Fixes and closes #5261

Json printing logic is added, as well as supporting unit tests. Different outputs with json formats are show below for reference.

Help section of pip show

$ pip show --help

Usage:   
  pip show [options] <package> ...

Description:
  Show information about one or more installed packages.
  
  The output is in RFC-compliant mail header format.

Show Options:
  -f, --files                 Show the full list of installed files for each package.
  --format <list_format>      Select the output format among: header (default) or json

Output of pip show pip --format=header or pip show pip

$ pip show pip
Name: pip
Version: 20.1.dev0
Summary: The PyPA recommended tool for installing Python packages.
Home-page: https://pip.pypa.io/
Author: The pip developers
Author-email: pypa-dev@groups.google.com
License: MIT
Location: /Users/devesh/pip/src
Requires: 
Required-by:

Output of pip show pip --format=json

[{
	"name": "pip",
	"version": "20.1.dev0",
	"summary": "The PyPA recommended tool for installing Python packages.",
	"home-page": "https://pip.pypa.io/",
	"author": "The pip developers",
	"author-email": "pypa-dev@groups.google.com",
	"license": "MIT",
	"location": "/Users/devesh/pip/src",
	"requires": [],
	"required-by": []
}]

Output of pip show pip -v --format=json

[{
	"name": "pip",
	"version": "20.1.dev0",
	"summary": "The PyPA recommended tool for installing Python packages.",
	"home-page": "https://pip.pypa.io/",
	"author": "The pip developers",
	"author-email": "pypa-dev@groups.google.com",
	"license": "MIT",
	"location": "/Users/devesh/pip/src",
	"requires": [],
	"required-by": [],
	"metadata-version": "1.2",
	"installer": "",
	"classifiers": ["Development Status :: 5 - Production/Stable", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Topic :: Software Development :: Build Tools", "Programming Language :: Python", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Programming Language :: Python :: 3.8", "Programming Language :: Python :: Implementation :: CPython", "Programming Language :: Python :: Implementation :: PyPy"],
	"entry-points": ["[console_scripts]", "pip = pip._internal.cli.main:main", "pip3 = pip._internal.cli.main:main", "pip3.8 = pip._internal.cli.main:main"]
}]

Output of pip show pip -f -v --format=json (When files can't be located)

[{
	"name": "pip",
	"version": "20.1.dev0",
	"summary": "The PyPA recommended tool for installing Python packages.",
	"home-page": "https://pip.pypa.io/",
	"author": "The pip developers",
	"author-email": "pypa-dev@groups.google.com",
	"license": "MIT",
	"location": "/Users/devesh/pip/src",
	"requires": [],
	"required-by": [],
	"metadata-version": "1.2",
	"installer": "",
	"classifiers": ["Development Status :: 5 - Production/Stable", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Topic :: Software Development :: Build Tools", "Programming Language :: Python", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Programming Language :: Python :: 3.8", "Programming Language :: Python :: Implementation :: CPython", "Programming Language :: Python :: Implementation :: PyPy"],
	"entry-points": ["[console_scripts]", "pip = pip._internal.cli.main:main", "pip3 = pip._internal.cli.main:main", "pip3.8 = pip._internal.cli.main:main"],
	"files": null
}]

Output of pip show tox -v -f --format=json (When files can be located)

[{
	"name": "tox",
	"version": "3.14.6",
	"summary": "tox is a generic virtualenv management and test command line tool",
	"home-page": "http://tox.readthedocs.org",
	"author": "Holger Krekel, Oliver Bestwalter, Bernát Gábor and others",
	"author-email": null,
	"license": "MIT",
	"location": "/Users/devesh/pip/.env/lib/python3.8/site-packages",
	"requires": ["pluggy", "packaging", "virtualenv", "filelock", "toml", "py", "six"],
	"required-by": [],
	"metadata-version": "2.1",
	"installer": "pip",
	"classifiers": ["Development Status :: 5 - Production/Stable", "Framework :: tox", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Operating System :: POSIX", "Operating System :: Microsoft :: Windows", "Operating System :: MacOS :: MacOS X", "Topic :: Software Development :: Testing", "Topic :: Software Development :: Libraries", "Topic :: Utilities", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Programming Language :: Python :: 3.8"],
	"entry-points": ["[console_scripts]", "tox = tox:cmdline", "tox-quickstart = tox._quickstart:main"],
	"files": ["../../../bin/tox", "../../../bin/tox-quickstart", "tox-3.14.6.dist-info/INSTALLER", "tox-3.14.6.dist-info/LICENSE", "tox-3.14.6.dist-info/METADATA", "tox-3.14.6.dist-info/RECORD", "tox-3.14.6.dist-info/WHEEL", "tox-3.14.6.dist-info/entry_points.txt", "tox-3.14.6.dist-info/top_level.txt", "tox/__init__.py", "tox/__main__.py", "tox/__pycache__/__init__.cpython-38.pyc", "tox/__pycache__/__main__.cpython-38.pyc", "tox/__pycache__/_pytestplugin.cpython-38.pyc", "tox/__pycache__/_quickstart.cpython-38.pyc", "tox/__pycache__/action.cpython-38.pyc", "tox/__pycache__/cli.cpython-38.pyc", "tox/__pycache__/constants.cpython-38.pyc", "tox/__pycache__/exception.cpython-38.pyc", "tox/__pycache__/hookspecs.cpython-38.pyc", "tox/__pycache__/reporter.cpython-38.pyc", "tox/__pycache__/venv.cpython-38.pyc", "tox/__pycache__/version.cpython-38.pyc", "tox/_pytestplugin.py", "tox/_quickstart.py", "tox/action.py", "tox/cli.py", "tox/config/__init__.py", "tox/config/__pycache__/__init__.cpython-38.pyc", "tox/config/__pycache__/parallel.cpython-38.pyc", "tox/config/__pycache__/reporter.cpython-38.pyc", "tox/config/parallel.py", "tox/config/reporter.py", "tox/constants.py", "tox/exception.py", "tox/helper/__init__.py", "tox/helper/__pycache__/__init__.cpython-38.pyc", "tox/helper/__pycache__/build_isolated.cpython-38.pyc", "tox/helper/__pycache__/build_requires.cpython-38.pyc", "tox/helper/__pycache__/get_site_package_dir.cpython-38.pyc", "tox/helper/__pycache__/get_version.cpython-38.pyc", "tox/helper/build_isolated.py", "tox/helper/build_requires.py", "tox/helper/get_site_package_dir.py", "tox/helper/get_version.py", "tox/hookspecs.py", "tox/interpreters/__init__.py", "tox/interpreters/__pycache__/__init__.cpython-38.pyc", "tox/interpreters/__pycache__/common.cpython-38.pyc", "tox/interpreters/__pycache__/py_spec.cpython-38.pyc", "tox/interpreters/__pycache__/unix.cpython-38.pyc", "tox/interpreters/__pycache__/via_path.cpython-38.pyc", "tox/interpreters/common.py", "tox/interpreters/py_spec.py", "tox/interpreters/unix.py", "tox/interpreters/via_path.py", "tox/interpreters/windows/__init__.py", "tox/interpreters/windows/__pycache__/__init__.cpython-38.pyc", "tox/interpreters/windows/__pycache__/pep514.cpython-38.pyc", "tox/interpreters/windows/pep514.py", "tox/logs/__init__.py", "tox/logs/__pycache__/__init__.cpython-38.pyc", "tox/logs/__pycache__/command.cpython-38.pyc", "tox/logs/__pycache__/env.cpython-38.pyc", "tox/logs/__pycache__/result.cpython-38.pyc", "tox/logs/command.py", "tox/logs/env.py", "tox/logs/result.py", "tox/package/__init__.py", "tox/package/__pycache__/__init__.cpython-38.pyc", "tox/package/__pycache__/local.cpython-38.pyc", "tox/package/__pycache__/view.cpython-38.pyc", "tox/package/builder/__init__.py", "tox/package/builder/__pycache__/__init__.cpython-38.pyc", "tox/package/builder/__pycache__/isolated.cpython-38.pyc", "tox/package/builder/__pycache__/legacy.cpython-38.pyc", "tox/package/builder/isolated.py", "tox/package/builder/legacy.py", "tox/package/local.py", "tox/package/view.py", "tox/reporter.py", "tox/session/__init__.py", "tox/session/__pycache__/__init__.cpython-38.pyc", "tox/session/commands/__init__.py", "tox/session/commands/__pycache__/__init__.cpython-38.pyc", "tox/session/commands/__pycache__/help.cpython-38.pyc", "tox/session/commands/__pycache__/help_ini.cpython-38.pyc", "tox/session/commands/__pycache__/provision.cpython-38.pyc", "tox/session/commands/__pycache__/show_config.cpython-38.pyc", "tox/session/commands/__pycache__/show_env.cpython-38.pyc", "tox/session/commands/help.py", "tox/session/commands/help_ini.py", "tox/session/commands/provision.py", "tox/session/commands/run/__init__.py", "tox/session/commands/run/__pycache__/__init__.cpython-38.pyc", "tox/session/commands/run/__pycache__/parallel.cpython-38.pyc", "tox/session/commands/run/__pycache__/sequential.cpython-38.pyc", "tox/session/commands/run/parallel.py", "tox/session/commands/run/sequential.py", "tox/session/commands/show_config.py", "tox/session/commands/show_env.py", "tox/util/__init__.py", "tox/util/__pycache__/__init__.cpython-38.pyc", "tox/util/__pycache__/graph.cpython-38.pyc", "tox/util/__pycache__/lock.cpython-38.pyc", "tox/util/__pycache__/main.cpython-38.pyc", "tox/util/__pycache__/path.cpython-38.pyc", "tox/util/__pycache__/spinner.cpython-38.pyc", "tox/util/__pycache__/stdlib.cpython-38.pyc", "tox/util/graph.py", "tox/util/lock.py", "tox/util/main.py", "tox/util/path.py", "tox/util/spinner.py", "tox/util/stdlib.py", "tox/venv.py", "tox/version.py"]
}]

deveshks · 2020-04-03T11:33:40Z

Hi @chrahunt and @cjerdonek

Apologies for the ping but I saw your comments on the last PR attempting to implement show --json, and I have tried to implement this PR along those lines, with future PR's being added towards this effort as well.

I would appreciate it if you guys can shed any thoughts on this, and any necessary scope of improvement :)

src/pip/_internal/commands/show.py

xavfernandez

Now we'd need an actual json printer and its tests :)

src/pip/_internal/commands/show.py

deveshks · 2020-04-06T08:19:45Z

Now we'd need an actual json printer and its tests :)

Hi @xavfernandez

I was planning to implement the json printer and the associated tests in a follow up PR, so as to not crowd this one and making sure the default format tests are passing with the refactoring

xavfernandez · 2020-04-06T08:41:08Z

I was planning to implement the json printer and the associated tests in a follow up PR, so as to not crowd this one and making sure the default format tests are passing with the refactoring

That's definitely a good idea but then I'd say you need to:

remove the news/5261.feature file in favor of a .trivial
remove the Fixes and Closes #5261 from the PR description
remove the print_results_json function (and the if option == ... checks in run.

deveshks · 2020-04-06T08:52:18Z

That's definitely a good idea but then I'd say you need to:

Hi @xavfernandez

Thanks for that, I have addressed all the points you made in the latest commits. Please have a look 😊

deveshks · 2020-04-06T09:00:37Z

Thanks @xavfernandez for the approval. I will tag you to the follow up PR for this, which will add the
JSON printer, associated unit tests and command line options --format=

Hi @pradyunsg , Could I please get this PR merged as well :)

src/pip/_internal/commands/show.py

xavfernandez

Sorry I did not check the code more thoroughly before reviewing but it seems that search_packages_info is already somewhat performing the role of the new get_package_info (i.e. collecting information before formatting): it might make for sense to modify the key/title (capitalize, etc) there ?

src/pip/_internal/commands/show.py

deveshks · 2020-04-06T10:22:26Z

Sorry I did not check the code more thoroughly before reviewing but it seems that search_packages_info is already somewhat performing the role of the new get_package_info (i.e. collecting information before formatting): it might make for sense to modify the key/title (capitalize, etc) there ?

Hi @xavfernandez

If I understand correctly, search_packages_info is populating the different key-value pairs pertaining to a package, at different stages, and get_package_info is collecting that info and applying the necessary formatting in the end.

I would prefer to keep those two separate, as they were before this change (print_results was performing the formatting task) otherwise the complexity of search_packages_info will grow more.

What do you think?

xavfernandez · 2020-04-06T11:54:19Z

Currently, we have search_packages_info collecting information and print_results that prints it.

We definitely want those 2 steps separated.

But currently in this PR, we now have search_packages_info collecting information, get_package_info applying light transformation (mainly changing key formats: classifiers -> Classifiers) and finally print_results_default that prints it: this seems needlessly complex.

I think get_package_info could be merged into either search_packages_info or print_results_default.

deveshks · 2020-04-06T12:01:15Z

I think get_package_info could be merged into either search_packages_info or print_results_default.

Hi @xavfernandez

I can also do it the way you mentioned where search_packages_info collects information and print_results_default that prints it in default format, and a print_results_json in a follow up PR to print it in the json format. Does that sounds better?

Actually I was thinking earlier that we have search_packages_info collecting information, get_package_info applying light transformation and print_results_default that prints it, but this light transformation will help us to print the json directly, as well as reduce the printing code by for loops.

But I am not sure which one is better, this or the idea above it?

deveshks · 2020-04-06T13:10:02Z

Hi @xavfernandez

I have merged get_package_info and print_results_defaulttogether, and since the code has almost reverted to the older one, I will add print_results_json and the unit tests in this PR as well.

deveshks · 2020-04-06T15:33:57Z

Hi @xavfernandez

I have added the JSON printer, and I have also copied over the unit tests to work with json formatting. Please take a look

sbidoul · 2020-04-06T16:45:20Z

Let's be careful not rushing this out. Once released it will be very hard to change.

We need to see if we can be compatible (or at least consistent) with pip list --format=json.

Perhaps it's a case where we'd want to document the output before implementing. Several fields are obvious (yet documenting their relation to standards would help clarify), some other less so.

deveshks · 2020-04-06T16:57:05Z

Hi @sbidoul

Let's be careful not rushing this out. Once released it will be very hard to change.

Agreed.

We need to see if we can be compatible (or at least consistent) with pip list --format=json.

How can we be sure of that. Currently I have taken the default output and mapped it to json directly. The keys are the same along with the casing, and the values are either a string (this is for keys Name, Version, Summary, Home-page, Author, Author-email, License, Location, Metadata-Version and Installer , or a list of strings if it was a comma separated value. (this is for keys Requires, Required-by, Classifiers and Entry-points

The only exception is Files value is the string 'Cannot locate installed-files.txt' if we cannot find files, else it's a list of files.

Perhaps it's a case where we'd want to document the output before implementing. Several fields are obvious (yet documenting their relation to standards would help clarify), some other less so.

I do see that there is no documentation of what each field refers to in the pip show display in the latest documentation. Should I create a parallel PR modifying that and adding the information about what each value signifies from there before proceeding with this PR?

Once this document is agreed upon, I can just change around the keys and values for pip list according to that spec.

xavfernandez

Some documentation update would also be needed indeed 👍

src/pip/_internal/commands/show.py

deveshks · 2020-04-07T04:22:14Z

Some documentation update would also be needed indeed 👍

@xavfernandez I will create a separate companion PR to include the document changes and link it here.

Also do we want to update https://github.com/pypa/pip/blob/master/docs/html/reference/pip_show.rst for this ?

BrownTruck · 2020-05-18T10:00:03Z

Hello!

I am an automated bot and I have noticed that this pull request is not currently able to be merged. If you are able to either merge the master branch into this pull request or rebase this pull request against master then it will be eligible for code review and hopefully merging!

deveshks · 2020-05-21T08:19:27Z

To move this PR ahead, I have added some suggestions made at #8008 (comment) into the document PR #8008

I am open to reviews of the document PR, and once that is in an acceptable state, I can start the implementation here according to what we have in the docs.

BrownTruck · 2020-05-24T11:30:02Z

Hello!

I am an automated bot and I have noticed that this pull request is not currently able to be merged. If you are able to either merge the master branch into this pull request or rebase this pull request against master then it will be eligible for code review and hopefully merging!

deveshks · 2020-06-28T11:45:55Z

Hi @xavfernandez , @sbidoul

Since #8008 , the documentation PR is at a good stage now, pending discussion on the nitty-grittes of fields, I was wondering if I can start the implementation of the atleast the basic fields in print_results_json in order to move this PR forward?

xavfernandez · 2020-07-03T21:13:01Z

@deveshks the safest would be to first make sure that most maintainers are on board with this change before implementing it :)

deveshks · 2020-07-04T05:33:58Z

Thanks for the tip @xavfernandez . I will hold of on making changes here before getting agreement on what changes need to be made in the doc PR.

BrownTruck · 2021-02-04T16:00:34Z

Hello!

I am an automated bot and I have noticed that this pull request is not currently able to be merged. If you are able to either merge the master branch into this pull request or rebase this pull request against master then it will be eligible for code review and hopefully merging!

deveshks mentioned this pull request Apr 2, 2020

pip show --json #5261

Closed

xavfernandez reviewed Apr 4, 2020

View reviewed changes

src/pip/_internal/commands/show.py Outdated Show resolved Hide resolved

deveshks force-pushed the add-show-json branch from 80cd023 to 17d9bb8 Compare April 5, 2020 05:12

deveshks requested a review from xavfernandez April 5, 2020 05:15

xavfernandez reviewed Apr 6, 2020

View reviewed changes

src/pip/_internal/commands/show.py Outdated Show resolved Hide resolved

deveshks requested a review from xavfernandez April 6, 2020 08:34

xavfernandez added skip news Does not need a NEWS file entry (eg: trivial changes) type: refactor Refactoring code C: list/show 'pip list' or 'pip show' and removed skip news Does not need a NEWS file entry (eg: trivial changes) labels Apr 6, 2020

xavfernandez previously approved these changes Apr 6, 2020

View reviewed changes

sbidoul reviewed Apr 6, 2020

View reviewed changes

src/pip/_internal/commands/show.py Outdated Show resolved Hide resolved

xavfernandez reviewed Apr 6, 2020

View reviewed changes

src/pip/_internal/commands/show.py Outdated Show resolved Hide resolved

xavfernandez mentioned this pull request Apr 6, 2020

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

Open

deveshks requested review from xavfernandez and sbidoul April 6, 2020 15:40

xavfernandez reviewed Apr 6, 2020

View reviewed changes

deveshks mentioned this pull request May 5, 2020

Add support for outputting a list of extras and their requirements. #4824

Open

BrownTruck added the needs rebase or merge PR has conflicts with current master label May 18, 2020

pypa-bot removed the needs rebase or merge PR has conflicts with current master label May 18, 2020

deveshks force-pushed the add-show-json branch from 8cb32a8 to 9757f11 Compare May 18, 2020 17:15

BrownTruck added the needs rebase or merge PR has conflicts with current master label May 24, 2020

pypa-bot removed the needs rebase or merge PR has conflicts with current master label May 24, 2020

deveshks added 7 commits June 28, 2020 16:55

Add json formatting option to pip show

b87c55a

Moved formatting decision to run()

c6cdb51

Reverted json based changes

8a92ff1

Replaced feature news entry with trivial

a835171

Merging get_package_info to print_results_default

8e729c6

Changes to add json printer and associated unit tests

8def1b0

Lowercasing keys in json format

58acd6b

deveshks force-pushed the add-show-json branch from 0f330ee to 58acd6b Compare June 28, 2020 11:30

Fixed type annotations

7f9551b

deveshks requested a review from xavfernandez June 28, 2020 11:46

BrownTruck added the needs rebase or merge PR has conflicts with current master label Feb 4, 2021

Merge branch 'master' into add-show-json

9b193cb

pypa-bot removed the needs rebase or merge PR has conflicts with current master label Feb 26, 2021

github-actions bot added the needs rebase or merge PR has conflicts with current master label Aug 15, 2021

sbidoul mentioned this pull request Jul 11, 2022

Add pip inspect command #11245

Merged

sbidoul closed this in #11245 Jul 18, 2022

github-actions bot locked as resolved and limited conversation to collaborators Aug 2, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add json formatting option to pip show #7967

Add json formatting option to pip show #7967

deveshks commented Apr 2, 2020 •

edited

Loading

deveshks commented Apr 3, 2020

xavfernandez left a comment

deveshks commented Apr 6, 2020

xavfernandez commented Apr 6, 2020

deveshks commented Apr 6, 2020

deveshks commented Apr 6, 2020

xavfernandez left a comment

deveshks commented Apr 6, 2020

xavfernandez commented Apr 6, 2020

deveshks commented Apr 6, 2020 •

edited

Loading

deveshks commented Apr 6, 2020 •

edited

Loading

deveshks commented Apr 6, 2020

sbidoul commented Apr 6, 2020

deveshks commented Apr 6, 2020 •

edited

Loading

xavfernandez left a comment

deveshks commented Apr 7, 2020 •

edited

Loading

BrownTruck commented May 18, 2020

deveshks commented May 21, 2020

BrownTruck commented May 24, 2020

deveshks commented Jun 28, 2020 •

edited

Loading

xavfernandez commented Jul 3, 2020

deveshks commented Jul 4, 2020

BrownTruck commented Feb 4, 2021

Add json formatting option to pip show #7967

Add json formatting option to pip show #7967

Conversation

deveshks commented Apr 2, 2020 • edited Loading

deveshks commented Apr 3, 2020

xavfernandez left a comment

Choose a reason for hiding this comment

deveshks commented Apr 6, 2020

xavfernandez commented Apr 6, 2020

deveshks commented Apr 6, 2020

deveshks commented Apr 6, 2020

xavfernandez left a comment

Choose a reason for hiding this comment

deveshks commented Apr 6, 2020

xavfernandez commented Apr 6, 2020

deveshks commented Apr 6, 2020 • edited Loading

deveshks commented Apr 6, 2020 • edited Loading

deveshks commented Apr 6, 2020

sbidoul commented Apr 6, 2020

deveshks commented Apr 6, 2020 • edited Loading

xavfernandez left a comment

Choose a reason for hiding this comment

deveshks commented Apr 7, 2020 • edited Loading

BrownTruck commented May 18, 2020

deveshks commented May 21, 2020

BrownTruck commented May 24, 2020

deveshks commented Jun 28, 2020 • edited Loading

xavfernandez commented Jul 3, 2020

deveshks commented Jul 4, 2020

BrownTruck commented Feb 4, 2021

deveshks commented Apr 2, 2020 •

edited

Loading

deveshks commented Apr 6, 2020 •

edited

Loading

deveshks commented Apr 6, 2020 •

edited

Loading

deveshks commented Apr 6, 2020 •

edited

Loading

deveshks commented Apr 7, 2020 •

edited

Loading

deveshks commented Jun 28, 2020 •

edited

Loading