piptools._internal._pip_api package

Submodules

• piptools._internal._pip_api.cli_options module
  • postprocess_cli_options()
• piptools._internal._pip_api.install_requirements module
  • copy_install_requirement()
  • create_install_requirement()
  • create_install_requirement_from_line()
• piptools._internal._pip_api.package_finder module
  • finder_allows_all_prereleases()
  • finder_allows_prereleases_of_req()
• piptools._internal._pip_api.pip_version module
  • get_pip_version_for_python_executable()

Module contents

The piptools._pip_api subpackage defines an API layer on top of pip internals and usage. It is a private API for the rest of piptools to leverage.

piptools._internal._pip_api.copy_install_requirement(template: InstallRequirement, **extra_kwargs: Any) → InstallRequirement

Make a copy of a template InstallRequirement with extra kwargs.

piptools._internal._pip_api.create_install_requirement(name: str, version: str | Version, ireq: InstallRequirement) → InstallRequirement

piptools._internal._pip_api.create_install_requirement_from_line(*args: Any, **kwargs: Any) → InstallRequirement

piptools._internal._pip_api.finder_allows_all_prereleases(finder: PackageFinder) → bool

Check if a package finder will get prereleases for all requirements.

On older pip versions, this is not specific to the requirement, but on newer ones it is. However, --pre is translated internally to ":all:" on those versions.

piptools._internal._pip_api.finder_allows_prereleases_of_req(finder: PackageFinder, ireq: InstallRequirement) → bool

Check if a package finder will get prereleases for a given requirement.

On older pip versions, this is not specific to the requirement, but on newer ones it is.

piptools._internal._pip_api.get_pip_version_for_python_executable(python_executable: str) → Version

Return pip version for the given python executable.

piptools._internal._pip_api.postprocess_cli_options(options: Values) → None

After CLI parsing, pip processes options further to check various constraints and coalesce values. Emulate and/or invoke those same behaviors.