veriflow.datasources.base#

Module with the base class that all datasources should inherit from.

Classes

`BaseDatasource`(config)	Class to inherit from, defines the required methods and attributes.
`BaseDatasourceConfig`(*, import_adapter, ...)	Base config for a datasource config.

class veriflow.datasources.base.BaseDatasource(config)[source]#

Class to inherit from, defines the required methods and attributes.

property data_type: DataType#: Whether the instance represents sim or obs data.

abstractmethod fetch_data()[source]#

Fetch data from datasource.

get_data()[source]#

Get cached data, or fetch and cache.

class veriflow.datasources.base.BaseDatasourceConfig(*, import_adapter, source, data_type, general, id_mapping=None, **extra_data)[source]#

Base config for a datasource config.

Specific config definitions should inherit from this base class.

Parameters:

import_adapter (str)
source (Annotated[str, StringConstraints(strip_whitespace=None, to_upper=None, to_lower=None, strict=None, min_length=1, max_length=None, pattern=^[A-Za-z][A-Za-z0-9_]*$, ascii_only=None), MinLen(min_length=1)])
data_type (DataType)
general (Annotated[GeneralInfoConfig, SkipJsonSchema()])
id_mapping (Annotated[IdMappingConfig, SkipJsonSchema()] | None)
extra_data (Any)