felicity-lims/felicity/apps/instrument/schemas.py

from datetime import datetime
from typing import List, Optional

from pydantic import BaseModel, ConfigDict

from felicity.apps.common.schemas import BaseAuditModel
from felicity.apps.setup.schemas import ManufacturerInDB, SupplierInDB


#
# InstrumentType Schemas
#

# Shared properties
class InstrumentTypeBase(BaseAuditModel):
    name: str | None = None
    description: str | None = None
    active: bool | None = True


class InstrumentTypeBaseInDB(InstrumentTypeBase):
    uid: str | None = None

    model_config = ConfigDict(from_attributes=True)


# Properties to receive via API on creation
class InstrumentTypeCreate(InstrumentTypeBase):
    pass


# Properties to receive via API on update
class InstrumentTypeUpdate(InstrumentTypeBase):
    pass


# Properties to return via API
class InstrumentType(InstrumentTypeBaseInDB):
    pass


# Properties stored in DB
class AnalysisCategoryInDB(InstrumentTypeBaseInDB):
    pass


#
#  Instrument
#

# Shared properties
class InstrumentBase(BaseModel):
    name: str
    description: str | None = None
    keyword: str | None = None
    instrument_type_uid: str | None = None
    instrument_type: InstrumentType | None = None
    manufacturer_uid: str | None = None
    manufacturer: ManufacturerInDB | None = None
    supplier_uid: str | None = None
    supplier: SupplierInDB | None = None


# Properties to receive via API on creation
class InstrumentCreate(InstrumentBase):
    supplier_uid: str | None = None
    keyword: str | None = None
    instrument_type_uid: str | None = None
    manufacturer_uid: str | None = None


# Properties to receive via API on update
class InstrumentUpdate(InstrumentBase):
    supplier_uid: str | None = None


class InstrumentInDBBase(InstrumentBase):
    uid: str

    model_config = ConfigDict(from_attributes=True)


# Additional properties to return via API
class Instrument(InstrumentInDBBase):
    pass


# Additional properties stored in DB
class InstrumentInDB(InstrumentInDBBase):
    pass


#
# Laboratory Instrument
#

# Shared properties
class LaboratoryInstrumentBase(BaseModel):
    instrument_uid: str | None = None
    instrument: Instrument | None = None
    lab_name: str | None = None
    serial_number: str | None = None
    date_commissioned: datetime | None = None
    date_decommissioned: datetime | None = None


# Properties to receive via API on creation
class LaboratoryInstrumentCreate(LaboratoryInstrumentBase):
    instrument_uid: str


# Properties to receive via API on update
class LaboratoryInstrumentUpdate(LaboratoryInstrumentBase):
    pass


class LaboratoryInstrumentInDBBase(LaboratoryInstrumentBase):
    uid: str

    model_config = ConfigDict(from_attributes=True)


# Additional properties to return via API
class LaboratoryInstrument(LaboratoryInstrumentInDBBase):
    pass


# Additional properties stored in DB
class LaboratoryInstrumentInDB(LaboratoryInstrumentInDBBase):
    pass


#
#  InstrumentCalibration
#

# Shared properties
class InstrumentCalibrationBase(BaseModel):
    laboratory_instrument_uid: str
    laboratory_instrument: Optional[LaboratoryInstrument] = None
    calibration_id: str
    date_reported: datetime
    report_id: str
    performed_by: str
    start_date: datetime
    end_date: datetime
    notes_before: str
    work_done: str
    remarks: str


# Properties to receive via API on creation
class InstrumentCalibrationCreate(InstrumentCalibrationBase):
    pass


# Properties to receive via API on update
class InstrumentCalibrationUpdate(InstrumentCalibrationBase):
    pass


class InstrumentCalibrationInDBBase(InstrumentCalibrationBase):
    uid: str = None


model_config = ConfigDict(from_attributes=True)


# Additional properties to return via API
class InstrumentCalibration(InstrumentCalibrationInDBBase):
    pass


# Additional properties stored in DB
class InstrumentCalibrationInDB(InstrumentCalibrationInDBBase):
    pass


#
#  CalibrationCertificate
#

# Shared properties
class CalibrationCertificateBase(BaseModel):
    laboratory_instrument_uid: str
    laboratory_instrument: Optional[LaboratoryInstrument] = None
    certificate_code: str
    internal: bool = True
    issuer: str
    date_issued: datetime
    valid_from_date: datetime
    valid_to_date: datetime
    performed_by: str
    approved_by: str
    remarks: str


# Properties to receive via API on creation
class CalibrationCertificateCreate(CalibrationCertificateBase):
    pass


# Properties to receive via API on update
class CalibrationCertificateUpdate(CalibrationCertificateBase):
    pass


class CalibrationCertificateInDBBase(CalibrationCertificateBase):
    uid: str = None
    model_config = ConfigDict(from_attributes=True)


# Additional properties to return via API
class CalibrationCertificate(CalibrationCertificateInDBBase):
    pass


# Additional properties stored in DB
class CalibrationCertificateInDB(CalibrationCertificateInDBBase):
    pass


#
#  InstrumentCompetence
#

# Shared properties
class InstrumentCompetenceBase(BaseModel):
    instrument_uid: str
    instrument: Optional[Instrument] = None
    description: str
    user_uid: str
    issue_date: datetime
    expiry_date: datetime
    internal: bool
    competence: str


# Properties to receive via API on creation
class InstrumentCompetenceCreate(InstrumentCompetenceBase):
    pass


# Properties to receive via API on update
class InstrumentCompetenceUpdate(InstrumentCompetenceBase):
    pass


class InstrumentCompetenceInDBBase(InstrumentCompetenceBase):
    uid: str = None
    model_config = ConfigDict(from_attributes=True)


# Additional properties to return via API
class InstrumentCompetence(InstrumentCompetenceInDBBase):
    pass


# Additional properties stored in DB
class InstrumentCompetenceInDB(InstrumentCompetenceInDBBase):
    pass


#
#  Method
#

# Shared properties
class MethodBase(BaseModel):
    name: str = None
    description: str = None
    keyword: str = None
    instruments: Optional[List[Instrument]] = []


# Properties to receive via API on creation
class MethodCreate(MethodBase):
    pass


# Properties to receive via API on update
class MethodUpdate(MethodBase):
    pass


class MethodInDBBase(MethodBase):
    uid: str = None
    model_config = ConfigDict(from_attributes=True)


# Additional properties to return via API
class Method(MethodInDBBase):
    pass


# Additional properties stored in DB
class MethodInDB(MethodInDBBase):
    pass