compile_template_result

scikitplot.cython.compile_template_result(template_id, *, module_name=None, cache_dir=None, use_cache=True, force_rebuild=False, verbose=0, profile=None, numpy_support=True, numpy_required=None, annotate=False, view_annotate=False, compiler_directives=None, include_dirs=None, extra_compile_args=None, extra_link_args=None, extra_sources=None, support_files=None, support_paths=None, include_cwd=True, lock_timeout_s=60.0, language=None)

Compile and import a Cython template and return a structured result.

Parameters:

template_idstr

Template ID resolving to a .pyx template.

module_namestr or None, default=None

Compiled module name override. If None, the builder derives a unique, deterministic name from the full cache key (recommended to avoid collisions when building the same template under different options).

include_cwdbool, default=True

If True, include the current working directory in include paths.

lock_timeout_sfloat, default=60.0

Max seconds to wait for the per-key build lock.

cache_dir, use_cache, force_rebuild, verbose, annotate, view_annotate, compiler_directives, include_dirs, extra_sources

See scikitplot.cython.compile_and_load.

profile{‘fast-debug’, ‘release’, ‘annotate’} or None, default=None

Optional build profile preset.

numpy_supportbool, default=True

If True, attempt to include NumPy headers if NumPy is installed.

numpy_requiredbool or None, default=None

If True, raise if NumPy is unavailable. If None, value is derived from template metadata (requires_numpy) when present.

support_files, support_paths

Additional support files/paths to include for compilation.

language{‘c’, ‘c++’} or None, default=None

Optional language override. If None, may be derived from metadata.

Returns:

scikitplot.cython.BuildResult

Structured build result.

Raises:

ValueError

If the resolved template is not a Cython template.

Parameters:

• template_id (str)

• module_name (str | None)

• cache_dir (str | Path | None)

• use_cache (bool)

• force_rebuild (bool)

• verbose (int)

• profile (str | None)

• numpy_support (bool)

• numpy_required (bool | None)

• annotate (bool)

• view_annotate (bool)

• compiler_directives (Mapping[str, Any] | None)

• include_dirs (list[str | Path] | None)

• extra_compile_args (list[str] | None)

• extra_link_args (list[str] | None)

• extra_sources (list[str | Path] | None)

• support_files (Mapping[str, str | bytes] | None)

• support_paths (list[str | Path] | None)

• include_cwd (bool)

• lock_timeout_s (float)

• language (str | None)

Gallery examples

Browse and compile templates

Browse and compile templates