lsst-pipe-base 29.2025.4400__tar.gz → 29.2025.4500__tar.gz

{lsst_pipe_base-29.2025.4400/python/lsst_pipe_base.egg-info → lsst_pipe_base-29.2025.4500}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lsst-pipe-base
-Version: 29.2025.4400
+Version: 29.2025.4500
 Summary: Pipeline infrastructure for the Rubin Science Pipelines.
 Author-email: Rubin Observatory Data Management <dm-admin@lists.lsst.org>
 License-Expression: BSD-3-Clause OR GPL-3.0-or-later

{lsst_pipe_base-29.2025.4400 → lsst_pipe_base-29.2025.4500}/doc/lsst.pipe.base/creating-a-pipeline.rst

@@ -387,13 +387,23 @@ paths in a platform agnostic way.
 Alternatively, the elements of the imports list may be yaml mapping. This
 mapping begins with a key named ``location`` who's value is the same as the
 path described above. The mapping can optionally contain the keys
-``include``, ``exclude``, and ``importContracts``. The keys ``include`` and
-``exclude`` can be used to specify which labels (or labeled subsets) to
-include or exclude, respectively, when inheriting a ``Pipeline``. The values
-associated with these keys are specified as a yaml list, and these two keys
-are mutually exclusive, only one can be specified at at time. The
-``importContracts`` key is optional and is associated with a boolean value
-that controls wether ``contracts`` from the imported pipeline should be
+``include``, ``exclude``, ``rename``, and ``importContracts``. The keys
+``include`` and ``exclude`` can be used to specify which labels
+(or labeled subsets) to include or exclude, respectively, when inheriting
+a ``Pipeline``. The values associated with these keys are specified as
+a yaml list, and these two keys are mutually exclusive: only one can be
+specified at at time.
+
+The ``rename`` key is a dictionary mapping existing labels to be renamed to
+new labels. This is particularly useful for renaming tasks with dynamic
+output connections, since changing the output dimensions can also change the
+metadata (config/log) dataset dimensions, which must therefore be renamed to
+avoid conflicting with the original label definitions. Otherwise, when using
+this feature, remember to apply subsequent config overrides to the new label
+rather than the old.
+
+The ``importContracts`` key is optional and is associated with a boolean value
+that controls whether ``contracts`` from the imported pipeline should be
 included when importing, with a default value of true.
 
 A few further notes about including and excluding. When specifying labels

{lsst_pipe_base-29.2025.4400 → lsst_pipe_base-29.2025.4500}/python/lsst/pipe/base/pipelineIR.py

@@ -45,7 +45,7 @@ import warnings
 from collections import Counter
 from collections.abc import Generator, Hashable, Iterable, MutableMapping
 from dataclasses import dataclass, field
-from typing import Any, Literal
+from typing import Any, Literal, cast
 
 import yaml
 
@@ -461,6 +461,8 @@ class ImportIR:
     """list of tasks that should be excluded when inheriting this pipeline.
     Either the include or exclude attributes may be specified, but not both.
     """
+    rename: dict[str, str] = field(default_factory=dict)
+    """dict of tasks to rename, keyed by old name with new name value."""
     importContracts: bool = True
     """Boolean attribute to dictate if contracts should be inherited with the
     pipeline or not.
@@ -497,18 +499,49 @@ class ImportIR:
                 "An include list and an exclude list cannot both be specified"
                 " when declaring a pipeline import."
             )
+        if rename_keys := self.rename.keys():
+            rename_values_set = set(self.rename.values())
+            if len(rename_values_set) != len(rename_keys):
+                raise ValueError(f"rename {rename_keys=} must not have duplicates")
+            if rename_values_set.intersection(rename_keys):
+                raise ValueError(
+                    f"rename keys={rename_keys} must not intersect with values={self.rename.values()}"
+                )
+
         tmp_pipeline = PipelineIR.from_uri(os.path.expandvars(self.location))
         if self.instrument is not _Tags.KeepInstrument:
             tmp_pipeline.instrument = self.instrument
 
         included_labels = set()
+        renamed_tasks = {}
         for label in tmp_pipeline.tasks:
+            is_included = self.include and label in self.include
             if (
-                (self.include and label in self.include)
+                is_included
                 or (self.exclude and label not in self.exclude)
                 or (self.include is None and self.exclude is None)
             ):
-                included_labels.add(label)
+                if (label_new := self.rename.get(label)) is not None:
+                    renamed_tasks[label] = label_new
+                    if is_included:
+                        self.include = [
+                            label_new if (x == label) else label for x in cast(list[str], self.include)
+                        ]
+                else:
+                    label_new = label
+                included_labels.add(label_new)
+
+        rename_errors = []
+        for label, label_new in renamed_tasks.items():
+            if label_new in tmp_pipeline.tasks:
+                rename_errors.append(f"Can't rename {label=} to existing {label_new=}")
+            else:
+                task = tmp_pipeline.tasks.pop(label)
+                task.label = label_new
+                tmp_pipeline.tasks[label_new] = task
+
+        if rename_errors:
+            raise ValueError("; ".join(rename_errors))
 
         # Handle labeled subsets being specified in the include or exclude
         # list, adding or removing labels.

lsst_pipe_base-29.2025.4500/python/lsst/pipe/base/version.py

@@ -0,0 +1,2 @@
+__all__ = ["__version__"]
+__version__ = "29.2025.4500"

{lsst_pipe_base-29.2025.4400 → lsst_pipe_base-29.2025.4500/python/lsst_pipe_base.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lsst-pipe-base
-Version: 29.2025.4400
+Version: 29.2025.4500
 Summary: Pipeline infrastructure for the Rubin Science Pipelines.
 Author-email: Rubin Observatory Data Management <dm-admin@lists.lsst.org>
 License-Expression: BSD-3-Clause OR GPL-3.0-or-later

{lsst_pipe_base-29.2025.4400 → lsst_pipe_base-29.2025.4500}/tests/test_pipelineIR.py

@@ -165,7 +165,7 @@ class PipelineIRTestCase(unittest.TestCase):
         pipeline = PipelineIR.from_string(pipeline_str)
         self.assertEqual(set(pipeline.tasks.keys()), {"modA", "modB"})
 
-        # Test that you cant include and exclude a task
+        # Test that you can't include and exclude a task
         pipeline_str = textwrap.dedent(
             """
         description: Test Pipeline
