pip._internal.operations.install.wheel Namespace Reference

Classes
class	File
class	MissingCallableSuffix
class	PipScriptMaker
class	ScriptFile
class	ZipBackedFile

Functions
Tuple[str, str]	rehash (str path, int blocksize=1<< 20)
Dict[str, Any]	csv_io_kwargs (str mode)
bool	fix_script (str path)
bool	wheel_root_is_purelib (Message metadata)
Tuple[Dict[str, str], Dict[str, str]]	get_entrypoints (BaseDistribution dist)
Optional[str]	message_about_scripts_not_on_PATH (Sequence[str] scripts)
List[Tuple[str, str, str]]	_normalized_outrows (Iterable[InstalledCSVRow] outrows)
str	_record_to_fs_path (RecordPath record_path, str lib_dir)
RecordPath	_fs_to_record_path (str path, str lib_dir)
List[InstalledCSVRow]	get_csv_rows_for_installed (List[List[str]] old_csv_rows, Dict[RecordPath, RecordPath] installed, Set[RecordPath] changed, List[str] generated, str lib_dir)
List[str]	get_console_script_specs (Dict[str, str] console)
None	_raise_for_invalid_entrypoint (str specification)
None	_install_wheel (str name, ZipFile wheel_zip, str wheel_path, Scheme scheme, bool pycompile=True, bool warn_script_location=True, Optional[DirectUrl] direct_url=None, bool requested=False)
Generator[None, None, None]	req_error_context (str req_description)
None	install_wheel (str name, str wheel_path, Scheme scheme, str req_description, bool pycompile=True, bool warn_script_location=True, Optional[DirectUrl] direct_url=None, bool requested=False)

Variables
	logger = logging.getLogger(__name__)
	RecordPath = NewType("RecordPath", str)
	InstalledCSVRow = Tuple[RecordPath, str, Union[int, str]]

Detailed Description

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

Function Documentation

_install_wheel()

None pip._internal.operations.install.wheel._install_wheel ( str  name, ZipFile  wheel_zip, str  wheel_path, Scheme  scheme, bool   pycompile = True, bool   warn_script_location = True, Optional[DirectUrl]   direct_url = None, bool   requested = False  )

protected

Install a wheel.

:param name: Name of the project to install
:param wheel_zip: open ZipFile for wheel being installed
:param scheme: Distutils scheme dictating the install directories
:param req_description: String used in place of the requirement, for
    logging
:param pycompile: Whether to byte-compile installed Python files
:param warn_script_location: Whether to check that scripts are installed
    into a directory on PATH
:raises UnsupportedWheel:
    * when the directory holds an unpacked wheel with incompatible
      Wheel-Version
    * when the .dist-info dir does not match the wheel

_normalized_outrows()

List[Tuple[str, str, str]] pip._internal.operations.install.wheel._normalized_outrows ( Iterable[InstalledCSVRow]  outrows )

protected

Normalize the given rows of a RECORD file.

Items in each row are converted into str. Rows are then sorted to make
the value more predictable for tests.

Each row is a 3-tuple (path, hash, size) and corresponds to a record of
a RECORD file (see PEP 376 and PEP 427 for details).  For the rows
passed to this function, the size can be an integer as an int or string,
or the empty string.

csv_io_kwargs()

Dict[str, Any] pip._internal.operations.install.wheel.csv_io_kwargs

(

str

mode

)

Return keyword arguments to properly open a CSV file
in the given mode.

fix_script()

bool pip._internal.operations.install.wheel.fix_script

(

str

path

)

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

get_console_script_specs()

List[str] pip._internal.operations.install.wheel.get_console_script_specs

(

Dict[str, str]

console

)

Given the mapping from entrypoint name to callable, return the relevant
console script specs.

get_csv_rows_for_installed()

List[InstalledCSVRow] pip._internal.operations.install.wheel.get_csv_rows_for_installed	(	List[List[str]]	old_csv_rows,
		Dict[RecordPath, RecordPath]	installed,
		Set[RecordPath]	changed,
		List[str]	generated,
		str	lib_dir
	)

:param installed: A map from archive RECORD path to installation RECORD
    path.

message_about_scripts_not_on_PATH()

Optional[str] pip._internal.operations.install.wheel.message_about_scripts_not_on_PATH

(

Sequence[str]

scripts

)

Determine if any scripts are not on PATH and format a warning.
Returns a warning message if one or more scripts are not on PATH,
otherwise None.

rehash()

Tuple[str, str] pip._internal.operations.install.wheel.rehash	(	str	path,
		int	blocksize = 1 << 20
	)

Return (encoded_digest, length) for path using hashlib.sha256()