pip._internal.utils.misc.ConfiguredBuildBackendHookCaller Class Reference

Inheritance diagram for pip._internal.utils.misc.ConfiguredBuildBackendHookCaller:

Collaboration diagram for pip._internal.utils.misc.ConfiguredBuildBackendHookCaller:

Public Member Functions
	__init__ (self, Any config_holder, str source_dir, str build_backend, Optional[str] backend_path=None, Optional[Callable[..., None]] runner=None, Optional[str] python_executable=None)
str	build_wheel (self, str wheel_directory, Optional[Dict[str, Union[str, List[str]]]] config_settings=None, Optional[str] metadata_directory=None)
str	build_sdist (self, str sdist_directory, Optional[Dict[str, Union[str, List[str]]]] config_settings=None)
str	build_editable (self, str wheel_directory, Optional[Dict[str, Union[str, List[str]]]] config_settings=None, Optional[str] metadata_directory=None)
List[str]	get_requires_for_build_wheel (self, Optional[Dict[str, Union[str, List[str]]]] config_settings=None)
List[str]	get_requires_for_build_sdist (self, Optional[Dict[str, Union[str, List[str]]]] config_settings=None)
List[str]	get_requires_for_build_editable (self, Optional[Dict[str, Union[str, List[str]]]] config_settings=None)
str	prepare_metadata_for_build_wheel (self, str metadata_directory, Optional[Dict[str, Union[str, List[str]]]] config_settings=None, bool _allow_fallback=True)
str	prepare_metadata_for_build_editable (self, str metadata_directory, Optional[Dict[str, Union[str, List[str]]]] config_settings=None, bool _allow_fallback=True)
Public Member Functions inherited from pip._vendor.pyproject_hooks._impl.BuildBackendHookCaller
	subprocess_runner (self, runner)

Public Attributes
	config_holder
Public Attributes inherited from pip._vendor.pyproject_hooks._impl.BuildBackendHookCaller
	source_dir
	build_backend
	backend_path
	python_executable

Additional Inherited Members
Protected Member Functions inherited from pip._vendor.pyproject_hooks._impl.BuildBackendHookCaller
	_supported_features (self)
	_call_hook (self, hook_name, kwargs)
Protected Attributes inherited from pip._vendor.pyproject_hooks._impl.BuildBackendHookCaller
	_subprocess_runner

Constructor & Destructor Documentation

__init__()

pip._internal.utils.misc.ConfiguredBuildBackendHookCaller.__init__	(		self,
		Any	source_dir,
		str	build_backend,
		str	backend_path,
		Optional[str]	runner = None,
		Optional[Callable[..., None]]	python_executable = None,
		Optional[str]	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 from pip._vendor.pyproject_hooks._impl.BuildBackendHookCaller.

Member Function Documentation

build_editable()

str pip._internal.utils.misc.ConfiguredBuildBackendHookCaller.build_editable	(		self,
		str	wheel_directory,
		Optional[Dict[str, Union[str, List[str]]]]	config_settings = None,
		Optional[str]	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 from pip._vendor.pyproject_hooks._impl.BuildBackendHookCaller.

build_sdist()

str pip._internal.utils.misc.ConfiguredBuildBackendHookCaller.build_sdist	(		self,
		str	sdist_directory,
		Optional[Dict[str, Union[str, List[str]]]]	config_settings = None
	)

Build an sdist from this project.

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

Reimplemented from pip._vendor.pyproject_hooks._impl.BuildBackendHookCaller.

build_wheel()

str pip._internal.utils.misc.ConfiguredBuildBackendHookCaller.build_wheel	(		self,
		str	wheel_directory,
		Optional[Dict[str, Union[str, List[str]]]]	config_settings = None,
		Optional[str]	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 from pip._vendor.pyproject_hooks._impl.BuildBackendHookCaller.

get_requires_for_build_editable()

List[str] pip._internal.utils.misc.ConfiguredBuildBackendHookCaller.get_requires_for_build_editable	(		self,
		Optional[Dict[str, Union[str, List[str]]]]	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 from pip._vendor.pyproject_hooks._impl.BuildBackendHookCaller.

get_requires_for_build_sdist()

List[str] pip._internal.utils.misc.ConfiguredBuildBackendHookCaller.get_requires_for_build_sdist	(		self,
		Optional[Dict[str, Union[str, List[str]]]]	config_settings = None
	)

Get additional dependencies required for building an sdist.

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

Reimplemented from pip._vendor.pyproject_hooks._impl.BuildBackendHookCaller.

get_requires_for_build_wheel()

List[str] pip._internal.utils.misc.ConfiguredBuildBackendHookCaller.get_requires_for_build_wheel	(		self,
		Optional[Dict[str, Union[str, List[str]]]]	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 from pip._vendor.pyproject_hooks._impl.BuildBackendHookCaller.

prepare_metadata_for_build_editable()

str pip._internal.utils.misc.ConfiguredBuildBackendHookCaller.prepare_metadata_for_build_editable	(		self,
		str	metadata_directory,
		Optional[Dict[str, Union[str, List[str]]]]	config_settings = None,
		bool	_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 from pip._vendor.pyproject_hooks._impl.BuildBackendHookCaller.

prepare_metadata_for_build_wheel()

str pip._internal.utils.misc.ConfiguredBuildBackendHookCaller.prepare_metadata_for_build_wheel	(		self,
		str	metadata_directory,
		Optional[Dict[str, Union[str, List[str]]]]	config_settings = None,
		bool	_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 from pip._vendor.pyproject_hooks._impl.BuildBackendHookCaller.

---

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

• docs/help/help-venv/lib/python3.12/site-packages/pip/_internal/utils/misc.py