McSinyx
/
pip
mirror of https://github.com/pypa/pip
1
1
Fork 0
Code Issues Releases Activity

Add --format option to pip list 

with legacy, columns, freeze and json formats
This commit is contained in:
Xavier Fernandez 2016-05-13 23:50:44 +02:00
parent 5685e0149a
commit 5bbc73d145
2 changed files with 119 additions and 84 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

160
pip/commands/list.py
View File

@ -1,5 +1,6 @@
from __future__ import absolute_import
import json
import logging
import warnings
try:
@ -7,6 +8,8 @@ try:
except ImportError:
from itertools import izip_longest as zip_longest
from pip._vendor import six
from pip.basecommand import Command
from pip.exceptions import CommandError
from pip.index import PackageFinder
@ -15,7 +18,6 @@ from pip.utils import (
from pip.utils.deprecation import RemovedInPip10Warning
from pip.cmdoptions import make_option_group, index_group
logger = logging.getLogger(__name__)
@ -72,19 +74,31 @@ class ListCommand(Command):
"pip only finds stable versions."),
)
cmd_opts.add_option(
'--format',
action='store',
dest='list_format',
choices=('legacy', 'columns', 'freeze', 'json'),
default='legacy',
help="Select the output format among: legacy (default), columns, "
"freeze or json",
)
# TODO: When we switch the default, set default=True here.
cmd_opts.add_option(
'--columns',
action='store_true',
dest='columns',
action='store_const',
const='columns',
dest='list_format',
# default=True,
help="Align package names and versions into vertical columns.",
)
cmd_opts.add_option(
'--no-columns',
action='store_false',
dest='columns',
action='store_const',
const='legacy',
dest='list_format',
help=("Do not align package names and versions into "
"vertical columns (old-style formatting)"),
)
@ -132,43 +146,33 @@ class ListCommand(Command):
RemovedInPip10Warning,
)
# TODO: When we switch the default, remove
# ``and options.columns is not None``
if not options.columns and options.columns is not None:
warnings.warn(
"The --no-columns option will be removed in the future.",
RemovedInPip10Warning,
)
if options.outdated and options.uptodate:
raise CommandError(
"Options --outdated and --uptodate cannot be combined.")
if options.outdated:
self.run_outdated(options)
packages = self.get_outdated(options)
elif options.uptodate:
self.run_uptodate(options)
packages = self.get_uptodate(options)
else:
self.run_listing(options)
packages = self.get_listing(options)
self.output_package_listing(packages, options)
def run_outdated(self, options):
def get_outdated(self, options):
latest_pkgs = []
for dist, latest_version, typ in sorted(
for dist in sorted(
self.find_packages_latest_versions(options),
key=lambda p: p[0].project_name.lower()):
if latest_version > dist.parsed_version:
latest_pkgs.append((dist, latest_version, typ))
if (hasattr(options, "columns") and
options.columns and
len(latest_pkgs) > 0):
data, header = format_for_columns(latest_pkgs, options)
self.output_package_listing_columns(data, header)
else:
for dist, latest_version, typ in latest_pkgs:
logger.info(
'%s - Latest: %s [%s]',
self.output_package(dist), latest_version, typ,
)
key=lambda dist: dist.project_name.lower()):
if dist.latest_version > dist.parsed_version:
latest_pkgs.append(dist)
return latest_pkgs
def get_uptodate(self, options):
uptodate = []
for dist in self.find_packages_latest_versions(options):
if dist.parsed_version == dist.latest_version:
uptodate.append(dist)
return uptodate
def find_packages_latest_versions(self, options):
index_urls = [options.index_url] + options.extra_index_urls
@ -212,17 +216,21 @@ class ListCommand(Command):
typ = 'wheel'
else:
typ = 'sdist'
yield dist, remote_version, typ
# This is dirty but makes the rest of the code much cleaner
dist.latest_version = remote_version
dist.latest_filetype = typ
yield dist
def run_listing(self, options):
installed_packages = get_installed_distributions(
local_only=options.local,
user_only=options.user,
editables_only=options.editable,
)
self.output_package_listing(installed_packages, options)
def get_listing(self, options):
packages = []
for dist in get_installed_distributions(
local_only=options.local,
user_only=options.user,
editables_only=options.editable):
packages.append(dist)
return packages
def output_package(self, dist):
def output_legacy(self, dist):
if dist_is_editable(dist):
return '%s (%s, %s)' % (
dist.project_name,
@ -232,19 +240,42 @@ class ListCommand(Command):
else:
return '%s (%s)' % (dist.project_name, dist.version)
def output_package_listing(self, installed_packages, options=None):
installed_packages = sorted(
installed_packages,
def output_legacy_latest(self, dist):
return '%s - Latest: %s [%s]' % (
self.output_legacy(dist),
dist.latest_version,
dist.latest_filetype,
)
def output_package_listing(self, packages, options):
packages = sorted(
packages,
key=lambda dist: dist.project_name.lower(),
)
if (hasattr(options, "columns") and
options.columns and
len(installed_packages) > 0):
data, header = format_for_columns(installed_packages, options)
if options.list_format == 'columns' and packages:
data, header = format_for_columns(packages, options)
self.output_package_listing_columns(data, header)
else:
for dist in installed_packages:
logger.info(self.output_package(dist))
elif options.list_format == 'freeze':
for dist in packages:
logger.info("%s==%s", dist.project_name, dist.version)
elif options.list_format == 'json':
data = []
for dist in packages:
info = {
'name': dist.project_name,
'version': six.text_type(dist.version),
}
if options.outdated:
info['latest_version'] = six.text_type(dist.latest_version)
info['latest_filetype'] = dist.latest_filetype
data.append(info)
logger.info(json.dumps(data))
else: # legacy
for dist in packages:
if options.outdated:
logger.info(self.output_legacy_latest(dist))
else:
logger.info(self.output_legacy(dist))
def output_package_listing_columns(self, data, header):
# insert the header first: we need to know the size of column names
@ -260,13 +291,6 @@ class ListCommand(Command):
for val in pkg_strings:
logger.info(val)
def run_uptodate(self, options):
uptodate = []
for dist, version, typ in self.find_packages_latest_versions(options):
if dist.parsed_version == version:
uptodate.append(dist)
self.output_package_listing(uptodate, options)
def tabulate(vals):
# From pfmoore on GitHub:
@ -291,31 +315,25 @@ def format_for_columns(pkgs, options):
Convert the package data into something usable
by output_package_listing_columns.
"""
header = ["Package", "Version"]
running_outdated = False
running_outdated = options.outdated
# Adjust the header for the `pip list --outdated` case.
if isinstance(pkgs[0], (list, tuple)):
running_outdated = True
if running_outdated:
header = ["Package", "Version", "Latest", "Type"]
else:
header = ["Package", "Version"]
data = []
if any(dist_is_editable(x[0])
if running_outdated
else dist_is_editable(x)
for x in pkgs):
if any(dist_is_editable(x) for x in pkgs):
header.append("Location")
for proj in pkgs:
# if we're working on the 'outdated' list, separate out the
# latest_version and type
if running_outdated:
proj, latest_version, typ = proj
row = [proj.project_name, proj.version]
if running_outdated:
row.append(latest_version)
row.append(typ)
row.append(proj.latest_version)
row.append(proj.latest_filetype)
if dist_is_editable(proj):
row.append(proj.location)

43
tests/functional/test_list.py
View File

@ -1,9 +1,7 @@
import json
import os
import pytest
WARN_NOCOL = ("DEPRECATION: The --no-columns option will be "
"removed in the future.")
def test_list_command(script, data):
"""
@ -45,7 +43,6 @@ def test_nocolumns_flag(script, data):
'simple2==3.0',
)
result = script.pip('list', '--no-columns', expect_stderr=True)
assert WARN_NOCOL in result.stderr, str(result)
assert 'simple (1.0)' in result.stdout, str(result)
assert 'simple2 (3.0)' in result.stdout, str(result)
@ -62,7 +59,6 @@ def test_columns_nocolumns(script, data):
'list', '--columns', '--no-columns',
expect_error=True,
)
assert WARN_NOCOL in result.stderr, str(result)
assert 'simple (1.0)' in result.stdout, str(result)
assert 'simple2 (3.0)' in result.stdout, str(result)
assert 'simple 1.0' not in result.stdout, str(result)
@ -118,7 +114,6 @@ def test_local_nocolumns_flag(script, data):
"""
script.pip('install', '-f', data.find_links, '--no-index', 'simple==1.0')
result = script.pip('list', '--local', '--no-columns', expect_stderr=True)
assert WARN_NOCOL in result.stderr, str(result)
assert 'simple (1.0)' in result.stdout
@ -162,7 +157,6 @@ def test_user_nocolumns_flag(script, data, virtualenv):
script.pip('install', '-f', data.find_links, '--no-index',
'--user', 'simple2==2.0')
result = script.pip('list', '--user', '--no-columns', expect_stderr=True)
assert WARN_NOCOL in result.stderr, str(result)
assert 'simple (1.0)' not in result.stdout
assert 'simple2 (2.0)' in result.stdout, str(result)
@ -234,7 +228,6 @@ def test_uptodate_nocolumns_flag(script, data):
'list', '-f', data.find_links, '--no-index', '--uptodate',
'--no-columns', expect_stderr=True,
)
assert WARN_NOCOL in result.stderr, str(result)
assert 'simple (1.0)' not in result.stdout # 3.0 is latest
assert 'pip-test-package (0.1.1,' in result.stdout # editables included
assert 'simple2 (3.0)' in result.stdout, str(result)
@ -319,7 +312,6 @@ def test_outdated_nocolumns_flag(script, data):
'list', '-f', data.find_links, '--no-index', '--outdated',
'--no-columns', expect_stderr=True,
)
assert WARN_NOCOL in result.stderr, str(result)
assert 'simple (1.0) - Latest: 3.0 [sdist]' in result.stdout
assert 'simplewheel (1.0) - Latest: 2.0 [wheel]' in result.stdout
assert 'pip-test-package (0.1, ' in result.stdout
@ -376,7 +368,6 @@ def test_editables_nocolumns_flag(script, data):
result = script.pip(
'list', '--editable', '--no-columns', expect_stderr=True,
)
assert WARN_NOCOL in result.stderr, str(result)
assert 'simple (1.0)' not in result.stdout, str(result)
assert os.path.join('src', 'pip-test-package') in result.stdout, (
str(result)
@ -442,7 +433,6 @@ def test_uptodate_editables_nocolumns_flag(script, data):
'list', '-f', data.find_links, '--no-index', '--editable',
'--uptodate', '--no-columns', expect_stderr=True,
)
assert WARN_NOCOL in result.stderr, str(result)
assert 'simple (1.0)' not in result.stdout, str(result)
assert os.path.join('src', 'pip-test-package') in result.stdout, (
str(result)
@ -510,7 +500,6 @@ def test_outdated_editables_nocolumns_flag(script, data):
'--editable', '--outdated', '--no-columns',
expect_stderr=True,
)
assert WARN_NOCOL in result.stderr, str(result)
assert 'simple (1.0)' not in result.stdout, str(result)
assert os.path.join('src', 'pip-test-package') in result.stdout, (
str(result)
@ -579,4 +568,32 @@ def test_outdated_pre_nocolumns(script, data):
'--find-links', wheelhouse_path,
'--outdated', '--pre', '--no-columns', expect_stderr=True
)
assert WARN_NOCOL in result.stderr, str(result)
def test_list_freeze(script, data):
"""
Test freeze formating of list command
"""
script.pip(
'install', '-f', data.find_links, '--no-index', 'simple==1.0',
'simple2==3.0',
)
result = script.pip('list', '--format=freeze')
assert 'simple==1.0' in result.stdout, str(result)
assert 'simple2==3.0' in result.stdout, str(result)
def test_list_json(script, data):
"""
Test json formating of list command
"""
script.pip(
'install', '-f', data.find_links, '--no-index', 'simple==1.0',
'simple2==3.0',
)
result = script.pip('list', '--format=json')
data = json.loads(result.stdout)
assert {'name': 'simple', 'version': '1.0'} in data
assert {'name': 'simple2', 'version': '3.0'} in data