pip._vendor.pyproject_hooks._in_process._in_process Namespace Reference

Classes
class	_DummyException
class	BackendInvalid
class	BackendUnavailable
class	GotUnsupportedOperation
class	HookMissing

Functions
	write_json (obj, path, **kwargs)
	read_json (path)
	contained_in (filename, directory)
	_build_backend ()
	_supported_features ()
	get_requires_for_build_wheel (config_settings)
	get_requires_for_build_editable (config_settings)
	prepare_metadata_for_build_wheel (metadata_directory, config_settings, _allow_fallback)
	prepare_metadata_for_build_editable (metadata_directory, config_settings, _allow_fallback)
	_dist_info_files (whl_zip)
	_get_wheel_metadata_from_wheel (whl_basename, metadata_directory, config_settings)
	_find_already_built_wheel (metadata_directory)
	build_wheel (wheel_directory, config_settings, metadata_directory=None)
	build_editable (wheel_directory, config_settings, metadata_directory=None)
	get_requires_for_build_sdist (config_settings)
	build_sdist (sdist_directory, config_settings)
	main ()

Variables
str	WHEEL_BUILT_MARKER = 'PEP517_ALREADY_BUILT_WHEEL'
dict	HOOK_NAMES

Detailed Description

This is invoked in a subprocess to call the build backend hooks.

It expects:
- Command line args: hook_name, control_dir
- Environment variables:
      PEP517_BUILD_BACKEND=entry.point:spec
      PEP517_BACKEND_PATH=paths (separated with os.pathsep)
- control_dir/input.json:
  - {"kwargs": {...}}

Results:
- control_dir/output.json
  - {"return_val": ...}

Function Documentation

_build_backend()

pip._vendor.pyproject_hooks._in_process._in_process._build_backend ( )

protected

Find and load the build backend

_dist_info_files()

pip._vendor.pyproject_hooks._in_process._in_process._dist_info_files (   whl_zip )

protected

Identify the .dist-info folder inside a wheel ZipFile.

_find_already_built_wheel()

pip._vendor.pyproject_hooks._in_process._in_process._find_already_built_wheel (   metadata_directory )

protected

Check for a wheel already built during the get_wheel_metadata hook.

_get_wheel_metadata_from_wheel()

pip._vendor.pyproject_hooks._in_process._in_process._get_wheel_metadata_from_wheel (   whl_basename,   metadata_directory,   config_settings  )

protected

Extract the metadata from a wheel.

Fallback for when the build backend does not
define the 'get_wheel_metadata' hook.

_supported_features()

pip._vendor.pyproject_hooks._in_process._in_process._supported_features ( )

protected

Return the list of options features supported by the backend.

Returns a list of strings.
The only possible value is 'build_editable'.

build_editable()

pip._vendor.pyproject_hooks._in_process._in_process.build_editable	(		wheel_directory,
			config_settings,
			metadata_directory = None
	)

Invoke the optional build_editable hook.

If a wheel was already built in the
prepare_metadata_for_build_editable fallback, this
will copy it rather than rebuilding the wheel.

build_sdist()

pip._vendor.pyproject_hooks._in_process._in_process.build_sdist	(		sdist_directory,
			config_settings
	)

Invoke the mandatory build_sdist hook.

build_wheel()

pip._vendor.pyproject_hooks._in_process._in_process.build_wheel	(		wheel_directory,
			config_settings,
			metadata_directory = None
	)

Invoke the mandatory build_wheel hook.

If a wheel was already built in the
prepare_metadata_for_build_wheel fallback, this
will copy it rather than rebuilding the wheel.

contained_in()

pip._vendor.pyproject_hooks._in_process._in_process.contained_in	(		filename,
			directory
	)

Test if a file is located within the given directory.

get_requires_for_build_editable()

pip._vendor.pyproject_hooks._in_process._in_process.get_requires_for_build_editable

(

config_settings

)

Invoke the optional get_requires_for_build_editable hook

Returns [] if the hook is not defined.

get_requires_for_build_sdist()

pip._vendor.pyproject_hooks._in_process._in_process.get_requires_for_build_sdist

(

config_settings

)

Invoke the optional get_requires_for_build_wheel hook

Returns [] if the hook is not defined.

get_requires_for_build_wheel()

pip._vendor.pyproject_hooks._in_process._in_process.get_requires_for_build_wheel

(

config_settings

)

Invoke the optional get_requires_for_build_wheel hook

Returns [] if the hook is not defined.

prepare_metadata_for_build_editable()

pip._vendor.pyproject_hooks._in_process._in_process.prepare_metadata_for_build_editable	(		metadata_directory,
			config_settings,
			_allow_fallback
	)

Invoke optional prepare_metadata_for_build_editable

Implements a fallback by building an editable wheel if the hook isn't
defined, unless _allow_fallback is False in which case HookMissing is
raised.

prepare_metadata_for_build_wheel()

pip._vendor.pyproject_hooks._in_process._in_process.prepare_metadata_for_build_wheel	(		metadata_directory,
			config_settings,
			_allow_fallback
	)

Invoke optional prepare_metadata_for_build_wheel

Implements a fallback by building a wheel if the hook isn't defined,
unless _allow_fallback is False in which case HookMissing is raised.

Variable Documentation

HOOK_NAMES

dict pip._vendor.pyproject_hooks._in_process._in_process.HOOK_NAMES

Initial value:

=  {
    'get_requires_for_build_wheel',
    'prepare_metadata_for_build_wheel',
    'build_wheel',
    'get_requires_for_build_editable',
    'prepare_metadata_for_build_editable',
    'build_editable',
    'get_requires_for_build_sdist',
    'build_sdist',
    '_supported_features',
}