Revised CalCat API

This is based on our discussion last week, but it's still a WIP. In particular, I haven't implemented actually loading the constants yet.

I've tweaked the design slightly: rather than having CalibrationData subclasses for each detector type, you use CalibrationData.from_conditions() with a detector specific object like AGIPDConditions. Jump to the tests to see what this looks like.

Questions:

• How to deal with missing modules?
  • A module may be missing for one type of constant but not for another
  • How do we even tell if modules are missing - should we query the PDUs so we know how many modules to expect?
• How to deal with missing calibration types (e.g. SlopesPC)
  • Especially if one group (e.g. illuminated) not found - this currently raises an error, even if we have other constants we could return
• Naming:
  • 'Calibrations' vs 'calibration' types vs 'constant types' (e.g. Offset, SlopesPC
  • 'Modules' vs 'aggregators'
• How many of SingleConstantVersion fields do we actually want?
• Should .select_modules() and .select_calibrations() take *args or a list?

cc @schmidtp @ahmedk @hammerd

src/cal_tools/calcat_interface2.py

@@ -83,7 +83,7 @@ class ModulesConstantVersions:
 
     constants: Dict[str, SingleConstantVersion]  # Keys e.g. 'LPD00'
 
-    def select_modules(self, *aggregators) -> "ModulesConstantVersions":
+    def select_modules(self, aggregators) -> "ModulesConstantVersions":
         d = {aggr: scv for (aggr, scv) in self.constants.items() if aggr in aggregators}
         return ModulesConstantVersions(d)
 
@@ -173,7 +173,7 @@ class CalibrationData(Mapping):
 
         res = cls(d, modules)
         if modules:
-            res = res.select_modules(*modules)
+            res = res.select_modules(modules)
         return res
 
     @classmethod
@@ -227,14 +227,14 @@ class CalibrationData(Mapping):
     def qm_names(self):
         return [module_index_to_qm(n) for n in self.module_nums]
 
-    def require_calibrations(self, *calibrations):
+    def require_calibrations(self, calibrations):
         """Drop any modules missing the specified constant types"""
         mods = set(self.aggregators)
         for cal_type in calibrations:
             mods.intersection_update(self[cal_type].constants)
         return self.select_modules(mods)
 
-    def select_calibrations(self, *calibrations, require_all=True):
+    def select_calibrations(self, calibrations, require_all=True):
         if require_all:
             missing = set(calibrations) - set(self.constant_groups)
             if missing:
@@ -248,9 +248,9 @@ class CalibrationData(Mapping):
         # TODO: missing for some modules?
         return type(self)(d, self.aggregators)
 
-    def select_modules(self, *aggregators):
+    def select_modules(self, aggregators):
         return type(self)({
-                cal_type: mcv.select_modules(*aggregators).constants
+                cal_type: mcv.select_modules(aggregators).constants
                 for (cal_type, mcv) in self.constant_groups.items()
         }, sorted(aggregators))