Skip to content

Omnipy

models

omnipy.components.isa.models

MODULE	DESCRIPTION
`assay_schema`
`comment_schema`
`data_schema`
`factor_schema`
`factor_value_schema`
`investigation_schema`
`material_attribute_schema`
`material_attribute_value_schema`
`material_schema`
`ontology_annotation_schema`
`ontology_source_reference_schema`
`organization_schema`
`person_schema`
`process_parameter_value_schema`
`process_schema`
`protocol_parameter_schema`
`protocol_schema`
`publication_schema`
`sample_schema`
`source_schema`
`study_group`
`study_schema`
`validators`

CLASS	DESCRIPTION
`FlattenedIsaJsonModel`
`IsaJsonModel`
`IsaTopLevelModel`
`IsaTopLevelSchema`

ATTRIBUTE	DESCRIPTION
`ISA_JSON_MODEL_TOP_LEVEL_KEY`	TYPE: `str`

ISA_JSON_MODEL_TOP_LEVEL_KEY `module-attribute`

ISA_JSON_MODEL_TOP_LEVEL_KEY: str = 'investigation'

FlattenedIsaJsonModel

Bases: Model[JsonListOfDictsOfScalarsModel]

Source code in src/omnipy/components/isa/models/__init__.py

class FlattenedIsaJsonModel(Model[JsonListOfDictsOfScalarsModel]):
    ...

IsaJsonModel

Bases: Model[IsaInvestigationSchema | IsaTopLevelModel]

CLASS	DESCRIPTION
`Config`

Source code in src/omnipy/components/isa/models/__init__.py

class IsaJsonModel(Model[IsaInvestigationSchema | IsaTopLevelModel]):
    class Config:
        smart_union = False

    @classmethod
    def _parse_data(cls, data: IsaInvestigationSchema | IsaTopLevelModel) -> IsaTopLevelModel:
        if isinstance(data, IsaTopLevelModel):
            return data
        else:
            return IsaTopLevelModel(investigation=data)

Config

ATTRIBUTE	DESCRIPTION
`smart_union`

Source code in src/omnipy/components/isa/models/__init__.py

class Config:
    smart_union = False

smart_union `class-attribute` `instance-attribute`

smart_union = False

IsaTopLevelModel

Bases: Model[IsaTopLevelSchema]

Source code in src/omnipy/components/isa/models/__init__.py

class IsaTopLevelModel(Model[IsaTopLevelSchema]):
    ...

IsaTopLevelSchema

Bases: pyd.BaseModel

CLASS	DESCRIPTION
`Config`

ATTRIBUTE	DESCRIPTION
`investigation`	TYPE: `IsaInvestigationModel \| None`

Source code in src/omnipy/components/isa/models/__init__.py

class IsaTopLevelSchema(pyd.BaseModel):
    class Config:
        extra = pyd.Extra.forbid
        use_enum_values = True

    investigation: IsaInvestigationModel | None = None

investigation `class-attribute` `instance-attribute`

investigation: IsaInvestigationModel | None = None

Config

ATTRIBUTE	DESCRIPTION
`extra`
`use_enum_values`

Source code in src/omnipy/components/isa/models/__init__.py

class Config:
    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