pip API reference

203 public APIs from pip (pypa/pip) — 62 classes, 82 functions, 59 methods. Signatures extracted by static analysis of the actual source.

Repository: pypa/pip

Kind	Count
Classes	62
Functions	82
Methods	59

API list

classsrc.pip._internal.build_env.noop.NoOpBuildEnvironment

A no-op drop-in replacement for BuildEnvironment

classsrc.pip._internal.build_env.venv.VenvBuildEnvironment

A venv-based build environment.

classsrc.pip._internal.build_env.virtual.VirtualBuildEnvironment

Legacy build environment implementation.

methodsrc.pip._internal.cache.Cache.get_path_for_link(link:Link) -> str

Return a directory to store cached items in for link.

classsrc.pip._internal.cache.SimpleWheelCache

A cache of wheels for future installs.

funcsrc.pip._internal.cli.cmdoptions.check_build_constraints(options:Values) -> None

Function for validating build constraints options.

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

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

methodsrc.pip._internal.cli.index_command.SessionCommandMixin.get_default_session(options:Values) -> PipSession

Get a default-managed session.

funcsrc.pip._internal.cli.main_parser.create_main_parser() -> ConfigOptionParser

Creates and returns the main parser for pip's CLI

classsrc.pip._internal.cli.parser.PrettyHelpFormatter

A prettier/less verbose help formatter for optparse.

methodsrc.pip._internal.cli.parser.PrettyHelpFormatter.expand_default(option:optparse.Option) -> str

Overridden HelpFormatter.expand_default() which colorizes flags.

methodsrc.pip._internal.cli.parser.PrettyHelpFormatter.format_option(option:optparse.Option) -> str

Overridden method with Rich support.

classsrc.pip._internal.cli.parser.UpdatingDefaultsHelpFormatter

Custom help formatter for use in ConfigOptionParser.

classsrc.pip._internal.commands.cache.CacheCommand

Inspect and manage pip's wheel cache.

classsrc.pip._internal.commands.check.CheckCommand

Verify installed packages have compatible dependencies.

classsrc.pip._internal.commands.completion.CompletionCommand

A helper command to be used for command completion.

methodsrc.pip._internal.commands.completion.CompletionCommand.run(options:Values, args:list[str]) -> int

Prints the completion code of the given shell

classsrc.pip._internal.commands.configuration.ConfigurationCommand

Manage local and global configuration.

methodsrc.pip._internal.commands.configuration.ConfigurationCommand.print_config_file_values(variant:Kind, fname:str) -> None

Get key-value pairs from the file of a variant

funcsrc.pip._internal.commands.create_command(name:str, **kwargs:Any) -> Command

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

classsrc.pip._internal.commands.debug.DebugCommand

Display debug information.

classsrc.pip._internal.commands.freeze.FreezeCommand

Output installed packages in requirements format.

funcsrc.pip._internal.commands.get_similar_commands(name:str) -> str | None

Command name auto-correct.

classsrc.pip._internal.commands.hash.HashCommand

Compute a hash of a local package archive.

classsrc.pip._internal.commands.help.HelpCommand

Show help for commands

classsrc.pip._internal.commands.index.IndexCommand

Inspect information available from package indexes.

classsrc.pip._internal.commands.list.ListCommand

List installed packages, including editables.

funcsrc.pip._internal.commands.search.transform_hits(hits:list[dict[str, str]]) -> list[TransformedHit]

The list from pypi is really a list of versions.

classsrc.pip._internal.commands.show.ShowCommand

Show information about one or more installed packages.

func

src.pip._internal.commands.show.search_packages_info(query:list[str], include_files:bool) -> Generator[_PackageInfo, None, None]

Gather details from installed distributions.

classsrc.pip._internal.commands.uninstall.UninstallCommand

Uninstall packages.

classsrc.pip._internal.configuration.Configuration

Handles management of configuration.

