dkist-processing-common 10.6.1rc5__py3-none-any.whl → 10.6.3__py3-none-any.whl

dkist_processing_common/manual.py

@@ -182,7 +182,7 @@ def writing_metadata_store_record_provenance(self, is_task_manual: bool, library
         workflowVersion=self.workflow_version,
     )
     self.write(
-        data=asdict(params),
+        data=params.model_dump(),
         encoder=json_encoder,
         tags=["PROVENANCE_RECORD"],
         relative_path=f"{self.task_name}_provenance.json",

dkist_processing_common/models/wavelength.py

@@ -26,3 +26,4 @@ class WavelengthRange(BaseModel):
         """Validate that the max wavelength is greater than the min wavelength."""
         if self.min > self.max:
             raise ValueError("min is greater than max.  Values may be reversed.")
+        return self

dkist_processing_common/tasks/transfer_input_data.py

@@ -20,12 +20,17 @@ class TransferL0Data(WorkflowTaskBase, GlobusMixin, InputDatasetMixin):
 
     def download_input_dataset(self):
         """Get the input dataset document parts and save it to scratch with the appropriate tags."""
-        if doc := self.metadata_store_input_dataset_observe_frames.inputDatasetPartDocument:
-            self.write(doc, tags=Tag.input_dataset_observe_frames(), encoder=json_encoder)
-        if doc := self.metadata_store_input_dataset_calibration_frames.inputDatasetPartDocument:
-            self.write(doc, tags=Tag.input_dataset_calibration_frames(), encoder=json_encoder)
-        if doc := self.metadata_store_input_dataset_parameters.inputDatasetPartDocument:
-            self.write(doc, tags=Tag.input_dataset_parameters(), encoder=json_encoder)
+        if observe_frames := self.metadata_store_input_dataset_observe_frames:
+            observe_doc = observe_frames.inputDatasetPartDocument
+            self.write(observe_doc, tags=Tag.input_dataset_observe_frames(), encoder=json_encoder)
+        if calibration_frames := self.metadata_store_input_dataset_calibration_frames:
+            calibration_doc = calibration_frames.inputDatasetPartDocument
+            self.write(
+                calibration_doc, tags=Tag.input_dataset_calibration_frames(), encoder=json_encoder
+            )
+        if parameters := self.metadata_store_input_dataset_parameters:
+            parameters_doc = parameters.inputDatasetPartDocument
+            self.write(parameters_doc, tags=Tag.input_dataset_parameters(), encoder=json_encoder)
 
     def format_transfer_items(
         self, input_dataset_objects: list[InputDatasetObject]

dkist_processing_common/tests/test_manual_processing.py

@@ -0,0 +1,34 @@
+import pytest
+
+from dkist_processing_common.manual import ManualProcessing
+from dkist_processing_common.tasks import WorkflowTaskBase
+
+
+class ProvenanceTask(WorkflowTaskBase):
+    record_provenance = True
+
+    def run(self):
+        ...
+
+
+@pytest.fixture(scope="function")
+def manual_processing_run(tmp_path, recipe_run_id):
+    with ManualProcessing(
+        recipe_run_id=recipe_run_id,
+        workflow_path=tmp_path,
+        workflow_name="manual",
+        workflow_version="manual",
+    ) as manual_processing_run:
+        yield manual_processing_run
+
+
+def test_manual_record_provenance(tmp_path, recipe_run_id, manual_processing_run):
+    """
+    Given: A WorkflowTaskBase subclass with provenance recording turned on
+    When: Running the task with the ManualProcessing wrapper
+    Then: The provenance record exists on disk
+    """
+    manual_processing_run.run_task(task=ProvenanceTask)
+    directory = tmp_path / str(recipe_run_id)
+    provenance_file = directory / "ProvenanceTask_provenance.json"
+    assert provenance_file.exists()

dkist_processing_common/tests/test_transfer_input_data.py

@@ -17,10 +17,20 @@ class TransferL0DataTask(TransferL0Data):
         ...
 
 
-@pytest.fixture
-def transfer_l0_data_task(recipe_run_id, tmp_path, mocker):
+class FakeGQLClientMissingPart(FakeGQLClient):
+    """Same metadata mocker with calibration input dataset part missing."""
+
+    def execute_gql_query(self, **kwargs):
+        original_response = super().execute_gql_query(**kwargs)
+        # Remove calibration frames part
+        del original_response[0].recipeInstance.inputDataset.inputDatasetInputDatasetParts[2]
+        return original_response
+
+
+def _transfer_l0_data_task_with_client(recipe_run_id, tmp_path, mocker, client_cls):
     mocker.patch(
-        "dkist_processing_common.tasks.mixin.metadata_store.GraphQLClient", new=FakeGQLClient
+        "dkist_processing_common.tasks.mixin.metadata_store.GraphQLClient",
+        new=client_cls,
     )
     with TransferL0DataTask(
         recipe_run_id=recipe_run_id,
@@ -35,6 +45,18 @@ def transfer_l0_data_task(recipe_run_id, tmp_path, mocker):
         task._purge()
 
 
+@pytest.fixture
+def transfer_l0_data_task(recipe_run_id, tmp_path, mocker):
+    yield from _transfer_l0_data_task_with_client(recipe_run_id, tmp_path, mocker, FakeGQLClient)
+
+
+@pytest.fixture
+def transfer_l0_data_task_missing_part(recipe_run_id, tmp_path, mocker):
+    yield from _transfer_l0_data_task_with_client(
+        recipe_run_id, tmp_path, mocker, FakeGQLClientMissingPart
+    )
+
+
 def test_download_dataset(transfer_l0_data_task):
     """
     :Given: a TransferL0Data task with a valid input dataset
@@ -63,6 +85,29 @@ def test_download_dataset(transfer_l0_data_task):
     assert parameters_doc_from_file == expected_parameters_doc
 
 
+def test_download_dataset_missing_part(transfer_l0_data_task_missing_part):
+    """
+    :Given: a TransferL0Data task with a valid input dataset without calibration frames
+    :When: downloading the dataset documents from the metadata store
+    :Then: the correct number of documents are written to disk
+    """
+    # Given
+    task = transfer_l0_data_task_missing_part
+    # When
+    task.download_input_dataset()
+    # Then
+    observe_doc_from_file = next(
+        task.read(tags=Tag.input_dataset_observe_frames(), decoder=json_decoder)
+    )
+    parameters_doc_from_file = next(
+        task.read(tags=Tag.input_dataset_parameters(), decoder=json_decoder)
+    )
+    with pytest.raises(StopIteration):
+        calibration_doc_from_file = next(
+            task.read(tags=Tag.input_dataset_calibration_frames(), decoder=json_decoder)
+        )
+
+
 def test_format_frame_transfer_items(transfer_l0_data_task):
     """
     :Given: a TransferL0Data task with a downloaded input dataset

{dkist_processing_common-10.6.1rc5.dist-info → dkist_processing_common-10.6.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: dkist-processing-common
-Version: 10.6.1rc5
+Version: 10.6.3
 Summary: Common task classes used by the DKIST science data processing pipelines
 Author-email: NSO / AURA <dkistdc@nso.edu>
 License: BSD-3-Clause
@@ -65,6 +65,8 @@ Requires-Dist: dkist-quality<2.0,>=1.2.1; extra == "quality"
 dkist-processing-common
 =======================
 
+|codecov|
+
 This repository works in concert with `dkist-processing-core <https://pypi.org/project/dkist-processing-core/>`_ and `dkist-processing-*instrument*` to
 form the DKIST calibration processing stack.
 
@@ -173,3 +175,6 @@ then the Bitbucket pipeline will fail. To be able to use the same tag you must d
     # Re-tag with the same version
     git tag vWHATEVER.THE.VERSION
     git push --tags origin main
+
+.. |codecov| image:: https://codecov.io/bb/dkistdc/dkist-processing-common/graph/badge.svg?token=3QSLGSEF3O
+ :target: https://codecov.io/bb/dkistdc/dkist-processing-common

{dkist_processing_common-10.6.1rc5.dist-info → dkist_processing_common-10.6.3.dist-info}/RECORD

@@ -1,9 +1,7 @@
 changelog/.gitempty,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-changelog/236.misc.1.rst,sha256=wN9uYenjgu25jpjAcLtCxLIAlLz658rqAV6sIvWBulI,158
-changelog/236.misc.rst,sha256=V_aMXk7hePoQxIaiXCh7IKrvqe3Z0R_JYotQRMBAg9o,315
 dkist_processing_common/__init__.py,sha256=490Fwm_GgqpwriQlsYfKcLUZNhZ6GkINtJqcYSIEKoU,319
 dkist_processing_common/config.py,sha256=IcpaD_NvHZU-aLlUNOTdRC4V7ADIvVQwrZ2dHhIr4NY,4247
-dkist_processing_common/manual.py,sha256=4sGj3cChdnEpwzq2GSNSbTpUf2oS3YUWiXna6ALfMF4,7037
+dkist_processing_common/manual.py,sha256=IH72QxdGlr-BuWq2EDrfC9yStegO-elUWrobQqT4710,7042
 dkist_processing_common/_util/__init__.py,sha256=xf6JNpMKQgbhE2Jivymt-WO0WF6PpGt9rl604YpuTWk,92
 dkist_processing_common/_util/constants.py,sha256=b0zlRaT09aGj2RU72OQ5J-8u6Z_RevPXtcyx5tlnf-Y,3244
 dkist_processing_common/_util/graphql.py,sha256=qjsvLWDHqb1X7hDLA8uqbpOIDjZZ2mjsSIL0Wkt1TJc,3420
@@ -32,7 +30,7 @@ dkist_processing_common/models/parameters.py,sha256=Ymx-wvPVMkXg5emhOivv7NG0QsAt
 dkist_processing_common/models/quality.py,sha256=ONz1A6_qyEoZhQkVp9LChAgm93aGt1O5WSRneE3XCCA,2319
 dkist_processing_common/models/tags.py,sha256=ykOYqWMU7_ffvRCv84-avjXyty9pHBo7EXwsjIjStjs,12058
 dkist_processing_common/models/task_name.py,sha256=NL0n92A9vVYBV-yvh8d-qFOCxVy0X2GECDmLgIzrmOY,565
-dkist_processing_common/models/wavelength.py,sha256=mH4xkNdPU7kedJfQStI6A0WdkMLi61wfe47pJI9kHBI,946
+dkist_processing_common/models/wavelength.py,sha256=Wtmu5QhjPpsqIGfUQ0Wh-3PQlGeRdGV9BfFAy23HLGg,966
 dkist_processing_common/parsers/__init__.py,sha256=XJQzHtPb78F6-qXXKXjyztc0x-aHVlgv1C_l4dR88tI,67
 dkist_processing_common/parsers/cs_step.py,sha256=en1ovwy8H2jeUxZd0XDSV8Qv3ZawRm03q6wpJj4a3C8,6461
 dkist_processing_common/parsers/dsps_repeat.py,sha256=NiUMnfMYSn0qserHM735V1Z6BCfw4CAanlqtjfyRkos,1571
@@ -57,7 +55,7 @@ dkist_processing_common/tasks/output_data_base.py,sha256=CC1TnCrChi8_iuMymr425CJ
 dkist_processing_common/tasks/parse_l0_input_data.py,sha256=iRMGdvhxBobNsTDQ0IEl0myDfB4P_xpxA00guuBWDj8,7986
 dkist_processing_common/tasks/quality_metrics.py,sha256=g6MUq8s8jELDinkn6o45rfONyODw92JyVMrzb7Dd7OI,12458
 dkist_processing_common/tasks/teardown.py,sha256=e4LKnphJDYDVDAez2tH7MxpZgCmxYsKrq9Zk0qAkzzM,2355
-dkist_processing_common/tasks/transfer_input_data.py,sha256=bv2t0DN7nQ9opfl3VPdXG9m69zdzNIjordlCyZVNyBQ,5324
+dkist_processing_common/tasks/transfer_input_data.py,sha256=afEW0glpCFMZRj90nFtQo_4XOQ4CuoOh86jahP6a-a0,5548
 dkist_processing_common/tasks/trial_catalog.py,sha256=Y3DKstRfMS8nWWtJFMB0MUVPlZ1jWS_2jhJGMWwxy50,8748
 dkist_processing_common/tasks/trial_output_data.py,sha256=aI_aRuu0qVO8zFGrr_9baxx9i3jUEHZSmsmbO6ytlkE,6960
 dkist_processing_common/tasks/write_l1.py,sha256=C5IRUX1JO_Wa7suv_tgE4tH1E2eAUkro0rtj9EHduqw,22429
@@ -83,6 +81,7 @@ dkist_processing_common/tests/test_flower_pot.py,sha256=X9_UI3maa3ZQncV3jYHgovWn
 dkist_processing_common/tests/test_input_dataset.py,sha256=AI5uqaDea4kOwpwAU5qQdzUbxMpBwD20YCAvB7nzD5o,18766
 dkist_processing_common/tests/test_interservice_bus.py,sha256=M_iv2CLmx5TnCB1VUN4YjkQ2LEUjfCKk7-ZlkV62XEQ,3000
 dkist_processing_common/tests/test_interservice_bus_mixin.py,sha256=8TTl0aypkq5gBPeyqSaQHbz_jmt5RmSD2oI8kT4Q1ZA,4195
+dkist_processing_common/tests/test_manual_processing.py,sha256=wAZJztsF33jzJE3m3vJ6cJT0ujgIkMg01jGq-Ys_a4c,1045
 dkist_processing_common/tests/test_output_data_base.py,sha256=Y9MFz5xw11tAnKjpHH7qrzsRYP1rZM_Trt4AylY0S6k,3120
 dkist_processing_common/tests/test_parameters.py,sha256=Tr0Wu8-_rj9Lp7CkUVmJjSouW7CAL_ZwhShK_U1GzVs,12384
 dkist_processing_common/tests/test_parse_l0_input_data.py,sha256=SMNV1qyQTvnMx94MCNsiA-RyS9uxaxIABEDDxsuVzqY,10629
@@ -96,7 +95,7 @@ dkist_processing_common/tests/test_tags.py,sha256=UwlOJ45rkvbfbd5L5m5YltvOxQc8kG
 dkist_processing_common/tests/test_task_name.py,sha256=kqFr59XX2K87xzfTlClzDV4-Je1dx72LvdaJ22UE8UU,1233
 dkist_processing_common/tests/test_task_parsing.py,sha256=QXt1X6DTO3_liBD2c-t84DToLeEn7B3J-eteIyN4HEM,4027
 dkist_processing_common/tests/test_teardown.py,sha256=w2sATQHkg2lMLvm6VFZF1mNGFYHwWj_SxvF9RQu-tuY,5362
-dkist_processing_common/tests/test_transfer_input_data.py,sha256=MYPsZldzQ_j0AoGFqP6_ahn8Nr5mX8WAyG0wpcQReeI,4735
+dkist_processing_common/tests/test_transfer_input_data.py,sha256=pys5JI-alVEsN4nFE6KDLrAfvLOAH5lSHHpkruLR6lE,6390
 dkist_processing_common/tests/test_transfer_l1_output_data.py,sha256=27PifkyH3RZg0nsM-AjmrFJ-hbYuCk5Tt_0Zx8PJBfM,2109
 dkist_processing_common/tests/test_trial_catalog.py,sha256=SZ-nyn0MXU9Lkg_94FbKER_cwiGoi06GYlzF_3AmvKg,6802
 dkist_processing_common/tests/test_trial_output_data.py,sha256=cBCj0kXyF5NEMzKh6zPVksdoXyE8ju1opJgWgjdcJWA,12790
@@ -110,7 +109,7 @@ docs/landing_page.rst,sha256=aPAuXFhBx73lEZ59B6E6JXxkK0LlxzD0n-HXqHrfumQ,746
 docs/make.bat,sha256=mBAhtURwhQ7yc95pqwJzlhqBSvRknr1aqZ5s8NKvdKs,4513
 docs/requirements.txt,sha256=Kbl_X4c7RQZw035YTeNB63We6I7pvXFU4T0Uflp2yDY,29
 licenses/LICENSE.rst,sha256=piZaQplkzOMmH1NXg6QIdo9wwo9pPCoHkvm2-DmH76E,1462
-dkist_processing_common-10.6.1rc5.dist-info/METADATA,sha256=zeyUZWd51nX30x1doSzvFHRNQraAhTthpfdoQCWgARM,6973
-dkist_processing_common-10.6.1rc5.dist-info/WHEEL,sha256=52BFRY2Up02UkjOa29eZOS2VxUrpPORXg1pkohGGUS8,91
-dkist_processing_common-10.6.1rc5.dist-info/top_level.txt,sha256=LJhd1W-Vn90K8HnQDIE4r52YDpUjjMWDnllAWHBByW0,48
-dkist_processing_common-10.6.1rc5.dist-info/RECORD,,
+dkist_processing_common-10.6.3.dist-info/METADATA,sha256=e_NApWqP_nEbasza1gENhO_v3h2w8yBNjcjbuk4HBWY,7154
+dkist_processing_common-10.6.3.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+dkist_processing_common-10.6.3.dist-info/top_level.txt,sha256=LJhd1W-Vn90K8HnQDIE4r52YDpUjjMWDnllAWHBByW0,48
+dkist_processing_common-10.6.3.dist-info/RECORD,,

{dkist_processing_common-10.6.1rc5.dist-info → dkist_processing_common-10.6.3.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (76.0.0)
+Generator: setuptools (78.1.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

changelog/236.misc.1.rst

@@ -1,2 +0,0 @@
-Change returns from the metadata store queries into Pydantic BaseModel instances.  Remove unnecessary parsing
-and error checking in the metadata store mixin.

changelog/236.misc.rst

@@ -1,3 +0,0 @@
-Convert dataclasses in the graphql model to Pydantic BaseModels for additional validation. In the
-RecipeRunResponse class, configuration is converted from a JSON dictionary to its own Pydantic BaseModel.
-In the InputDatasetPartResponse class, the inputDatasetPartDocument is now returned as a list of dictionaries.