pip-shims: Shims for importing packages from pip's internals.

Warning

The authors of pip do not condone the use of this package. Relying on pip's internals is a dangerous idea for your software as they are broken intentionally and regularly. This package may not always be completely updated up PyPI, so relying on it may break your code! User beware!

Installation

Install from PyPI:

$ pipenv install pip-shims

Install from Github:

$ pipenv install -e git+https://github.com/sarugaku/pip-shims.git#egg=pip-shims

Summary

pip-shims is a set of compatibilty access shims to the pip internal API. pip-shims provides compatibility across several pip releases. The shims are provided using a lazy import strategy by hacking a module by overloading a class instance's getattr method. This library exists due to my constant writing of the same set of import shims across many different libraries, including pipenv, pip-tools, requirementslib, and passa.

Pip Compatibility

Due to the fact that pip has adopted calver, this project provides shims for pip releases up to 2 years. pip earlier than that period MAY work but the compatibility isn't guaranteed by the continous integration. For example, the support for pip==20.0 will be dropped at 1/1/2023.

Usage

Importing a shim

You can use pip-shims to expose elements of pip's internal API by importing them:

>>> from pip_shims import Wheel
>>> mywheel = Wheel('/path/to/my/wheel.whl')

Resolving Dependencies

You can resolve the dependencies of a package using the shimmed resolver interface:

>>> from pip_shims.shims import resolve, InstallRequirement
>>> ireq = InstallRequirement.from_line("requests>=2.20")
>>> results = resolve(ireq)
>>> for k, v in results.items():
...    print("{0}: {1!r}".format(k, v))
requests: <InstallRequirement object: requests>=2.20 from https://files.pythonhosted.org/packages/51/bd/23c926cd341ea6b7dd0b2a00aba99ae0f828be89d72b2190f27c11d4b7fb/requests-2.22.0-py2.py3-none-any.whl#sha256=9cf5292fcd0f598c671cfc1e0d7d1a7f13bb8085e9a590f48c010551dc6c4b31 editable=False>
idna: <InstallRequirement object: idna<2.9,>=2.5 from https://files.pythonhosted.org/packages/14/2c/cd551d81dbe15200be1cf41cd03869a46fe7226e7450af7a6545bfc474c9/idna-2.8-py2.py3-none-any.whl#sha256=ea8b7f6188e6fa117537c3df7da9fc686d485087abf6ac197f9c46432f7e4a3c (from requests>=2.20) editable=False>
urllib3: <InstallRequirement object: urllib3!=1.25.0,!=1.25.1,<1.26,>=1.21.1 from https://files.pythonhosted.org/packages/b4/40/a9837291310ee1ccc242ceb6ebfd9eb21539649f193a7c8c86ba15b98539/urllib3-1.25.7-py2.py3-none-any.whl#sha256=a8a318824cc77d1fd4b2bec2ded92646630d7fe8619497b142c84a9e6f5a7293 (from requests>=2.20) editable=False>
chardet: <InstallRequirement object: chardet<3.1.0,>=3.0.2 from https://files.pythonhosted.org/packages/bc/a9/01ffebfb562e4274b6487b4bb1ddec7ca55ec7510b22e4c51f14098443b8/chardet-3.0.4-py2.py3-none-any.whl#sha256=fc323ffcaeaed0e0a02bf4d117757b98aed530d9ed4531e3e15460124c106691 (from requests>=2.20) editable=False>
certifi: <InstallRequirement object: certifi>=2017.4.17 from https://files.pythonhosted.org/packages/18/b0/8146a4f8dd402f60744fa380bc73ca47303cccf8b9190fd16a827281eac2/certifi-2019.9.11-py2.py3-none-any.whl#sha256=fd7c7c74727ddcf00e9acd26bba8da604ffec95bf1c2144e67aff7a8b50e6cef (from requests>=2.20) editable=False>

Available Shims

pip-shims provides the following compatibility shims:

