Skip to content

omnipy.components.isa.models.investigation_schema

CLASS DESCRIPTION
FieldType
IsaInvestigationModel
IsaInvestigationSchema

FieldType

Bases: Enum

ATTRIBUTE DESCRIPTION
Investigation

Source code in src/omnipy/components/isa/models/investigation_schema.py
class FieldType(Enum):
    Investigation = 'Investigation'

Investigation class-attribute instance-attribute

Investigation = 'Investigation'

IsaInvestigationModel

Bases: Model[IsaInvestigationSchema]

Source code in src/omnipy/components/isa/models/investigation_schema.py
class IsaInvestigationModel(Model[IsaInvestigationSchema]):
    ...

IsaInvestigationSchema

Bases: pyd.BaseModel

CLASS DESCRIPTION
Config
ATTRIBUTE DESCRIPTION
comments

TYPE: Optional[List[comment_schema.IsaCommentModel]]

description

TYPE: Optional[str]

field_context

TYPE: Optional[str]

field_id

TYPE: Optional[str]

field_type

TYPE: Optional[FieldType]

filename

TYPE: Optional[str]

identifier

TYPE: Optional[str]

ontologySourceReferences

TYPE: Optional[List[ontology_source_reference_schema.IsaOntologySourceReferenceModel]]

people

TYPE: Optional[List[person_schema.IsaPersonModel]]

publicReleaseDate

TYPE: Optional[Union[datetime, date, pyd.constr(max_length=0)]]

publications

TYPE: Optional[List[publication_schema.IsaPublicationModel]]

studies

TYPE: Optional[List[study_schema.IsaStudyModel]]

submissionDate

TYPE: Optional[Union[datetime, date, pyd.constr(max_length=0)]]

title

TYPE: Optional[str]

Source code in src/omnipy/components/isa/models/investigation_schema.py
class IsaInvestigationSchema(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')
    filename: Optional[str] = None
    identifier: Optional[str] = None
    title: Optional[str] = None
    description: Optional[str] = None
    submissionDate: Optional[Union[datetime, date, pyd.constr(max_length=0)]] = None
    publicReleaseDate: Optional[Union[datetime, date, pyd.constr(max_length=0)]] = None
    ontologySourceReferences: Optional[List[
        ontology_source_reference_schema.IsaOntologySourceReferenceModel]] = None
    publications: Optional[List[publication_schema.IsaPublicationModel]] = None
    people: Optional[List[person_schema.IsaPersonModel]] = None
    studies: Optional[List[study_schema.IsaStudyModel]] = None
    comments: Optional[List[comment_schema.IsaCommentModel]] = None

    _date_to_iso_format = pyd.validator(
        'submissionDate', 'publicReleaseDate', allow_reuse=True)(
            date_to_iso_format)

comments class-attribute instance-attribute

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

filename class-attribute instance-attribute

filename: Optional[str] = None

identifier class-attribute instance-attribute

identifier: Optional[str] = None

ontologySourceReferences class-attribute instance-attribute

ontologySourceReferences: Optional[
    List[ontology_source_reference_schema.IsaOntologySourceReferenceModel]
] = None

people class-attribute instance-attribute

people: Optional[List[person_schema.IsaPersonModel]] = None

publicReleaseDate class-attribute instance-attribute

publicReleaseDate: Optional[Union[datetime, date, pyd.constr(max_length=0)]] = None

publications class-attribute instance-attribute

publications: Optional[List[publication_schema.IsaPublicationModel]] = None

studies class-attribute instance-attribute

studies: Optional[List[study_schema.IsaStudyModel]] = None

submissionDate class-attribute instance-attribute

submissionDate: Optional[Union[datetime, date, pyd.constr(max_length=0)]] = None

title class-attribute instance-attribute

title: Optional[str] = None

Config

ATTRIBUTE DESCRIPTION
extra

use_enum_values

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