omnipy.components.isa.models.ontology_annotation_schema

CLASS	DESCRIPTION
FieldType
IsaOntologyReferenceModel
IsaOntologyReferenceSchema

FieldType

Bases: Enum

ATTRIBUTE	DESCRIPTION
OntologyAnnotation

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

class FieldType(Enum):
    OntologyAnnotation = 'OntologyAnnotation'

OntologyAnnotation class-attribute instance-attribute

OntologyAnnotation = 'OntologyAnnotation'

IsaOntologyReferenceModel

Bases: Model[IsaOntologyReferenceSchema]

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

class IsaOntologyReferenceModel(Model[IsaOntologyReferenceSchema]):
    ...

IsaOntologyReferenceSchema

Bases: pyd.BaseModel

CLASS	DESCRIPTION
Config

ATTRIBUTE	DESCRIPTION
annotationValue	TYPE: Optional[Union[str, float]]
comments	TYPE: Optional[List[comment_schema.IsaCommentModel]]
field_context	TYPE: Optional[str]
field_id	TYPE: Optional[str]
field_type	TYPE: Optional[FieldType]
termAccession	TYPE: Optional[str]
termSource	TYPE: Optional[str]

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

class IsaOntologyReferenceSchema(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')
    annotationValue: Optional[Union[str, float]] = None
    termSource: Optional[str] = pyd.Field(
        None,
        description='The abbreviated ontology name. It should correspond to one of the sources as '
        'specified in the ontologySourceReference section of the Investigation.',
    )
    termAccession: Optional[str] = None
    comments: Optional[List[comment_schema.IsaCommentModel]] = None

annotationValue class-attribute instance-attribute

annotationValue: Optional[Union[str, float]] = None

comments class-attribute instance-attribute

comments: Optional[List[comment_schema.IsaCommentModel]] = 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')

termAccession class-attribute instance-attribute

termAccession: Optional[str] = None

termSource class-attribute instance-attribute

termSource: Optional[str] = pyd.Field(
    None,
    description="The abbreviated ontology name. It should correspond to one of the sources as specified in the ontologySourceReference section of the Investigation.",
)

Config

ATTRIBUTE	DESCRIPTION
extra
use_enum_values

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