pip._internal.commands Namespace Reference

Namespaces
namespace	cache
namespace	check
namespace	completion
namespace	configuration
namespace	debug
namespace	download
namespace	freeze
namespace	hash
namespace	help
namespace	index
namespace	inspect
namespace	install
namespace	list
namespace	search
namespace	show
namespace	uninstall
namespace	wheel

Functions
Command	create_command (str name, **Any kwargs)
Optional[str]	get_similar_commands (str name)

Variables
	CommandInfo = namedtuple("CommandInfo", "module_path, class_name, summary")
dict	commands_dict

Detailed Description

Package containing all pip commands

Function Documentation

create_command()

Command create_command	(	str	name,
		**Any	kwargs
	)

Create an instance of the Command class with the given name.

Definition at line 109 of file __init__.py.

def create_command(name: str, **kwargs: Any) -> Command:
    """
    Create an instance of the Command class with the given name.
    """
    module_path, class_name, summary = commands_dict[name]
    module = importlib.import_module(module_path)
    command_class = getattr(module, class_name)
    command = command_class(name=name, summary=summary, **kwargs)
 
    return command
 
 

References i.

get_similar_commands()

Optional[str] get_similar_commands

(

str

name

)

Command name auto-correct.

Definition at line 121 of file __init__.py.

def get_similar_commands(name: str) -> Optional[str]:
    """Command name auto-correct."""
    from difflib import get_close_matches
 
    name = name.lower()
 
    close_commands = get_close_matches(name, commands_dict.keys())
 
    if close_commands:
        return close_commands[0]
    else:
        return None

References i.

Variable Documentation

CommandInfo

CommandInfo = namedtuple("CommandInfo", "module_path, class_name, summary")

Definition at line 11 of file __init__.py.

commands_dict

dict commands_dict

Definition at line 20 of file __init__.py.