dkist-processing-common 11.2.1rc3__py3-none-any.whl → 11.3.0__py3-none-any.whl

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,6 +4,7 @@ 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 string import ascii_uppercase
 

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,4 +1,5 @@
 """Abstraction layer for accessing fits data via class attributes."""
+
 from __future__ import annotations
 
 from pathlib import Path

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,4 +1,5 @@
 """Components of the Tag model.  Stem + Optional Suffix = Tag."""
+
 from enum import Enum
 
 from dkist_processing_common.models.task_name import TaskName

dkist_processing_common/models/task_name.py

@@ -1,4 +1,5 @@
 """Controlled list of common IP task tag names."""
+
 from enum import Enum
 
 

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

dkist_processing_common/parsers/dsps_repeat.py

@@ -1,4 +1,5 @@
 """Classes supporting the Data Set Parameters Set (DSPS) Repeat parameter."""
+
 from dkist_processing_common.models.constants import BudName
 from dkist_processing_common.models.flower_pot import SpilledDirt
 from dkist_processing_common.models.tags import StemName

dkist_processing_common/parsers/experiment_id_bud.py

@@ -1,4 +1,5 @@
 """Experiment Id parser."""
+
 from dkist_processing_common.models.constants import BudName
 from dkist_processing_common.parsers.id_bud import ContributingIdsBud
 from dkist_processing_common.parsers.id_bud import IdBud

dkist_processing_common/parsers/id_bud.py

@@ -1,4 +1,5 @@
 """Base classes for ID bud parsing."""
+
 from typing import Type
 
 from dkist_processing_common.models.flower_pot import SpilledDirt

dkist_processing_common/parsers/l0_fits_access.py

@@ -1,4 +1,5 @@
 """By-frame 214 L0 header keywords that are not instrument specific."""
+
 from astropy.io import fits
 
 from dkist_processing_common.parsers.l1_fits_access import L1FitsAccess

dkist_processing_common/parsers/l1_fits_access.py

@@ -1,4 +1,5 @@
 """By-frame 214 L1 only header keywords that are not instrument specific."""
+
 from astropy.io import fits
 
 from dkist_processing_common.models.fits_access import FitsAccessBase

dkist_processing_common/parsers/near_bud.py

@@ -1,4 +1,5 @@
 """Pre-made flower that reads a single header key from all files and raises a ValueError if the values are not in a supplied range."""
+
 from statistics import mean
 from typing import Callable
 

dkist_processing_common/parsers/proposal_id_bud.py

@@ -1,4 +1,5 @@
 """Proposal Id parser."""
+
 from dkist_processing_common.models.constants import BudName
 from dkist_processing_common.parsers.id_bud import ContributingIdsBud
 from dkist_processing_common.parsers.id_bud import IdBud

dkist_processing_common/parsers/quality.py

@@ -1,4 +1,5 @@
 """Support classes to define object attributes from header information."""
+
 from astropy.io import fits
 
 from dkist_processing_common.parsers.l0_fits_access import L1FitsAccess

dkist_processing_common/parsers/retarder.py

@@ -1,4 +1,5 @@
 """Bud that parses the name of the retarder used during POLCAL task observations."""
+
 from dkist_processing_common.models.constants import BudName
 from dkist_processing_common.models.task_name import TaskName
 from dkist_processing_common.parsers.unique_bud import TaskUniqueBud

dkist_processing_common/parsers/single_value_single_key_flower.py

@@ -1,4 +1,5 @@
 """Pre-made flower that produces tag based on a single header key."""
+
 from dkist_processing_common.models.flower_pot import Stem
 from dkist_processing_common.parsers.l0_fits_access import L0FitsAccess
 

dkist_processing_common/parsers/task.py

@@ -1,4 +1,5 @@
 """Module for parsing IP task related things."""
+
 from typing import Callable
 from typing import Type
 

dkist_processing_common/parsers/time.py

@@ -1,4 +1,5 @@
 """Time parser."""
+
 from datetime import datetime
 from datetime import timezone
 from typing import Callable

dkist_processing_common/parsers/unique_bud.py

@@ -1,4 +1,5 @@
 """Pre-made flower that reads a single header key from all files and raises a ValueError if it is not unique."""
+
 from typing import Callable
 
 from dkist_processing_common.models.flower_pot import SpilledDirt

