pip.wheel Namespace Reference

Classes
class	Wheel
class	WheelBuilder

Functions
def	rehash
def	binary
def	open_for_csv
def	fix_script
def	root_is_purelib
def	get_entrypoints
def	move_wheel_files
def	_unique
def	uninstallation_paths
def	wheel_version
def	check_compatibility

Variables
string	wheel_ext = '.whl'
tuple	VERSION_COMPATIBLE = (1, 0)
tuple	dist_info_re = re.compile(r"""^(?P<namever>(?P<name>.+?)(-(?P<ver>\d.+?))?) \.dist-info$""", re.VERBOSE)

Detailed Description

Support for installing and building the "wheel" binary package format.

Function Documentation

def pip.wheel._unique (   fn )

private

def pip.wheel.binary

(

s

)

def pip.wheel.check_compatibility	(		version,
			name
	)

Raises errors or warns if called with an incompatible Wheel-Version.

Pip should refuse to install a Wheel-Version that's a major series
ahead of what it's compatible with (e.g 2.0 > 1.1); and warn when
installing a version only minor version ahead (e.g 1.2 > 1.1).

version: a 2-tuple representing a Wheel-Version (Major, Minor)
name: name of wheel or package to raise exception about

:raises UnsupportedWheel: when an incompatible Wheel-Version is given

def pip.wheel.fix_script

(

path

)

Replace #!python with #!/path/to/python
Return True if file was changed.

def pip.wheel.get_entrypoints

(

filename

)

def pip.wheel.move_wheel_files	(		name,
			req,
			wheeldir,
			user = False,
			home = None,
			root = None,
			pycompile = True,
			scheme = None
	)

Install a wheel

def pip.wheel.open_for_csv	(		name,
			mode
	)

def pip.wheel.rehash	(		path,
			algo = 'sha256',
			blocksize = 1<<20
	)

Return (hash, length) for path using hashlib.new(algo)

def pip.wheel.root_is_purelib	(		name,
			wheeldir
	)

Return True if the extracted wheel in wheeldir should go into purelib.

def pip.wheel.uninstallation_paths

(

dist

)

Yield all the uninstallation paths for dist based on RECORD-without-.pyc

Yield paths to all the files in RECORD. For each .py file in RECORD, add
the .pyc in the same directory.

UninstallPathSet.add() takes care of the __pycache__ .pyc.

def pip.wheel.wheel_version

(

source_dir

)

Return the Wheel-Version of an extracted wheel, if possible.

Otherwise, return False if we couldn't parse / extract it.

Variable Documentation

tuple pip.wheel.dist_info_re = re.compile(r"""^(?P<namever>(?P<name>.+?)(-(?P<ver>\d.+?))?) \.dist-info$""", re.VERBOSE)

tuple pip.wheel.VERSION_COMPATIBLE = (1, 0)

string pip.wheel.wheel_ext = '.whl'