Source code for pyobs.robotic.scripts.script

from __future__ import annotations

import logging
from typing import TYPE_CHECKING, Any

from pyobs.utils.serialization import PolymorphicBaseModel
from pyobs.utils.time import Time

if TYPE_CHECKING:
    from pyobs.robotic.task import TaskData

log = logging.getLogger(__name__)



[docs]
class Script(PolymorphicBaseModel):
    exptime_done: float = 0.0

    _cant_run_reason: str | None = None


[docs]
    async def can_run(self, data: TaskData | None) -> bool:
        """Checks whether this script could run now.

        Returns:
            True, if the script can run now.
        """
        return True



[docs]
    def cant_run_reason(self) -> str | None:
        """Returns reason why script cannot run, or None if it can."""
        return self._cant_run_reason



[docs]
    async def run(self, data: TaskData | None) -> None:
        """Run script.

        Raises:
            InterruptedError: If interrupted
        """
        raise NotImplementedError



[docs]
    def get_fits_headers(self, namespaces: list[str] | None = None) -> dict[str, Any]:
        """Returns FITS header for the current status of this module.

        Args:
            namespaces: If given, only return FITS headers for the given namespaces.

        Returns:
            Dictionary containing FITS headers.
        """
        return {}



[docs]
    def estimate_duration(self, data: TaskData | None = None, time: Time | None = None) -> float:
        """Estimate duration of this script in seconds."""
        return 0.0




__all__ = ["Script"]