dkist-processing-common 11.2.1rc3__py3-none-any.whl → 11.3.1rc1__py3-none-any.whl

changelog/265.feature.1.rst

@@ -0,0 +1,3 @@
+Add `_set_metadata_key_value` method to FitsAccessBase that takes a StrEnum and sets
+a class attribute.  The attribute name is the StrEnum name and the attribute value
+gets the header value with the StrEnum value as key.

changelog/265.feature.rst

@@ -0,0 +1,4 @@
+Create new MetadataKey string enum class.  Replace usages like `metadata_key="keyword_name"`
+with `metadata_key=MetadataKey.keyword_name`.  Note that unlike other enum classes, we are using
+the name, not the value. Stem bases now check if they are passed a MetadataKey, and take
+the name as the required string.

changelog/265.misc.rst

@@ -0,0 +1,2 @@
+Change classes that inherit from `str` and `Enum` to inherit `StrEnum` instead: BudName, StemName, TaskName.  Convert
+strings to class members where relevant.

dkist_processing_common/__init__.py

@@ -1,4 +1,5 @@
 """Package providing support classes and methods used by all workflow tasks."""
+
 from importlib.metadata import PackageNotFoundError
 from importlib.metadata import version
 

dkist_processing_common/_util/constants.py

@@ -1,4 +1,5 @@
 """Wrapper for interactions with shared database that holds arbitrary data that persists across the entire recipe run."""
+
 import json
 from collections.abc import MutableMapping
 from enum import Enum

dkist_processing_common/_util/graphql.py

@@ -1,4 +1,5 @@
 """Extension of the GraphQL supporting retries for data processing use cases."""
+
 import logging
 from typing import Any
 from typing import Callable

dkist_processing_common/_util/scratch.py

@@ -1,4 +1,5 @@
 """Scratch file system api."""
+
 import logging
 from contextlib import contextmanager
 from os import umask
@@ -9,7 +10,6 @@ from typing import Generator
 from dkist_processing_common._util.tags import TagDB
 from dkist_processing_common.config import common_configurations
 
-
 logger = logging.getLogger(__name__)
 
 

dkist_processing_common/_util/tags.py

@@ -1,4 +1,5 @@
 """Tag cloud manager."""
+
 from pathlib import Path
 from typing import Iterable
 

dkist_processing_common/codecs/array.py

@@ -1,4 +1,5 @@
 """Encoder/decoder for writing/reading numpy arrays."""
+
 import io
 from pathlib import Path
 

dkist_processing_common/codecs/asdf.py

@@ -1,4 +1,5 @@
 """Encoders and decoders for writing and reading ASDF files."""
+
 from io import BytesIO
 from pathlib import Path
 

dkist_processing_common/codecs/basemodel.py

@@ -1,4 +1,5 @@
 """Encoder/decoder for writing and reading Pydantic BaseModel objects."""
+
 from pathlib import Path
 from typing import Type
 

dkist_processing_common/codecs/bytes.py

@@ -1,4 +1,5 @@
 """Encoder/decoder for writing and reading bytes objects."""
+
 from pathlib import Path
 
 

dkist_processing_common/codecs/fits.py

@@ -1,4 +1,5 @@
 """Encoders and decoders for writing and reading FITS files."""
+
 from io import BytesIO
 from pathlib import Path
 from typing import Type

dkist_processing_common/codecs/iobase.py

@@ -1,4 +1,5 @@
 """Encoder/decoder for writing and reading IOBase binary (i.e., not Text) objects."""
+
 from io import BytesIO
 from io import IOBase
 from io import TextIOBase

dkist_processing_common/codecs/json.py

@@ -1,4 +1,5 @@
 """Encoder/decoders for writing and reading JSON files."""
+
 import json
 from pathlib import Path
 from typing import Any

dkist_processing_common/codecs/path.py

@@ -1,4 +1,5 @@
 """Default decoder to pass through paths from `read`."""
+
 from pathlib import Path
 
 

dkist_processing_common/codecs/quality.py

