Add config access to getOutputNames()

python/lsst/analysis/tools/interfaces/_actions.py

@@ -41,6 +41,7 @@
 from dataclasses import dataclass
 from typing import Iterable
 
+import lsst.pex.config as pexConfig
 from lsst.pex.config.configurableActions import ConfigurableAction, ConfigurableActionField
 
 from ..contexts import ContextApplier
@@ -193,10 +194,16 @@ class PlotAction(AnalysisAction):
     a `Mapping` of `str` to `PlotType` when called.
     """
 
-    def getOutputNames(self) -> Iterable[str]:
+    def getOutputNames(self, config: pexConfig.Config | None = None) -> Iterable[str]:
         """Returns a list of names that will be used as keys if this action's
         call method returns a mapping. Otherwise return an empty Iterable
 
+        Parameters
+        ----------
+        config : `lsst.pex.config.Config`, optional
+            Configuration of the task. This is only used if the output naming
+            needs to be config-aware.
+
         Returns
         -------
         result : `Iterable` of `str`
@@ -251,14 +258,26 @@ def getInputSchema(self) -> KeyedDataSchema:
         yield from self.metric.getInputSchema()
         yield from self.plot.getInputSchema()
 
-    def getOutputNames(self) -> Iterable[str]:
+    def getOutputNames(self, config: pexConfig.Config | None = None) -> Iterable[str]:
         """Returns a list of names that will be used as keys if this action's
-        call method returns a mapping. Otherwise return an empty Iterable
+        call method returns a mapping. Otherwise return an empty Iterable.
+
+        Parameters
+        ----------
+        config : `lsst.pex.config.Config`, optional
+            Configuration of the task. This is only used if the output naming
+            needs to be config-aware.
 
         Returns
         -------
         result : `Iterable` of `str`
             If a `PlotAction` produces more than one plot, this should be the
             keys the action will use in the returned `Mapping`.
         """
-        return self.plot.getOutputNames()
+        if config is None:
+            # `dynamicOutputNames`` is set to False.
+            outNames = self.plot.getOutputNames()
+        else:
+            # `dynamicOutputNames`` is set to True.
+            outNames = self.plot.getOutputNames(config=config)
+        return outNames

python/lsst/analysis/tools/interfaces/_analysisTools.py

@@ -27,6 +27,7 @@
 from functools import wraps
 from typing import Callable, Iterable, Protocol, runtime_checkable
 
+import lsst.pex.config as pexConfig
 from lsst.pex.config import Field, ListField
 from lsst.pex.config.configurableActions import ConfigurableActionField
 from lsst.verify import Measurement
@@ -38,7 +39,7 @@
 
 @runtime_checkable
 class _HasOutputNames(Protocol):
-    def getOutputNames(self) -> Iterable[str]:
+    def getOutputNames(self, config: pexConfig.Config | None = None) -> Iterable[str]:
         ...
 
 
@@ -133,6 +134,11 @@ def __init_subclass__(cls: type[AnalysisTool], **kwargs):
         if "finalize" in vars(cls):
             cls.finalize = _finalizeWrapper(cls.finalize, cls)
 
+    dynamicOutputNames: bool | Field[bool] = False
+    """Determines whether to grant the getOutputNames() method access to config
+    parameters.
+    """
+
     parameterizedBand: bool | Field[bool] = True
     """Specifies if an `AnalysisTool` may parameterize a band within any field
     in any stage, or if the set of bands is already uniquely determined though
@@ -234,14 +240,20 @@ def populatePrepFromProcess(self):
         """
         self.prep.addInputSchema(self.process.getInputSchema())
 
-    def getOutputNames(self) -> Iterable[str]:
+    def getOutputNames(self, config: pexConfig.Config | None = None) -> Iterable[str]:
         """Return the names of the plots produced by this analysis tool.
 
         If there is a `PlotAction` defined in the produce action, these names
         will either come from the `PlotAction` if it defines a
         ``getOutputNames`` method (likely if it returns a mapping of figures),
         or a default value is used and a single figure is assumed.
 
+        Parameters
+        ----------
+        config : `lsst.pex.config.Config`, optional
+            Configuration of the task. This is only used if the output naming
+            needs to be config-aware.
+
         Returns
         -------
         result : `tuple` of `str`
@@ -251,7 +263,7 @@ def getOutputNames(self) -> Iterable[str]:
             case JointAction(plot=NoPlot()):
                 return tuple()
             case _HasOutputNames():
-                outNames = tuple(self.produce.getOutputNames())
+                outNames = tuple(self.produce.getOutputNames(config=config))
             case _:
                 raise ValueError(f"Unsupported Action type {type(self.produce)} for getting output names")
 

python/lsst/analysis/tools/interfaces/_task.py

@@ -147,11 +147,15 @@ def __init__(self, *, config: AnalysisBaseConfig = None):  # type: ignore
         # AnalysisPlots.
         names: list[str] = []
         for action in config.atools:
+            if action.dynamicOutputNames:
+                outputNames = action.getOutputNames(config=config)
+            else:
+                outputNames = action.getOutputNames()
             if action.parameterizedBand:
                 for band in config.bands:
-                    names.extend(name.format(band=band) for name in action.getOutputNames())
+                    names.extend(name.format(band=band) for name in outputNames)
             else:
-                names.extend(action.getOutputNames())
+                names.extend(outputNames)
 
         # For each of the names found, create output connections.
         for name in names: