Classes
class	PipOption

Functions
None	raise_option_error (OptionParser parser, Option option, str msg)

OptionGroup	make_option_group (Dict[str, Any] group, ConfigOptionParser parser)

None	check_dist_restriction (Values options, bool check_target=False)

str	_path_option_check (Option option, str opt, str value)

str	_package_name_option_check (Option option, str opt, str value)

Option	exists_action ()

Option	extra_index_url ()

Option	find_links ()

Option	trusted_host ()

Option	constraints ()

Option	requirements ()

Option	editable ()

None	_handle_src (Option option, str opt_str, str value, OptionParser parser)

Any	_get_format_control (Values values, Option option)

None	_handle_no_binary (Option option, str opt_str, str value, OptionParser parser)

None	_handle_only_binary (Option option, str opt_str, str value, OptionParser parser)

Option	no_binary ()

Option	only_binary ()

Tuple[Tuple[int,...], Optional[str]]	_convert_python_version (str value)

None	_handle_python_version (Option option, str opt_str, str value, OptionParser parser)

None	add_target_python_options (OptionGroup cmd_opts)

TargetPython	make_target_python (Values options)

Option	prefer_binary ()

None	_handle_no_cache_dir (Option option, str opt, str value, OptionParser parser)

None	_handle_no_use_pep517 (Option option, str opt, str value, OptionParser parser)

None	_handle_config_settings (Option option, str opt_str, str value, OptionParser parser)

None	_handle_merge_hash (Option option, str opt_str, str value, OptionParser parser)

None	check_list_path_option (Values options)

Variables
	logger = logging.getLogger(__name__)

Callable	cert

Callable	client_cert

Callable	index_url

Callable	no_index

Callable	src

Callable	platforms

Callable	python_version

Callable	implementation

Callable	abis

Callable	cache_dir

Callable	no_cache

Callable	no_deps

Callable	ignore_requires_python

Callable	no_build_isolation

Callable	check_build_deps

Any	use_pep517

Any	no_use_pep517

Callable	config_settings

Callable	build_options

Callable	global_options

Callable	no_clean

Callable	pre

Callable	disable_pip_version_check

Callable	root_user_action

Callable	hash

Callable	require_hashes

Callable	list_path

Callable	list_exclude

Callable	no_python_version_warning

list	ALWAYS_ENABLED_FEATURES

Callable	use_new_feature

Callable	use_deprecated_feature

dict	general_group
	groups #

dict	index_group

Detailed Description

shared options and groups

The principle here is to define options once, but *not* instantiate them
globally. One reason being that options with action='append' can carry state
between parses. pip parses general options twice internally, and shouldn't
pass on state. To be consistent, all options will follow this design.

Function Documentation

◆ _convert_python_version()

Tuple[Tuple[int, ...], Optional[str]] pip._internal.cli.cmdoptions._convert_python_version ( str value )

protected

Convert a version string like "3", "37", or "3.7.3" into a tuple of ints.

:return: A 2-tuple (version_info, error_msg), where `error_msg` is
    non-None if and only if there was a parsing error.

◆ _get_format_control()

Any pip._internal.cli.cmdoptions._get_format_control	(	Values	values,
		Option	option
	)

protected

Get a format_control object.

◆ _handle_merge_hash()

None pip._internal.cli.cmdoptions._handle_merge_hash	(	Option	option,
		str	opt_str,
		str	value,
		OptionParser	parser
	)

protected

Given a value spelled "algo:digest", append the digest to a list
pointed to in a dict by the algo name.

◆ _handle_no_cache_dir()

None pip._internal.cli.cmdoptions._handle_no_cache_dir	(	Option	option,
		str	opt,
		str	value,
		OptionParser	parser
	)

protected

Process a value provided for the --no-cache-dir option.

This is an optparse.Option callback for the --no-cache-dir option.

◆ _handle_no_use_pep517()

None pip._internal.cli.cmdoptions._handle_no_use_pep517	(	Option	option,
		str	opt,
		str	value,
		OptionParser	parser
	)

protected

Process a value provided for the --no-use-pep517 option.

This is an optparse.Option callback for the no_use_pep517 option.

◆ _handle_python_version()

None pip._internal.cli.cmdoptions._handle_python_version	(	Option	option,
		str	opt_str,
		str	value,
		OptionParser	parser
	)

protected

Handle a provided --python-version value.

◆ check_dist_restriction()

None pip._internal.cli.cmdoptions.check_dist_restriction	(	Values	options,
		bool	check_target = `False`
	)

Function for determining if custom platform options are allowed.

