Skip to content

omnipy.components.isa.models.person_schema

CLASS DESCRIPTION
FieldType
IsaPersonModel
IsaPersonSchema

FieldType

Bases: Enum

ATTRIBUTE DESCRIPTION
Person

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

Person class-attribute instance-attribute

Person = 'Person'

IsaPersonModel

Bases: Model[IsaPersonSchema]

Source code in src/omnipy/components/isa/models/person_schema.py
class IsaPersonModel(Model[IsaPersonSchema]):
    ...

IsaPersonSchema

Bases: pyd.BaseModel

CLASS DESCRIPTION
Config
ATTRIBUTE DESCRIPTION
address

TYPE: Optional[str]

affiliation

TYPE: Optional[str]

comments

TYPE: Optional[List[comment_schema.IsaCommentModel]]

email

TYPE: Optional[pyd.EmailStr]

fax

TYPE: Optional[str]

field_context

TYPE: Optional[str]

field_id

TYPE: Optional[str]

field_type

TYPE: Optional[FieldType]

firstName

TYPE: Optional[str]

lastName

TYPE: Optional[str]

midInitials

TYPE: Optional[str]

phone

TYPE: Optional[str]

roles

TYPE: Optional[List[ontology_annotation_schema.IsaOntologyReferenceModel]]

Source code in src/omnipy/components/isa/models/person_schema.py
class IsaPersonSchema(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')
    lastName: Optional[str] = None
    firstName: Optional[str] = None
    midInitials: Optional[str] = None
    email: Optional[pyd.EmailStr] = None
    phone: Optional[str] = None
    fax: Optional[str] = None
    address: Optional[str] = None
    affiliation: Optional[str] = None
    roles: Optional[List[ontology_annotation_schema.IsaOntologyReferenceModel]] = None
    comments: Optional[List[comment_schema.IsaCommentModel]] = None

address class-attribute instance-attribute

address: Optional[str] = None

affiliation class-attribute instance-attribute

affiliation: Optional[str] = None

comments class-attribute instance-attribute

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

email class-attribute instance-attribute

email: Optional[pyd.EmailStr] = None

fax class-attribute instance-attribute

fax: 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')

firstName class-attribute instance-attribute

firstName: Optional[str] = None

lastName class-attribute instance-attribute

lastName: Optional[str] = None

midInitials class-attribute instance-attribute

midInitials: Optional[str] = None

phone class-attribute instance-attribute

phone: Optional[str] = None

roles class-attribute instance-attribute

Config

ATTRIBUTE DESCRIPTION
extra

use_enum_values

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