pip-shims 0.3.4

Compatibility shims for pip versions 8 thru current.

Warning

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 with pip versions 8.0 through the current release (18.x). 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.

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')

Available Shims

pip-shims provides the following compatibility shims:

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