pip._internal.commands.list Namespace Reference

Data Structures
class	_DistWithLatestInfo
class	ListCommand

Functions
Tuple[List[List[str]], List[str]]	format_for_columns ("_ProcessedDists" pkgs, Values options)
str	format_for_json ("_ProcessedDists" packages, Values options)

Variables
	_ProcessedDists
	logger = logging.getLogger(__name__)

Function Documentation

format_for_columns()

Tuple[List[List[str]], List[str]] format_for_columns	(	"_ProcessedDists"	pkgs,
		Values	options
	)

Convert the package data into something usable
by output_package_listing_columns.

Definition at line 306 of file list.py.

) -> Tuple[List[List[str]], List[str]]:
    """
    Convert the package data into something usable
    by output_package_listing_columns.
    """
    header = ["Package", "Version"]
 
    running_outdated = options.outdated
    if running_outdated:
        header.extend(["Latest", "Type"])
 
    has_editables = any(x.editable for x in pkgs)
    if has_editables:
        header.append("Editable project location")
 
    if options.verbose >= 1:
        header.append("Location")
    if options.verbose >= 1:
        header.append("Installer")
 
    data = []
    for proj in pkgs:
        # if we're working on the 'outdated' list, separate out the
        # latest_version and type
        row = [proj.raw_name, str(proj.version)]
 
        if running_outdated:
            row.append(str(proj.latest_version))
            row.append(proj.latest_filetype)
 
        if has_editables:
            row.append(proj.editable_project_location or "")
 
        if options.verbose >= 1:
            row.append(proj.location or "")
        if options.verbose >= 1:
            row.append(proj.installer)
 
        data.append(row)
 
    return data, header
 
 

References i.

Referenced by ListCommand.output_package_listing().

Here is the caller graph for this function:

format_for_json()

str format_for_json	(	"_ProcessedDists"	packages,
		Values	options
	)

Definition at line 351 of file list.py.

def format_for_json(packages: "_ProcessedDists", options: Values) -> str:
    data = []
    for dist in packages:
        info = {
            "name": dist.raw_name,
            "version": str(dist.version),
        }
        if options.verbose >= 1:
            info["location"] = dist.location or ""
            info["installer"] = dist.installer
        if options.outdated:
            info["latest_version"] = str(dist.latest_version)
            info["latest_filetype"] = dist.latest_filetype
        editable_project_location = dist.editable_project_location
        if editable_project_location:
            info["editable_project_location"] = editable_project_location
        data.append(info)
    return json.dumps(data)

References i.

Referenced by ListCommand.output_package_listing().

Here is the caller graph for this function:

Variable Documentation

_ProcessedDists

_ProcessedDists

protected

Definition at line 33 of file list.py.

logger

logger = logging.getLogger(__name__)

Definition at line 36 of file list.py.