Source code for pyenzyme.enzymeml.core.creator

# File: creator.py
# Project: core
# Author: Jan Range
# License: BSD-2 clause
# Copyright (c) 2022 Institute of Biochemistry and Technical Biochemistry Stuttgart

from pydantic import Field, validator, ValidationError
from typing import TYPE_CHECKING, Optional
from dataclasses import dataclass

from pyenzyme.enzymeml.core.enzymemlbase import EnzymeMLBase
from pyenzyme.enzymeml.core.utils import type_checking, deprecated_getter

if TYPE_CHECKING:  # pragma: no cover
    static_check_init_args = dataclass
else:
    static_check_init_args = type_checking


[docs]@static_check_init_args class Creator(EnzymeMLBase): given_name: str = Field( ..., description="Given name of the author or contributor.", ) family_name: str = Field( ..., description="Family name of the author or contributor.", ) mail: str = Field( ..., description="Email address of the author or contributor.", ) id: Optional[str] = Field( None, description="Unique identifier of the protein.", regex=r"a[\d]+" )
[docs] @validator("given_name", "family_name", "mail", pre=True) def check_empty_strings(cls, value): if not value: raise ValueError( "An empty string has been provided. Please make sure to provide a valid string." ) return value
[docs] @validator("mail") def check_mail_consistency(cls, mail): if len(mail.split("@")) != 2: raise ValueError(f"{mail} is not a valid mail adress.") return mail
[docs] @deprecated_getter("family_name") def getFname(self) -> str: return self.family_name
[docs] @deprecated_getter("given_name") def getGname(self) -> str: return self.given_name
[docs] @deprecated_getter("mail") def getMail(self) -> str: return self.mail