scikit_build_core.setuptools package

Submodules

scikit_build_core.setuptools.build_cmake module

class scikit_build_core.setuptools.build_cmake.BuildCMake(dist, **kw)

Bases: Command

build_lib: str | None

build_temp: str | None

cmake_args: list[str] | str | None = None

debug: bool | None

editable_mode: bool

finalize_options()

Set final values for all the options that this command supports. This is always called as late as possible, ie. after any option assignments from the command-line or from other commands have been done. Thus, this is the place to code option dependencies: if ‘foo’ depends on ‘bar’, then it is safe to set ‘foo’ from ‘bar’ as long as ‘foo’ still has the same value it was assigned in ‘initialize_options()’.

This method must be implemented by all command classes.

Return type:

None

initialize_options()

Set default values for all the options that this command supports. Note that these defaults may be overridden by other commands, by the setup script, by config files, or by the command-line. Thus, this is not the place to code dependencies between options; generally, ‘initialize_options()’ implementations are just a bunch of “self.foo = None” assignments.

This method must be implemented by all command classes.

Return type:

None

parallel: int | None

plat_name: str | None

run()

A command’s raison d’etre: carry out the action it exists to perform, controlled by the options initialized in ‘initialize_options()’, customized by other commands, the setup script, the command-line, and config files, and finalized in ‘finalize_options()’. All terminal output and filesystem interaction should be done by ‘run()’.

This method must be implemented by all command classes.

Return type:

None

source_dir: str | None = None

user_options: ClassVar[list[tuple[str, str, str]]] = [('build-lib=', 'b', 'directory for compiled extension modules'), ('build-temp=', 't', 'directory for temporary files (build by-products)'), ('plat-name=', 'p', 'platform name to cross-compile for, if supported '), ('debug', 'g', 'compile/link with debugging information'), ('parallel=', 'j', 'number of parallel build jobs'), ('source-dir=', 'j', 'directory with CMakeLists.txt'), ('cmake-args=', 'a', 'extra arguments for CMake')]

scikit_build_core.setuptools.build_cmake.cmake_source_dir(_dist, attr, value)

Return type:

None

scikit_build_core.setuptools.build_cmake.finalize_distribution_options(dist)

Return type:

None

scikit_build_core.setuptools.build_meta module

scikit_build_core.setuptools.build_meta.build_editable(wheel_directory, config_settings=None, metadata_directory=None)

scikit_build_core.setuptools.build_meta.build_sdist(sdist_directory, config_settings=None)

scikit_build_core.setuptools.build_meta.build_wheel(wheel_directory, config_settings=None, metadata_directory=None)

scikit_build_core.setuptools.build_meta.get_requires_for_build_editable(config_settings=None)

Return type:

list[str]

scikit_build_core.setuptools.build_meta.get_requires_for_build_sdist(config_settings=None)

Return type:

list[str]

scikit_build_core.setuptools.build_meta.get_requires_for_build_wheel(config_settings=None)

Return type:

list[str]

scikit_build_core.setuptools.build_meta.prepare_metadata_for_build_editable(metadata_directory, config_settings=None)

scikit_build_core.setuptools.build_meta.prepare_metadata_for_build_wheel(metadata_directory, config_settings=None)

scikit_build_core.setuptools.wrapper module

scikit_build_core.setuptools.wrapper.setup(*, cmake_args=(), cmake_install_dir='', cmake_source_dir='', cmake_with_sdist=False, cmake_languages=None, cmake_minimum_required_version=None, cmake_process_manifest_hook=None, cmake_install_target='install', **kw)

Return type:

Distribution