dkist-processing-common 10.6.0rc2__tar.gz → 10.6.1rc2__tar.gz

{dkist_processing_common-10.6.0rc2 → dkist_processing_common-10.6.1rc2}/CHANGELOG.rst

@@ -1,3 +1,13 @@
+v10.6.0 (2025-03-03)
+====================
+
+Features
+--------
+
+- Add the `RetarderNameBud` that can parse the name of the GOS retarder and ensure that only a single retarder was used
+  for the given set of POLCAL input data. (`#235 <https://bitbucket.org/dkistdc/dkist-processing-common/pull-requests/235>`__)
+
+
 v10.5.15 (2025-02-24)
 =====================
 

dkist_processing_common-10.6.1rc2/PKG-INFO

@@ -0,0 +1,398 @@
+Metadata-Version: 2.2
+Name: dkist-processing-common
+Version: 10.6.1rc2
+Summary: Common task classes used by the DKIST science data processing pipelines
+Author-email: NSO / AURA <dkistdc@nso.edu>
+License: BSD-3-Clause
+Project-URL: Homepage, https://nso.edu/dkist/data-center/
+Project-URL: Repository, https://bitbucket.org/dkistdc/dkist-processing-common/
+Project-URL: Documentation, https://docs.dkist.nso.edu/projects/common
+Project-URL: Help, https://nso.atlassian.net/servicedesk/customer/portal/5
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.11
+Description-Content-Type: text/x-rst
+Requires-Dist: asdf<4.0.0,>=3.5.0
+Requires-Dist: astropy<7.0.0,>=6.0.0
+Requires-Dist: dkist-fits-specifications<5.0,>=4.0.0
+Requires-Dist: dkist-header-validator<6.0,>=5.0.0
+Requires-Dist: dkist-processing-core==5.1.0
+Requires-Dist: dkist-processing-pac<4.0,>=3.1
+Requires-Dist: dkist-service-configuration<3.0,>=2.0.2
+Requires-Dist: dkist-spectral-lines<4.0,>=3.0.0
+Requires-Dist: globus-sdk>=3.12.0
+Requires-Dist: gqlclient==1.2.3
+Requires-Dist: sqids==0.5.1
+Requires-Dist: matplotlib>=3.4
+Requires-Dist: moviepy>=2.0.0
+Requires-Dist: numpy>=1.20.2
+Requires-Dist: object-clerk==0.1.1
+Requires-Dist: pandas>=1.4.2
+Requires-Dist: pillow>=10.2.0
+Requires-Dist: pydantic>=2.0
+Requires-Dist: redis==4.6.0
+Requires-Dist: requests>=2.23
+Requires-Dist: scipy>=1.15.1
+Requires-Dist: sunpy>=3.0.0
+Requires-Dist: talus==1.1.0
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-xdist; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: pytest-mock; extra == "test"
+Requires-Dist: hypothesis; extra == "test"
+Requires-Dist: towncrier; extra == "test"
+Requires-Dist: dkist-data-simulator>=5.0.0; extra == "test"
+Requires-Dist: dkist-processing-common[inventory]; extra == "test"
+Requires-Dist: dkist-processing-common[asdf]; extra == "test"
+Requires-Dist: dkist-processing-common[quality]; extra == "test"
+Provides-Extra: docs
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: sphinx-astropy; extra == "docs"
+Requires-Dist: sphinx-changelog; extra == "docs"
+Requires-Dist: sphinx-autoapi!=3.1.0; extra == "docs"
+Requires-Dist: pytest; extra == "docs"
+Requires-Dist: towncrier<22.12.0; extra == "docs"
+Requires-Dist: dkist-sphinx-theme; extra == "docs"
+Provides-Extra: inventory
+Requires-Dist: dkist-inventory<2.0,>=1.6.0; extra == "inventory"
+Provides-Extra: asdf
+Requires-Dist: dkist-inventory[asdf]<2.0,>=1.6.0; extra == "asdf"
+Provides-Extra: quality
+Requires-Dist: dkist-quality<2.0,>=1.2.1; extra == "quality"
+Provides-Extra: frozen
+Requires-Dist: ConfigUpdater==3.2; extra == "frozen"
+Requires-Dist: Deprecated==1.2.18; extra == "frozen"
+Requires-Dist: Flask==2.2.5; extra == "frozen"
+Requires-Dist: Flask-AppBuilder==4.5.3; extra == "frozen"
+Requires-Dist: Flask-Babel==2.0.0; extra == "frozen"
+Requires-Dist: Flask-Caching==2.3.1; extra == "frozen"
+Requires-Dist: Flask-JWT-Extended==4.7.1; extra == "frozen"
+Requires-Dist: Flask-Limiter==3.10.1; extra == "frozen"
+Requires-Dist: Flask-Login==0.6.3; extra == "frozen"
+Requires-Dist: Flask-SQLAlchemy==2.5.1; extra == "frozen"
+Requires-Dist: Flask-Session==0.5.0; extra == "frozen"
+Requires-Dist: Flask-WTF==1.2.2; extra == "frozen"
+Requires-Dist: Jinja2==3.1.5; extra == "frozen"
+Requires-Dist: Mako==1.3.9; extra == "frozen"
+Requires-Dist: MarkupSafe==3.0.2; extra == "frozen"
+Requires-Dist: PyJWT==2.10.1; extra == "frozen"
+Requires-Dist: PyYAML==6.0.2; extra == "frozen"
+Requires-Dist: Pygments==2.19.1; extra == "frozen"
+Requires-Dist: SQLAlchemy==1.4.54; extra == "frozen"
+Requires-Dist: SQLAlchemy-JSONField==1.0.2; extra == "frozen"
+Requires-Dist: SQLAlchemy-Utils==0.41.2; extra == "frozen"
+Requires-Dist: WTForms==3.2.1; extra == "frozen"
+Requires-Dist: Werkzeug==2.2.3; extra == "frozen"
+Requires-Dist: aioftp==0.24.1; extra == "frozen"
+Requires-Dist: aiohappyeyeballs==2.4.8; extra == "frozen"
+Requires-Dist: aiohttp==3.11.13; extra == "frozen"
+Requires-Dist: aiosignal==1.3.2; extra == "frozen"
+Requires-Dist: aiosqlite==0.21.0; extra == "frozen"
+Requires-Dist: alembic==1.15.1; extra == "frozen"
+Requires-Dist: amqp==5.3.1; extra == "frozen"
+Requires-Dist: annotated-types==0.7.0; extra == "frozen"
+Requires-Dist: anyio==4.8.0; extra == "frozen"
+Requires-Dist: apache-airflow==2.10.5; extra == "frozen"
+Requires-Dist: apache-airflow-providers-celery==3.10.0; extra == "frozen"
+Requires-Dist: apache-airflow-providers-common-compat==1.5.0; extra == "frozen"
+Requires-Dist: apache-airflow-providers-common-io==1.5.0; extra == "frozen"
+Requires-Dist: apache-airflow-providers-common-sql==1.23.0; extra == "frozen"
+Requires-Dist: apache-airflow-providers-fab==1.5.3; extra == "frozen"
+Requires-Dist: apache-airflow-providers-ftp==3.12.2; extra == "frozen"
+Requires-Dist: apache-airflow-providers-http==5.2.0; extra == "frozen"
+Requires-Dist: apache-airflow-providers-imap==3.8.2; extra == "frozen"
+Requires-Dist: apache-airflow-providers-postgres==6.1.0; extra == "frozen"
+Requires-Dist: apache-airflow-providers-smtp==2.0.0; extra == "frozen"
+Requires-Dist: apache-airflow-providers-sqlite==4.0.0; extra == "frozen"
+Requires-Dist: apispec==6.8.1; extra == "frozen"
+Requires-Dist: argcomplete==3.5.3; extra == "frozen"
+Requires-Dist: asdf==3.5.0; extra == "frozen"
+Requires-Dist: asdf_standard==1.1.1; extra == "frozen"
+Requires-Dist: asdf_transform_schemas==0.5.0; extra == "frozen"
+Requires-Dist: asgiref==3.8.1; extra == "frozen"
+Requires-Dist: asteval==1.0.6; extra == "frozen"
+Requires-Dist: astropy==6.1.7; extra == "frozen"
+Requires-Dist: astropy-iers-data==0.2025.3.3.0.34.45; extra == "frozen"
+Requires-Dist: asyncpg==0.30.0; extra == "frozen"
+Requires-Dist: attrs==25.1.0; extra == "frozen"
+Requires-Dist: babel==2.17.0; extra == "frozen"
+Requires-Dist: billiard==4.2.1; extra == "frozen"
+Requires-Dist: blinker==1.9.0; extra == "frozen"
+Requires-Dist: boto3==1.37.6; extra == "frozen"
+Requires-Dist: botocore==1.37.6; extra == "frozen"
+Requires-Dist: cachelib==0.13.0; extra == "frozen"
+Requires-Dist: celery==5.4.0; extra == "frozen"
+Requires-Dist: certifi==2025.1.31; extra == "frozen"
+Requires-Dist: cffi==1.17.1; extra == "frozen"
+Requires-Dist: charset-normalizer==3.4.1; extra == "frozen"
+Requires-Dist: click==8.1.8; extra == "frozen"
+Requires-Dist: click-didyoumean==0.3.1; extra == "frozen"
+Requires-Dist: click-plugins==1.1.1; extra == "frozen"
+Requires-Dist: click-repl==0.3.0; extra == "frozen"
+Requires-Dist: clickclick==20.10.2; extra == "frozen"
+Requires-Dist: colorama==0.4.6; extra == "frozen"
+Requires-Dist: colorlog==6.9.0; extra == "frozen"
+Requires-Dist: connexion==2.14.2; extra == "frozen"
+Requires-Dist: contourpy==1.3.1; extra == "frozen"
+Requires-Dist: cron-descriptor==1.4.5; extra == "frozen"
+Requires-Dist: croniter==6.0.0; extra == "frozen"
+Requires-Dist: cryptography==44.0.2; extra == "frozen"
+Requires-Dist: cycler==0.12.1; extra == "frozen"
+Requires-Dist: dacite==1.9.2; extra == "frozen"
+Requires-Dist: decorator==5.2.1; extra == "frozen"
+Requires-Dist: dill==0.3.9; extra == "frozen"
+Requires-Dist: dkist-header-validator==5.1.1; extra == "frozen"
+Requires-Dist: dkist-processing-common==10.6.1rc2; extra == "frozen"
+Requires-Dist: dkist-processing-core==5.1.0; extra == "frozen"
+Requires-Dist: dkist-processing-pac==3.1.1; extra == "frozen"
+Requires-Dist: dkist-service-configuration==2.3.0; extra == "frozen"
+Requires-Dist: dkist-spectral-lines==3.0.0; extra == "frozen"
+Requires-Dist: dkist_fits_specifications==4.11.0; extra == "frozen"
+Requires-Dist: dnspython==2.7.0; extra == "frozen"
+Requires-Dist: ecs-logging==2.2.0; extra == "frozen"
+Requires-Dist: elastic-apm==6.23.0; extra == "frozen"
+Requires-Dist: email_validator==2.2.0; extra == "frozen"
+Requires-Dist: fastjsonschema==2.21.1; extra == "frozen"
+Requires-Dist: flower==2.0.1; extra == "frozen"
+Requires-Dist: fonttools==4.56.0; extra == "frozen"
+Requires-Dist: frozenlist==1.5.0; extra == "frozen"
+Requires-Dist: fsspec==2025.2.0; extra == "frozen"
+Requires-Dist: globus-sdk==3.50.0; extra == "frozen"
+Requires-Dist: google-re2==1.1.20240702; extra == "frozen"
+Requires-Dist: googleapis-common-protos==1.69.0; extra == "frozen"
+Requires-Dist: gqlclient==1.2.3; extra == "frozen"
+Requires-Dist: greenlet==3.1.1; extra == "frozen"
+Requires-Dist: grpcio==1.70.0; extra == "frozen"
+Requires-Dist: gunicorn==23.0.0; extra == "frozen"
+Requires-Dist: h11==0.14.0; extra == "frozen"
+Requires-Dist: httpcore==1.0.7; extra == "frozen"
+Requires-Dist: httpx==0.28.1; extra == "frozen"
+Requires-Dist: humanize==4.12.1; extra == "frozen"
+Requires-Dist: idna==3.10; extra == "frozen"
+Requires-Dist: imageio==2.37.0; extra == "frozen"
+Requires-Dist: imageio-ffmpeg==0.6.0; extra == "frozen"
+Requires-Dist: importlib_metadata==8.5.0; extra == "frozen"
+Requires-Dist: inflection==0.5.1; extra == "frozen"
+Requires-Dist: itsdangerous==2.2.0; extra == "frozen"
+Requires-Dist: jmespath==1.0.1; extra == "frozen"
+Requires-Dist: jsonschema==4.23.0; extra == "frozen"
+Requires-Dist: jsonschema-specifications==2024.10.1; extra == "frozen"
+Requires-Dist: jupyter_core==5.7.2; extra == "frozen"
+Requires-Dist: kiwisolver==1.4.8; extra == "frozen"
+Requires-Dist: kombu==5.4.2; extra == "frozen"
+Requires-Dist: lazy-object-proxy==1.10.0; extra == "frozen"
+Requires-Dist: limits==4.0.1; extra == "frozen"
+Requires-Dist: linkify-it-py==2.0.3; extra == "frozen"
+Requires-Dist: lmfit==1.3.2; extra == "frozen"
+Requires-Dist: lockfile==0.12.2; extra == "frozen"
+Requires-Dist: loguru==0.7.3; extra == "frozen"
+Requires-Dist: markdown-it-py==3.0.0; extra == "frozen"
+Requires-Dist: marshmallow==3.26.1; extra == "frozen"
+Requires-Dist: marshmallow-oneofschema==3.1.1; extra == "frozen"
+Requires-Dist: marshmallow-sqlalchemy==0.28.2; extra == "frozen"
+Requires-Dist: matplotlib==3.10.1; extra == "frozen"
+Requires-Dist: mdit-py-plugins==0.4.2; extra == "frozen"
+Requires-Dist: mdurl==0.1.2; extra == "frozen"
+Requires-Dist: methodtools==0.4.7; extra == "frozen"
+Requires-Dist: more-itertools==10.6.0; extra == "frozen"
+Requires-Dist: moviepy==2.1.2; extra == "frozen"
+Requires-Dist: multidict==6.1.0; extra == "frozen"
+Requires-Dist: nbformat==5.10.4; extra == "frozen"
+Requires-Dist: numpy==2.2.3; extra == "frozen"
+Requires-Dist: object-clerk==0.1.1; extra == "frozen"
+Requires-Dist: opentelemetry-api==1.30.0; extra == "frozen"
+Requires-Dist: opentelemetry-exporter-otlp==1.30.0; extra == "frozen"
+Requires-Dist: opentelemetry-exporter-otlp-proto-common==1.30.0; extra == "frozen"
+Requires-Dist: opentelemetry-exporter-otlp-proto-grpc==1.30.0; extra == "frozen"
+Requires-Dist: opentelemetry-exporter-otlp-proto-http==1.30.0; extra == "frozen"
+Requires-Dist: opentelemetry-proto==1.30.0; extra == "frozen"
+Requires-Dist: opentelemetry-sdk==1.30.0; extra == "frozen"
+Requires-Dist: opentelemetry-semantic-conventions==0.51b0; extra == "frozen"
+Requires-Dist: ordered-set==4.1.0; extra == "frozen"
+Requires-Dist: packaging==24.2; extra == "frozen"
+Requires-Dist: pandas==2.2.3; extra == "frozen"
+Requires-Dist: parfive==2.1.0; extra == "frozen"
+Requires-Dist: pathspec==0.12.1; extra == "frozen"
+Requires-Dist: pendulum==3.0.0; extra == "frozen"
+Requires-Dist: pika==1.3.2; extra == "frozen"
+Requires-Dist: pillow==10.4.0; extra == "frozen"
+Requires-Dist: pip==25.0.1; extra == "frozen"
+Requires-Dist: platformdirs==4.3.6; extra == "frozen"
+Requires-Dist: pluggy==1.5.0; extra == "frozen"
+Requires-Dist: prison==0.2.1; extra == "frozen"
+Requires-Dist: proglog==0.1.10; extra == "frozen"
+Requires-Dist: prometheus_client==0.21.1; extra == "frozen"
+Requires-Dist: prompt_toolkit==3.0.50; extra == "frozen"
+Requires-Dist: propcache==0.3.0; extra == "frozen"
+Requires-Dist: protobuf==5.29.3; extra == "frozen"
+Requires-Dist: psutil==7.0.0; extra == "frozen"
+Requires-Dist: psycopg2-binary==2.9.10; extra == "frozen"
+Requires-Dist: py==1.11.0; extra == "frozen"
+Requires-Dist: pycparser==2.22; extra == "frozen"
+Requires-Dist: pydantic==2.10.6; extra == "frozen"
+Requires-Dist: pydantic-settings==2.8.1; extra == "frozen"
+Requires-Dist: pydantic_core==2.27.2; extra == "frozen"
+Requires-Dist: pyerfa==2.0.1.5; extra == "frozen"
+Requires-Dist: pyparsing==3.2.1; extra == "frozen"
+Requires-Dist: python-daemon==3.1.2; extra == "frozen"
+Requires-Dist: python-dateutil==2.9.0.post0; extra == "frozen"
+Requires-Dist: python-dotenv==1.0.1; extra == "frozen"
+Requires-Dist: python-nvd3==0.16.0; extra == "frozen"
+Requires-Dist: python-slugify==8.0.4; extra == "frozen"
+Requires-Dist: pytz==2025.1; extra == "frozen"
+Requires-Dist: redis==4.6.0; extra == "frozen"
+Requires-Dist: referencing==0.36.2; extra == "frozen"
+Requires-Dist: requests==2.32.3; extra == "frozen"
+Requires-Dist: requests-toolbelt==1.0.0; extra == "frozen"
+Requires-Dist: retry==0.9.2; extra == "frozen"
+Requires-Dist: rfc3339-validator==0.1.4; extra == "frozen"
+Requires-Dist: rich==13.9.4; extra == "frozen"
+Requires-Dist: rich-argparse==1.7.0; extra == "frozen"
+Requires-Dist: rpds-py==0.23.1; extra == "frozen"
+Requires-Dist: s3transfer==0.11.4; extra == "frozen"
+Requires-Dist: scipy==1.15.2; extra == "frozen"
+Requires-Dist: semantic-version==2.10.0; extra == "frozen"
+Requires-Dist: setproctitle==1.3.5; extra == "frozen"
+Requires-Dist: setuptools==65.5.0; extra == "frozen"
+Requires-Dist: six==1.17.0; extra == "frozen"
+Requires-Dist: sniffio==1.3.1; extra == "frozen"
+Requires-Dist: sqids==0.5.1; extra == "frozen"
+Requires-Dist: sqlparse==0.5.3; extra == "frozen"
+Requires-Dist: sunpy==6.1.1; extra == "frozen"
+Requires-Dist: tabulate==0.9.0; extra == "frozen"
+Requires-Dist: talus==1.1.0; extra == "frozen"
+Requires-Dist: tenacity==9.0.0; extra == "frozen"
+Requires-Dist: termcolor==2.5.0; extra == "frozen"
+Requires-Dist: text-unidecode==1.3; extra == "frozen"
+Requires-Dist: time-machine==2.16.0; extra == "frozen"
+Requires-Dist: tornado==6.4.2; extra == "frozen"
+Requires-Dist: tqdm==4.67.1; extra == "frozen"
+Requires-Dist: traitlets==5.14.3; extra == "frozen"
+Requires-Dist: typing_extensions==4.12.2; extra == "frozen"
+Requires-Dist: tzdata==2025.1; extra == "frozen"
+Requires-Dist: uc-micro-py==1.0.3; extra == "frozen"
+Requires-Dist: uncertainties==3.2.2; extra == "frozen"
+Requires-Dist: universal_pathlib==0.2.6; extra == "frozen"
+Requires-Dist: urllib3==2.3.0; extra == "frozen"
+Requires-Dist: vine==5.1.0; extra == "frozen"
+Requires-Dist: voluptuous==0.15.2; extra == "frozen"
+Requires-Dist: wcwidth==0.2.13; extra == "frozen"
+Requires-Dist: wirerope==1.0.0; extra == "frozen"
+Requires-Dist: wrapt==1.17.2; extra == "frozen"
+Requires-Dist: yamale==6.0.0; extra == "frozen"
+Requires-Dist: yarl==1.18.3; extra == "frozen"
+Requires-Dist: zipp==3.21.0; extra == "frozen"
+
+dkist-processing-common
+=======================
+
+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.
+
+Usage
+-----
+
+The classes in this repository should be used as the base of any DKIST processing pipeline tasks. Science tasks should subclass `ScienceTaskL0ToL1Base`.
+
+Each class is built on an abstract base class with the `run` method left for a developer to fill out with the required steps that the task should take.
+This class is then used as the callable object for the workflow and scheduling engine.
+
+Example
+-------
+
+.. code-block:: python
+
+    from dkist_processing_common.tasks.base import ScienceTaskL0ToL1Base
+
+
+    class RemoveArtifacts(ScienceTaskL0ToL1Base):
+        def run(self):
+            # task code here
+            total = 2 + 5
+
+Deployment
+----------
+
+dkist-processing-common is deployed to `PyPI <https://pypi.org/project/dkist-processing-common/>`_
+
+Development
+-----------
+
+There are two prerequisites for test execution on a local machine:
+
+
+* Redis.  A running instance of redis on the local machine is required. The tests will use the default host ip of localhost and port of 6379 to connect to the database.
+
+* RabbitMQ.  A running instance of rabbitmq on the local machine is required.  The tests will use the default host of localhost and a port of 5672 to connect to the interservice bus.
+
+
+To run the tests locally, clone the repository and install the package in editable mode with the test extras.
+
+
+.. code-block:: bash
+
+    git clone git@bitbucket.org:dkistdc/dkist-processing-common.git
+    cd dkist-processing-common
+    pre-commit install
+    pip install -e .[test]
+    # Redis must be running
+    pytest -v --cov dkist_processing_common
+
+Changelog
+#########
+
+When you make **any** change to this repository it **MUST** be accompanied by a changelog file.
+The changelog for this repository uses the `towncrier <https://github.com/twisted/towncrier>`__ package.
+Entries in the changelog for the next release are added as individual files (one per change) to the ``changelog/`` directory.
+
+Writing a Changelog Entry
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+A changelog entry accompanying a change should be added to the ``changelog/`` directory.
+The name of a file in this directory follows a specific template::
+
+  <PULL REQUEST NUMBER>.<TYPE>[.<COUNTER>].rst
+
+The fields have the following meanings:
+
+* ``<PULL REQUEST NUMBER>``: This is the number of the pull request, so people can jump from the changelog entry to the diff on BitBucket.
+* ``<TYPE>``: This is the type of the change and must be one of the values described below.
+* ``<COUNTER>``: This is an optional field, if you make more than one change of the same type you can append a counter to the subsequent changes, i.e. ``100.bugfix.rst`` and ``100.bugfix.1.rst`` for two bugfix changes in the same PR.
+
+The list of possible types is defined the the towncrier section of ``pyproject.toml``, the types are:
+
+* ``feature``: This change is a new code feature.
+* ``bugfix``: This is a change which fixes a bug.
+* ``doc``: A documentation change.
+* ``removal``: A deprecation or removal of public API.
+* ``misc``: Any small change which doesn't fit anywhere else, such as a change to the package infrastructure.
+
+
+Rendering the Changelog at Release Time
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+When you are about to tag a release first you must run ``towncrier`` to render the changelog.
+The steps for this are as follows:
+
+* Run `towncrier build --version vx.y.z` using the version number you want to tag.
+* Agree to have towncrier remove the fragments.
+* Add and commit your changes.
+* Tag the release.
+
+**NOTE:** If you forget to add a Changelog entry to a tagged release (either manually or automatically with ``towncrier``)
+then the Bitbucket pipeline will fail. To be able to use the same tag you must delete it locally and on the remote branch:
+
+.. code-block:: bash
+
+    # First, actually update the CHANGELOG and commit the update
+    git commit
+
+    # Delete tags
+    git tag -d vWHATEVER.THE.VERSION
+    git push --delete origin vWHATEVER.THE.VERSION
+
+    # Re-tag with the same version
+    git tag vWHATEVER.THE.VERSION
+    git push --tags origin main

