scikit_build_core.hatch package

Submodules

scikit_build_core.hatch.hooks module

scikit_build_core.hatch.hooks.hatch_register_build_hook()

Return type:

Any

scikit_build_core.hatch.plugin module

class scikit_build_core.hatch.plugin.ScikitBuildHook(*args, **kwargs)

Bases: BuildHookInterface

PLUGIN_NAME = 'scikit-build'

The name used for selection.

dependencies()

A list of extra [dependencies](../../config/dependency.md) that must be installed prior to builds.

Return type:

list[str]

!!! warning

• For this to have any effect the hook dependency itself cannot be dynamic and

  must always be defined in build-system.requires.

• As the hook must be imported to call this method, imports that require these

  dependencies must be evaluated lazily.

finalize(version, build_data, artifact_path)

This occurs immediately after each build and will not run if the –hooks-only flag was passed to the [build](../../cli/reference.md#hatch-build) command.

The build data will reflect any modifications done by the target during the build.

Return type:

None

initialize(version, build_data)

This occurs immediately before each build.

Any modifications to the build data will be seen by the build target.

Return type:

None