Source code for rubin_nights.ts_xml_enums

# xml_enums isolates the use of ts-xml enums here
# if ts-xml is installed, use the proper imports
# if not, substitute hard-coded versions and issue warning

import enum
import logging
from typing import TYPE_CHECKING

import pandas as pd

logger = logging.getLogger(__name__)

__all__ = ["ScriptState", "CSCState", "SalIndex", "CategoryIndexExtended", "apply_enum"]

# Make mypy happy like this
if TYPE_CHECKING:
    from lsst.ts.xml.enums.Script import ScriptState
    from lsst.ts.xml.enums.ScriptQueue import SalIndex
    from lsst.ts.xml.sal_enums import State as CSCState


else:
    try:
        from lsst.ts.xml.enums.Script import ScriptState
        from lsst.ts.xml.enums.ScriptQueue import SalIndex
        from lsst.ts.xml.sal_enums import State as CSCState

    except ModuleNotFoundError:

        logger.warning("Could not import ts-xml; substituting copies but please install lsst-ts-xml.")
        # Could not import ts_xml so define the enums here
        # These are fairly stable; but better to import from ts-xml.



        class CSCState(enum.IntEnum):
            """CSC summaryState constants."""

            OFFLINE = 4
            STANDBY = 5
            DISABLED = 1
            ENABLED = 2
            FAULT = 3




        class ScriptState(enum.IntEnum):
            """ScriptState constants."""

            UNKNOWN = 0
            UNCONFIGURED = 1
            CONFIGURED = 2
            RUNNING = 3
            PAUSED = 4
            ENDING = 5
            STOPPING = 6
            FAILING = 7
            DONE = 8
            STOPPED = 9
            FAILED = 10
            CONFIGURE_FAILED = 11




        class SalIndex(enum.IntEnum):
            """Allowed SAL indices for the bin scripts.

            The CSC allows other positive values, as well,
            but those should only be used for unit testing.
            """

            MAIN_TEL = 1
            AUX_TEL = 2
            OCS = 3





class CategoryIndexExtended(enum.IntEnum):
    """Add assigned `category index` values for other portions of the
    scriptqueue context feed.
    """

    MAIN_TEL = SalIndex.MAIN_TEL.value
    AUX_TEL = SalIndex.AUX_TEL.value
    OCS = SalIndex.OCS.value
    ERRORS_SIMONYI = 4
    ERRORS_AUX = 5
    ERRORS_OTHER = 6
    EXP_SIMONYI = 7
    EXP_AUX = 8
    EXP_OTHER = 9
    AUTOLOG_SIMONYI = 10
    AUTOLOG_AUX = 11
    AUTOLOG_OTHER = 12
    NARRATIVE_LOG_SIMONYI = 20
    NARRATIVE_LOG_AUX = 21
    NARRATIVE_LOG_OTHER = 22
    OBSERVATORY_STATUS_SIMONYI = 23





def apply_enum(x: pd.Series, column: str, enumvals: ScriptState | CSCState) -> str:
    """Apply one of the ts-xml enums"""
    return enumvals(x[column]).name