omnipy.components.isa.models.study_group

CLASS	DESCRIPTION
FieldType
IsaStudyGroupModel
IsaStudyGroupSchema

FieldType

Bases: Enum

ATTRIBUTE	DESCRIPTION
Study_Group

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

class FieldType(Enum):
    Study_Group = 'Study Group'

Study_Group class-attribute instance-attribute

Study_Group = 'Study Group'

IsaStudyGroupModel

Bases: Model[IsaStudyGroupSchema]

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

class IsaStudyGroupModel(Model[IsaStudyGroupSchema]):
    ...

IsaStudyGroupSchema

Bases: pyd.BaseModel

CLASS	DESCRIPTION
Config

ATTRIBUTE	DESCRIPTION
comments	TYPE: Optional[List[comment_schema.IsaCommentModel]]
factor_levels	TYPE: Optional[List[factor_value_schema.IsaFactorValueModel]]
field_context	TYPE: Optional[str]
field_id	TYPE: Optional[str]
field_type	TYPE: Optional[FieldType]
members	TYPE: Optional[List[sample_schema.IsaSampleModel]]
name	TYPE: Optional[str]
study_group_size	TYPE: Optional[int]

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

class IsaStudyGroupSchema(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
    factor_levels: Optional[List[factor_value_schema.IsaFactorValueModel]] = None
    study_group_size: Optional[int] = None
    members: Optional[List[sample_schema.IsaSampleModel]] = None
    comments: Optional[List[comment_schema.IsaCommentModel]] = None

comments class-attribute instance-attribute

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

factor_levels class-attribute instance-attribute

factor_levels: Optional[List[factor_value_schema.IsaFactorValueModel]] = 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')

members class-attribute instance-attribute

members: Optional[List[sample_schema.IsaSampleModel]] = None

name class-attribute instance-attribute

name: Optional[str] = None

study_group_size class-attribute instance-attribute

study_group_size: Optional[int] = None

Config

ATTRIBUTE	DESCRIPTION
extra
use_enum_values

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