Import Path	Import Name	Former Path
__version__ <shimmed> <shimmed> <shimmed> <shimmed>	pip_version build_wheel get_package_finder get_requirement_set get_resolver
<shimmed>	is_archive_file	download
<shimmed> <shimmed> <shimmed> <shimmed>	is_file_url make_preparer resolve shim_unpack	download
cache	WheelCache	wheel
cli	cmdoptions	cmdoptions
cli.base_command	Command	basecommand
cli.cmdoptions	index_group	cmdoptions
cli.cmdoptions	make_option_group	cmdoptions
cli.parser cli.req_command collector commands commands.freeze commands.install	ConfigOptionParser SessionCommandMixin LinkCollector commands_dict DEV_PKGS InstallCommand	baseparser
distributions distributions.base distributions.installed distributions.source distributions.wheel download download exceptions exceptions exceptions exceptions exceptions exceptions exceptions exceptions exceptions exceptions index index index index index locations	make_distribution_for_install_requirement AbstractDistribution InstalledDistribution SourceDistribution WheelDistribution path_to_url unpack_url BadCommand BestVersionAlreadyInstalled CommandError DistributionNotFound DistributionNotFound InstallationError PipError PreviousBuildDirError RequirementsFileParseError UninstallationError CandidateEvaluator CandidatePreferences LinkEvaluator PackageFinder parse_version USER_CACHE_DIR	operations.prepare.make_abstract_dist
models models.index	FormatControl PyPI	index
models.link models.search_scope models.selection_prefs models.target_python	Link SearchScope SelectionPreferences TargetPython	index
network.cache	SafeFileCache	download
operations.freeze operations.prepare	FrozenRequirement Downloader	<__init__>
operations.prepare operations.prepare pep425tags pep425tags	make_abstract_dist RequirementPreparer get_supported get_tags	req.req_set
req.constructors	_strip_extras	req.req_install
req.constructors	install_req_from_editable	req.req_install.InstallRequirement
req.constructors req.constructors req.req_file req.req_install req.req_set req.req_tracker req.req_tracker req.req_uninstall resolve	install_req_from_line install_req_from_req_string parse_requirements InstallRequirement RequirementSet get_requirement_tracker RequirementTracker UninstallPathSet Resolver	req.req_install.InstallRequirement
utils.compat utils.hashes	stdlib_pkgs FAVORITE_HASH	compat
utils.misc	get_installed_distributions	utils
utils.misc utils.temp_dir utils.temp_dir	is_installable_dir global_tempdir_manager TempDirectory	utils
utils.urls	url_to_path	download
vcs.versioncontrol wheel wheel wheel_builder wheel_builder wheel_builder	VcsSupport Wheel WheelBuilder build build_one build_one_inside_env	vcs.VcsSupport

pip-shims
Release 0.7.2

Release 0.7.2

0.7.3

0.7.2

0.7.1

0.7.0

0.6.0

0.5.3

0.5.2

0.5.1

0.5.0

0.4.0

Documentation

pip-shims: Shims for importing packages from pip's internals.

Warning

Installation

Summary

Pip Compatibility

Usage

Importing a shim

Resolving Dependencies

Available Shims

Stats

Development practices

Releases

Contributors

pip-shims Release 0.7.2

Release 0.7.2 Toggle Dropdown 0.7.3 0.7.2 0.7.1 0.7.0 0.6.0 0.5.3 0.5.2 0.5.1 0.5.0 0.4.0

Documentation

pip-shims: Shims for importing packages from pip's internals.

Warning

Installation

Summary

Pip Compatibility

Usage

Importing a shim

Resolving Dependencies

Available Shims

Stats

Development practices

Releases

Contributors

pip-shims
Release 0.7.2

Release 0.7.2

0.7.3

0.7.2

0.7.1

0.7.0

0.6.0

0.5.3

0.5.2

0.5.1

0.5.0

0.4.0