1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
|
``pyproject_hooks``
===================
.. autoclass:: pyproject_hooks.BuildBackendHookCaller
:special-members: __init__
:members:
.. _Subprocess Runners:
Subprocess Runners
------------------
A subprocess runner is a function that is expected to execute the subprocess. They are typically used for controlling how output is presented from the subprocess.
The subprocess runners provided out-of-the-box with this library are:
.. autofunction:: pyproject_hooks.default_subprocess_runner(...)
.. autofunction:: pyproject_hooks.quiet_subprocess_runner(...)
Custom Subprocess Runners
^^^^^^^^^^^^^^^^^^^^^^^^^
It is possible to provide a custom subprocess runner, that behaves differently. The expected protocol for subprocess runners is as follows:
.. function:: subprocess_runner_protocol(cmd, cwd=None, extra_environ=None)
:noindex:
:param cmd: The command and arguments to execute, as would be passed to :func:`subprocess.run`.
:type cmd: typing.Sequence[str]
:param cwd: The working directory that must be used for the subprocess.
:type cwd: typing.Optional[str]
:param extra_environ: Mapping of environment variables (name to value) which must be set for the subprocess execution.
:type extra_environ: typing.Optional[typing.Mapping[str, str]]
:rtype: None
Since this codebase is currently Python 3.7-compatible, the type annotation for this protocol is only available to type checkers. To annotate a variable as a subprocess runner, you can do something along the lines of:
.. code-block:: python
from typing import TYPE_CHECKING
if TYPE_CHECKING:
from pyproject_hooks import SubprocessRunner
# Example usage
def build(awesome_runner: "SubprocessRunner") -> None:
...
Exceptions
----------
Each exception has public attributes with the same name as their constructors.
.. autoexception:: pyproject_hooks.BackendUnavailable
.. autoexception:: pyproject_hooks.HookMissing
.. autoexception:: pyproject_hooks.UnsupportedOperation
|