:param options: The OptionParser options.
:param check_target: Whether or not to check if --target is being used.

◆ make_option_group()

OptionGroup pip._internal.cli.cmdoptions.make_option_group	(	Dict[str, Any]	group,
		ConfigOptionParser	parser
	)

Return an OptionGroup object
group  -- assumed to be dict with 'name' and 'options' keys
parser -- an optparse Parser

◆ raise_option_error()

None pip._internal.cli.cmdoptions.raise_option_error	(	OptionParser	parser,
		Option	option,
		str	msg
	)

Raise an option parsing error using parser.error().

Args:
  parser: an OptionParser instance.
  option: an Option instance.
  msg: the error text.

Variable Documentation

◆ abis

Callable pip._internal.cli.cmdoptions.abis

Initial value:

=  partial(
    Option,
    "--abi",
    dest="abis",
    metavar="abi",
    action="append",
    default=None,
    help=(
        "Only use wheels compatible with Python abi <abi>, e.g. 'pypy_41'. "
        "If not specified, then the current interpreter abi tag is used. "
        "Use this option multiple times to specify multiple abis supported "
        "by the target interpreter. Generally you will need to specify "
        "--implementation, --platform, and --python-version when using this "
        "option."
    ),
)

◆ ALWAYS_ENABLED_FEATURES

list pip._internal.cli.cmdoptions.ALWAYS_ENABLED_FEATURES

Initial value:

=  [
    "no-binary-enable-wheel-cache",  # always on since 23.1
]

◆ build_options

Callable pip._internal.cli.cmdoptions.build_options

Initial value:

=  partial(
    Option,
    "--build-option",
    dest="build_options",
    metavar="options",
    action="append",
    help="Extra arguments to be supplied to 'setup.py bdist_wheel'.",
)

◆ cache_dir

Callable pip._internal.cli.cmdoptions.cache_dir

Initial value:

=  partial(
    PipOption,
    "--cache-dir",
    dest="cache_dir",
    default=USER_CACHE_DIR,
    metavar="dir",
    type="path",
    help="Store the cache data in <dir>.",
)

◆ cert

Callable pip._internal.cli.cmdoptions.cert

Initial value:

=  partial(
    PipOption,
    "--cert",
    dest="cert",
    type="path",
    metavar="path",
    help=(
        "Path to PEM-encoded CA certificate bundle. "
        "If provided, overrides the default. "
        "See 'SSL Certificate Verification' in pip documentation "
        "for more information."
    ),
)

◆ check_build_deps

Callable pip._internal.cli.cmdoptions.check_build_deps

Initial value:

=  partial(
    Option,
    "--check-build-dependencies",
    dest="check_build_deps",
    action="store_true",
    default=False,
    help="Check the build dependencies when PEP517 is used.",
)

◆ client_cert

Callable pip._internal.cli.cmdoptions.client_cert

Initial value:

=  partial(
    PipOption,
    "--client-cert",
    dest="client_cert",
    type="path",
    default=None,
    metavar="path",
    help="Path to SSL client certificate, a single file containing the "
    "private key and the certificate in PEM format.",
)

◆ config_settings

Callable pip._internal.cli.cmdoptions.config_settings

Initial value:

=  partial(
    Option,
    "-C",
    "--config-settings",
    dest="config_settings",
    type=str,
    action="callback",
    callback=_handle_config_settings,
    metavar="settings",
    help="Configuration settings to be passed to the PEP 517 build backend. "
    "Settings take the form KEY=VALUE. Use multiple --config-settings options "
    "to pass multiple keys to the backend.",
)

◆ disable_pip_version_check

Callable pip._internal.cli.cmdoptions.disable_pip_version_check

Initial value:

=  partial(
    Option,
    "--disable-pip-version-check",
    dest="disable_pip_version_check",
    action="store_true",
    default=True,
    help="Don't periodically check PyPI to determine whether a new version "
    "of pip is available for download. Implied with --no-index.",
)

◆ general_group

dict pip._internal.cli.cmdoptions.general_group

Initial value:

=  {
    "name": "General Options",
    "options": [
        help_,
        debug_mode,
        isolated_mode,
        require_virtualenv,
        python,
        verbose,
        version,
        quiet,
        log,
        no_input,
        keyring_provider,
        proxy,
        retries,
        timeout,
        exists_action,
        trusted_host,
        cert,
        client_cert,
        cache_dir,
        no_cache,
        disable_pip_version_check,
        no_color,
        no_python_version_warning,
        use_new_feature,
        use_deprecated_feature,
    ],
}

groups #

◆ global_options