@@ -1,4 +1,5 @@
 """Encoder/decoders for writing and reading quality data."""
+
 import json
 import logging
 from datetime import datetime
@@ -10,7 +11,6 @@ import numpy as np
 from dkist_processing_common.codecs.json import json_decoder
 from dkist_processing_common.codecs.json import json_encoder
 
-
 logger = logging.getLogger(__name__)
 
 

dkist_processing_common/codecs/str.py

@@ -1,4 +1,5 @@
 """Encoder/decoder for writing and reading str to files."""
+
 from pathlib import Path
 
 from dkist_processing_common.codecs.bytes import bytes_decoder

dkist_processing_common/config.py

@@ -1,4 +1,5 @@
 """Common configurations."""
+
 from dkist_processing_core.config import DKISTProcessingCoreConfiguration
 from dkist_service_configuration.settings import DEFAULT_MESH_SERVICE
 from dkist_service_configuration.settings import MeshService

dkist_processing_common/manual.py

@@ -1,4 +1,5 @@
 """Task wrapper for manual execution outside the workflow engine."""
+
 import json
 import logging
 import shutil
@@ -14,7 +15,6 @@ from dkist_processing_common.models.tags import Tag
 from dkist_processing_common.tasks.base import WorkflowTaskBase
 from dkist_processing_common.tests.mock_metadata_store import fake_gql_client_factory
 
-
 logger = logging.getLogger(__name__)
 
 

dkist_processing_common/models/constants.py

@@ -4,7 +4,8 @@ Components of the Constant model.
 Contains names of database entries and Base class for an object that simplifies
 accessing the database (tab completion, etc.)
 """
-from enum import Enum
+
+from enum import StrEnum
 from string import ascii_uppercase
 
 from sqids import Sqids
@@ -12,13 +13,13 @@ from sqids import Sqids
 from dkist_processing_common._util.constants import ConstantsDb
 
 
-class BudName(str, Enum):
+class BudName(StrEnum):
     """Controlled list of names for constant stems (buds)."""
 
-    recipe_run_id = "RECIPE_RUN_ID"
     instrument = "INSTRUMENT"
     num_cs_steps = "NUM_CS_STEPS"
     num_modstates = "NUM_MODSTATES"
+    retarder_name = "RETARDER_NAME"
     proposal_id = "PROPOSAL_ID"
     contributing_proposal_ids = "CONTRIBUTING_PROPOSAL_IDS"
     experiment_id = "EXPERIMENT_ID"
@@ -32,7 +33,6 @@ class BudName(str, Enum):
     dark_exposure_times = "DARK_EXPOSURE_TIMES"
     dark_readout_exp_times = "DARK_READOUT_EXP_TIMES"
     wavelength = "WAVELENGTH"
-    retarder_name = "RETARDER_NAME"
 
 
 class ConstantsBase:
@@ -62,7 +62,7 @@ class ConstantsBase:
     Parameters
     ----------
     recipe_run_id
-        Thew recipe_run_id
+        The recipe_run_id
     task_name
         The task_name
     """
@@ -90,6 +90,31 @@ class ConstantsBase:
         """Define the dataset_id constant."""
         return Sqids(min_length=6, alphabet=ascii_uppercase).encode([self._recipe_run_id])
 
+    @property
+    def stokes_params(self) -> [str]:
+        """Return the list of stokes parameter names."""
+        return ["I", "Q", "U", "V"]
+
+    @property
+    def instrument(self) -> str:
+        """Get the instrument name."""
+        return self._db_dict[BudName.instrument]
+
+    @property
+    def num_cs_steps(self):
+        """Get the number of calibration sequence steps."""
+        return self._db_dict[BudName.num_cs_steps]
+
+    @property
+    def num_modstates(self):
+        """Get the number of modulation states."""
+        return self._db_dict[BudName.num_modstates]
+
+    @property
+    def retarder_name(self):
+        """Get the retarder name."""
+        return self._db_dict[BudName.retarder_name]
+
     @property
     def proposal_id(self) -> str:
         """Get the proposal_id constant."""