dkist_processing_common-10.6.1rc2/changelog/236.misc.1.rst

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

dkist_processing_common-10.6.1rc2/changelog/236.misc.rst

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

{dkist_processing_common-10.6.0rc2 → dkist_processing_common-10.6.1rc2}/dkist_processing_common/models/graphql.py

@@ -1,24 +1,22 @@
 """GraphQL Data models for the metadata store api."""
-from dataclasses import dataclass
+from pydantic import BaseModel
+from pydantic import Json
 
 
-@dataclass
-class RecipeRunMutation:
+class RecipeRunMutation(BaseModel):
     """Recipe run mutation record."""
 
     recipeRunId: int
     recipeRunStatusId: int
 
 
-@dataclass
-class RecipeRunStatusQuery:
+class RecipeRunStatusQuery(BaseModel):
     """Recipe run status query for the recipeRunStatuses endpoint."""
 
     recipeRunStatusName: str
 
 
-@dataclass
-class RecipeRunStatusMutation:
+class RecipeRunStatusMutation(BaseModel):
     """Recipe run status mutation record."""
 
     recipeRunStatusName: str
@@ -26,38 +24,33 @@ class RecipeRunStatusMutation:
     recipeRunStatusDescription: str
 
 
-@dataclass
-class RecipeRunStatusResponse:
+class RecipeRunStatusResponse(BaseModel):
     """Response to a recipe run status query."""
 
     recipeRunStatusId: int
 
 
