Add an API function for reporting run summary

The distinction between a high-level API function and a driver was
rather blurred for the driver function responsible for printing out the
run summary.  Hence, I moved out the content of the driver to a separate
function, report(), and made the driver call it instead.

python/lsst/ctrl/bps/drivers.py

@@ -36,7 +36,6 @@
 import time
 
 from lsst.obs.base import Instrument
-from lsst.utils import doImport
 
 from . import BpsConfig
 from .bps_draw import draw_networkx_dot
@@ -45,7 +44,7 @@
 from .prepare import prepare
 from .submit import BPS_SEARCH_ORDER, submit
 from .cancel import cancel
-from .report import print_headers, print_run, print_single_run_summary
+from .report import report
 
 
 _LOG = logging.getLogger(__name__)
@@ -224,28 +223,7 @@ def report_driver(wms_service, user, run_id, hist_days, pass_thru):
     pass_thru : `str`
         A string to pass directly to the WMS service class.
     """
-    wms_service_class = doImport(wms_service)
-    wms_service = wms_service_class({})
-
-    # If reporting on single run, increase history until better mechanism
-    # for handling completed jobs is available.
-    if run_id:
-        hist_days = max(hist_days, 2)
-
-    runs, message = wms_service.report(run_id, user, hist_days, pass_thru)
-
-    if run_id:
-        if not runs:
-            print(f"No information found for id='{run_id}'.")
-            print(f"Double check id and retry with a larger --hist value"
-                  f"(currently: {hist_days})")
-        for run in runs:
-            print_single_run_summary(run)
-    else:
-        print_headers()
-        for run in sorted(runs, key=lambda j: j.wms_id):
-            print_run(run)
-    print(message)
+    report(wms_service, user, run_id, hist_days, pass_thru)
 
 
 def cancel_driver(wms_service, run_id, user, require_bps, pass_thru):

python/lsst/ctrl/bps/report.py

@@ -27,6 +27,8 @@
 
 import logging
 
+from lsst.utils import doImport
+
 from .wms_service import WmsStates
 
 
@@ -36,6 +38,46 @@
 _LOG = logging.getLogger(__name__)
 
 
+def report(wms_service, user, run_id, hist_days, pass_thru):
+    """Print out summary of jobs submitted for execution.
+
+    Parameters
+    ----------
+    wms_service : `str`
+        Name of the class.
+    user : `str`
+        A user name the report will be restricted to.
+    run_id : `str`
+        A run id the report will be restricted to.
+    hist_days : int
+        Number of days
+    pass_thru : `str`
+        A string to pass directly to the WMS service class.
+    """
+    wms_service_class = doImport(wms_service)
+    wms_service = wms_service_class({})
+
+    # If reporting on single run, increase history until better mechanism
+    # for handling completed jobs is available.
+    if run_id:
+        hist_days = max(hist_days, 2)
+
+    runs, message = wms_service.report(run_id, user, hist_days, pass_thru)
+
+    if run_id:
+        if not runs:
+            print(f"No information found for id='{run_id}'.")
+            print(f"Double check id and retry with a larger --hist value"
+                  f"(currently: {hist_days})")
+        for run in runs:
+            print_single_run_summary(run)
+    else:
+        print_headers()
+        for run in sorted(runs, key=lambda j: j.wms_id):
+            print_run(run)
+    print(message)
+
+
 def print_headers():
     """Print headers.
     """