scikit_build_core package¶

scikit-build-core: PEP 517 builder for Scikit-Build

Subpackages¶

Submodules¶

scikit_build_core.cmake module¶

class scikit_build_core.cmake.CMake(version, cmake_path)[source]¶

Bases: object

cmake_path: Path¶

classmethod default_search(*, version=None, module=True, env=None)[source]¶

Return type:: Self

version: Version¶

class scikit_build_core.cmake.CMaker(cmake, source_dir, build_dir, build_type, module_dirs=<factory>, prefix_dirs=<factory>, single_config=True)[source]¶

Bases: object

build(build_args=(), *, targets=(), verbose=False)[source]¶

Return type:: None

build_dir: Path¶

build_type: str¶

cmake: CMake¶

configure(*, defines=None, cmake_args=())[source]¶

Return type:: None

env: dict[str, str]¶

get_generator(*args)[source]¶

Try to get the generator that will be used to build the project. If it’s not set, return None (default generator will be used).

Return type:: str | None

init_cache(cache_settings)[source]¶

Return type:: None

init_cache_file: Path = PosixPath('.')¶

install(prefix, *, strip=False, components=())[source]¶

Return type:: None

module_dirs: list[Path]¶

prefix_dirs: list[Path]¶

single_config: bool = True¶

source_dir: Path¶

scikit_build_core.errors module¶

exception scikit_build_core.errors.CMakeAccessError(exception, description)[source]¶

Bases: FailedProcessError

Error raised when CMake access fails.

exception scikit_build_core.errors.CMakeConfigError[source]¶

Bases: ScikitBuildError

Something is misconfigured.

exception scikit_build_core.errors.CMakeNotFoundError[source]¶

Bases: NotFoundError

Raised when cmake is not found.

exception scikit_build_core.errors.CMakeVersionError[source]¶

Bases: ScikitBuildError

Error raised when CMake version is not supported.

exception scikit_build_core.errors.FailedLiveProcessError[source]¶

Bases: Exception

Exception for when output was not being redirected.

exception scikit_build_core.errors.FailedProcessError(exception, description)[source]¶

Bases: Exception

Exception raised when an call fails.

exception scikit_build_core.errors.NinjaNotFoundError[source]¶

Bases: NotFoundError

Raised when ninja is not found.

exception scikit_build_core.errors.NinjaVersionError[source]¶

Bases: ScikitBuildError

Error raised when CMake version is not supported.

exception scikit_build_core.errors.NotFoundError[source]¶

Bases: ScikitBuildError

Raised when a program is not found.

exception scikit_build_core.errors.ScikitBuildError[source]¶

Bases: Exception

Base class for all ScikitBuildError errors.

scikit_build_core.program_search module¶

class scikit_build_core.program_search.Program(path, version)[source]¶

Bases: NamedTuple

path: Path¶: Alias for field number 0

version: Version | None¶: Alias for field number 1

scikit_build_core.program_search.best_program(programs, *, version)[source]¶

Select the first program entry that is of a supported version, or None if not found.

Return type:: Program | None

scikit_build_core.program_search.get_cmake_program(cmake_path)[source]¶

Get the Program (with version) for CMake given a path. The version will be None if it cannot be determined.

Return type:: Program

scikit_build_core.program_search.get_cmake_programs(*, module=True)[source]¶

Get the path and version for CMake. If the version cannot be determined, yiels (path, None). Otherwise, yields (path, version). Best matches are yielded first.

Return type:: Generator[Program, None, None]

scikit_build_core.program_search.get_ninja_programs(*, module=True)[source]¶

Get the path and version for Ninja. If the version cannot be determined, yields (path, None). Otherwise, yields (path, version). Best matches are yielded first.

Return type:: Generator[Program, None, None]