Skip to content

omnipy.components.isa.models.organization_schema

ISA model representing an organization in an investigation.

ISA-JSON (Investigation/Study/Assay) stores metadata as JSON-LD, which these classes model for Omnipy.

CLASS DESCRIPTION
FieldType

JSON-LD type labels used for ISA organization entities.
IsaOrganizationModel

Omnipy model wrapper for ISA organization entries.
IsaOrganizationSchema

Schema for organization entries referenced in ISA metadata.

FieldType

Bases: Enum


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

              

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

JSON-LD type labels used for ISA organization entities.

ATTRIBUTE DESCRIPTION
Organization

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

    Attributes:
        Organization: Marks a JSON object as an ISA organization.
    """

    Organization = 'Organization'

Organization class-attribute instance-attribute 

Organization = 'Organization'

IsaOrganizationModel

Bases: Model[IsaOrganizationSchema]


              flowchart BT
              omnipy.components.isa.models.organization_schema.IsaOrganizationModel[IsaOrganizationModel]
              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.organization_schema.IsaOrganizationModel
                                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.organization_schema.IsaOrganizationModel href "" "omnipy.components.isa.models.organization_schema.IsaOrganizationModel"
              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 organization entries.

Wraps :class:IsaOrganizationSchema so organizations can be embedded as typed ISA model values.

Source code in src/omnipy/components/isa/models/organization_schema.py 
50
51
52
53
54
55
56
57
class IsaOrganizationModel(Model[IsaOrganizationSchema]):
    """Omnipy model wrapper for ISA organization entries.

    Wraps :class:`IsaOrganizationSchema` so organizations can be embedded as
    typed ISA model values.
    """

    ...

IsaOrganizationSchema

Bases: pyd.BaseModel


              flowchart BT
              omnipy.components.isa.models.organization_schema.IsaOrganizationSchema[IsaOrganizationSchema]

                              omnipy.util.pydantic.BaseModel --> omnipy.components.isa.models.organization_schema.IsaOrganizationSchema
                


              click omnipy.components.isa.models.organization_schema.IsaOrganizationSchema href "" "omnipy.components.isa.models.organization_schema.IsaOrganizationSchema"

Schema for organization entries referenced in ISA metadata.

ATTRIBUTE DESCRIPTION
name

Organization name.

TYPE: str | None

Subclassed by:
CLASS DESCRIPTION
Config

Validation settings for ISA organization schema parsing.
Source code in src/omnipy/components/isa/models/organization_schema.py 
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
class IsaOrganizationSchema(pyd.BaseModel):
    """Schema for organization entries referenced in ISA metadata.

    Attributes:
        name: Organization name.
    """
    class Config:
        """Validation settings for ISA organization schema parsing.

        Attributes:
            extra: Rejects unknown keys.
            use_enum_values: Emits enum members as 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')
    name: Optional[str] = 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')

name class-attribute instance-attribute 

name: str | None = None

Config

Validation settings for ISA organization schema parsing.

ATTRIBUTE DESCRIPTION
extra

Rejects unknown keys.
use_enum_values

Emits enum members as value strings.
Source code in src/omnipy/components/isa/models/organization_schema.py 
33
34
35
36
37
38
39
40
41
42
class Config:
    """Validation settings for ISA organization schema parsing.

    Attributes:
        extra: Rejects unknown keys.
        use_enum_values: Emits enum members as 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