Source code for neuroconv.tools.nwb_helpers._configuration_models._hdf5_backend

"""Base Pydantic models for the HDF5DatasetConfiguration."""

from typing import ClassVar, Dict, Literal, Type

from pydantic import Field
from pynwb import H5DataIO

from ._base_backend import BackendConfiguration
from ._hdf5_dataset_io import HDF5DatasetIOConfiguration


class HDF5BackendConfiguration(BackendConfiguration):
    """A model for matching collections of DatasetConfigurations specific to the HDF5 backend."""

    backend: ClassVar[Literal["hdf5"]] = "hdf5"
    # Field(  # TODO: in pydantic v2 use property instead of class attribute
    #     default="hdf5", description="The name of the backend used to configure the NWBFile."
    # )
    data_io_class: Type[H5DataIO] = Field(  # TODO: in pydantic v2 use property instead of class attribute
        default=H5DataIO, description="The DataIO class that is specific to HDF5."
    )
    dataset_configurations: Dict[str, HDF5DatasetIOConfiguration] = Field(
        description=(
            "A mapping from object locations to their HDF5DatasetConfiguration specification that contains all "
            "information for writing the datasets to disk using the HDF5 backend."
        )
    )