@@ -104,14 +129,22 @@ class ConstantsBase:
         return proposal_ids
 
     @property
-    def instrument(self) -> str:
-        """Get the instrument name."""
-        return self._db_dict[BudName.instrument]
+    def experiment_id(self) -> str:
+        """Get the experiment_id constant."""
+        return self._db_dict[BudName.experiment_id]
+
+    @property
+    def contributing_experiment_ids(self) -> [str]:
+        """Return the list of contributing experiment IDs."""
+        experiment_ids = self._db_dict[BudName.contributing_experiment_ids]
+        if isinstance(experiment_ids, str):
+            return [experiment_ids]
+        return experiment_ids
 
     @property
     def obs_ip_start_time(self) -> str:
         """Return the start time of the observe IP."""
-        return self._db_dict[BudName.obs_ip_start_time.value]
+        return self._db_dict[BudName.obs_ip_start_time]
 
     @property
     def average_cadence(self) -> float:
@@ -148,25 +181,7 @@ class ConstantsBase:
         """Get a list of readout exp times for all DARK frames."""
         return self._db_dict[BudName.dark_readout_exp_times]
 
-    @property
-    def stokes_params(self) -> [str]:
-        """Return the list of stokes parameter names."""
-        return ["I", "Q", "U", "V"]
-
-    @property
-    def experiment_id(self) -> str:
-        """Get the experiment_id constant."""
-        return self._db_dict[BudName.experiment_id]
-
-    @property
-    def contributing_experiment_ids(self) -> [str]:
-        """Return the list of contributing experiment IDs."""
-        experiment_ids = self._db_dict[BudName.contributing_experiment_ids]
-        if isinstance(experiment_ids, str):
-            return [experiment_ids]
-        return experiment_ids
-
     @property
     def wavelength(self) -> float:
         """Wavelength."""
-        return self._db_dict[BudName.wavelength.value]
+        return self._db_dict[BudName.wavelength]

dkist_processing_common/models/dkist_location.py

@@ -3,10 +3,10 @@
 Cartesian geocentric coordinates of DKIST on Earth as retrieved from
 https://github.com/astropy/astropy-data/blob/gh-pages/coordinates/sites.json#L838
 """
+
 import astropy.units as u
 from astropy.coordinates import EarthLocation
 
-
 _dkist_site_info = {
     "aliases": ["DKIST", "ATST"],
     "name": "Daniel K. Inouye Solar Telescope",

dkist_processing_common/models/fits_access.py

@@ -1,11 +1,45 @@
 """Abstraction layer for accessing fits data via class attributes."""
+
 from __future__ import annotations
 
+from enum import StrEnum
 from pathlib import Path
+from typing import Any
 
 import numpy as np
 from astropy.io import fits
 
+NOT_FOUND_MESSAGE = "_HEADER_KEYWORD_NOT_FOUND"
+
+
+class MetadataKey(StrEnum):
+    """Controlled list of names for FITS metadata header keys."""
+
+    ip_task_type = "IPTASK"  # in L0FitsAccess
+    ip_start_time = "DKIST011"  # in L0FitsAccess
+    ip_end_time = "DKIST012"  # in L0FitsAccess
+    elevation = "ELEV_ANG"
+    azimuth = "TAZIMUTH"
+    table_angle = "TTBLANGL"
+    gos_level3_status = "LVL3STAT"
+    gos_level3_lamp_status = "LAMPSTAT"
+    gos_polarizer_status = "LVL2STAT"
+    gos_polarizer_angle = "POLANGLE"
+    gos_retarder_status = "LVL1STAT"
+    gos_retarder_angle = "RETANGLE"
+    gos_level0_status = "LVL0STAT"
+    time_obs = "DATE-BEG"
+    ip_id = "IP_ID"
+    instrument = "INSTRUME"
+    wavelength = "LINEWAV"
+    proposal_id = "PROP_ID"
+    experiment_id = "EXPER_ID"
+    num_dsps_repeats = "DSPSREPS"
+    current_dsps_repeat = "DSPSNUM"
+    fpa_exposure_time_ms = "XPOSURE"
+    sensor_readout_exposure_time_ms = "TEXPOSUR"
+    num_raw_frames_per_fpa = "NSUMEXP"
+
 
 class FitsAccessBase:
     """
