API Documentation
This project exposes 2 modules:
build
module
build - A simple, correct PEP517 package builder
-
exception
build.
BuildBackendException
Bases: Exception
Exception raised when the backend fails
-
exception
build.
BuildException
Bases: Exception
Exception raised by ProjectBuilder
-
exception
build.
IncompleteCheckWarning
Bases: Warning
Warning raised when we have an incomplete check
-
class
build.
ProjectBuilder
(srcdir, config_settings=None, python_executable='/usr/bin/python')
Bases: object
-
build
(distribution, outdir)
Builds a distribution
- Parameters
-
- Return type
None
-
property
build_dependencies
- Return type
Set
[str
]
-
check_dependencies
(distribution)
Returns a set of the missing dependencies
- Parameters
distribution (str
) – Distribution to build (sdist or wheel)
- Return type
Set
[str
]
-
get_dependencies
(distribution)
Returns a set of dependencies
- Return type
Set
[str
]
-
property
python_executable
- Return type
Union
[bytes
, str
]
-
exception
build.
TypoWarning
Bases: Warning
Warning raised when a potential typo is found
-
build.
check_version
(requirement_string, extra='')
- Parameters
-
- Return type
bool
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
Return the executable of the isolated build environment.
- Return type
str
-
abstract
install
(requirements)
Install PEP-508 requirements into the isolated build environment.
- Parameters
requirements (Iterable
[str
]) – PEP-508 requirements
- Return type
None
-
class
build.env.
IsolatedEnvBuilder
Bases: object