dkist_processing_common/parsers/wavelength.py

@@ -1,4 +1,5 @@
 """Bud to get the wavelength of observe frames."""
+
 from dkist_processing_common.models.constants import BudName
 from dkist_processing_common.models.task_name import TaskName
 from dkist_processing_common.parsers.unique_bud import TaskUniqueBud

dkist_processing_common/tasks/__init__.py

@@ -1,11 +1,12 @@
 """Common tasks and bases."""
-from dkist_processing_common.tasks.base import *  # noreorder
+
+from dkist_processing_common.tasks.base import *  # isort: skip
 from dkist_processing_common.tasks.assemble_movie import *
 from dkist_processing_common.tasks.l1_output_data import *
 from dkist_processing_common.tasks.parse_l0_input_data import *
 from dkist_processing_common.tasks.quality_metrics import *
 from dkist_processing_common.tasks.teardown import *
 from dkist_processing_common.tasks.transfer_input_data import *
-from dkist_processing_common.tasks.write_l1 import *
 from dkist_processing_common.tasks.trial_catalog import *
 from dkist_processing_common.tasks.trial_output_data import *
+from dkist_processing_common.tasks.write_l1 import *

dkist_processing_common/tasks/assemble_movie.py

@@ -1,4 +1,5 @@
 """Task(s) for assembling a browse movie."""
+
 import logging
 from abc import ABC
 from abc import abstractmethod

dkist_processing_common/tasks/base.py

@@ -1,4 +1,5 @@
 """Wrappers for all workflow tasks."""
+
 import json
 import logging
 import re

dkist_processing_common/tasks/l1_output_data.py

@@ -1,4 +1,5 @@
 """Task(s) for the transfer and publishing of L1 data from a production run of a processing pipeline."""
+
 import logging
 from abc import ABC
 from itertools import chain
@@ -20,7 +21,6 @@ from dkist_processing_common.tasks.mixin.quality import QualityMixin
 from dkist_processing_common.tasks.output_data_base import OutputDataBase
 from dkist_processing_common.tasks.output_data_base import TransferDataBase
 
