Remove show json tests and add format option to show

Author: deveshks

src/pip/_internal/commands/show.py

@@ -40,7 +40,14 @@ def __init__(self, *args, **kw):
             action='store_true',
             default=False,
             help='Show the full list of installed files for each package.')
-
+        self.cmd_opts.add_option(
+            '--format',
+            action='store',
+            dest='list_format',
+            default="header",
+            choices=('header', 'json'),
+            help="Select the output format among: header (default) or json",
+        )
         self.parser.insert_option_group(0, self.cmd_opts)
 
     def run(self, options, args):

tests/functional/test_show.py

@@ -1,4 +1,3 @@
-import json
 import os
 import re
 
@@ -22,18 +21,6 @@ def test_basic_show(script):
     assert 'Requires: ' in lines
 
 
-def test_basic_show_json(script):
-    """
-    Test end to end test for show command.
-    """
-    result = script.pip('show', 'pip', '--format=json')
-    data = json.loads(result.stdout)[0]
-    assert len(data) == 10
-    assert data['name'] == 'pip'
-    assert data['version'] == '{}'.format(__version__)
-    assert {'location', 'requires'} <= set(data)
-
-
 def test_show_with_files_not_found(script, data):
     """
     Test for show command with installed files listing enabled and
@@ -52,21 +39,6 @@ def test_show_with_files_not_found(script, data):
     assert 'Cannot locate installed-files.txt' in lines
 
 
-def test_show_with_files_not_found_json(script, data):
-    """
-    Test for show command with installed files listing enabled and
-    installed-files.txt not found.
-    """
-    editable = data.packages.joinpath('SetupPyUTF8')
-    script.pip('install', '-e', editable)
-    result = script.pip('show', '-f', 'SetupPyUTF8', '--format=json')
-    data = json.loads(result.stdout)[0]
-    assert data['name'] == 'SetupPyUTF8'
-    assert data['version'] == '0.0.0'
-    assert {'location', 'requires'} <= set(data)
-    assert not data['files']
-
-
 def test_show_with_files_from_wheel(script, data):
     """
     Test that a wheel's files can be listed
@@ -80,18 +52,6 @@ def test_show_with_files_from_wheel(script, data):
     assert re.search(r"Files:\n(  .+\n)+", result.stdout)
 
 
-def test_show_with_files_from_wheel_json(script, data):
-    """
-    Test that a wheel's files can be listed
-    """
-    wheel_file = data.packages.joinpath('simple.dist-0.1-py2.py3-none-any.whl')
-    script.pip('install', '--no-index', wheel_file)
-    result = script.pip('show', '-f', 'simple.dist', '--format=json')
-    data = json.loads(result.stdout)[0]
-    assert data['name'] == 'simple.dist'
-    assert data['files']
-
-
 @pytest.mark.network
 def test_show_with_all_files(script):
     """
@@ -104,17 +64,6 @@ def test_show_with_all_files(script):
     assert re.search(r"Files:\n(  .+\n)+", result.stdout)
 
 
-@pytest.mark.network
-def test_show_with_all_files_json(script):
-    """
-    Test listing all files in the show command.
-    """
-    script.pip('install', 'initools==0.2')
-    result = script.pip('show', '--files', 'initools', '--format=json')
-    data = json.loads(result.stdout)[0]
-    assert data['files']
-
-
 def test_missing_argument(script):
     """
     Test show command with no arguments.
@@ -159,21 +108,6 @@ def test_report_mixed_not_found(script):
     assert 'Name: pip' in lines
 
 
-def test_report_mixed_not_found_json(script):
-    """
-    Test passing a mixture of found and not-found names.
-    """
-    # We test passing non-canonicalized names.
-    result = script.pip(
-        'show', 'Abcd3', 'A-B-C', 'pip', '--format=json',
-        allow_stderr_warning=True
-    )
-    assert 'WARNING: Package(s) not found: A-B-C, Abcd3' in result.stderr
-    print(result.stdout)
-    data = json.loads(result.stdout)[0]
-    assert data['name'] == 'pip'
-
-
 def test_search_any_case():
     """
     Search for a package in any case.
@@ -204,17 +138,6 @@ def test_show_verbose_with_classifiers(script):
     assert "Intended Audience :: Developers" in result.stdout
 
 
-def test_show_verbose_with_classifiers_json(script):
-    """
-    Test that classifiers can be listed
-    """
-    result = script.pip('show', 'pip', '--verbose', '--format=json')
-    data = json.loads(result.stdout)[0]
-    assert data['name'] == 'pip'
-    assert data['classifiers']
-    assert "Intended Audience :: Developers" in data["classifiers"]
-
-
 def test_show_verbose_installer(script, data):
     """
     Test that the installer is shown (this currently needs a wheel install)
@@ -227,18 +150,6 @@ def test_show_verbose_installer(script, data):
     assert 'Installer: pip' in lines
 
 
