omnipy.components.isa.models.protocol_schema

CLASS	DESCRIPTION
Component
FieldType
IsaProtocolModel
IsaProtocolSchema

Component

Bases: pyd.BaseModel

ATTRIBUTE	DESCRIPTION
comments	TYPE: Optional[List[comment_schema.IsaCommentModel]]
componentName	TYPE: Optional[str]
componentType	TYPE: Optional[ontology_annotation_schema.IsaOntologyReferenceModel]

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

class Component(pyd.BaseModel):
    componentName: Optional[str] = None
    componentType: Optional[ontology_annotation_schema.IsaOntologyReferenceModel] = (None)
    comments: Optional[List[comment_schema.IsaCommentModel]] = None

comments class-attribute instance-attribute

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

componentName class-attribute instance-attribute

componentName: Optional[str] = None

componentType class-attribute instance-attribute

componentType: Optional[ontology_annotation_schema.IsaOntologyReferenceModel] = None

FieldType

Bases: Enum

ATTRIBUTE	DESCRIPTION
Protocol

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

class FieldType(Enum):
    Protocol = 'Protocol'

Protocol class-attribute instance-attribute

Protocol = 'Protocol'

IsaProtocolModel

Bases: Model[IsaProtocolSchema]

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

class IsaProtocolModel(Model[IsaProtocolSchema]):
    ...

IsaProtocolSchema

Bases: pyd.BaseModel

CLASS	DESCRIPTION
Config

ATTRIBUTE	DESCRIPTION
comments	TYPE: Optional[List[comment_schema.IsaCommentModel]]
components	TYPE: Optional[List[Component]]
description	TYPE: Optional[str]
field_context	TYPE: Optional[str]
field_id	TYPE: Optional[str]
field_type	TYPE: Optional[FieldType]
name	TYPE: Optional[str]
parameters	TYPE: Optional[List[protocol_parameter_schema.IsaProtocolParameterModel]]
protocolType	TYPE: Optional[ontology_annotation_schema.IsaOntologyReferenceModel]
uri	TYPE: Optional[str]
version	TYPE: Optional[str]

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

class IsaProtocolSchema(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')
    name: Optional[str] = None
    protocolType: Optional[ontology_annotation_schema.IsaOntologyReferenceModel] = None
    description: Optional[str] = None
    uri: Optional[str] = None
    version: Optional[str] = None
    parameters: Optional[List[protocol_parameter_schema.IsaProtocolParameterModel]] = (None)
    components: Optional[List[Component]] = None
    comments: Optional[List[comment_schema.IsaCommentModel]] = None

comments class-attribute instance-attribute

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

components class-attribute instance-attribute

components: Optional[List[Component]] = None

description class-attribute instance-attribute

description: Optional[str] = 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')

name class-attribute instance-attribute

name: Optional[str] = None

parameters class-attribute instance-attribute

parameters: Optional[List[protocol_parameter_schema.IsaProtocolParameterModel]] = None

protocolType class-attribute instance-attribute

protocolType: Optional[ontology_annotation_schema.IsaOntologyReferenceModel] = None

uri class-attribute instance-attribute

uri: Optional[str] = None

version class-attribute instance-attribute

version: Optional[str] = None

Config

ATTRIBUTE	DESCRIPTION
extra
use_enum_values

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