omnipy.components.isa.models.comment_schema

CLASS	DESCRIPTION
FieldType
IsaCommentModel
IsaCommentSchema

FieldType

Bases: Enum

ATTRIBUTE	DESCRIPTION
Comment

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

class FieldType(Enum):
    Comment = 'Comment'

Comment class-attribute instance-attribute

Comment = 'Comment'

IsaCommentModel

Bases: Model[IsaCommentSchema]

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

class IsaCommentModel(Model[IsaCommentSchema]):
    ...

IsaCommentSchema

Bases: pyd.BaseModel

CLASS	DESCRIPTION
Config

ATTRIBUTE	DESCRIPTION
field_context	TYPE: Optional[str]
field_id	TYPE: Optional[str]
field_type	TYPE: Optional[FieldType]
name	TYPE: Optional[str]
value	TYPE: Optional[str]

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

class IsaCommentSchema(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
    value: 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

value class-attribute instance-attribute

value: Optional[str] = None

Config

ATTRIBUTE	DESCRIPTION
extra
use_enum_values

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