methodsrc.pip._internal.configuration.Configuration.get_value(key:str) -> Any

Get a value from the configuration.

methodsrc.pip._internal.configuration.Configuration.get_values_in_config(variant:Kind) -> dict[str, Any]

Get values present in a config file

methodsrc.pip._internal.configuration.Configuration.save() -> None

Save the current in-memory state.

methodsrc.pip._internal.configuration.Configuration.set_value(key:str, value:Any) -> None

Modify a value in the configuration.

methodsrc.pip._internal.configuration.Configuration.unset_value(key:str) -> None

Unset a value in the configuration.

classsrc.pip._internal.distributions.base.AbstractDistribution

A base class for handling installable artifacts.

classsrc.pip._internal.distributions.installed.InstalledDistribution

Represents an installed package.

classsrc.pip._internal.distributions.sdist.SourceDistribution

Represents a source distribution.

methodsrc.pip._internal.distributions.sdist.SourceDistribution.build_tracker_id() -> str | None

Identify this requirement uniquely by its link.

classsrc.pip._internal.distributions.wheel.WheelDistribution

Represents a wheel distribution.

classsrc.pip._internal.exceptions.BadCommand

Raised when virtualenv or a command is not found

classsrc.pip._internal.exceptions.BuildDependencyInstallError

Raised when build dependencies cannot be installed.

classsrc.pip._internal.exceptions.CommandError

Raised when there is an error in command-line arguments

classsrc.pip._internal.exceptions.ConfigurationError

General exception in configuration

classsrc.pip._internal.exceptions.DiagnosticPipError

An error, that presents diagnostic information to the user.

classsrc.pip._internal.exceptions.ExternallyManagedEnvironment

The current environment is externally managed.

classsrc.pip._internal.exceptions.FailedToPrepareCandidate

