scikit_build_core package

Copyright (c) 2022 Henry Schreiner. All rights reserved.

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

Subpackages

• scikit_build_core.build package
  • build_editable()
  • build_sdist()
  • build_wheel()
  • get_requires_for_build_editable()
  • get_requires_for_build_sdist()
  • get_requires_for_build_wheel()
  • prepare_metadata_for_build_editable()
  • prepare_metadata_for_build_wheel()
  • Submodules
  • scikit_build_core.build.generate module
    • generate_file_contents()
  • scikit_build_core.build.sdist module
    • build_sdist()
  • scikit_build_core.build.wheel module
• scikit_build_core.builder package
  • Submodules
  • scikit_build_core.builder.builder module
    • Builder
      • Builder.build()
      • Builder.config
      • Builder.configure()
      • Builder.get_cmake_args()
      • Builder.install()
      • Builder.settings
    • archs_to_tags()
    • get_archs()
  • scikit_build_core.builder.generator module
    • set_environment_for_gen()
  • scikit_build_core.builder.get_requires module
    • GetRequires
      • GetRequires.cmake()
      • GetRequires.config_settings
      • GetRequires.dynamic_metadata()
      • GetRequires.ninja()
      • GetRequires.settings
  • scikit_build_core.builder.macos module
    • MacOSVer
      • MacOSVer.major
      • MacOSVer.minor
    • get_macosx_deployment_target()
    • normalize_macos_version()
  • scikit_build_core.builder.sysconfig module
    • get_cmake_platform()
    • get_numpy_include_dir()
    • get_python_include_dir()
    • get_python_library()
    • get_soabi()
  • scikit_build_core.builder.wheel_tag module
    • WheelTag
      • WheelTag.abi
      • WheelTag.abis
      • WheelTag.arch
      • WheelTag.archs
      • WheelTag.as_tags_set()
      • WheelTag.compute_best()
      • WheelTag.pyver
      • WheelTag.pyvers
      • WheelTag.tags_dict()
• scikit_build_core.file_api package
  • Subpackages
    • scikit_build_core.file_api.model package
      • Submodules
      • scikit_build_core.file_api.model.cache module
      • scikit_build_core.file_api.model.cmakefiles module
      • scikit_build_core.file_api.model.codemodel module
      • scikit_build_core.file_api.model.common module
      • scikit_build_core.file_api.model.directory module
      • scikit_build_core.file_api.model.index module
      • scikit_build_core.file_api.model.toolchains module
  • Submodules
  • scikit_build_core.file_api.query module
    • stateless_query()
  • scikit_build_core.file_api.reply module
    • load_reply_dir()
• scikit_build_core.metadata package
  • Submodules
  • scikit_build_core.metadata.fancy_pypi_readme module
    • dynamic_metadata()
    • get_requires_for_dynamic_metadata()
  • scikit_build_core.metadata.regex module
    • dynamic_metadata()
  • scikit_build_core.metadata.setuptools_scm module
    • dynamic_metadata()
    • get_requires_for_dynamic_metadata()
• scikit_build_core.resources package
  • Subpackages
    • scikit_build_core.resources.find_python package