-@dataclass
-class InputDatasetPartTypeResponse:
+class InputDatasetPartTypeResponse(BaseModel):
     """Response class for the input dataset part type entity."""
 
     inputDatasetPartTypeName: str
 
 
-@dataclass
-class InputDatasetPartResponse:
+class InputDatasetPartResponse(BaseModel):
     """Response class for the input dataset part entity."""
 
     inputDatasetPartId: int
-    inputDatasetPartDocument: str
+    inputDatasetPartDocument: Json[list[dict]]
     inputDatasetPartType: InputDatasetPartTypeResponse
 
 
-@dataclass
-class InputDatasetInputDatasetPartResponse:
+class InputDatasetInputDatasetPartResponse(BaseModel):
     """Response class for the join entity between input datasets and input dataset parts."""
 
     inputDatasetPart: InputDatasetPartResponse
 
 
-@dataclass
-class InputDatasetResponse:
+class InputDatasetResponse(BaseModel):
     """Input dataset query response."""
 
     inputDatasetId: int
@@ -65,62 +58,54 @@ class InputDatasetResponse:
     inputDatasetInputDatasetParts: list[InputDatasetInputDatasetPartResponse]
 
 
-@dataclass
-class InputDatasetRecipeInstanceResponse:
+class InputDatasetRecipeInstanceResponse(BaseModel):
     """Recipe instance query response."""
 
     inputDataset: InputDatasetResponse
 
 
