dispel.providers.registry module

TODO: Write documentation about registry.

dispel.providers.registry.discover_providers()

Discover providers from the provider package.

TODO: describe the discovery process

dispel.providers.registry.get_processing_function(code, reading_type)

FIXME: documentation.

Parameters:

• code (str) –

• reading_type (type) –

Return type:

Callable[[Reading], DataTrace]

dispel.providers.registry.process_factory(task_name, steps, codes, supported_type=<class 'dispel.data.core.Reading'>)

Register and return the corresponding processing function.

Parameters:

• task_name (str | AbbreviatedValue) – The standard task name.

• steps (ProcessingStep | Iterable[ProcessingStep]) – The processing step(s) to be registered.

• codes (str | Tuple[str, ...]) – The possible task code acronyms.

• supported_type (Type[Reading]) – The type of reading supported for the processing

Returns:

The decorated processing function.

Return type:

Callable[[Reading], DataTrace]

dispel.providers.registry.register_processing(task_name, steps, codes, supported_type=<class 'dispel.data.core.Reading'>)

Register a processing function and steps for automatic processing.

Parameters:

• task_name (str | AbbreviatedValue) – The standard task name.

• steps (ProcessingStep | Iterable[ProcessingStep]) – The processing steps to be registered.

• codes (str | Tuple[str, ...]) – The possible task code acronyms.

• supported_type (Type[Reading]) – The supported reading type by the processing function.

Returns:

The decorated function.

Return type:

Callable

dispel.providers.registry.register_reader(readable, reading_type, registry=None)

Decorate a function to serve as a reader.

TODO: write documentation

Parameters:

• readable (Callable[[Any], bool]) –

• reading_type (Type[Reading]) –

• registry (Dict[Tuple[Callable[[Any], bool], Type[Reading]], Dict] | None) –

Return type:

Callable