Source code for autowisp.database.data_model.input_master_types

"""Define class specifying what masters are needed for what step/image type."""

from __future__ import annotations

from sqlalchemy import Column, Integer, String, Boolean, ForeignKey, Index
from sqlalchemy.orm import relationship

from autowisp.database.data_model.base import DataModelBase

__all__ = ["InputMasterTypes"]




class InputMasterTypes(DataModelBase):
    """The table describing the prerequisites for a step to run"""

    __tablename__ = "input_master_types"

    step_id = Column(
        Integer,
        ForeignKey("step.id"),
        doc="The step for which this prerequisite applies.",
    )
    image_type_id = Column(
        Integer,
        ForeignKey("image_type.id"),
        doc="The image type for which this prerequisite applies.",
    )
    master_type_id = Column(
        Integer,
        ForeignKey("master_type.id"),
        doc="The master type required for the step to run.",
    )
    optional = Column(
        Boolean,
        default=False,
        doc="Can processing by the given step of the given types of images "
        "can proceed if the given type of master is not found?",
    )
    config_name = Column(
        String(50),
        nullable=False,
        doc="The name of the configuration parameter that specifies the "
        "master when running the specified step.",
    )

    __table_args__ = (
        Index(
            "input_master_key2", "step_id", "image_type_id", "master_type_id"
        ),
    )

    step = relationship("Step")
    image_type = relationship("ImageType")
    master_type = relationship("MasterType")

    def __repr__(self):
        return (
            f"{self.step} {self.image_type} needs master "
            f"{self.master_type.name}"
        )