pip._vendor.pyproject_hooks._impl.BuildBackendHookCaller Class Reference

Inheritance diagram for pip._vendor.pyproject_hooks._impl.BuildBackendHookCaller:

Public Member Functions
	__init__ (self, source_dir, build_backend, backend_path=None, runner=None, python_executable=None)
	subprocess_runner (self, runner)
	get_requires_for_build_wheel (self, config_settings=None)
	prepare_metadata_for_build_wheel (self, metadata_directory, config_settings=None, _allow_fallback=True)
	build_wheel (self, wheel_directory, config_settings=None, metadata_directory=None)
	get_requires_for_build_editable (self, config_settings=None)
	prepare_metadata_for_build_editable (self, metadata_directory, config_settings=None, _allow_fallback=True)
	build_editable (self, wheel_directory, config_settings=None, metadata_directory=None)
	get_requires_for_build_sdist (self, config_settings=None)
	build_sdist (self, sdist_directory, config_settings=None)

Public Attributes
	source_dir
	build_backend
	backend_path
	python_executable

Protected Member Functions
	_supported_features (self)
	_call_hook (self, hook_name, kwargs)

Protected Attributes
	_subprocess_runner

Detailed Description

A wrapper to call the build backend hooks for a source directory.

Constructor & Destructor Documentation

__init__()

pip._vendor.pyproject_hooks._impl.BuildBackendHookCaller.__init__	(		self,
			source_dir,
			build_backend,
			backend_path = None,
			runner = None,
			python_executable = None
	)

:param source_dir: The source directory to invoke the build backend for
:param build_backend: The build backend spec
:param backend_path: Additional path entries for the build backend spec
:param runner: The :ref:`subprocess runner <Subprocess Runners>` to use
:param python_executable:
    The Python executable used to invoke the build backend

Reimplemented in pip._internal.utils.misc.ConfiguredBuildBackendHookCaller.

Member Function Documentation

_supported_features()

pip._vendor.pyproject_hooks._impl.BuildBackendHookCaller._supported_features (   self )

protected

Return the list of optional features supported by the backend.

build_editable()

pip._vendor.pyproject_hooks._impl.BuildBackendHookCaller.build_editable	(		self,
			wheel_directory,
			config_settings = None,
			metadata_directory = None
	)

Build an editable wheel from this project.

:returns:
    The name of the newly created wheel within ``wheel_directory``.

.. admonition:: Interaction with fallback

    If the ``build_editable`` hook was called in the fallback for
    :meth:`prepare_metadata_for_build_editable`, the build backend
    would not be invoked. Instead, the previously built wheel will be
    copied to ``wheel_directory`` and the name of that file will be
    returned.

Reimplemented in pip._internal.utils.misc.ConfiguredBuildBackendHookCaller.

build_sdist()

pip._vendor.pyproject_hooks._impl.BuildBackendHookCaller.build_sdist	(		self,
			sdist_directory,
			config_settings = None
	)

Build an sdist from this project.

:returns:
    The name of the newly created sdist within ``wheel_directory``.

Reimplemented in pip._internal.utils.misc.ConfiguredBuildBackendHookCaller.

build_wheel()

pip._vendor.pyproject_hooks._impl.BuildBackendHookCaller.build_wheel	(		self,
			wheel_directory,
			config_settings = None,
			metadata_directory = None
	)

Build a wheel from this project.

:returns:
    The name of the newly created wheel within ``wheel_directory``.

.. admonition:: Interaction with fallback

    If the ``build_wheel`` hook was called in the fallback for
    :meth:`prepare_metadata_for_build_wheel`, the build backend would
    not be invoked. Instead, the previously built wheel will be copied
    to ``wheel_directory`` and the name of that file will be returned.

Reimplemented in pip._internal.utils.misc.ConfiguredBuildBackendHookCaller.

get_requires_for_build_editable()

pip._vendor.pyproject_hooks._impl.BuildBackendHookCaller.get_requires_for_build_editable	(		self,
			config_settings = None
	)

Get additional dependencies required for building an editable wheel.

:returns: A list of :pep:`dependency specifiers <508>`.
:rtype: list[str]

.. admonition:: Fallback

    If the build backend does not defined a hook with this name, an
    empty list will be returned.

Reimplemented in pip._internal.utils.misc.ConfiguredBuildBackendHookCaller.

get_requires_for_build_sdist()

pip._vendor.pyproject_hooks._impl.BuildBackendHookCaller.get_requires_for_build_sdist	(		self,
			config_settings = None
	)

Get additional dependencies required for building an sdist.

:returns: A list of :pep:`dependency specifiers <508>`.
:rtype: list[str]

Reimplemented in pip._internal.utils.misc.ConfiguredBuildBackendHookCaller.

get_requires_for_build_wheel()

pip._vendor.pyproject_hooks._impl.BuildBackendHookCaller.get_requires_for_build_wheel	(		self,
			config_settings = None
	)

Get additional dependencies required for building a wheel.

:returns: A list of :pep:`dependency specifiers <508>`.
:rtype: list[str]

.. admonition:: Fallback

    If the build backend does not defined a hook with this name, an
    empty list will be returned.

Reimplemented in pip._internal.utils.misc.ConfiguredBuildBackendHookCaller.

prepare_metadata_for_build_editable()

pip._vendor.pyproject_hooks._impl.BuildBackendHookCaller.prepare_metadata_for_build_editable	(		self,
			metadata_directory,
			config_settings = None,
			_allow_fallback = True
	)

Prepare a ``*.dist-info`` folder with metadata for this project.

:returns: Name of the newly created subfolder within
          ``metadata_directory``, containing the metadata.
:rtype: str

.. admonition:: Fallback

    If the build backend does not define a hook with this name and
    ``_allow_fallback`` is truthy, the backend will be asked to build a
    wheel via the ``build_editable`` hook and the dist-info
    extracted from that will be returned.

Reimplemented in pip._internal.utils.misc.ConfiguredBuildBackendHookCaller.

prepare_metadata_for_build_wheel()

pip._vendor.pyproject_hooks._impl.BuildBackendHookCaller.prepare_metadata_for_build_wheel	(		self,
			metadata_directory,
			config_settings = None,
			_allow_fallback = True
	)

Prepare a ``*.dist-info`` folder with metadata for this project.

:returns: Name of the newly created subfolder within
          ``metadata_directory``, containing the metadata.
:rtype: str

.. admonition:: Fallback

    If the build backend does not define a hook with this name and
    ``_allow_fallback`` is truthy, the backend will be asked to build a
    wheel via the ``build_wheel`` hook and the dist-info extracted from
    that will be returned.

Reimplemented in pip._internal.utils.misc.ConfiguredBuildBackendHookCaller.

subprocess_runner()

pip._vendor.pyproject_hooks._impl.BuildBackendHookCaller.subprocess_runner	(		self,
			runner
	)

A context manager for temporarily overriding the default
:ref:`subprocess runner <Subprocess Runners>`.

.. code-block:: python

    hook_caller = BuildBackendHookCaller(...)
    with hook_caller.subprocess_runner(quiet_subprocess_runner):
        ...

---

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

• docs/help/help-venv/lib/python3.12/site-packages/pip/_vendor/pyproject_hooks/_impl.py