FIX #205

Author: prjemian

CHANGES.rst

@@ -4,6 +4,13 @@
 Change History
 ##############
 
+:1.1.10:  release *tba* : updates & bug fix
+
+    * `#205 <https://github.com/BCDA-APS/apstools/issues/205>`_
+       ``show_ophyd_symbols`` uses ipython shell's namespace
+    * `#202 <https://github.com/BCDA-APS/apstools/issues/202>`_
+       add ``labels`` attribute to enable ``wa`` and ``ct`` magic commands
+
 :1.1.9:  released *2019-07-28* : updates & bug fix
 
     * `#203 <https://github.com/BCDA-APS/apstools/issues/203>`_

apstools/utils.py

@@ -210,7 +210,11 @@ def print_RE_md(dictionary=None, fmt="simple", printing=True):
         ======================== ===================================
     
     """
-    global RE
+    try:
+        from IPython import get_ipython
+        RE = get_ipython().user_ns["RE"]
+    except AttributeError as _exc:
+        RE = None
     dictionary = dictionary or RE.md
     md = dict(dictionary)   # copy of input for editing
     v = dictionary_table(md["versions"], fmt=fmt)   # sub-table
@@ -279,29 +283,7 @@ def show_ophyd_symbols(show_pv=True, printing=True, verbose=False, symbols=None)
         If True, also show ``str(obj``.
     symbols: dict (default: `globals()`)
         If None, use global symbol table.
-        If not None, use provided dictionary.                                                                                                                                                                                            
-    
-    **TIP** ``globals()`` only gets the module's globals
-    
-    To get ``globals()`` from the global namespace, need to
-    pass that from the global namespace into this function.
-    Define this function *in* the global namespace::
-    
-        from apstools import utils as APS_utils
-    
-        def show_ophyd_symbols(
-            show_pv=True, 
-            printing=True, 
-            verbose=False, 
-            symbols=None
-        ):
-            symbols = symbols or globals()
-            return APS_utils.show_ophyd_symbols(
-                show_pv=show_pv,
-                printing=printing,
-                verbose=verbose,
-                symbols=symbols
-            )
+        If not None, use provided dictionary. 
     
     EXAMPLE::
     
@@ -333,7 +315,12 @@ def show_ophyd_symbols(
         table.addLabel("EPICS PV")
     if verbose:
         table.addLabel("object representation")
-    g = symbols or globals()
+    try:
+        from IPython import get_ipython
+        g = get_ipython().user_ns
+    except AttributeError as _exc:
+        g = globals()
+    g = symbols or g
     for k, v in sorted(g.items()):
         if isinstance(v, (ophyd.Signal, ophyd.Device)):
             row = [k, v.__class__.__name__]

tests/test_utils.py

@@ -108,21 +108,26 @@ def test_print_RE_md(self):
 
         expected = [
             'RunEngine metadata dictionary:',
-            '========= ================================',
-            'key       value                           ',
-            '========= ================================',
-            'purpose   testing                         ',
-            'something else                            ',
-            'versions  ======== =======================',
-            '          key      value                  ',
-            '          ======== =======================',
+            '========= ===============================',
+            'key       value                          ',
+            '========= ===============================',
+            'purpose   testing                        ',
+            'something else                           ',
+            'versions  ======== ======================',
+            '          key      value                 ',
+            '          ======== ======================',
             f'          apstools {APS__version__}',
-            '          ======== =======================',
-            '========= ================================',
+            '          ======== ======================',
+            '========= ===============================',
             ''
             ]
-        for r, e in zip(received, expected):
-            self.assertEqual(r, e)
+        self.assertEqual(len(received), len(expected))
+        self.assertEqual(received[4].strip(), expected[4].strip())
+        self.assertEqual(received[5].strip(), expected[5].strip())
+        self.assertEqual(
+            received[9].strip(), 
+            expected[9].strip()
+            )
 
     def test_pairwise(self):
         items = [1.0, 1.1, 1.01, 1.001, 1.0001, 1.00001, 2]