-@dataclass
-class InputDatasetRecipeRunResponse:
+class InputDatasetRecipeRunResponse(BaseModel):
     """Recipe run query response."""
 
     recipeInstance: InputDatasetRecipeInstanceResponse
 
 
-@dataclass
-class RecipeInstanceResponse:
+class RecipeInstanceResponse(BaseModel):
     """Recipe instance query response."""
 
     recipeId: int
     inputDatasetId: int
 
 
-@dataclass
-class RecipeRunProvenanceResponse:
+class RecipeRunProvenanceResponse(BaseModel):
     """Response for the metadata store recipeRunProvenances and mutations endpoints."""
 
     recipeRunProvenanceId: int
     isTaskManual: bool
 
 
-@dataclass
-class RecipeRunResponse:
+class RecipeRunResponse(BaseModel):
     """Recipe run query response."""
 
     recipeInstance: RecipeInstanceResponse
     recipeInstanceId: int
     recipeRunProvenances: list[RecipeRunProvenanceResponse]
-    configuration: str = None
+    configuration: Json[dict] | None = {}
 
 
-@dataclass
-class RecipeRunMutationResponse:
+class RecipeRunMutationResponse(BaseModel):
     """Recipe run mutation response."""
 
     recipeRunId: int
 
 
-@dataclass
-class RecipeRunQuery:
+class RecipeRunQuery(BaseModel):
     """Query parameters for the metadata store endpoint recipeRuns."""
 
     recipeRunId: int
 
 