• scikit_build_core.settings package
  • Submodules
  • scikit_build_core.settings.documentation module
    • pull_docs()
  • scikit_build_core.settings.json_schema module
    • FailedConversion
    • convert_type()
    • to_json_schema()
  • scikit_build_core.settings.metadata module
    • get_standard_metadata()
  • scikit_build_core.settings.skbuild_docs module
    • mk_skbuild_docs()
  • scikit_build_core.settings.skbuild_model module
    • BackportSettings
      • BackportSettings.find_python
    • CMakeSettings
      • CMakeSettings.args
      • CMakeSettings.build_type
      • CMakeSettings.define
      • CMakeSettings.minimum_version
      • CMakeSettings.source_dir
      • CMakeSettings.targets
      • CMakeSettings.verbose
    • EditableSettings
      • EditableSettings.mode
      • EditableSettings.rebuild
      • EditableSettings.verbose
    • GenerateSettings
      • GenerateSettings.location
      • GenerateSettings.path
      • GenerateSettings.template
      • GenerateSettings.template_path
    • InstallSettings
      • InstallSettings.components
      • InstallSettings.strip
    • LoggingSettings
      • LoggingSettings.level
    • NinjaSettings
      • NinjaSettings.make_fallback
      • NinjaSettings.minimum_version
    • SDistSettings
      • SDistSettings.cmake
      • SDistSettings.exclude
      • SDistSettings.include
      • SDistSettings.reproducible
    • ScikitBuildSettings
      • ScikitBuildSettings.backport
      • ScikitBuildSettings.build_dir
      • ScikitBuildSettings.cmake
      • ScikitBuildSettings.editable
      • ScikitBuildSettings.experimental
      • ScikitBuildSettings.generate
      • ScikitBuildSettings.install
      • ScikitBuildSettings.logging
      • ScikitBuildSettings.metadata
      • ScikitBuildSettings.minimum_version
      • ScikitBuildSettings.ninja
      • ScikitBuildSettings.sdist
      • ScikitBuildSettings.strict_config
      • ScikitBuildSettings.wheel
    • WheelSettings
      • WheelSettings.expand_macos_universal_tags
      • WheelSettings.install_dir
      • WheelSettings.license_files
      • WheelSettings.packages
      • WheelSettings.py_api
  • scikit_build_core.settings.skbuild_read_settings module
    • SettingsReader
      • SettingsReader.from_file()
      • SettingsReader.print_suggestions()
      • SettingsReader.suggestions()
      • SettingsReader.unrecognized_options()
      • SettingsReader.validate_may_exit()
  • scikit_build_core.settings.skbuild_schema module
    • generate_skbuild_schema()
    • get_skbuild_schema()
  • scikit_build_core.settings.sources module
    • ConfSource
      • ConfSource.all_option_names()
      • ConfSource.convert()
      • ConfSource.get_item()
      • ConfSource.has_item()
      • ConfSource.unrecognized_options()
    • EnvSource
      • EnvSource.all_option_names()
      • EnvSource.convert()
      • EnvSource.get_item()
      • EnvSource.has_item()
      • EnvSource.unrecognized_options()
    • Source
      • Source.all_option_names()
      • Source.convert()
      • Source.get_item()
      • Source.has_item()
      • Source.unrecognized_options()
    • SourceChain
      • SourceChain.convert_target()
      • SourceChain.get_item()
      • SourceChain.has_item()
      • SourceChain.unrecognized_options()
    • TOMLSource
      • TOMLSource.all_option_names()
      • TOMLSource.convert()
      • TOMLSource.get_item()
      • TOMLSource.has_item()
      • TOMLSource.unrecognized_options()
• scikit_build_core.setuptools package
  • Submodules
  • scikit_build_core.setuptools.build_cmake module
    • BuildCMake
      • BuildCMake.build_lib
      • BuildCMake.build_temp
      • BuildCMake.cmake_args
      • BuildCMake.debug
      • BuildCMake.editable_mode
      • BuildCMake.finalize_options()
      • BuildCMake.initialize_options()
      • BuildCMake.parallel
      • BuildCMake.plat_name
      • BuildCMake.run()
      • BuildCMake.source_dir
      • BuildCMake.user_options
    • cmake_source_dir()
    • finalize_distribution_options()
  • scikit_build_core.setuptools.build_meta module
    • build_editable()
    • build_sdist()
    • build_wheel()
    • get_requires_for_build_editable()
    • get_requires_for_build_sdist()
    • get_requires_for_build_wheel()
    • prepare_metadata_for_build_editable()
    • prepare_metadata_for_build_wheel()
  • scikit_build_core.setuptools.wrapper module
    • setup()

Submodules

scikit_build_core.cmake module

class scikit_build_core.cmake.CMake(version, cmake_path)

Bases: object

cmake_path: Path

classmethod default_search(*, minimum_version=None, module=True)

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)

Bases: object

build(build_args=(), *, targets=(), verbose=False)

Return type:

None

build_dir: Path

build_type: str

cmake: CMake

configure(*, defines=None, cmake_args=())

Return type:

None

env: dict[str, str]

init_cache(cache_settings)

Return type:

None

init_cache_file: Path = PosixPath('.')

install(prefix, *, strip=False, components=())

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)

Bases: FailedProcessError

Error raised when CMake access fails.

exception scikit_build_core.errors.CMakeConfigError

Bases: ScikitBuildError

Something is misconfigured.

exception scikit_build_core.errors.CMakeNotFoundError

Bases: NotFoundError

Raised when cmake is not found.

exception scikit_build_core.errors.CMakeVersionError

Bases: ScikitBuildError

Error raised when CMake version is not supported.

exception scikit_build_core.errors.FailedLiveProcessError

Bases: Exception

Exception for when output was not being redirected.

exception scikit_build_core.errors.FailedProcessError(exception, description)

Bases: Exception

Exception raised when an call fails.

exception scikit_build_core.errors.NinjaNotFoundError

Bases: NotFoundError

Raised when ninja is not found.

exception scikit_build_core.errors.NinjaVersionError

Bases: ScikitBuildError

Error raised when CMake version is not supported.

exception scikit_build_core.errors.NotFoundError

Bases: ScikitBuildError

Raised when a program is not found.

exception scikit_build_core.errors.ScikitBuildError

Bases: Exception

Base class for all ScikitBuildError errors.

scikit_build_core.program_search module

class scikit_build_core.program_search.Program(path, version)

Bases: NamedTuple

path: Path

Alias for field number 0

version: Optional[Version]

Alias for field number 1

scikit_build_core.program_search.best_program(programs, *, minimum_version)

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

Return type:

Optional[Program]

scikit_build_core.program_search.get_cmake_programs(*, module=True)

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)

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]