lsst-ctrl-bps 30.0.0rc2__tar.gz → 30.0.1rc1__tar.gz

{lsst_ctrl_bps-30.0.0rc2/python/lsst_ctrl_bps.egg-info → lsst_ctrl_bps-30.0.1rc1}/PKG-INFO

@@ -1,20 +1,20 @@
 Metadata-Version: 2.4
 Name: lsst-ctrl-bps
-Version: 30.0.0rc2
+Version: 30.0.1rc1
 Summary: Pluggable execution of workflow graphs from Rubin pipelines.
 Author-email: Rubin Observatory Data Management <dm-admin@lists.lsst.org>
 License-Expression: BSD-3-Clause OR GPL-3.0-or-later
 Project-URL: Homepage, https://github.com/lsst/ctrl_bps
+Project-URL: Source, https://github.com/lsst/ctrl_bps
 Keywords: lsst
 Classifier: Intended Audience :: Science/Research
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: Scientific/Engineering :: Astronomy
-Requires-Python: >=3.11.0
+Requires-Python: >=3.12.0
 Description-Content-Type: text/markdown
 License-File: COPYRIGHT
 License-File: LICENSE
@@ -23,7 +23,7 @@ License-File: gpl-v3.0.txt
 Requires-Dist: astropy>=4.0
 Requires-Dist: pyyaml>=5.1
 Requires-Dist: click>=7.0
-Requires-Dist: networkx<3.6
+Requires-Dist: networkx
 Requires-Dist: lsst-daf-butler
 Requires-Dist: lsst-pipe-base
 Requires-Dist: lsst-ctrl-mpexec

{lsst_ctrl_bps-30.0.0rc2 → lsst_ctrl_bps-30.0.1rc1}/doc/lsst.ctrl.bps/CHANGES.rst

@@ -1,3 +1,47 @@
+lsst-ctrl-bps v30.0.1 (2026-02-03)
+==================================
+
+Dropped Python 3.11.
+Tested with Python 3.14.
+
+Other Changes and Additions
+---------------------------
+
+- - Bumped minimum Python version to 3.12.
+  - Dropped ``black`` and ``isort`` sections from ``pyproject.toml``.
+  - Switched documentation build to use ``sphinxutils``. (`DM-54006 <https://rubinobs.atlassian.net/browse/DM-54006>`_)
+
+
+lsst-ctrl-bps v30.0.0 (2026-01-16)
+==================================
+
+New Features
+------------
+
+- Added support for transferring input files to the execution site and bringing the produced output files back to the submit site when using ``bps submitcmd``. (`DM-48479 <https://rubinobs.atlassian.net/browse/DM-48479>`_)
+- Added ``bpsGenerateConfig`` and ``bpsEval`` to run functions to produce config values.  ``bpsGenerateConfig`` is used when inserting or updating one or more key/value pairs.  ``bpsEval`` is for replacing part of a string value. (`DM-50616 <https://rubinobs.atlassian.net/browse/DM-50616>`_)
+
+Bug Fixes
+---------
+
+- Fixed bug where the ``return_exit_codes`` command line value was not passed to the plugin's report function.  While it was correctly used when displaying the report, not having the value didn't allow the plugin to optimize its report function. (`DM-52791 <https://rubinobs.atlassian.net/browse/DM-52791>`_)
+
+Performance Enhancement
+-----------------------
+
+- Switched the default ``finalJob`` implementation to the new ``aggregate-graph`` command, which makes use of multiple cores much more effectively than ``transfer-from-graph``. (`DM-52360 <https://rubinobs.atlassian.net/browse/DM-52360>`_)
+
+
+Other Changes and Additions
+---------------------------
+
+- Removed exit code 1 from the default for ``finalJob``\ 's ``retryUnlessExit`` as the majority of these are related to system issues which could be transient. (`DM-51313 <https://rubinobs.atlassian.net/browse/DM-51313>`_)
+- Modified the BPS report driver so it compiles exit code summary only when necessary, i.e., when ``--return-exit-codes`` option was used with ``bps report``. (`DM-52898 <https://rubinobs.atlassian.net/browse/DM-52898>`_)
+- Added a custom __new__ method to the GenericWorkflow class so **ctrl_bps** can work when using NetworkX 3.6. (`DM-53492 <https://rubinobs.atlassian.net/browse/DM-53492>`_)
+- Made the BPS reporting mechanism a bit more robust. If the BPS plugin does not explicitly includes jobs labels for which there are no failures in the run's exit code summary, it will try to use the run's job summary to do that. (`DM-51261 <https://rubinobs.atlassian.net/browse/DM-51261>`_)
+- Used the new ``PredictedQuantumGraph`` class internally and default to the new QG file format via the "``.qg``" extension. (`DM-52339 <https://rubinobs.atlassian.net/browse/DM-52339>`_)
+
+
 lsst-ctrl-bps v29.1.0 (2025-06-13)
 ==================================
 

