Merge pull request #1058 from BCDA-APS/1056-hklpy-configuration

Callbacks should gather hklpy diffractometer configurations

@MDecarabas Thanks!

.gitignore

@@ -41,3 +41,6 @@ build_log.txt
 
 # setuptools-scm : generated version number
 _version.py
+
+# bs_model_instrument
+.re_md_dict.yml

CHANGES.rst

@@ -26,6 +26,11 @@ describe future plans.
 
    Release expected by 2025-02-28.
 
+   Enhancements
+   -------------
+
+   * Recover diffractometer configurations in FileWriterCallbackBase.
+
    Fixes
    -----
 

apstools/callbacks/callback_base.py

@@ -43,6 +43,7 @@ class FileWriterCallbackBase:
     .. autosummary::
 
        ~clear
+       ~get_hklpy_configurations
        ~make_file_name
        ~writer
 
@@ -101,6 +102,7 @@ def clear(self):
         """
         self.acquisitions = {}
         self.detectors = []
+        self.diffractometers = {}
         self.exit_status = None
         self.externals = {}
         self.doc_timestamp = None
@@ -131,6 +133,20 @@ def file_path(self):
     def file_path(self, value):
         self._file_path = pathlib.Path(value)
 
+    def get_hklpy_configurations(self, doc: dict) -> dict:
+        """Diffractometer details (from hklpy) in RE descriptor documents."""
+        configurations = {}  # zero, one, or more diffractometers are possible
+        for diffractometer_name in doc.get("configuration", {}):
+            record = doc["configuration"][diffractometer_name].get("data", {})
+            attrs = record.get(f"{diffractometer_name}_orientation_attrs")
+            if attrs is not None:
+                configurations[diffractometer_name] = {
+                    # empty when no orientation_attrs
+                    attr: record[f"{diffractometer_name}_{attr}"]
+                    for attr in attrs
+                }
+        return configurations
+
     def make_file_name(self):
         """
         generate a file name to be used as default
@@ -271,6 +287,9 @@ def descriptor(self, doc):
             dd["time"] = []  # entry time stamps here
             dd["external"] = entry.get("external") is not None
             # logger.debug("dd %s: %s", k, data[k])
+
+        # Gather any available diffractometer configurations.
+        self.diffractometers.update(self.get_hklpy_configurations(doc))
 
     def event(self, doc):
         """