Source code for tidy3d.web.core.task_info

""" Defnes information about a task """
from datetime import datetime
from enum import Enum
from abc import ABC
from typing import Optional

import pydantic.v1 as pydantic




class TaskStatus(Enum):
    """The statuses that the task can be in."""

    INIT = "initialized"
    QUEUE = "queued"
    PRE = "preprocessing"
    RUN = "running"
    POST = "postprocessing"
    SUCCESS = "success"
    ERROR = "error"



class TaskBase(pydantic.BaseModel, ABC):
    """Base config for all task objects."""

    class Config:
        """configure class"""

        arbitrary_types_allowed = True


class ChargeType(str, Enum):
    """The payment method of task."""

    FREE = "free"
    PAID = "paid"


class TaskBlockInfo(TaskBase):
    """The block info that task will be blocked by all three features of DE,
    User limit and Insufficient balance"""

    chargeType: ChargeType = None
    maxFreeCount: int = None
    maxGridPoints: int = None
    maxTimeSteps: int = None




class TaskInfo(TaskBase):
    """General information about task."""

    taskId: str
    taskName: str = None
    nodeSize: int = None
    completedAt: Optional[datetime] = None
    status: str = None
    realCost: float = None
    timeSteps: int = None
    solverVersion: str = None
    createAt: Optional[datetime] = None
    estCostMin: float = None
    estCostMax: float = None
    realFlexUnit: float = None
    oriRealFlexUnit: float = None
    estFlexUnit: float = None
    estFlexCreditTimeStepping: float = None
    estFlexCreditPostProcess: float = None
    estFlexCreditMode: float = None
    s3Storage: float = None
    startSolverTime: Optional[datetime] = None
    finishSolverTime: Optional[datetime] = None
    totalSolverTime: int = None
    callbackUrl: str = None
    taskType: str = None
    metadataStatus: str = None
    taskBlockInfo: TaskBlockInfo = None



class RunInfo(TaskBase):
    """Information about the run."""

    perc_done: pydantic.confloat(ge=0.0, le=100.0)
    field_decay: pydantic.confloat(ge=0.0, le=1.0)

    def display(self):
        """Print some info."""
        print(f" - {self.perc_done:.2f} (%) done")
        print(f" - {self.field_decay:.2e} field decay from max")