PipOption Class Reference

Inheritance diagram for PipOption:

Collaboration diagram for PipOption:

Static Public Attributes
	TYPES = Option.TYPES + ("path", "package_name")
	TYPE_CHECKER = Option.TYPE_CHECKER.copy()
Callable	help_
	options #
Callable	debug_mode
Callable	isolated_mode
Callable	require_virtualenv
Callable	override_externally_managed
Callable	python
Callable	verbose
Callable	no_color
Callable	version
Callable	quiet
Callable	progress_bar
Callable	log

Detailed Description

Definition at line 110 of file cmdoptions.py.

Field Documentation

debug_mode

Callable debug_mode

static

Initial value:

=  partial(
    Option,
    "--debug",
    dest="debug_mode",
    action="store_true",
    default=False,
    help=(
        "Let unhandled exceptions propagate outside the main subroutine, "
        "instead of logging them to stderr."
    ),
)

Definition at line 130 of file cmdoptions.py.

help_

Callable help_

static

Initial value:

=  partial(
    Option,
    "-h",
    "--help",
    dest="help",
    action="help",
    help="Show help.",
)

options #

Definition at line 121 of file cmdoptions.py.

isolated_mode

Callable isolated_mode

static

Initial value:

=  partial(
    Option,
    "--isolated",
    dest="isolated_mode",
    action="store_true",
    default=False,
    help=(
        "Run pip in an isolated mode, ignoring environment variables and user "
        "configuration."
    ),
)

Definition at line 142 of file cmdoptions.py.

log

Callable log

static

Initial value:

=  partial(
    PipOption,
    "--log",
    "--log-file",
    "--local-log",
    dest="log",
    metavar="path",
    type="path",
    help="Path to a verbose appending log.",
)

Definition at line 234 of file cmdoptions.py.

Referenced by VerboseLogger.verbose().

no_color

Callable no_color

static

Initial value:

=  partial(
    Option,
    "--no-color",
    dest="no_color",
    action="store_true",
    default=False,
    help="Suppress colored output.",
)

Definition at line 192 of file cmdoptions.py.

Referenced by Console._render_buffer().

override_externally_managed

Callable override_externally_managed

static

Initial value:

=  partial(
    Option,
    "--break-system-packages",
    dest="override_externally_managed",
    action="store_true",
    help="Allow pip to modify an EXTERNALLY-MANAGED Python installation",
)

Definition at line 167 of file cmdoptions.py.

progress_bar

Callable progress_bar

static

Initial value:

=  partial(
    Option,
    "--progress-bar",
    dest="progress_bar",
    type="choice",
    choices=["on", "off"],
    default="on",
    help="Specify whether the progress bar should be used [on, off] (default: on)",
)

Definition at line 224 of file cmdoptions.py.

python

Callable python

static

Initial value:

=  partial(
    Option,
    "--python",
    dest="python",
    help="Run pip with the specified Python interpreter.",
)

Definition at line 175 of file cmdoptions.py.

quiet

Callable quiet

static

Initial value:

=  partial(
    Option,
    "-q",
    "--quiet",
    dest="quiet",
    action="count",
    default=0,
    help=(
        "Give less output. Option is additive, and can be used up to 3"
        " times (corresponding to WARNING, ERROR, and CRITICAL logging"
        " levels)."
    ),
)

Definition at line 210 of file cmdoptions.py.

Referenced by Console._check_buffer().

require_virtualenv

Callable require_virtualenv

static

Initial value:

=  partial(
    Option,
    "--require-virtualenv",
    "--require-venv",
    dest="require_venv",
    action="store_true",
    default=False,
    help=(
        "Allow pip to only run in a virtual environment; "
        "exit with an error otherwise."
    ),
)

Definition at line 154 of file cmdoptions.py.

TYPE_CHECKER

TYPE_CHECKER = Option.TYPE_CHECKER.copy()

static

Definition at line 112 of file cmdoptions.py.

TYPES

TYPES = Option.TYPES + ("path", "package_name")

static

Definition at line 111 of file cmdoptions.py.

verbose

Callable verbose

static

Initial value:

=  partial(
    Option,
    "-v",
    "--verbose",
    dest="verbose",
    action="count",
    default=0,
    help="Give more output. Option is additive, and can be used up to 3 times.",
)

Definition at line 182 of file cmdoptions.py.

Referenced by SubprocessMixin.reader(), and SubprocessMixin.run_command().

version

Callable version

static

Initial value:

=  partial(
    Option,
    "-V",
    "--version",
    dest="version",
    action="store_true",
    help="Show version and exit.",
)

Definition at line 201 of file cmdoptions.py.

Referenced by AlreadyInstalledCandidate.__eq__(), Distribution.__eq__(), Distribution.__hash__(), InstallationCandidate.__repr__(), Distribution.__repr__(), Metadata.__repr__(), InstallationCandidate.__str__(), InstalledDistribution.__str__(), EggInfoDistribution.__str__(), PlatformDirsABC._append_app_name_and_version(), WrappedSocket._custom_validate(), Wheel._get_extensions(), Wheel.build(), Wheel.filename(), InstalledDistribution.get_distinfo_file(), Wheel.get_wheel_metadata(), LinuxDistribution.info(), Wheel.install(), LinuxDistribution.linux_distribution(), Wheel.metadata(), LinuxDistribution.name(), Distribution.name_and_version(), Distribution.provides(), Metadata.provides(), Wheel.update(), Wheel.verify(), and LinuxDistribution.version_parts().

---

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

• /home/liwuen/projects_dev/pqc-engineering-ssec-23/venv/lib/python3.12/site-packages/pip/_internal/cli/cmdoptions.py