@@ -178,6 +178,112 @@ class PipelineIRTestCase(unittest.TestCase):
         """
         )
 
+        with self.assertRaises(ValueError):
+            PipelineIR.from_string(pipeline_str)
+
+        # Test that you can rename a task
+        pipeline_str = textwrap.dedent(
+            """
+        description: Test Pipeline
+        imports:
+            - location: $TESTDIR/pipelines/testPipeline1.yaml
+              rename:
+                modB: modZ
+              labeledSubsetModifyMode: EDIT
+        """
+        )
+
+        pipeline = PipelineIR.from_string(pipeline_str)
+        self.assertEqual(set(pipeline.tasks.keys()), {"modA", "modZ"})
+
+        # Test that renaming and including work together
+        pipeline_str = textwrap.dedent(
+            """
+        description: Test Pipeline
+        imports:
+            - location: $TESTDIR/pipelines/testPipeline1.yaml
+              include: modB
+              rename:
+                modB: modZ
+              labeledSubsetModifyMode: EDIT
+        """
+        )
+
+        pipeline = PipelineIR.from_string(pipeline_str)
+        self.assertEqual(
+            set(pipeline.tasks.keys()),
+            {
+                "modZ",
+            },
+        )
+
+        # Test that renaming an excluded label works, although perhaps it
+        # should emit a warning
+        pipeline_str = textwrap.dedent(
+            """
+        description: Test Pipeline
+        imports:
+            - location: $TESTDIR/pipelines/testPipeline1.yaml
+              exclude: modB
+              rename:
+                modB: modZ
+              labeledSubsetModifyMode: EDIT
+        """
+        )
+
+        pipeline = PipelineIR.from_string(pipeline_str)
+        self.assertEqual(
+            set(pipeline.tasks.keys()),
+            {
+                "modA",
+            },
+        )
+
+        # Test that you can't rename a task to an existing task
+        pipeline_str = textwrap.dedent(
+            """
+        description: Test Pipeline
+        imports:
+            - location: $TESTDIR/pipelines/testPipeline1.yaml
+              rename:
+                modB: modA
+              labeledSubsetModifyMode: EDIT
+        """
+        )
+
+        with self.assertRaises(ValueError):
+            PipelineIR.from_string(pipeline_str)
+
+        # Test that you can't rename two tasks to the same new name
+        pipeline_str = textwrap.dedent(
+            """
+        description: Test Pipeline
+        imports:
+            - location: $TESTDIR/pipelines/testPipeline1.yaml
+              rename:
+                modA: modC
+                modB: modC
+              labeledSubsetModifyMode: EDIT
+        """
+        )
+
+        with self.assertRaises(ValueError):
+            PipelineIR.from_string(pipeline_str)
+
+        # Test that you can't rename a task back to its old name
+        # This could work but is confusing and pointless
+        pipeline_str = textwrap.dedent(
+            """
+        description: Test Pipeline
+        imports:
+            - location: $TESTDIR/pipelines/testPipeline1.yaml
+              rename:
+                modB: modC
+                modC: modB
+              labeledSubsetModifyMode: EDIT
+        """
+        )
+
         with self.assertRaises(ValueError):
             PipelineIR.from_string(pipeline_str)
 

lsst_pipe_base-29.2025.4400/python/lsst/pipe/base/version.py

@@ -1,2 +0,0 @@
-__all__ = ["__version__"]
-__version__ = "29.2025.4400"