-def test_show_verbose_installer_json(script, data):
-    """
-    Test that the installer is shown (this currently needs a wheel install)
-    """
-    wheel_file = data.packages.joinpath('simple.dist-0.1-py2.py3-none-any.whl')
-    script.pip('install', '--no-index', wheel_file)
-    result = script.pip('show', '--verbose', 'simple.dist', '--format=json')
-    data = json.loads(result.stdout)[0]
-    assert data['name'] == 'simple.dist'
-    assert data['installer'] == 'pip'
-
-
 def test_show_verbose(script):
     """
     Test end to end test for verbose show command.
@@ -251,17 +162,6 @@ def test_show_verbose(script):
     assert 'Classifiers:' in lines
 
 
-def test_show_verbose_json(script):
-    """
-    Test end to end test for verbose show command.
-    """
-    result = script.pip('show', '--verbose', 'pip', '--format=json')
-    data = json.loads(result.stdout)[0]
-
-    assert {'metadata-version', 'installer',
-            'entry-points', 'classifiers'} <= set(data)
-
-
 def test_all_fields(script):
     """
     Test that all the fields are present
@@ -275,18 +175,6 @@ def test_all_fields(script):
     assert actual == expected
 
 
-def test_all_fields_json(script):
-    """
-    Test that all the fields are present
-    """
-    result = script.pip('show', 'pip', '--format=json')
-    data = json.loads(result.stdout)[0]
-    expected = {'name', 'version', 'summary', 'home-page', 'author',
-                'author-email', 'license', 'location', 'requires',
-                'required-by'}
-    assert set(data) == expected
-
-
 def test_pip_show_is_short(script):
     """
     Test that pip show stays short
@@ -296,15 +184,6 @@ def test_pip_show_is_short(script):
     assert len(lines) <= 10
 
 
-def test_pip_show_is_short_json(script):
-    """
-    Test that pip show stays short
-    """
-    result = script.pip('show', 'pip', '--format=json')
-    data = json.loads(result.stdout)[0]
-    assert len(data) <= 10
-
-
 def test_pip_show_divider(script, data):
     """
     Expect a divider between packages
@@ -343,22 +222,6 @@ def test_show_required_by_packages_basic(script, data):
     assert 'Required-by: requires-simple' in lines
 
 
-def test_show_required_by_packages_basic_json(script, data):
-    """
-    Test that installed packages that depend on this package are shown
-    """
-    editable_path = os.path.join(data.src, 'requires_simple')
-    script.pip(
-        'install', '--no-index', '-f', data.find_links, editable_path
-    )
-
-    result = script.pip('show', 'simple', '--format=json')
-    data = json.loads(result.stdout)[0]
-
-    assert data['name'] == 'simple'
-    assert data['required-by'] == ['requires-simple']
-
-
 def test_show_required_by_packages_capitalized(script, data):
     """
     Test that the installed packages which depend on a package are shown
@@ -376,23 +239,6 @@ def test_show_required_by_packages_capitalized(script, data):
     assert 'Required-by: Requires-Capitalized' in lines
 
 
-def test_show_required_by_packages_capitalized_json(script, data):
-    """
-    Test that the installed packages which depend on a package are shown
-    where the package has a capital letter
-    """
-    editable_path = os.path.join(data.src, 'requires_capitalized')
-    script.pip(
-        'install', '--no-index', '-f', data.find_links, editable_path
-    )
-
-    result = script.pip('show', 'simple', '--format=json')
-    data = json.loads(result.stdout)[0]
-
-    assert data['name'] == 'simple'
-    assert data['required-by'] == ['Requires-Capitalized']
-
-
 def test_show_required_by_packages_requiring_capitalized(script, data):
     """
     Test that the installed packages which depend on a package are shown
@@ -415,28 +261,6 @@ def test_show_required_by_packages_requiring_capitalized(script, data):
     assert 'Required-by: requires-requires-capitalized' in lines
 
 
-def test_show_required_by_packages_requiring_capitalized_json(script, data):
-    """
-    Test that the installed packages which depend on a package are shown
-    where the package has a name with a mix of
-    lower and upper case letters
-    """
-    required_package_path = os.path.join(data.src, 'requires_capitalized')
-    script.pip(
-        'install', '--no-index', '-f', data.find_links, required_package_path
-    )
-    editable_path = os.path.join(data.src, 'requires_requires_capitalized')
-    script.pip(
-        'install', '--no-index', '-f', data.find_links, editable_path
-    )
-
-    result = script.pip('show', 'Requires_Capitalized', '--format=json')
-    data = json.loads(result.stdout)[0]
-
-    assert data['name'] == 'Requires-Capitalized'
-    assert data['required-by'] == ['requires-requires-capitalized']
-
-
 def test_show_skip_work_dir_pkg(script):
     """
     Test that show should not include package