-@dataclass
-class DatasetCatalogReceiptAccountMutation:
+class DatasetCatalogReceiptAccountMutation(BaseModel):
     """
     Dataset catalog receipt account mutation record.
 
@@ -132,15 +117,13 @@ class DatasetCatalogReceiptAccountMutation:
     expectedObjectCount: int
 
 
-@dataclass
-class DatasetCatalogReceiptAccountResponse:
+class DatasetCatalogReceiptAccountResponse(BaseModel):
     """Dataset catalog receipt account response for query and mutation endpoints."""
 
     datasetCatalogReceiptAccountId: int
 
 
-@dataclass
-class RecipeRunProvenanceMutation:
+class RecipeRunProvenanceMutation(BaseModel):
     """Recipe run provenance mutation record."""
 
     inputDatasetId: int
@@ -152,8 +135,7 @@ class RecipeRunProvenanceMutation:
     codeVersion: str = None
 
 
-@dataclass
-class QualityCreation:
+class QualityCreation(BaseModel):
     """Quality data creation record."""
 
     datasetId: str
@@ -173,15 +155,13 @@ class QualityCreation:
     efficiencyData: str | None = None
 
 
-@dataclass
-class QualitiesRequest:
+class QualitiesRequest(BaseModel):
     """Query parameters for quality data."""
 
     datasetId: str
 
 
-@dataclass
-class QualityResponse:
+class QualityResponse(BaseModel):
     """Query Response for quality data."""
 
     qualityId: int