pip._internal.commands.configuration.ConfigurationCommand Class Reference

Inheritance diagram for pip._internal.commands.configuration.ConfigurationCommand:

Collaboration diagram for pip._internal.commands.configuration.ConfigurationCommand:

Public Member Functions
None	add_options (self)
int	run (self, Values options, List[str] args)
None	list_values (self, Values options, List[str] args)
None	get_name (self, Values options, List[str] args)
None	set_name_value (self, Values options, List[str] args)
None	unset_name (self, Values options, List[str] args)
None	list_config_values (self, Values options, List[str] args)
None	print_config_file_values (self, Kind variant)
None	print_env_var_values (self)
None	open_in_editor (self, Values options, List[str] args)
Public Member Functions inherited from pip._internal.cli.base_command.Command
None	__init__ (self, str name, str summary, bool isolated=False)
None	handle_pip_version_check (self, Values options)
Tuple[Values, List[str]]	parse_args (self, List[str] args)
int	main (self, List[str] args)
Public Member Functions inherited from pip._internal.cli.command_context.CommandContextMixIn
Generator[None, None, None]	main_context (self)
_T	enter_context (self, ContextManager[_T] context_provider)

Public Attributes
	cmd_opts
	list_values
	open_in_editor
	get_name
	set_name_value
	unset_name
	list_config_values
	configuration
Public Attributes inherited from pip._internal.cli.base_command.Command
	name
	summary
	parser
	cmd_opts
	tempdir_registry
	verbosity

Static Public Attributes
bool	ignore_require_venv = True
str	usage
Static Public Attributes inherited from pip._internal.cli.base_command.Command
str	usage = ""
bool	ignore_require_venv = False

Protected Member Functions
Optional[Kind]	_determine_file (self, Values options, bool need_value)
Any	_get_n_args (self, List[str] args, str example, int n)
None	_save_configuration (self)
str	_determine_editor (self, Values options)
Protected Member Functions inherited from pip._internal.cli.base_command.Command
int	_main (self, List[str] args)

Additional Inherited Members
Protected Attributes inherited from pip._internal.cli.command_context.CommandContextMixIn
	_in_main_context
	_main_context

Detailed Description

Manage local and global configuration.

Subcommands:

- list: List the active configuration (or from the file specified)
- edit: Edit the configuration file in an editor
- get: Get the value associated with command.option
- set: Set the command.option=value
- unset: Unset the value associated with command.option
- debug: List the configuration files and values defined under them

Configuration keys should be dot separated command and option name,
with the special prefix "global" affecting any command. For example,
"pip config set global.index-url https://example.org/" would configure
the index url for all commands, but "pip config set download.timeout 10"
would configure a 10 second timeout only for "pip download" commands.

If none of --user, --global and --site are passed, a virtual
environment configuration file is used if one is active and the file
exists. Otherwise, all modifications happen to the user file by
default.

Member Function Documentation

_get_n_args()

Any pip._internal.commands.configuration.ConfigurationCommand._get_n_args (   self, List[str]  args, str  example, int  n  )

protected

Helper to make sure the command got the right number of arguments

add_options()

None pip._internal.commands.configuration.ConfigurationCommand.add_options

(

self

)

Reimplemented from pip._internal.cli.base_command.Command.

list_config_values()

None pip._internal.commands.configuration.ConfigurationCommand.list_config_values	(		self,
		Values	options,
		List[str]	args
	)

List config key-value pairs across different config files

print_config_file_values()

None pip._internal.commands.configuration.ConfigurationCommand.print_config_file_values	(		self,
		Kind	variant
	)

Get key-value pairs from the file of a variant

print_env_var_values()

None pip._internal.commands.configuration.ConfigurationCommand.print_env_var_values

(

self

)

Get key-values pairs present as environment variables

run()

int pip._internal.commands.configuration.ConfigurationCommand.run	(		self,
		Values	options,
		List[str]	args
	)

Reimplemented from pip._internal.cli.base_command.Command.

Member Data Documentation

usage

str pip._internal.commands.configuration.ConfigurationCommand.usage

static

Initial value:

=  """
        %prog [<file-option>] list
        %prog [<file-option>] [--editor <editor-path>] edit
 
        %prog [<file-option>] get command.option
        %prog [<file-option>] set command.option value
        %prog [<file-option>] unset command.option
        %prog [<file-option>] debug
    """

---

The documentation for this class was generated from the following file:

• docs/help/help-venv/lib/python3.12/site-packages/pip/_internal/commands/configuration.py