@@ -34,6 +68,29 @@ class FitsAccessBase:
     def __repr__(self):
         return f"{self.__class__.__name__}(hdu={self._hdu!r}, name={self.name!r}, auto_squeeze={self.auto_squeeze})"
 
+    def _set_metadata_key_value(
+        self, key: StrEnum, optional: bool = False, default: Any = NOT_FOUND_MESSAGE
+    ) -> None:
+        """
+        Get the header value and assign it as a metadata key name attribute.
+
+        Parameters
+        ----------
+        key
+            The StrEnum member in attribute_name = fits_keyword structure
+        optional
+            If the keyword is optional
+        default
+            Value for the attribute if the key is not found
+        """
+        if optional:
+            if default != NOT_FOUND_MESSAGE:
+                setattr(self, key.name, self.header.get(key, default))
+            else:
+                setattr(self, key.name, self.header.get(key, key + NOT_FOUND_MESSAGE))
+        else:
+            setattr(self, key.name, self.header[key])
+
     @property
     def data(self) -> np.ndarray:
         """

dkist_processing_common/models/flower_pot.py

@@ -6,6 +6,7 @@ Defines:
 
     FlowerPot -> Container for Stem children (Flowers)
 """
+
 from __future__ import annotations
 
 from abc import ABC

dkist_processing_common/models/graphql.py

@@ -1,9 +1,10 @@
 """GraphQL Data models for the metadata store api."""
+
 from pydantic import BaseModel
 from pydantic import ConfigDict
+from pydantic import Json
 from pydantic import field_serializer
 from pydantic import field_validator
-from pydantic import Json
 
 from dkist_processing_common.models.input_dataset import InputDatasetBaseModel
 from dkist_processing_common.models.input_dataset import InputDatasetPartDocumentList

dkist_processing_common/models/input_dataset.py

@@ -1,4 +1,5 @@
 """Input dataset models for the inputDatasetPartDocument from the metadata store api."""
+
 import json
 from datetime import datetime
 from typing import Any
@@ -6,10 +7,10 @@ from typing import Any
 from pydantic import BaseModel
 from pydantic import ConfigDict
 from pydantic import Field
-from pydantic import field_serializer
-from pydantic import field_validator
 from pydantic import Json
 from pydantic import PlainSerializer
+from pydantic import field_serializer
+from pydantic import field_validator
 from pydantic.alias_generators import to_camel
 from typing_extensions import Annotated
 

dkist_processing_common/models/message.py

@@ -1,11 +1,11 @@
 """Data structures for messages placed on the interservice bus."""
+
 from typing import Type
 
 from pydantic import Field
 from talus import MessageBodyBase
 from talus import PublishMessageBase
 
-
 ########################
 # Message Body Schemas #
 ########################

dkist_processing_common/models/message_queue_binding.py

@@ -1,4 +1,5 @@
 """Binding between a queue and a message to be published."""
+
 from talus import Binding
 from talus import Queue
 
@@ -7,7 +8,6 @@ from dkist_processing_common.models.message import CatalogFrameMessage
 from dkist_processing_common.models.message import CatalogObjectMessage
 from dkist_processing_common.models.message import CreateQualityReportMessage
 
-
 catalog_frame_queue = Queue(
     name="catalog.frame.q", arguments=common_configurations.isb_queue_arguments
 )

dkist_processing_common/models/metric_code.py

@@ -1,4 +1,5 @@
 """Controlled list of quality metric codes."""
+
 from enum import StrEnum
 
 

dkist_processing_common/models/parameters.py

@@ -1,4 +1,5 @@
 """Base class for parameter-parsing object."""
