omnipy.components.isa.models.material_schema

CLASS	DESCRIPTION
FieldType
IsaMaterialModel
IsaMaterialSchema
Type

FieldType

Bases: Enum

ATTRIBUTE	DESCRIPTION
Material

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

class FieldType(Enum):
    Material = 'Material'

Material class-attribute instance-attribute

Material = 'Material'

IsaMaterialModel

Bases: Model[IsaMaterialSchema]

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

class IsaMaterialModel(Model[IsaMaterialSchema]):
    ...

IsaMaterialSchema

Bases: pyd.BaseModel

CLASS	DESCRIPTION
Config

ATTRIBUTE	DESCRIPTION
characteristics	TYPE: Optional[List[material_attribute_value_schema.IsaMaterialAttributeValueModel]]
comments	TYPE: Optional[List[comment_schema.IsaCommentModel]]
derivesFrom	TYPE: Optional[List[IsaMaterialModel]]
field_context	TYPE: Optional[str]
field_id	TYPE: Optional[str]
field_type	TYPE: Optional[FieldType]
name	TYPE: Optional[str]
type	TYPE: Optional[Type]

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

class IsaMaterialSchema(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
    type: Optional[Type] = None
    characteristics: Optional[List[
        material_attribute_value_schema.IsaMaterialAttributeValueModel]] = None
    derivesFrom: Optional[List['IsaMaterialModel']] = None
    comments: Optional[List[comment_schema.IsaCommentModel]] = None

characteristics class-attribute instance-attribute

characteristics: Optional[List[material_attribute_value_schema.IsaMaterialAttributeValueModel]] = (
    None
)

comments class-attribute instance-attribute

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

derivesFrom class-attribute instance-attribute

derivesFrom: Optional[List[IsaMaterialModel]] = 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

type class-attribute instance-attribute

type: Optional[Type] = None

Config

ATTRIBUTE	DESCRIPTION
extra
use_enum_values

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

Type

Bases: Enum

ATTRIBUTE	DESCRIPTION
Extract_Name
Labeled_Extract_Name

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

class Type(Enum):
    Extract_Name = 'Extract Name'
    Labeled_Extract_Name = 'Labeled Extract Name'

Extract_Name class-attribute instance-attribute

Extract_Name = 'Extract Name'

Labeled_Extract_Name class-attribute instance-attribute

Labeled_Extract_Name = 'Labeled Extract Name'