pip._vendor.distlib.wheel.Wheel Class Reference

Inheritance diagram for pip._vendor.distlib.wheel.Wheel:

Public Member Functions
def	__init__
def	filename
def	exists
def	tags
def	metadata
def	get_wheel_metadata
def	info
def	process_shebang
def	get_hash
def	write_record
def	write_records
def	build_zip
def	build
def	install
def	is_compatible
def	is_mountable
def	mount
def	unmount
def	verify
def	update

Public Attributes
	sign
	should_verify
	buildver
	pyver
	abi
	arch
	dirname
	name
	version

Static Public Attributes
tuple	wheel_version = (1, 1)
string	hash_kind = 'sha256'

Private Member Functions
def	_get_dylib_cache
def	_get_extensions

Private Attributes
	_filename

Detailed Description

Class to build and install from Wheel files (PEP 427).

Constructor & Destructor Documentation

def pip._vendor.distlib.wheel.Wheel.__init__	(		self,
			filename = None,
			sign = False,
			verify = False
	)

Initialise an instance using a (valid) filename.

Member Function Documentation

def pip._vendor.distlib.wheel.Wheel._get_dylib_cache (   self )

private

def pip._vendor.distlib.wheel.Wheel._get_extensions (   self )

private

def pip._vendor.distlib.wheel.Wheel.build	(		self,
			paths,
			tags = None,
			wheel_version = None
	)

Build a wheel from files in specified paths, and use any specified tags
when determining the name of the wheel.

def pip._vendor.distlib.wheel.Wheel.build_zip	(		self,
			pathname,
			archive_paths
	)

def pip._vendor.distlib.wheel.Wheel.exists

(

self

)

def pip._vendor.distlib.wheel.Wheel.filename

(

self

)

Build and return a filename from the various components.

def pip._vendor.distlib.wheel.Wheel.get_hash	(		self,
			data,
			hash_kind = None
	)

def pip._vendor.distlib.wheel.Wheel.get_wheel_metadata	(		self,
			zf
	)

def pip._vendor.distlib.wheel.Wheel.info

(

self

)

def pip._vendor.distlib.wheel.Wheel.install	(		self,
			paths,
			maker,
			kwargs
	)

Install a wheel to the specified paths. If kwarg ``warner`` is
specified, it should be a callable, which will be called with two
tuples indicating the wheel version of this software and the wheel
version in the file, if there is a discrepancy in the versions.
This can be used to issue any warnings to raise any exceptions.
If kwarg ``lib_only`` is True, only the purelib/platlib files are
installed, and the headers, scripts, data and dist-info metadata are
not written.

The return value is a :class:`InstalledDistribution` instance unless
``options.lib_only`` is True, in which case the return value is ``None``.

def pip._vendor.distlib.wheel.Wheel.is_compatible

(

self

)

Determine if a wheel is compatible with the running system.

def pip._vendor.distlib.wheel.Wheel.is_mountable

(

self

)

Determine if a wheel is asserted as mountable by its metadata.

def pip._vendor.distlib.wheel.Wheel.metadata

(

self

)

def pip._vendor.distlib.wheel.Wheel.mount	(		self,
			append = False
	)

def pip._vendor.distlib.wheel.Wheel.process_shebang	(		self,
			data
	)

def pip._vendor.distlib.wheel.Wheel.tags

(

self

)

def pip._vendor.distlib.wheel.Wheel.unmount

(

self

)

def pip._vendor.distlib.wheel.Wheel.update	(		self,
			modifier,
			dest_dir = None,
			kwargs
	)

Update the contents of a wheel in a generic way. The modifier should
be a callable which expects a dictionary argument: its keys are
archive-entry paths, and its values are absolute filesystem paths
where the contents the corresponding archive entries can be found. The
modifier is free to change the contents of the files pointed to, add
new entries and remove entries, before returning. This method will
extract the entire contents of the wheel to a temporary location, call
the modifier, and then use the passed (and possibly updated)
dictionary to write a new wheel. If ``dest_dir`` is specified, the new
wheel is written there -- otherwise, the original wheel is overwritten.

The modifier should return True if it updated the wheel, else False.
This method returns the same value the modifier returns.

def pip._vendor.distlib.wheel.Wheel.verify

(

self

)

def pip._vendor.distlib.wheel.Wheel.write_record	(		self,
			records,
			record_path,
			base
	)

def pip._vendor.distlib.wheel.Wheel.write_records	(		self,
			info,
			libdir,
			archive_paths
	)

Member Data Documentation

pip._vendor.distlib.wheel.Wheel._filename

private

pip._vendor.distlib.wheel.Wheel.abi

pip._vendor.distlib.wheel.Wheel.arch

pip._vendor.distlib.wheel.Wheel.buildver

pip._vendor.distlib.wheel.Wheel.dirname

string pip._vendor.distlib.wheel.Wheel.hash_kind = 'sha256'

static

pip._vendor.distlib.wheel.Wheel.name

pip._vendor.distlib.wheel.Wheel.pyver

pip._vendor.distlib.wheel.Wheel.should_verify

pip._vendor.distlib.wheel.Wheel.sign

pip._vendor.distlib.wheel.Wheel.version

tuple pip._vendor.distlib.wheel.Wheel.wheel_version = (1, 1)

static

---

The documentation for this class was generated from the following file:

• orbits/lib/python2.7/site-packages/pip/_vendor/distlib/wheel.py