{lsst_ctrl_bps-30.0.0rc2 → lsst_ctrl_bps-30.0.1rc1}/doc/lsst.ctrl.bps/quickstart.rst

@@ -1,3 +1,6 @@
+User Guide
+==========
+
 Overview
 --------
 

{lsst_ctrl_bps-30.0.0rc2 → lsst_ctrl_bps-30.0.1rc1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "lsst-ctrl-bps"
-requires-python = ">=3.11.0"
+requires-python = ">=3.12.0"
 description = "Pluggable execution of workflow graphs from Rubin pipelines."
 license = "BSD-3-Clause OR GPL-3.0-or-later"
 license-files = ["COPYRIGHT", "LICENSE", "bsd_license.txt", "gpl-v3.0.txt"]
@@ -16,7 +16,6 @@ classifiers = [
     "Intended Audience :: Science/Research",
     "Operating System :: OS Independent",
     "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
     "Programming Language :: Python :: 3.14",
@@ -27,7 +26,7 @@ dependencies = [
     "astropy >=4.0",
     "pyyaml >=5.1",
     "click >= 7.0",
-    "networkx <3.6",
+    "networkx",
     "lsst-daf-butler",
     "lsst-pipe-base",
     "lsst-ctrl-mpexec",
@@ -38,8 +37,9 @@ dynamic = ["version"]
 
 [project.urls]
 "Homepage" = "https://github.com/lsst/ctrl_bps"
-[project.optional-dependencies]
+"Source" = "https://github.com/lsst/ctrl_bps"
 
+[project.optional-dependencies]
 test = [
     "pytest >= 3.2",
     "pytest-openfiles >= 0.5.0"
@@ -98,15 +98,6 @@ bps = "lsst.ctrl.bps.cli.bps:main"
         name = "An API Removal or Deprecation"
         showcontent = true
 
-[tool.black]
-line-length = 110
-target-version = ["py311"]
-
-[tool.isort]
-profile = "black"
-line_length = 110
-known_first_party = ["lsst"]
-
 [tool.lsst_versions]
 write_to = "python/lsst/ctrl/bps/version.py"
 
@@ -134,7 +125,7 @@ exclude_lines = [
 
 [tool.ruff]
 line-length = 110
-target-version = "py311"
+target-version = "py312"
 exclude = [
     "__init__.py",
 ]
@@ -200,6 +191,7 @@ checks = [
     "RT01",  # Unfortunately our @property trigger this.
     "RT02",  # Does not want named return value. DM style says we do.
     "SS05",  # pydocstyle is better at finding infinitive verb.
+    "RT03",  # Temporarily disable for sphinx empty returns.
 ]
 exclude = [
     '^test_.*',  # Do not test docstrings in test code.

{lsst_ctrl_bps-30.0.0rc2 → lsst_ctrl_bps-30.0.1rc1}/python/lsst/ctrl/bps/bps_config.py

@@ -87,7 +87,7 @@ class BpsConfig(Config):
         afterwards. WMS settings takes precedence over provided defaults.
     wms_service_class_fqn : `str`, optional
         Fully qualified name of the WMS service class to use to get plugin's
-        specific default settings. If ``None`` (default), the WMS service
+        specific default settings. If `None` (default), the WMS service
         class provided by
 
         1. ``other`` config,
@@ -197,7 +197,7 @@ class BpsConfig(Config):
         ----------
         key : `str`
             Key to look for in config.
-        default : Any, optional
+        default : `~typing.Any`, optional
             Default value to return if the key is not in the config.
 
         Returns
@@ -256,7 +256,7 @@ class BpsConfig(Config):
         ----------
         key : `str`
             Key to look for in config.
-        opt : `dict` [`str`, `Any`], optional
+        opt : `dict` [`str`, `~typing.Any`], optional
             Options dictionary to use while searching.  All are optional.
 
             ``"curvals"``
@@ -264,7 +264,7 @@ class BpsConfig(Config):
                     (curr_<sectname>) or variable replacements.
                     (`dict`, optional)
             ``"default"``
-                    Value to return if not found. (`Any`, optional)
+                    Value to return if not found. (`~typing.Any`, optional)
             ``"replaceEnvVars"``
                     If search result is string, whether to replace environment
                     variables inside it with special placeholder (<ENV:name>).

{lsst_ctrl_bps-30.0.0rc2 → lsst_ctrl_bps-30.0.1rc1}/python/lsst/ctrl/bps/clustered_quantum_graph.py

@@ -61,7 +61,7 @@ class QuantaCluster:
         be unique within ClusteredQuantumGraph.
     label : `str`
         Value used to group clusters.
-    tags : `dict` [`str`, `Any`], optional
+    tags : `dict` [`str`, `~typing.Any`], optional
         Arbitrary key/value pairs for the cluster.
 
     Raises
@@ -248,7 +248,8 @@ class ClusteredQuantumGraph:
 
         Parameters
         ----------
-        clusters_for_adding : `QuantaCluster` or `Iterable` [`QuantaCluster`]
+        clusters_for_adding : `QuantaCluster` or \
+                `~collections.abc.Iterable` [`QuantaCluster`]
             The cluster to be added to the ClusteredQuantumGraph.
         """
         for cluster in ensure_iterable(clusters_for_adding):
@@ -311,7 +312,7 @@ class ClusteredQuantumGraph:
 
         Returns
         -------
-        names : `Iterator` [`str`]
+        names : `~collections.abc.Iterator` [`str`]
             Iterator over names of clusters.
         """
         return self._cluster_graph.nodes()
@@ -321,7 +322,7 @@ class ClusteredQuantumGraph:
 
         Returns
         -------
-        clusters : `Iterator` [`lsst.ctrl.bps.QuantaCluster`]
+        clusters : `~collections.abc.Iterator` [`lsst.ctrl.bps.QuantaCluster`]
             Iterator over clusters in topological order.
         """
         return map(self.get_cluster, topological_sort(self._cluster_graph))
@@ -337,7 +338,7 @@ class ClusteredQuantumGraph:
 
         Returns
         -------
-        clusters : `Iterator` [`lsst.ctrl.bps.QuantaCluster`]
+        clusters : `~collections.abc.Iterator` [`lsst.ctrl.bps.QuantaCluster`]
             Iterator over successors of given cluster.
         """
         return map(self.get_cluster, self._cluster_graph.successors(name))
@@ -353,7 +354,7 @@ class ClusteredQuantumGraph:
 
         Returns
         -------
-        clusters : `Iterator` [`lsst.ctrl.bps.QuantaCluster`]
+        clusters : `~collections.abc.Iterator` [`lsst.ctrl.bps.QuantaCluster`]
             Iterator over predecessors of given cluster.
         """
         return map(self.get_cluster, self._cluster_graph.predecessors(name))

{lsst_ctrl_bps-30.0.0rc2 → lsst_ctrl_bps-30.0.1rc1}/python/lsst/ctrl/bps/construct.py

@@ -181,7 +181,8 @@ def create_job_files(
         The mapping between file keys and file paths.
     prefix : `str` | `pathlib.Path`
         The root directory to which the files will be written.
-    path_creator : `Callable` [[`Path`, `Path`], `Path`]
+    path_creator : `~collections.abc.Callable` \
+            [[`pathlib.Path`, `pathlib.Path`], `pathlib.Path`]
         File category that determines actions that need to be taken during
         file creation.
 

{lsst_ctrl_bps-30.0.0rc2 → lsst_ctrl_bps-30.0.1rc1}/python/lsst/ctrl/bps/generic_workflow.py

@@ -332,6 +332,18 @@ class GenericWorkflow(DiGraph):
         self.run_id = None
         self._final: GenericWorkflowJob | GenericWorkflow | None = None
 
+    # Starting from ver. 3.6 of NetworkX, the DiGraph class defines its custom
+    # __new__ method that explicitly defines arguments it accepts. As a result,
+    # we need to override it to let our subclass use different ones.
+    #
+    # Notes
+    # -----
+    # Most likely overriding __new__ in this manner will prevent us from using
+    # different graph backends with our subclass. However, since we are not
+    # using any backends, this should not be a problem at the moment.
+    def __new__(cls, *args, **kwargs) -> "GenericWorkflow":
+        return object.__new__(cls)
+
     @property
     def name(self) -> str:
         """Retrieve name of generic workflow.
@@ -416,7 +428,7 @@ class GenericWorkflow(DiGraph):
         ----------
         data : `bool`, optional
             Whether to return the file data as well as the file object name
-            (The default is False).
+            (The default is `False`).
         transfer_only : `bool`, optional
             Whether to only return files for which a workflow management system
             would be responsible for transferring.
@@ -478,7 +490,7 @@ class GenericWorkflow(DiGraph):
         ----------
         node_for_adding : `lsst.ctrl.bps.GenericWorkflowJob`
             Job to be added to generic workflow.
-        **attr
+        **attr : `~typing.Any`
             Needed to match original networkx function, but not used.
         """
         self.add_job(node_for_adding)
@@ -512,7 +524,7 @@ class GenericWorkflow(DiGraph):
         ebunch_to_add : Iterable [`tuple` [`str`, `str`]]
             Iterable of job name pairs between which a dependency should be
             saved.
-        **attr : keyword arguments, optional
+        **attr : `~typing.Any`
             Data can be assigned using keyword arguments (not currently used).
         """
         for edge_to_add in ebunch_to_add:
@@ -527,7 +539,7 @@ class GenericWorkflow(DiGraph):
             Name of parent job.
         v_of_edge : `str`
             Name of child job.
-        **attr : keyword arguments, optional
+        **attr
             Attributes to save with edge.
         """
         if u_of_edge not in self:

{lsst_ctrl_bps-30.0.0rc2 → lsst_ctrl_bps-30.0.1rc1}/python/lsst/ctrl/bps/initialize.py

@@ -58,7 +58,8 @@ def init_submission(
     ----------
     config_file : `str`
         Name of the configuration file.
-    validators : `Iterable[Callable[[BpsConfig], None]]`, optional
+    validators : `~collections.abc.Iterable` \
+            [`~collections.abc.Callable` [[`BpsConfig`], `None`]], optional
         A list of functions performing checks on the given configuration.
         Each function should take a single argument, a BpsConfig object, and
         raise if the check fails. By default, no checks are performed.

{lsst_ctrl_bps-30.0.0rc2 → lsst_ctrl_bps-30.0.1rc1}/python/lsst/ctrl/bps/quantum_clustering_funcs.py

@@ -789,7 +789,7 @@ def get_cluster_name_from_info(
     -------
     cluster_name : `str`
         Name of the cluster in which to add the given node.
-    info : dict [`str`, `Any`]
+    info : dict [`str`, `~typing.Any`]
         Information needed if creating a new node.
     """
     # Gather info for cluster name template into a dictionary.

{lsst_ctrl_bps-30.0.0rc2 → lsst_ctrl_bps-30.0.1rc1}/python/lsst/ctrl/bps/transform.py

@@ -210,7 +210,7 @@ def _enhance_command(config, generic_workflow, gwjob, cached_job_values):
     gwjob : `lsst.ctrl.bps.GenericWorkflowJob`
         Generic workflow job to which the updated executable, arguments,
         and values should be saved.
-    cached_job_values : `dict` [`str`, dict[`str`, `Any`]]
+    cached_job_values : `dict` [`str`, dict[`str`, `~typing.Any`]]
         Cached values common across jobs with same label.  Updated if values
         aren't already saved for given gwjob's label.
     """
@@ -286,7 +286,7 @@ def _fill_arguments(use_shared, generic_workflow, arguments, cmdvals):
         Generic workflow containing the job.
     arguments : `str`
         String containing placeholders.
-    cmdvals : `dict` [`str`, `Any`]
+    cmdvals : `dict` [`str`, `~typing.Any`]
         Any command line values that can be used to replace placeholders.
 
     Returns
@@ -365,14 +365,14 @@ def _get_job_values(config, search_opt, cmd_line_key):
     ----------
     config : `lsst.ctrl.bps.BpsConfig`
         Bps configuration.
-    search_opt : `dict` [`str`, `Any`]
+    search_opt : `dict` [`str`, `~typing.Any`]
         Search options to be used when searching config.
     cmd_line_key : `str` or None
         Which command line key to search for (e.g., "runQuantumCommand").
 
     Returns
     -------
-    job_values : `dict` [ `str`, `Any` ]`
+    job_values : `dict` [ `str`, `~typing.Any` ]`
         A mapping between job attributes and their values.
     """
     _LOG.debug("cmd_line_key=%s, search_opt=%s", cmd_line_key, search_opt)
@@ -443,7 +443,7 @@ def _handle_job_values(quantum_job_values, gwjob, attributes=_ATTRS_ALL):
         Job values for running single Quantum.
     gwjob : `lsst.ctrl.bps.GenericWorkflowJob`
         Generic workflow job in which to store the universal values.
-    attributes : `Iterable` [`str`], optional
+    attributes : `~collections.abc.Iterable` [`str`], optional
         Job attributes to be set in the job following different rules.
         The default value is _ATTRS_ALL.
     """
@@ -463,7 +463,7 @@ def _handle_job_values_universal(quantum_job_values, gwjob, attributes=_ATTRS_UN
         Job values for running single Quantum.
     gwjob : `lsst.ctrl.bps.GenericWorkflowJob`
         Generic workflow job in which to store the universal values.
-    attributes : `Iterable` [`str`], optional
+    attributes : `~collections.abc.Iterable` [`str`], optional
         Job attributes to be set in the job following different rules.
         The default value is _ATTRS_UNIVERSAL.
     """
@@ -502,11 +502,11 @@ def _handle_job_values_max(quantum_job_values, gwjob, attributes=_ATTRS_MAX):
 
     Parameters
     ----------
-    quantum_job_values : `dict` [`str`, `Any`]
+    quantum_job_values : `dict` [`str`, `~typing.Any`]
         Job values for running single Quantum.
     gwjob : `lsst.ctrl.bps.GenericWorkflowJob`
         Generic workflow job in which to store the aggregate values.
-    attributes : `Iterable` [`str`], optional
+    attributes : `~collections.abc.Iterable` [`str`], optional
         Job attributes to be set in the job following different rules.
         The default value is _ATTR_MAX.
     """
@@ -547,11 +547,11 @@ def _handle_job_values_sum(quantum_job_values, gwjob, attributes=_ATTRS_SUM):
 
     Parameters
     ----------
-    quantum_job_values : `dict` [`str`, `Any`]
+    quantum_job_values : `dict` [`str`, `~typing.Any`]
         Job values for running single Quantum.
     gwjob : `lsst.ctrl.bps.GenericWorkflowJob`
         Generic workflow job in which to store the aggregate values.
-    attributes : `Iterable` [`str`], optional
+    attributes : `~collections.abc.Iterable` [`str`], optional
         Job attributes to be set in the job following different rules.
         The default value is _ATTRS_SUM.
     """

{lsst_ctrl_bps-30.0.0rc2 → lsst_ctrl_bps-30.0.1rc1}/python/lsst/ctrl/bps/version.py

@@ -1,2 +1,2 @@
 __all__ = ["__version__"]
-__version__ = "30.0.0rc2"
+__version__ = "30.0.1rc1"

{lsst_ctrl_bps-30.0.0rc2 → lsst_ctrl_bps-30.0.1rc1}/python/lsst/ctrl/bps/wms_service.py

@@ -121,14 +121,14 @@ class WmsSpecificInfo:
 
         Returns
         -------
-        context : `dict` [`str`, `Any`]
+        context : `dict` [`str`, `~typing.Any`]
             A copy of the dictionary representing the mapping between
             *every* template variable and its value.
 
         Notes
         -----
         The property returns a *shallow* copy of the dictionary representing
-        the context as the intended purpose of the ``WmsSpecificInfo`` is to
+        the context as the intended purpose of the `WmsSpecificInfo` is to
         pass a small number of brief messages from WMS to BPS reporting
         subsystem. Hence, it is assumed that the dictionary will only contain
         immutable objects (e.g. strings, numbers).
@@ -157,7 +157,7 @@ class WmsSpecificInfo:
         ----------
         template : `str`
             A message template.
-        context : `dict` [`str`, `Any`], optional
+        context : `dict` [`str`, `~typing.Any`], optional
             A mapping between template variables and their values.
         **kwargs
             Additional keyword arguments.
@@ -296,7 +296,7 @@ class BaseWmsService:
         -----
         This property is currently being used in ``BpsConfig.__init__()``.
         As long as that's the case it cannot be changed to return
-        a ``BpsConfig`` instance.
+        a `BpsConfig` instance.
         """
         return None
 
@@ -386,7 +386,7 @@ class BaseWmsService:
 
         Returns
         -------
-        job_ids : `list` [`Any`]
+        job_ids : `list` [`~typing.Any`]
             Only job ids to be used by cancel and other functions.  Typically
             this means top-level jobs (i.e., not children jobs).
         """

{lsst_ctrl_bps-30.0.0rc2 → lsst_ctrl_bps-30.0.1rc1/python/lsst_ctrl_bps.egg-info}/PKG-INFO

@@ -1,20 +1,20 @@
 Metadata-Version: 2.4
 Name: lsst-ctrl-bps
-Version: 30.0.0rc2
+Version: 30.0.1rc1
 Summary: Pluggable execution of workflow graphs from Rubin pipelines.
 Author-email: Rubin Observatory Data Management <dm-admin@lists.lsst.org>
 License-Expression: BSD-3-Clause OR GPL-3.0-or-later
 Project-URL: Homepage, https://github.com/lsst/ctrl_bps
+Project-URL: Source, https://github.com/lsst/ctrl_bps
 Keywords: lsst
 Classifier: Intended Audience :: Science/Research
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: Scientific/Engineering :: Astronomy
-Requires-Python: >=3.11.0
+Requires-Python: >=3.12.0
 Description-Content-Type: text/markdown
 License-File: COPYRIGHT
 License-File: LICENSE
@@ -23,7 +23,7 @@ License-File: gpl-v3.0.txt
 Requires-Dist: astropy>=4.0
 Requires-Dist: pyyaml>=5.1
 Requires-Dist: click>=7.0
-Requires-Dist: networkx<3.6
+Requires-Dist: networkx
 Requires-Dist: lsst-daf-butler
 Requires-Dist: lsst-pipe-base
 Requires-Dist: lsst-ctrl-mpexec

{lsst_ctrl_bps-30.0.0rc2 → lsst_ctrl_bps-30.0.1rc1}/python/lsst_ctrl_bps.egg-info/requires.txt

@@ -1,7 +1,7 @@
 astropy>=4.0
 pyyaml>=5.1
 click>=7.0
-networkx<3.6
+networkx
 lsst-daf-butler
 lsst-pipe-base
 lsst-ctrl-mpexec