Skip to content

omnipy.components.isa.models.material_attribute_schema

ISA model representing a material attribute category.

ISA refers to Investigation/Study/Assay, and these models encode ISA-JSON JSON-LD metadata fields.

Returned by:
CLASS DESCRIPTION
FieldType

JSON-LD type labels used for ISA material-attribute entities.
IsaMaterialAttributeModel

Omnipy model wrapper for ISA material attribute categories.
IsaMaterialAttributeSchema

Schema for material attribute categories in ISA.

FieldType

Bases: Enum


              flowchart BT
              omnipy.components.isa.models.material_attribute_schema.FieldType[FieldType]

              

              click omnipy.components.isa.models.material_attribute_schema.FieldType href "" "omnipy.components.isa.models.material_attribute_schema.FieldType"

JSON-LD type labels used for ISA material-attribute entities.

ATTRIBUTE DESCRIPTION
MaterialAttribute

Marks a JSON object as an ISA material attribute.
Returned by:
Source code in src/omnipy/components/isa/models/material_attribute_schema.py 
19
20
21
22
23
24
25
26
class FieldType(Enum):
    """JSON-LD type labels used for ISA material-attribute entities.

    Attributes:
        MaterialAttribute: Marks a JSON object as an ISA material attribute.
    """

    MaterialAttribute = 'MaterialAttribute'

MaterialAttribute class-attribute instance-attribute 

MaterialAttribute = 'MaterialAttribute'

IsaMaterialAttributeModel

Bases: Model[IsaMaterialAttributeSchema]


              flowchart BT
              omnipy.components.isa.models.material_attribute_schema.IsaMaterialAttributeModel[IsaMaterialAttributeModel]
              omnipy.data.model.Model[Model]
              omnipy.data._mixins.display.ModelDisplayMixin[ModelDisplayMixin]
              omnipy.data._mixins.display.BaseDisplayMixin[BaseDisplayMixin]
              omnipy.data._data_class_creator.DataClassBase[DataClassBase]

                              omnipy.data.model.Model --> omnipy.components.isa.models.material_attribute_schema.IsaMaterialAttributeModel
                                omnipy.data._mixins.display.ModelDisplayMixin --> omnipy.data.model.Model
                                omnipy.data._mixins.display.BaseDisplayMixin --> omnipy.data._mixins.display.ModelDisplayMixin
                

                omnipy.data._data_class_creator.DataClassBase --> omnipy.data.model.Model
                
                omnipy.util.pydantic.GenericModel --> omnipy.data.model.Model
                



              click omnipy.components.isa.models.material_attribute_schema.IsaMaterialAttributeModel href "" "omnipy.components.isa.models.material_attribute_schema.IsaMaterialAttributeModel"
              click omnipy.data.model.Model href "" "omnipy.data.model.Model"
              click omnipy.data._mixins.display.ModelDisplayMixin href "" "omnipy.data._mixins.display.ModelDisplayMixin"
              click omnipy.data._mixins.display.BaseDisplayMixin href "" "omnipy.data._mixins.display.BaseDisplayMixin"
              click omnipy.data._data_class_creator.DataClassBase href "" "omnipy.data._data_class_creator.DataClassBase"

Omnipy model wrapper for ISA material attribute categories.

Provides Omnipy Model integration over :class:IsaMaterialAttributeSchema.

Returned by:
Source code in src/omnipy/components/isa/models/material_attribute_schema.py 
52
53
54
55
56
57
58
59
class IsaMaterialAttributeModel(Model[IsaMaterialAttributeSchema]):
    """Omnipy model wrapper for ISA material attribute categories.

    Provides Omnipy ``Model`` integration over
    :class:`IsaMaterialAttributeSchema`.
    """

    ...

IsaMaterialAttributeSchema

Bases: pyd.BaseModel


              flowchart BT
              omnipy.components.isa.models.material_attribute_schema.IsaMaterialAttributeSchema[IsaMaterialAttributeSchema]

                              omnipy.util.pydantic.BaseModel --> omnipy.components.isa.models.material_attribute_schema.IsaMaterialAttributeSchema
                


              click omnipy.components.isa.models.material_attribute_schema.IsaMaterialAttributeSchema href "" "omnipy.components.isa.models.material_attribute_schema.IsaMaterialAttributeSchema"

Schema for material attribute categories in ISA.

ATTRIBUTE DESCRIPTION
characteristicType

Ontology term describing the attribute category.

TYPE: ontology_annotation_schema.IsaOntologyReferenceModel | None

Subclassed by:
CLASS DESCRIPTION
Config

Validation settings for ISA material-attribute schema parsing.
Source code in src/omnipy/components/isa/models/material_attribute_schema.py 
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
class IsaMaterialAttributeSchema(pyd.BaseModel):
    """Schema for material attribute categories in ISA.

    Attributes:
        characteristicType: Ontology term describing the attribute category.
    """
    class Config:
        """Validation settings for ISA material-attribute schema parsing.

        Attributes:
            extra: Rejects keys not present in the schema.
            use_enum_values: Serializes enums with raw value strings.
        """

        extra = pyd.Extra.forbid
        use_enum_values = True

    field_id: Optional[str] = pyd.Field(None, alias='@id')
    field_context: Optional[str] = pyd.Field(None, alias='@context')
    field_type: Optional[FieldType] = pyd.Field(None, alias='@type')
    characteristicType: Optional[ontology_annotation_schema.IsaOntologyReferenceModel] = None

characteristicType class-attribute instance-attribute 

characteristicType: ontology_annotation_schema.IsaOntologyReferenceModel | None = None

field_context class-attribute instance-attribute 

field_context: str | None = pyd.Field(None, alias='@context')

field_id class-attribute instance-attribute 

field_id: str | None = pyd.Field(None, alias='@id')

field_type class-attribute instance-attribute 

field_type: FieldType | None = pyd.Field(None, alias='@type')

Config

Validation settings for ISA material-attribute schema parsing.

ATTRIBUTE DESCRIPTION
extra

Rejects keys not present in the schema.
use_enum_values

Serializes enums with raw value strings.
Source code in src/omnipy/components/isa/models/material_attribute_schema.py 
35
36
37
38
39
40
41
42
43
44
class Config:
    """Validation settings for ISA material-attribute schema parsing.

    Attributes:
        extra: Rejects keys not present in the schema.
        use_enum_values: Serializes enums with raw value strings.
    """

    extra = pyd.Extra.forbid
    use_enum_values = True

extra class-attribute instance-attribute 

extra = pyd.Extra.forbid

use_enum_values class-attribute instance-attribute 

use_enum_values = True