TST #195 make it testable

Author: prjemian

apstools/utils.py

@@ -262,7 +262,7 @@ def wrapper(*args, **kwargs):
     return wrapper
 
 
-def show_ophyd_symbols(show_pv=True, printing=True, verbose=False):
+def show_ophyd_symbols(show_pv=True, printing=True, verbose=False, symbols=None):
     """
     show all the ophyd Signal and Device objects defined as globals
     
@@ -274,14 +274,17 @@ def show_ophyd_symbols(show_pv=True, printing=True, verbose=False):
         If True, print table to stdout.
     verbose: bool (default: False)
         If True, also show ``str(obj``.
+    symbols: dict (default: `globals()`)
+        If None, use global symbol table.
+        If not None, use provided dictionary.
     """
     table = pyRestTable.Table()
     table.labels = ["name", "ophyd structure"]
     if show_pv:
         table.addLabel("EPICS PV")
     if verbose:
         table.addLabel("object representation")
-    g = globals()
+    g = symbols or globals()
     for k, v in sorted(g.items()):
         if isinstance(v, (ophyd.Signal, ophyd.Device)):
             row = [k, v.__class__.__name__]

tests/test_utils.py

@@ -153,13 +153,19 @@ def test_trim_string_for_EPICS(self):
 
     def test_show_ophyd_symbols(self):
         from ophyd.sim import hw
-        sims = hw()
-        globals().update(sims.__dict__)
-        num = len(sims.__dict__)
+        sims = hw().__dict__
+        wont_show = ("flyer1", "flyer2", "new_trivial_flyer", "trivial_flyer")
+        num = len(sims) - len(wont_show)
+        kk = sorted(sims.keys())
         # sims hardware not found by show_ophyd_symbols() in globals!
-        table = APS_utils.show_ophyd_symbols()
+        table = APS_utils.show_ophyd_symbols(symbols=sims, printing=False)
         self.assertEqual(3, len(table.labels))
-        # FIXME: self.assertEqual(num, len(table.rows))
+        rr = [r[0] for r in table.rows]
+        for k in kk:
+            msg = f"{k} not found"
+            if k not in wont_show:
+                self.assertTrue(k in rr, msg)
+        self.assertEqual(num, len(table.rows))
 
 
 def suite(*args, **kw):