Skip to content

Group

oqd_dataschema.group

GroupBase

Bases: BaseModel

Schema representation for a group object within an HDF5 file.

Each grouping of data should be defined as a subclass of GroupBase, and specify the datasets that it will contain. This base object only has attributes, attrs, which are associated to the HDF5 group.

Attributes:

Name Type Description
attrs Attrs

A dictionary of attributes to append to the group.
Source code in oqd-dataschema/src/oqd_dataschema/group.py 
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
class GroupBase(BaseModel, extra="forbid"):
    """
    Schema representation for a group object within an HDF5 file.

    Each grouping of data should be defined as a subclass of `GroupBase`, and specify the datasets that it will contain.
    This base object only has attributes, `attrs`, which are associated to the HDF5 group.

    Attributes:
        attrs: A dictionary of attributes to append to the group.

    """

    attrs: Attrs = Field(default_factory=lambda: {})

    @staticmethod
    def _is_basic_groupfield_type(v):
        return reduce(
            lambda x, y: x or y,
            (gf._is_supported_type(v) for gf in GroupField.__subclasses__()),
        )

    @classmethod
    def _is_groupfield_type(cls, v):
        is_datafield = cls._is_basic_groupfield_type(v)

        is_annotated_datafield = typing.get_origin(
            v
        ) is Annotated and cls._is_basic_groupfield_type(v.__origin__)

        is_optional_datafield = typing.get_origin(v) is Union and (
            (v.__args__[0] == NoneType and cls._is_basic_groupfield_type(v.__args__[1]))
            or (
                v.__args__[1] == NoneType
                and cls._is_basic_groupfield_type(v.__args__[0])
            )
        )

        is_dict_datafield = (
            typing.get_origin(v) is dict
            and v.__args__[0] is str
            and cls._is_basic_groupfield_type(v.__args__[1])
        )

        return (
            is_datafield
            or is_annotated_datafield
            or is_optional_datafield
            or is_dict_datafield
        )

    @classmethod
    def _is_classvar(cls, v):
        return v is ClassVar or typing.get_origin(v) is ClassVar

    def __init_subclass__(cls, **kwargs):
        super().__init_subclass__(**kwargs)

        for k, v in cls.__annotations__.items():
            if k == "class_":
                raise AttributeError("`class_` attribute should not be set manually.")

            if k == "attrs" and v is not Attrs:
                raise AttributeError(
                    "`attrs` attribute must have type annotation of Attrs."
                )

            if k == "attrs" or cls._is_classvar(v):
                continue

            if not cls._is_groupfield_type(v):
                raise TypeError(
                    "All fields of `GroupBase` have to be of type `Dataset`, `Table` or `Folder`."
                )

        cls.__annotations__["class_"] = Literal[cls.__name__]
        setattr(cls, "class_", cls.__name__)

        # Auto-register new group types
        GroupRegistry.register(cls)

GroupRegistry

Represents the GroupRegistry

Source code in oqd-dataschema/src/oqd_dataschema/group.py 
169
170
171
172
173
174
class GroupRegistry(metaclass=MetaGroupRegistry):
    """
    Represents the GroupRegistry
    """

    pass