+
 import logging
 from contextlib import contextmanager
 from datetime import datetime
@@ -18,7 +19,6 @@ from dkist_processing_common.models.input_dataset import InputDatasetFilePointer
 from dkist_processing_common.models.input_dataset import InputDatasetPartDocumentList
 from dkist_processing_common.models.tags import Tag
 
-
 logger = logging.getLogger(__name__)
 
 

dkist_processing_common/models/quality.py

@@ -1,4 +1,5 @@
 """Support classes used to create a quality report."""
+
 from typing import Any
 
 from pydantic import BaseModel

dkist_processing_common/models/tags.py

@@ -1,5 +1,7 @@
 """Components of the Tag model.  Stem + Optional Suffix = Tag."""
+
 from enum import Enum
+from enum import StrEnum
 
 from dkist_processing_common.models.task_name import TaskName
 
@@ -7,7 +9,7 @@ from dkist_processing_common.models.task_name import TaskName
 EXP_TIME_ROUND_DIGITS: int = 6
 
 
-class StemName(str, Enum):
+class StemName(StrEnum):
     """Controlled list of Tag Stems."""
 
     output = "OUTPUT"

dkist_processing_common/models/task_name.py

@@ -1,8 +1,9 @@
 """Controlled list of common IP task tag names."""
-from enum import Enum
 
+from enum import StrEnum
 
-class TaskName(str, Enum):
+
+class TaskName(StrEnum):
     """Controlled list of task tag names."""
 
     observe = "OBSERVE"

dkist_processing_common/models/wavelength.py

@@ -1,10 +1,11 @@
 """Support classes for manipulating wavelengths."""
+
 import astropy.units as u
 from pydantic import BaseModel
 from pydantic import ConfigDict
+from pydantic import ValidationInfo
 from pydantic import field_validator
 from pydantic import model_validator
-from pydantic import ValidationInfo
 
 
 class WavelengthRange(BaseModel):

dkist_processing_common/parsers/cs_step.py

@@ -1,4 +1,5 @@
 """Classes supporting Calibration Sequence steps."""
+
 from __future__ import annotations
 
 from datetime import datetime
@@ -100,7 +101,7 @@ class CSStepFlower(Stem):
     """
 
     def __init__(self, max_cs_step_time_sec: float):
-        super().__init__(stem_name=StemName.cs_step.value)
+        super().__init__(stem_name=StemName.cs_step)
         self.max_cs_step_time_sec = max_cs_step_time_sec
 
     def setter(self, fits_obj: L0FitsAccess) -> CSStep | Type[SpilledDirt]:
@@ -147,7 +148,7 @@ class NumCSStepBud(Stem):
     """
 
     def __init__(self, max_cs_step_time_sec: float):
-        super().__init__(stem_name=BudName.num_cs_steps.value)
+        super().__init__(stem_name=BudName.num_cs_steps)
         self.max_cs_step_time_sec = max_cs_step_time_sec
 
     def setter(self, fits_obj: L0FitsAccess) -> CSStep | Type[SpilledDirt]:

dkist_processing_common/parsers/dsps_repeat.py

@@ -1,5 +1,7 @@
 """Classes supporting the Data Set Parameters Set (DSPS) Repeat parameter."""
+
 from dkist_processing_common.models.constants import BudName
+from dkist_processing_common.models.fits_access import MetadataKey
 from dkist_processing_common.models.flower_pot import SpilledDirt
 from dkist_processing_common.models.tags import StemName
 from dkist_processing_common.models.task_name import TaskName
@@ -15,9 +17,9 @@ class TotalDspsRepeatsBud(TaskUniqueBud):
 
     def __init__(self):
         super().__init__(
-            constant_name=BudName.num_dsps_repeats.value,
-            metadata_key="num_dsps_repeats",
-            ip_task_types=TaskName.observe.value,
+            constant_name=BudName.num_dsps_repeats,
+            metadata_key=MetadataKey.num_dsps_repeats,
+            ip_task_types=TaskName.observe,
         )
 
 
