API Documentation
This project exposes 2 modules:
build
module
build - A simple, correct PEP 517 package builder
-
exception
build.
BuildBackendException
Bases: Exception
Exception raised when the backend fails
-
exception
build.
BuildException
Bases: Exception
Exception raised by ProjectBuilder
-
class
build.
ProjectBuilder
(srcdir, python_executable='/usr/bin/python', scripts_dir=None)
Bases: object
The PEP 517 consumer API.
- Parameters
srcdir (str
) – The source directory
scripts_dir (Union
[bytes
, str
, None
]) – The location of the scripts dir (defaults to the folder where the python executable lives)
python_executable (Union
[bytes
, str
]) – The python executable where the backend lives
-
build
(distribution, outdir, config_settings=None)
Build a distribution.
- Parameters
-
- Return type
str
- Returns
The full path to the built distribution
-
property
build_dependencies
The dependencies defined in the pyproject.toml
’s
build-system.requires
field or the default build dependencies
if pyproject.toml
is missing or build-system
is undefined.
- Return type
Set
[str
]
-
check_dependencies
(distribution, config_settings=None)
Return the dependencies which are not satisfied from the combined set of
build_dependencies
and get_dependencies()
for a given
distribution.
- Parameters
-
- Return type
Set
[Tuple
[str
, …]]
- Returns
Set of variable-length unmet dependency tuples
-
get_dependencies
(distribution, config_settings=None)
Return the dependencies defined by the backend in addition to
build_dependencies
for a given distribution.
- Parameters
-
- Return type
Set
[str
]
-
property
python_executable
The Python executable used to invoke the backend.
- Return type
Union
[bytes
, str
]
-
property
scripts_dir
The folder where the scripts are stored for the python executable.
- Return type
Union
[None
, bytes
, str
]
-
exception
build.
TypoWarning
Bases: Warning
Warning raised when a potential typo is found
-
build.
check_dependency
(req_string, ancestral_req_strings=(), parent_extras=frozenset({}))
Verify that a dependency and all of its dependencies are met.
- Parameters
-
- Yields
Unmet dependencies
- Return type
Iterator
[Tuple
[str
, …]]
build.env
module
Creates and manages isolated build environments.
-
class
build.env.
IsolatedEnv
Bases: object
Abstract base of isolated build environments, as required by the build project.
-
abstract property
executable
The executable of the isolated build environment.
- Return type
str
-
abstract
install
(requirements)
Install packages from PEP 508 requirements in the isolated build environment.
- Parameters
requirements (Iterable
[str
]) – PEP 508 requirements
- Return type
None
-
abstract property
scripts_dir
The scripts directory of the isolated build environment.
- Return type
str
-
class
build.env.
IsolatedEnvBuilder
Bases: object
Builder object for isolated environments.