omnipy.components.isa.models.assay_schema

CLASS	DESCRIPTION
FieldType
IsaAssayJsonModel
IsaAssayJsonSchema

FieldType

Bases: Enum

ATTRIBUTE	DESCRIPTION
Assay

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

class FieldType(Enum):
    Assay = 'Assay'

Assay class-attribute instance-attribute

Assay = 'Assay'

IsaAssayJsonModel

Bases: Model[IsaAssayJsonSchema]

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

class IsaAssayJsonModel(Model[IsaAssayJsonSchema]):
    ...

IsaAssayJsonSchema

Bases: pyd.BaseModel

CLASS	DESCRIPTION
Config

ATTRIBUTE	DESCRIPTION
characteristicCategories	TYPE: Optional[List[material_attribute_schema.IsaMaterialAttributeModel]]
comments	TYPE: Optional[List[comment_schema.IsaCommentModel]]
dataFiles	TYPE: Optional[List[data_schema.IsaDataModel]]
field_context	TYPE: Optional[str]
field_id	TYPE: Optional[str]
field_type	TYPE: Optional[FieldType]
filename	TYPE: Optional[str]
materials	TYPE: Optional[_MaterialsModel]
measurementType	TYPE: Optional[ontology_annotation_schema.IsaOntologyReferenceModel]
processSequence	TYPE: Optional[List[process_schema.IsaProcessOrProtocolApplicationModel]]
technologyPlatform	TYPE: Optional[str]
technologyType	TYPE: Optional[ontology_annotation_schema.IsaOntologyReferenceModel]
unitCategories	TYPE: Optional[List[ontology_annotation_schema.IsaOntologyReferenceModel]]

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

class IsaAssayJsonSchema(pyd.BaseModel):
    class Config:
        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')
    filename: Optional[str] = None
    measurementType: Optional[ontology_annotation_schema.IsaOntologyReferenceModel] = (None)
    technologyType: Optional[ontology_annotation_schema.IsaOntologyReferenceModel] = (None)
    technologyPlatform: Optional[str] = None
    dataFiles: Optional[List[data_schema.IsaDataModel]] = None
    materials: Optional[_MaterialsModel] = None
    characteristicCategories: Optional[List[material_attribute_schema.IsaMaterialAttributeModel]] =\
        pyd.Field(
            None,
            description='List of all the characteristics categories (or material attributes) '
            'defined in the study, used to avoid duplication of their declaration '
            'when each material_attribute_value is created. ')
    unitCategories: Optional[List[ontology_annotation_schema.IsaOntologyReferenceModel]] = \
        pyd.Field(
            None,
            description='List of all the units defined in the study, used to avoid duplication '
                        'of their declaration when each value is created. ')
    processSequence: Optional[List[process_schema.IsaProcessOrProtocolApplicationModel]] = None
    comments: Optional[List[comment_schema.IsaCommentModel]] = None

characteristicCategories class-attribute instance-attribute

characteristicCategories: Optional[List[material_attribute_schema.IsaMaterialAttributeModel]] = (
    pyd.Field(
        None,
        description="List of all the characteristics categories (or material attributes) defined in the study, used to avoid duplication of their declaration when each material_attribute_value is created. ",
    )
)

comments class-attribute instance-attribute

comments: Optional[List[comment_schema.IsaCommentModel]] = None

dataFiles class-attribute instance-attribute

dataFiles: Optional[List[data_schema.IsaDataModel]] = None

field_context class-attribute instance-attribute

field_context: Optional[str] = pyd.Field(None, alias='@context')

field_id class-attribute instance-attribute

field_id: Optional[str] = pyd.Field(None, alias='@id')

field_type class-attribute instance-attribute

field_type: Optional[FieldType] = pyd.Field(None, alias='@type')

filename class-attribute instance-attribute

filename: Optional[str] = None

materials class-attribute instance-attribute

materials: Optional[_MaterialsModel] = None

measurementType class-attribute instance-attribute

measurementType: Optional[ontology_annotation_schema.IsaOntologyReferenceModel] = None

processSequence class-attribute instance-attribute

processSequence: Optional[List[process_schema.IsaProcessOrProtocolApplicationModel]] = None

technologyPlatform class-attribute instance-attribute

technologyPlatform: Optional[str] = None

technologyType class-attribute instance-attribute

technologyType: Optional[ontology_annotation_schema.IsaOntologyReferenceModel] = None

unitCategories class-attribute instance-attribute

unitCategories: Optional[List[ontology_annotation_schema.IsaOntologyReferenceModel]] = pyd.Field(
    None,
    description="List of all the units defined in the study, used to avoid duplication of their declaration when each value is created. ",
)

Config

ATTRIBUTE	DESCRIPTION
extra
use_enum_values

Source code in src/omnipy/components/isa/models/assay_schema.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