@@ -26,7 +28,7 @@ class DspsRepeatNumberFlower(SingleValueSingleKeyFlower):
 
     def __init__(self):
         super().__init__(
-            tag_stem_name=StemName.dsps_repeat.value, metadata_key="current_dsps_repeat"
+            tag_stem_name=StemName.dsps_repeat, metadata_key=MetadataKey.current_dsps_repeat
         )
 
     def setter(self, fits_obj: L0FitsAccess):

dkist_processing_common/parsers/experiment_id_bud.py

@@ -1,5 +1,7 @@
 """Experiment Id parser."""
+
 from dkist_processing_common.models.constants import BudName
+from dkist_processing_common.models.fits_access import MetadataKey
 from dkist_processing_common.parsers.id_bud import ContributingIdsBud
 from dkist_processing_common.parsers.id_bud import IdBud
 
@@ -8,7 +10,9 @@ class ExperimentIdBud(IdBud):
     """Class to create a Bud for the experiment_id."""
 
     def __init__(self):
-        super().__init__(constant_name=BudName.experiment_id.value, metadata_key="experiment_id")
+        super().__init__(
+            constant_name=BudName.experiment_id, metadata_key=MetadataKey.experiment_id
+        )
 
 
 class ContributingExperimentIdsBud(ContributingIdsBud):
@@ -16,5 +20,5 @@ class ContributingExperimentIdsBud(ContributingIdsBud):
 
     def __init__(self):
         super().__init__(
-            stem_name=BudName.contributing_experiment_ids.value, metadata_key="experiment_id"
+            stem_name=BudName.contributing_experiment_ids, metadata_key=MetadataKey.experiment_id
         )

dkist_processing_common/parsers/id_bud.py

@@ -1,4 +1,6 @@
 """Base classes for ID bud parsing."""
+
+from enum import StrEnum
 from typing import Type
 
 from dkist_processing_common.models.flower_pot import SpilledDirt
@@ -11,19 +13,21 @@ from dkist_processing_common.parsers.unique_bud import TaskUniqueBud
 class IdBud(TaskUniqueBud):
     """Base class for ID buds."""
 
-    def __init__(self, constant_name, metadata_key):
+    def __init__(self, constant_name: str, metadata_key: str | StrEnum):
         super().__init__(
             constant_name=constant_name,
             metadata_key=metadata_key,
-            ip_task_types=TaskName.observe.value,
+            ip_task_types=TaskName.observe,
         )
 
 
 class ContributingIdsBud(Stem):
     """Base class for contributing ID buds."""
 
-    def __init__(self, stem_name, metadata_key):
+    def __init__(self, stem_name: str, metadata_key: str | StrEnum):
         super().__init__(stem_name=stem_name)
+        if isinstance(metadata_key, StrEnum):
+            metadata_key = metadata_key.name
         self.metadata_key = metadata_key
 
     def setter(self, fits_obj: L0FitsAccess) -> str | Type[SpilledDirt]:

dkist_processing_common/parsers/l0_fits_access.py

@@ -1,6 +1,8 @@
 """By-frame 214 L0 header keywords that are not instrument specific."""
+
 from astropy.io import fits
 
+from dkist_processing_common.models.fits_access import MetadataKey
 from dkist_processing_common.parsers.l1_fits_access import L1FitsAccess
 
 
@@ -25,6 +27,6 @@ class L0FitsAccess(L1FitsAccess):
         auto_squeeze: bool = True,
     ):
         super().__init__(hdu=hdu, name=name, auto_squeeze=auto_squeeze)
-        self.ip_task_type: str = self.header["IPTASK"]
-        self.ip_start_time: str = self.header["DKIST011"]
-        self.ip_end_time: str = self.header["DKIST012"]
+        self._set_metadata_key_value(MetadataKey.ip_task_type)
+        self._set_metadata_key_value(MetadataKey.ip_start_time)
+        self._set_metadata_key_value(MetadataKey.ip_end_time)