fhelium.benchmarks.registry
Benchmark discovery and custom benchmark registration.
BenchmarkRegistry
class View source
python
BenchmarkRegistry()1
Ordered process-local collection of named benchmark definitions.
register
method
python
def register(definition: BenchmarkDefinition, *, replace: bool=False) -> BenchmarkDefinition: ...1
Register and return definition under its unique public name.
Parameters
definition: Complete benchmark definition to retain by reference.replace: Replace an existing definition with the same name.
Raises
KeyError: If the name already exists andreplaceis false.
get
method
python
def get(name: str) -> BenchmarkDefinition: ...1
Return the definition named name or raise KeyError.
values
method
python
def values() -> tuple[BenchmarkDefinition, ...]: ...1
Return definitions in registration order.
registry
data View source
python
registry = BenchmarkRegistry()1
register_benchmark
function View source
python
def register_benchmark(definition: BenchmarkDefinition | None=None, *, replace: bool=False) -> BenchmarkDefinition | Callable[[BenchmarkDefinition], BenchmarkDefinition]: ...1
Register a definition on the public process-global registry.
The function accepts a definition directly or can be used as a decorator. Custom benchmark-file hooks should prefer their supplied registry instead of relying on this process-global object.
load_builtin_benchmarks
function View source
python
def load_builtin_benchmarks() -> BenchmarkRegistry: ...1
Load built-in definitions once and return the global registry.