Raised when we fail to prepare a candidate (i.e.

classsrc.pip._internal.exceptions.HashErrors

Multiple HashError instances rolled into one for reporting

classsrc.pip._internal.exceptions.HashMismatch

Distribution file hash values don't match.

classsrc.pip._internal.exceptions.HashMissing

A hash was needed for a requirement but is absent.

classsrc.pip._internal.exceptions.InstallationError

General exception during installation

classsrc.pip._internal.exceptions.InstallationSubprocessError

A subprocess call failed.

classsrc.pip._internal.exceptions.InvalidWheel

Invalid (e.g.

classsrc.pip._internal.exceptions.InvalidWheelFilename

Invalid wheel filename.

classsrc.pip._internal.exceptions.MetadataInconsistent

Built metadata contains inconsistent information.

classsrc.pip._internal.exceptions.MetadataInvalid

Metadata is invalid.

classsrc.pip._internal.exceptions.NetworkConnectionError

HTTP connection error

classsrc.pip._internal.exceptions.PipError

The base pip error.

classsrc.pip._internal.exceptions.PreviousBuildDirError

Raised when there's a previous conflicting build directory

classsrc.pip._internal.exceptions.UnsupportedWheel

Unsupported wheel.

classsrc.pip._internal.exceptions.VenvCreationError

Raised when a virtual environment can't be created.

classsrc.pip._internal.exceptions.VenvImportError

Raised when 'venv' can't be imported.

classsrc.pip._internal.index.collector.IndexContent

Represents one response (or page), along with its URL.

methodsrc.pip._internal.index.package_finder.LinkEvaluator.evaluate_link(link:Link) -> tuple[LinkType, str]

Determine whether a link is a candidate for installation.

classsrc.pip._internal.index.package_finder.PackageFinder

This finds packages.

method

src.pip._internal.index.package_finder.PackageFinder.create(link_collector:LinkCollector, selection_prefs:SelectionPreferences, target_python:TargetPython | None=None, uploaded_prior_to:datetime.datetime | None=None) -> PackageFinder

Create a PackageFinder.

funcsrc.pip._internal.locations.base.change_root(new_root:str, pathname:str) -> str

Return 'pathname' with 'new_root' prepended.

funcsrc.pip._internal.locations.get_platlib() -> str

Return the default platform-shared lib location.

funcsrc.pip._internal.locations.get_purelib() -> str

Return the default pure-Python lib location.

funcsrc.pip._internal.metadata._json.msg_to_json(msg:Message) -> dict[str, Any]

Convert a Message object into a JSON-compatible dictionary.

methodsrc.pip._internal.metadata.base.BaseDistribution.direct_url() -> DirectUrl | None

Obtain a DirectUrl from this distribution.

methodsrc.pip._internal.metadata.base.BaseDistribution.from_directory(directory:str) -> BaseDistribution

Load the distribution from a metadata directory.

methodsrc.pip._internal.metadata.base.BaseDistribution.from_wheel(wheel:Wheel, name:str) -> BaseDistribution

Load the distribution from a given wheel.

methodsrc.pip._internal.metadata.base.BaseDistribution.installed_as_egg() -> bool

Whether this distribution is installed as an egg.

methodsrc.pip._internal.metadata.base.BaseDistribution.installed_location() -> str | None

The distribution's "installed" location.

methodsrc.pip._internal.metadata.base.BaseDistribution.is_file(path:InfoPath) -> bool

Check whether an entry in the info directory is a file.

methodsrc.pip._internal.metadata.base.BaseDistribution.iter_dependencies(extras:Collection[str]=()) -> Iterable[Requirement]

Dependencies of this distribution.

methodsrc.pip._internal.metadata.base.BaseDistribution.iter_distutils_script_names() -> Iterator[str]

Find distutils 'scripts' entries metadata.

methodsrc.pip._internal.metadata.base.BaseDistribution.iter_provided_extras() -> Iterable[NormalizedName]

Extras provided by this distribution.

methodsrc.pip._internal.metadata.base.BaseDistribution.iter_raw_dependencies() -> Iterable[str]

Raw Requires-Dist metadata.

methodsrc.pip._internal.metadata.base.BaseDistribution.location() -> str | None

Where the distribution is loaded from.

methodsrc.pip._internal.metadata.base.BaseDistribution.metadata() -> email.message.Message

Metadata of distribution parsed from e.g.

methodsrc.pip._internal.metadata.base.BaseDistribution.raw_name() -> str

Value of "Name:" in distribution metadata.

methodsrc.pip._internal.metadata.base.BaseDistribution.read_text(path:InfoPath) -> str

Read a file in the info directory.

classsrc.pip._internal.metadata.base.BaseEnvironment

An environment containing distributions to introspect.

funcsrc.pip._internal.metadata.get_environment(paths:list[str] | None) -> BaseEnvironment

Get a representation of the environment specified by ``paths``.

classsrc.pip._internal.metadata.importlib._compat.BasePath

A protocol that various path objects conform.

func

src.pip._internal.metadata.importlib._compat.get_dist_canonical_name(dist:importlib.metadata.Distribution) -> NormalizedName

Get the distribution's normalized name.

classsrc.pip._internal.models.candidate.InstallationCandidate

Represents a potential "candidate" for installation.

classsrc.pip._internal.models.link.Link

Represents a parsed link from a Package Index's simple URL

methodsrc.pip._internal.models.link.Link.is_hash_allowed(hashes:Hashes | None) -> bool

Return True if the link has a hash and it is allowed by `hashes`.

methodsrc.pip._internal.models.link.Link.netloc() -> str

This can contain auth information.

classsrc.pip._internal.models.link.LinkHash

Links to content may have embedded hash values.

methodsrc.pip._internal.models.link.LinkHash.is_hash_allowed(hashes:Hashes | None) -> bool

Return True if the current hash is allowed by `hashes`.

funcsrc.pip._internal.models.link.as_path_component(name:str) -> PathComponent

Like ``_to_path_component`` but reject the empty result.

funcsrc.pip._internal.models.link.join_within_directory(directory:str, component:PathComponent) -> str

Join a single path ``component`` onto ``directory``.

methodsrc.pip._internal.models.release_control.ReleaseControl.allows_prereleases(canonical_name:NormalizedName) -> bool | None

Determine if pre-releases are allowed for a package.

method

src.pip._internal.models.release_control.ReleaseControl.handle_mutual_excludes(value:str, target:set[str], other:set[str], attr_name:str) -> None

Parse and apply release control option value.

classsrc.pip._internal.models.wheel.Wheel

A wheel file

methodsrc.pip._internal.models.wheel.Wheel.get_formatted_file_tags() -> list[str]

Return the wheel's tags as a sorted list of strings.

methodsrc.pip._internal.models.wheel.Wheel.supported(tags:Iterable[Tag]) -> bool

Return whether the wheel is compatible with one of the given tags.

classsrc.pip._internal.network.auth.KeyRingBaseProvider

Keyring base provider interface

classsrc.pip._internal.network.auth.KeyRingNullProvider

Keyring null provider

classsrc.pip._internal.network.auth.KeyRingPythonProvider

Keyring interface which uses locally imported `keyring`

funcsrc.pip._internal.network.download.sanitize_content_filename(filename:str) -> str

Sanitize the "filename" value from a Content-Disposition header.

classsrc.pip._internal.network.lazy_wheel.LazyZipOverHTTP

File-like object mapped to a ZIP file over HTTP.

methodsrc.pip._internal.network.lazy_wheel.LazyZipOverHTTP.close() -> None

Close the file.

methodsrc.pip._internal.network.lazy_wheel.LazyZipOverHTTP.closed() -> bool

Whether the file is closed.

methodsrc.pip._internal.network.lazy_wheel.LazyZipOverHTTP.mode() -> str

Opening mode, which is always rb.

methodsrc.pip._internal.network.lazy_wheel.LazyZipOverHTTP.name() -> str

Path to the underlying file.

methodsrc.pip._internal.network.lazy_wheel.LazyZipOverHTTP.read(size:int=-1) -> bytes

Read up to size bytes from the object and return them.

methodsrc.pip._internal.network.lazy_wheel.LazyZipOverHTTP.readable() -> bool

Return whether the file is readable, which is True.

methodsrc.pip._internal.network.lazy_wheel.LazyZipOverHTTP.seek(offset:int, whence:int=0) -> int

Change stream position and return the new absolute position.

methodsrc.pip._internal.network.lazy_wheel.LazyZipOverHTTP.tell() -> int

Return the current position.

methodsrc.pip._internal.network.lazy_wheel.LazyZipOverHTTP.truncate(size:int | None=None) -> int

Resize the stream to the given size in bytes.

methodsrc.pip._internal.network.lazy_wheel.LazyZipOverHTTP.writable() -> bool

Return False.

func

src.pip._internal.network.lazy_wheel.dist_from_wheel_url(name:NormalizedName, url:str, session:PipSession) -> BaseDistribution

Return a distribution object from the given wheel URL.

funcsrc.pip._internal.network.session.user_agent() -> str

Return a string representing the user agent.

func

src.pip._internal.network.utils.response_chunks(response:Response, chunk_size:int=DOWNLOAD_CHUNK_SIZE) -> Generator[bytes, None, None]

Given a requests Response, provide the data chunks.

funcsrc.pip._internal.operations.install.wheel.pyc_output_path(path:str) -> str

Return the path the pyc file would have been written to.

func

src.pip._internal.operations.install.wheel.record_installed(srcfile:RecordPath, destfile:str, modified:bool=False) -> None

Map archive RECORD paths to installation RECORD paths.

classsrc.pip._internal.operations.prepare.RequirementPreparer

Prepares a Requirement

method

src.pip._internal.operations.prepare.RequirementPreparer.prepare_editable_requirement(req:InstallRequirement) -> BaseDistribution

Prepare an editable requirement.

method

src.pip._internal.operations.prepare.RequirementPreparer.prepare_installed_requirement(req:InstallRequirement, skip_reason:str) -> BaseDistribution

Prepare an already-installed requirement.

func

src.pip._internal.operations.prepare.get_file_url(link:Link, download_dir:str | None=None, hashes:Hashes | None=None) -> File

Get file and optionally check its hash.

funcsrc.pip._internal.pyproject.load_pyproject_toml(pyproject_toml:str, setup_py:str, req_name:str) -> BuildSystemDetails

Load the pyproject.toml file.

funcsrc.pip._internal.req.constructors.check_first_requirement_in_file(filename:str) -> None

Check if file is parsable as a requirements file.

funcsrc.pip._internal.req.req_file.break_args_options(line:str) -> tuple[str, str]

Break up the line into an args and options string.

funcsrc.pip._internal.req.req_file.build_parser() -> optparse.OptionParser

Return a parser for parsing requirement lines

funcsrc.pip._internal.req.req_file.ignore_comments(lines_enum:ReqFileLines) -> ReqFileLines

Strips comments and filter empty lines.

funcsrc.pip._internal.req.req_uninstall.compress_for_rename(paths:Iterable[str]) -> set[str]

Returns a set containing the paths that need to be renamed.

method

src.pip._internal.resolution.legacy.resolver.Resolver.get_installation_order(req_set:RequirementSet) -> list[InstallRequirement]

Create the installation order.

methodsrc.pip._internal.resolution.resolvelib.base.Candidate.name() -> str

The name identifying this candidate in the resolver.

methodsrc.pip._internal.resolution.resolvelib.base.Candidate.project_name() -> NormalizedName

The "project name" of the candidate.

methodsrc.pip._internal.resolution.resolvelib.base.Requirement.project_name() -> NormalizedName

The "project name" of a requirement.

funcsrc.pip._internal.resolution.resolvelib.candidates.as_base_candidate(candidate:Candidate) -> BaseCandidate | None

The runtime version of BaseCandidate.

method

src.pip._internal.resolution.resolvelib.factory.Factory.get_wheel_cache_entry(link:Link, name:str | None) -> CacheEntry | None

Look up the link in the wheel cache.

classsrc.pip._internal.resolution.resolvelib.provider.PipProvider

Pip's provider implementation for resolvelib.

methodsrc.pip._internal.resolution.resolvelib.provider.PipProvider.constraints() -> dict[str, Constraint]

Public view of user-specified constraints.

classsrc.pip._internal.resolution.resolvelib.requirements.UnsatisfiableRequirement

A requirement that cannot be satisfied.

funcsrc.pip._internal.utils._jaraco_text.drop_comment(line)

Drop comments.

funcsrc.pip._internal.utils._log.getLogger(name:str) -> VerboseLogger

logging.getLogger, but ensures our VerboseLogger class is returned

funcsrc.pip._internal.utils._log.init_logging() -> None

funcsrc.pip._internal.utils.compat.get_locale_encoding() -> str

Return the locale encoding.

funcsrc.pip._internal.utils.compat.get_path_uid(path:str) -> int

Return path's uid.

funcsrc.pip._internal.utils.datetime.parse_iso_datetime(isodate:str) -> datetime.datetime

Convert an ISO format string to a datetime.

funcsrc.pip._internal.utils.direct_url_helpers.direct_url_as_pep440_direct_reference(direct_url:DirectUrl, name:str) -> str

Convert a DirectUrl to a pip requirement string.

funcsrc.pip._internal.utils.filesystem.subdirs_without_files(path:str) -> Generator[Path]

Yields every subdirectory of +path+ that has no files under it.

funcsrc.pip._internal.utils.filetypes.is_archive_file(name:str) -> bool

Return True if `name` is a considered as an archive file.

funcsrc.pip._internal.utils.logging.capture_logging() -> Generator[StringIO, None, None]

Capture all pip logs in a buffer temporarily.

funcsrc.pip._internal.utils.misc.ask(message:str, options:Iterable[str]) -> str

Ask the message interactively, with the given possible responses

funcsrc.pip._internal.utils.misc.ask_input(message:str) -> str

Ask for input interactively.

funcsrc.pip._internal.utils.misc.ask_password(message:str) -> str

Ask for a password interactively.

funcsrc.pip._internal.utils.misc.build_netloc(host:str, port:int | None) -> str

Build a netloc from a host-port pair

funcsrc.pip._internal.utils.misc.build_url_from_netloc(netloc:str, scheme:str='https') -> str

Build a full URL from a netloc.

funcsrc.pip._internal.utils.misc.ensure_dir(path:str) -> None

os.path.makedirs without EEXIST.

funcsrc.pip._internal.utils.misc.hash_file(path:str, blocksize:int=1 << 20) -> tuple[Any, int]

Return (hash, length) for path using hashlib.sha256()

funcsrc.pip._internal.utils.misc.is_console_interactive() -> bool

Is this console interactive?

funcsrc.pip._internal.utils.misc.is_installable_dir(path:str) -> bool

Is path is a directory containing pyproject.toml or setup.py?

funcsrc.pip._internal.utils.misc.looks_like_ci() -> bool

Return whether it looks like pip is running under CI.

funcsrc.pip._internal.utils.misc.normalize_path(path:str, resolve_symlinks:bool=True) -> str

Convert a path to its canonical, case-normalized, absolute version.

funcsrc.pip._internal.utils.misc.pairwise(iterable:Iterable[Any]) -> Iterator[tuple[Any, Any]]

Return paired elements.

funcsrc.pip._internal.utils.misc.parse_netloc(netloc:str) -> tuple[str | None, int | None]

Return the host-port pair from a netloc.

funcsrc.pip._internal.utils.misc.read_chunks(file:BinaryIO, size:int=FILE_CHUNK_SIZE) -> Generator[bytes, None, None]

Yield pieces of data from a file-like object until EOF.

funcsrc.pip._internal.utils.misc.redact_auth_from_requirement(req:Requirement) -> str

Replace the password in a given requirement url with ****.

funcsrc.pip._internal.utils.misc.redact_auth_from_url(url:str) -> str

Replace the password in a given url with ****.

funcsrc.pip._internal.utils.misc.redact_netloc(netloc:str) -> str

Replace the sensitive data in a netloc with "****", if it exists.

funcsrc.pip._internal.utils.misc.remove_auth_from_url(url:str) -> str

Return a copy of url with 'username:password@' removed.

funcsrc.pip._internal.utils.misc.renames(old:str, new:str) -> None

Like os.renames(), but handles renaming across devices.

funcsrc.pip._internal.utils.misc.split_auth_from_netloc(netloc:str) -> NetlocTuple

Parse out and remove the auth information from a netloc.

funcsrc.pip._internal.utils.misc.splitext(path:str) -> tuple[str, str]

Like os.path.splitext, but take off .tar too

funcsrc.pip._internal.utils.misc.strtobool(val:str) -> int

Convert a string representation of truth to true (1) or false (0).

funcsrc.pip._internal.utils.misc.tabulate(rows:Iterable[Iterable[Any]]) -> tuple[list[str], list[int]]

Return a list of formatted rows and a list of column sizes.

funcsrc.pip._internal.utils.misc.warn_if_run_as_root() -> None

Output a warning for sudo users on Unix.

funcsrc.pip._internal.utils.packaging.get_requirement(req_string:str) -> Requirement

Construct a packaging.Requirement object with caching

funcsrc.pip._internal.utils.retry.retry(wait:float, stop_after_delay:float) -> Callable[[Callable[P, T]], Callable[P, T]]

Decorator to automatically retry a function on error.

funcsrc.pip._internal.utils.subprocess.format_command_args(args:list[str] | CommandArgs) -> str

Format command arguments for display.

funcsrc.pip._internal.utils.subprocess.make_command(*args:str | HiddenText | CommandArgs) -> CommandArgs

Create a CommandArgs object.

funcsrc.pip._internal.utils.subprocess.reveal_command_args(args:list[str] | CommandArgs) -> list[str]

Return the arguments in their raw, unredacted form.

funcsrc.pip._internal.utils.subprocess.runner_with_spinner_message(message:str) -> Callable[..., None]

Provide a subprocess_runner that shows a spinner message.

classsrc.pip._internal.utils.temp_dir.TempDirectory

Helper class that owns and cleans up a temporary directory.

methodsrc.pip._internal.utils.temp_dir.TempDirectory.cleanup() -> None

Remove the temporary directory created and reset state

func

src.pip._internal.utils.temp_dir.TempDirectory.onerror(func:Callable[..., Any], path:Path, exc_val:BaseException) -> None

Log a warning for a `rmtree` error and continue

classsrc.pip._internal.utils.temp_dir.TempDirectoryTypeRegistry

Manages temp directory behavior

funcsrc.pip._internal.utils.unpacking.unpack_file(filename:str, location:str, content_type:str | None=None) -> None

Unpack ``filename`` into ``location``.

funcsrc.pip._internal.utils.unpacking.untar_file(filename:str, location:str) -> None

Untar the file (with path `filename`) to the destination `location`.

funcsrc.pip._internal.utils.urls.path_to_url(path:str) -> str

Convert a path to a file: URL.

funcsrc.pip._internal.utils.urls.url_to_path(url:str) -> str

Convert a file: URL to a path.

funcsrc.pip._internal.utils.virtualenv.running_under_virtualenv() -> bool

Checks if sys.base_prefix and sys.prefix match.

funcsrc.pip._internal.utils.wheel.wheel_dist_info_dir(source:ZipFile, name:str) -> str

Returns the name of the contained .dist-info directory.

funcsrc.pip._internal.utils.wheel.wheel_metadata(source:ZipFile, dist_info_dir:str) -> Message

Return the WHEEL metadata of an extracted wheel, if possible.

funcsrc.pip._internal.utils.wheel.wheel_version(wheel_data:Message) -> tuple[int, ...]

Given WHEEL metadata, return the parsed Wheel-Version.

methodsrc.pip._internal.vcs.git.Git.get_current_branch(location:str) -> str | None

Return the current branch, or None if HEAD isn't at a branch (e.g.

methodsrc.pip._internal.vcs.git.Git.get_remote_url(location:str) -> str

Return URL of the first remote encountered.

methodsrc.pip._internal.vcs.git.Git.get_subdirectory(location:str) -> str | None

Return the path to Python project root, relative to the repo root.

methodsrc.pip._internal.vcs.git.Git.has_commit(location:str, rev:str) -> bool

Check if rev is a commit that is available in the local repository.

methodsrc.pip._internal.vcs.git.Git.is_commit_id_equal(dest:str, name:str | None) -> bool

Return whether the current commit hash equals the given name.

funcsrc.pip._internal.vcs.versioncontrol.is_url(name:str) -> bool

Return true if the name looks like a URL.

func

src.pip._internal.vcs.versioncontrol.make_vcs_requirement_url(repo_url:str, rev:str, project_name:str, subdir:str | None=None) -> str

Return the URL for a VCS requirement.

func

src.pip._internal.wheel_builder.build(requirements:Iterable[InstallRequirement], wheel_cache:WheelCache, verify:bool, allow_editables:bool) -> BuildResult

Build wheels.

funcsrc.pip.main(args:list[str] | None=None) -> int

This is an internal API only meant for use by pip's own console scripts.

About this data

These signatures were extracted from the public source of pypa/pip using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries