pip._internal.configuration Namespace Reference

Classes
class	Configuration

Functions
str	_normalize_name (str name)
List[str]	_disassemble_key (str name)
Dict[Kind, List[str]]	get_configuration_files ()

Variables
	RawConfigParser = configparser.RawConfigParser
	Kind = NewType("Kind", str)
str	CONFIG_BASENAME = "pip.ini" if WINDOWS else "pip.conf"
str	ENV_NAMES_IGNORED = "version", "help"
	kinds
	OVERRIDE_ORDER = kinds.GLOBAL, kinds.USER, kinds.SITE, kinds.ENV, kinds.ENV_VAR
	VALID_LOAD_ONLY = kinds.USER, kinds.GLOBAL, kinds.SITE
	logger = getLogger(__name__)

Detailed Description

Configuration management setup

Some terminology:
- name
  As written in config files.
- value
  Value associated with a name
- key
  Name combined with it's section (section.name)
- variant
  A single word describing where the configuration key-value pair came from

Function Documentation

_normalize_name()

str pip._internal.configuration._normalize_name ( str  name )

protected

Make a name consistent regardless of source (environment or file)

Variable Documentation

kinds

pip._internal.configuration.kinds

Initial value:

=  enum(
    USER="user",  # User Specific
    GLOBAL="global",  # System Wide
    SITE="site",  # [Virtual] Environment Specific
    ENV="env",  # from PIP_CONFIG_FILE
    ENV_VAR="env-var",  # from Environment Variables
)