-
 __all__ = [
     "L1OutputDataBase",
     "TransferL1Data",

dkist_processing_common/tasks/mixin/globus.py

@@ -1,4 +1,5 @@
 """Mixin to add methods to a Task to support globus transfers."""
+
 import logging
 from dataclasses import dataclass
 from pathlib import Path
@@ -11,7 +12,6 @@ from globus_sdk import TransferData
 
 from dkist_processing_common.config import common_configurations
 
-
 logger = logging.getLogger(__name__)
 
 

dkist_processing_common/tasks/mixin/interservice_bus.py

@@ -1,4 +1,5 @@
 """Mixin for a WorkflowDataTaskBase subclass which implements interservice bus access functionality."""
+
 from talus import DurableProducer
 from talus import PublishMessageBase
 

dkist_processing_common/tasks/mixin/metadata_store.py

@@ -1,4 +1,5 @@
 """Mixin for a WorkflowDataTaskBase subclass which implements Metadata Store data access functionality."""
+
 import json
 import logging
 from functools import cached_property
@@ -26,7 +27,6 @@ from dkist_processing_common.models.graphql import RecipeRunStatusMutation
 from dkist_processing_common.models.graphql import RecipeRunStatusQuery
 from dkist_processing_common.models.graphql import RecipeRunStatusResponse
 
-
 logger = logging.getLogger(__name__)
 
 

dkist_processing_common/tasks/mixin/object_store.py

@@ -1,4 +1,5 @@
 """Mixin for a WorkflowDataTaskBase subclass which implements Object Store data access functionality."""
+
 from pathlib import Path
 
 from object_clerk import ObjectClerk

dkist_processing_common/tasks/mixin/quality/__init__.py

@@ -4,4 +4,5 @@ To improve readability the top-level mixin, `QualityMixin`, contains only base f
 metrics are grouped into sub-mixins. To protect a user, this mixin-on-mixin stack is hidden in protected modules
 and only the top-level mixin (`QualityMixin`) is exposed.
 """
+
 from ._base import QualityMixin

dkist_processing_common/tasks/mixin/quality/_base.py

@@ -1,4 +1,5 @@
 """Base QualityMixin class that contains machinery common to all metric types."""
+
 from typing import Iterable
 
 import numpy as np

dkist_processing_common/tasks/mixin/quality/_metrics.py

@@ -2,6 +2,7 @@
 
 These classes should not be directly mixed in to anything. They are pre-mixed into the top-level QualityMixin
 """
+
 import copy
 import json
 import logging

dkist_processing_common/tasks/output_data_base.py

@@ -1,4 +1,5 @@
 """Base class that supports common output data methods and paths."""
+
 import logging
 from abc import ABC
 from abc import abstractmethod

dkist_processing_common/tasks/parse_l0_input_data.py

@@ -20,6 +20,7 @@ that makes the rest of the pipeline easy to write.
 In other words, we can find exactly the frame we need (tags) and, once we have it, we never need to look
 at a different frame to get information (constants).
 """
+
 import logging
 from abc import ABC
 from abc import abstractmethod
@@ -44,7 +45,6 @@ from dkist_processing_common.parsers.time import VarianceCadenceBud
 from dkist_processing_common.parsers.unique_bud import UniqueBud
 from dkist_processing_common.tasks.base import WorkflowTaskBase
 
-
 __all__ = [
     "ParseL0InputDataBase",
     "ParseDataBase",

dkist_processing_common/tasks/quality_metrics.py

@@ -1,4 +1,5 @@
 """Classes to support the generation of quality metrics for the calibrated data."""
+
 import logging
 from dataclasses import dataclass
 from dataclasses import field
@@ -18,7 +19,6 @@ from dkist_processing_common.parsers.quality import L1QualityFitsAccess
 from dkist_processing_common.tasks.base import WorkflowTaskBase
 from dkist_processing_common.tasks.mixin.quality import QualityMixin
 
-
 __all__ = ["QualityL1Metrics", "QualityL0Metrics"]
 
 

dkist_processing_common/tasks/teardown.py

@@ -1,11 +1,11 @@
 """Task(s) for the clean up tasks at the conclusion of a processing pipeline."""
+
 import logging
 from abc import ABC
 from abc import abstractmethod
 
 from dkist_processing_common.tasks.base import WorkflowTaskBase
 
-
 __all__ = ["Teardown", "TrialTeardown"]
 
 

dkist_processing_common/tasks/transfer_input_data.py

@@ -1,4 +1,5 @@
 """Task(s) for the transfer in of data sources for a processing pipeline."""
+
 import logging
 from pathlib import Path
 
@@ -11,7 +12,6 @@ from dkist_processing_common.tasks.base import WorkflowTaskBase
 from dkist_processing_common.tasks.mixin.globus import GlobusMixin
 from dkist_processing_common.tasks.mixin.globus import GlobusTransferItem
 
-
 __all__ = ["TransferL0Data"]
 
 logger = logging.getLogger(__name__)

dkist_processing_common/tasks/trial_catalog.py

@@ -1,4 +1,5 @@
 """Tasks to support the generation of downstream artifacts in a trial workflow that wouldn't otherwise produce them."""
+
 import importlib
 import logging
 from datetime import datetime
@@ -24,8 +25,8 @@ __all__ = ["CreateTrialDatasetInventory", "CreateTrialAsdf", "CreateTrialQuality
 # Capture condition of dkist-processing-common[inventory] install
 INVENTORY_EXTRA_INSTALLED = False
 try:
-    from dkist_inventory.inventory import generate_inventory_from_frame_inventory
     from dkist_inventory.inventory import generate_asdf_filename
+    from dkist_inventory.inventory import generate_inventory_from_frame_inventory
 
     INVENTORY_EXTRA_INSTALLED = True
 except ModuleNotFoundError:
@@ -45,8 +46,8 @@ except ModuleNotFoundError:
 # Verify dkist-quality is installed
 QUALITY_EXTRA_INSTALLED = False
 try:
-    from dkist_quality.report import format_report
     from dkist_quality.report import ReportFormattingException
+    from dkist_quality.report import format_report
 
     QUALITY_EXTRA_INSTALLED = True
 except ModuleNotFoundError:

dkist_processing_common/tasks/trial_output_data.py

@@ -1,4 +1,5 @@
 """Tasks to support transferring an arbitrary collection of files to a customizable post-run location."""
+
 import logging
 from functools import cached_property
 from pathlib import Path