Callable pip._internal.cli.cmdoptions.global_options

Initial value:

=  partial(
    Option,
    "--global-option",
    dest="global_options",
    action="append",
    metavar="options",
    help="Extra global options to be supplied to the setup.py "
    "call before the install or bdist_wheel command.",
)

◆ hash

Callable pip._internal.cli.cmdoptions.hash

Initial value:

=  partial(
    Option,
    "--hash",
    # Hash values eventually end up in InstallRequirement.hashes due to
    # __dict__ copying in process_line().
    dest="hashes",
    action="callback",
    callback=_handle_merge_hash,
    type="string",
    help="Verify that the package's archive matches this "
    "hash before installing. Example: --hash=sha256:abcdef...",
)

◆ ignore_requires_python

Callable pip._internal.cli.cmdoptions.ignore_requires_python

Initial value:

=  partial(
    Option,
    "--ignore-requires-python",
    dest="ignore_requires_python",
    action="store_true",
    help="Ignore the Requires-Python information.",
)

◆ implementation

Callable pip._internal.cli.cmdoptions.implementation

Initial value:

=  partial(
    Option,
    "--implementation",
    dest="implementation",
    metavar="implementation",
    default=None,
    help=(
        "Only use wheels compatible with Python "
        "implementation <implementation>, e.g. 'pp', 'jy', 'cp', "
        " or 'ip'. If not specified, then the current "
        "interpreter implementation is used.  Use 'py' to force "
        "implementation-agnostic wheels."
    ),
)

◆ index_group

dict pip._internal.cli.cmdoptions.index_group

Initial value:

=  {
    "name": "Package Index Options",
    "options": [
        index_url,
        extra_index_url,
        no_index,
        find_links,
    ],
}

◆ index_url

Callable pip._internal.cli.cmdoptions.index_url

Initial value:

=  partial(
    Option,
    "-i",
    "--index-url",
    "--pypi-url",
    dest="index_url",
    metavar="URL",
    default=PyPI.simple_url,
    help="Base URL of the Python Package Index (default %default). "
    "This should point to a repository compliant with PEP 503 "
    "(the simple repository API) or a local directory laid out "
    "in the same format.",
)

◆ list_exclude

Callable pip._internal.cli.cmdoptions.list_exclude

Initial value:

=  partial(
    PipOption,
    "--exclude",
    dest="excludes",
    action="append",
    metavar="package",
    type="package_name",
    help="Exclude specified package from the output",
)

◆ list_path

Callable pip._internal.cli.cmdoptions.list_path

Initial value:

=  partial(
    PipOption,
    "--path",
    dest="path",
    type="path",
    action="append",
    help="Restrict to the specified installation path for listing "
    "packages (can be used multiple times).",
)

◆ no_build_isolation

Callable pip._internal.cli.cmdoptions.no_build_isolation

Initial value:

=  partial(
    Option,
    "--no-build-isolation",
    dest="build_isolation",
    action="store_false",
    default=True,
    help="Disable isolation when building a modern source distribution. "
    "Build dependencies specified by PEP 518 must be already installed "
    "if this option is used.",
)

◆ no_cache

Callable pip._internal.cli.cmdoptions.no_cache

Initial value:

=  partial(
    Option,
    "--no-cache-dir",
    dest="cache_dir",
    action="callback",
    callback=_handle_no_cache_dir,
    help="Disable the cache.",
)

◆ no_clean

Callable pip._internal.cli.cmdoptions.no_clean

Initial value:

=  partial(
    Option,
    "--no-clean",
    action="store_true",
    default=False,
    help="Don't clean up build directories.",
)

◆ no_deps

Callable pip._internal.cli.cmdoptions.no_deps

Initial value:

=  partial(
    Option,
    "--no-deps",
    "--no-dependencies",
    dest="ignore_dependencies",
    action="store_true",
    default=False,
    help="Don't install package dependencies.",
)

◆ no_index

Callable pip._internal.cli.cmdoptions.no_index

Initial value:

=  partial(
    Option,
    "--no-index",
    dest="no_index",
    action="store_true",
    default=False,
    help="Ignore package index (only looking at --find-links URLs instead).",
)

◆ no_python_version_warning

Callable pip._internal.cli.cmdoptions.no_python_version_warning

Initial value:

=  partial(
    Option,
    "--no-python-version-warning",
    dest="no_python_version_warning",
    action="store_true",
    default=False,
    help="Silence deprecation warnings for upcoming unsupported Pythons.",
)

◆ no_use_pep517

Any pip._internal.cli.cmdoptions.no_use_pep517

Initial value:

=  partial(
    Option,
    "--no-use-pep517",
    dest="use_pep517",
    action="callback",
    callback=_handle_no_use_pep517,
    default=None,
    help=SUPPRESS_HELP,
)

◆ platforms

Callable pip._internal.cli.cmdoptions.platforms

Initial value:

=  partial(
    Option,
    "--platform",
    dest="platforms",
    metavar="platform",
    action="append",
    default=None,
    help=(
        "Only use wheels compatible with <platform>. Defaults to the "
        "platform of the running system. Use this option multiple times to "
        "specify multiple platforms supported by the target interpreter."
    ),
)

◆ pre

Callable pip._internal.cli.cmdoptions.pre

Initial value:

=  partial(
    Option,
    "--pre",
    action="store_true",
    default=False,
    help="Include pre-release and development versions. By default, "
    "pip only finds stable versions.",
)

◆ python_version

Callable pip._internal.cli.cmdoptions.python_version

Initial value:

=  partial(
    Option,
    "--python-version",
    dest="python_version",
    metavar="python_version",
    action="callback",
    callback=_handle_python_version,
    type="str",
    default=None,
    help=dedent(
        
    ),
)

◆ require_hashes

Callable pip._internal.cli.cmdoptions.require_hashes

Initial value:

=  partial(
    Option,
    "--require-hashes",
    dest="require_hashes",
    action="store_true",
    default=False,
    help="Require a hash to check each requirement against, for "
    "repeatable installs. This option is implied when any package in a "
    "requirements file has a --hash option.",
)

◆ root_user_action

Callable pip._internal.cli.cmdoptions.root_user_action

Initial value:

=  partial(
    Option,
    "--root-user-action",
    dest="root_user_action",
    default="warn",
    choices=["warn", "ignore"],
    help="Action if pip is run as a root user. By default, a warning message is shown.",
)

◆ src

Callable pip._internal.cli.cmdoptions.src

Initial value:

=  partial(
    PipOption,
    "--src",
    "--source",
    "--source-dir",
    "--source-directory",
    dest="src_dir",
    type="path",
    metavar="dir",
    default=get_src_prefix(),
    action="callback",
    callback=_handle_src,
    help="Directory to check out editable projects into. "
    'The default in a virtualenv is "<venv path>/src". '
    'The default for global installs is "<current dir>/src".',
)

◆ use_deprecated_feature

Callable pip._internal.cli.cmdoptions.use_deprecated_feature

Initial value:

=  partial(
    Option,
    "--use-deprecated",
    dest="deprecated_features_enabled",
    metavar="feature",
    action="append",
    default=[],
    choices=[
        "legacy-resolver",
    ],
    help=("Enable deprecated functionality, that will be removed in the future."),
)

◆ use_new_feature

Callable pip._internal.cli.cmdoptions.use_new_feature

Initial value:

=  partial(
    Option,
    "--use-feature",
    dest="features_enabled",
    metavar="feature",
    action="append",
    default=[],
    choices=[
        "fast-deps",
        "truststore",
    ]
    + ALWAYS_ENABLED_FEATURES,
    help="Enable new functionality, that may be backward incompatible.",
)

◆ use_pep517

Any pip._internal.cli.cmdoptions.use_pep517

Initial value:

=  partial(
    Option,
    "--use-pep517",
    dest="use_pep517",
    action="store_true",
    default=None,
    help="Use PEP 517 for building source distributions "
    "(use --no-use-pep517 to force legacy behaviour).",
)

Classes

Functions

Variables

Detailed Description

Function Documentation

◆ _convert_python_version()

◆ _get_format_control()

◆ _handle_merge_hash()

◆ _handle_no_cache_dir()

◆ _handle_no_use_pep517()

◆ _handle_python_version()

◆ check_dist_restriction()

◆ make_option_group()

◆ raise_option_error()

Variable Documentation

◆ abis

◆ ALWAYS_ENABLED_FEATURES

◆ build_options

◆ cache_dir

◆ cert

◆ check_build_deps

◆ client_cert

◆ config_settings

◆ disable_pip_version_check

◆ general_group

◆ global_options

◆ hash

◆ ignore_requires_python

◆ implementation

◆ index_group

◆ index_url

◆ list_exclude

◆ list_path

◆ no_build_isolation

◆ no_cache

◆ no_clean

◆ no_deps

◆ no_index

◆ no_python_version_warning

◆ no_use_pep517

◆ platforms

◆ pre

◆ python_version

◆ require_hashes

◆ root_user_action

◆ src

◆ use_deprecated_feature

◆ use_new_feature

◆ use_pep517