fix #173 : when the editor is called from a script, displays the filename and line number in the status bar

alixdamman · web-flow · commit f1082e4fe127 · 2019-04-12T10:41:27.000+02:00
diff --git a/larray_editor/api.py b/larray_editor/api.py
@@ -2,9 +2,10 @@
 
 import sys
 import traceback
+from inspect import getframeinfo
 from collections import OrderedDict
 
-from qtpy.QtWidgets import QApplication, QMainWindow
+from qtpy.QtWidgets import QApplication
 import larray as la
 
 from larray_editor.editor import REOPEN_LAST_FILE, MappingEditor, ArrayEditor
@@ -65,7 +66,7 @@ def get_title(obj, depth=0, maxnames=3):
     return ', '.join(names)
 
 
-def edit(obj=None, title='', minvalue=None, maxvalue=None, readonly=False, depth=0):
+def edit(obj=None, title='', minvalue=None, maxvalue=None, readonly=False, depth=0, display_caller_info=True):
     """
     Opens a new editor window.
 
@@ -87,6 +88,9 @@ def edit(obj=None, title='', minvalue=None, maxvalue=None, readonly=False, depth
         Whether or not editing array values is forbidden. Defaults to False.
     depth : int, optional
         Stack depth where to look for variables. Defaults to 0 (where this function was called).
+    display_caller_info: bool, optional
+        Whether or not to display the filename and line number where the Editor has been called.
+        Defaults to True.
 
     Examples
     --------
@@ -109,8 +113,13 @@ def edit(obj=None, title='', minvalue=None, maxvalue=None, readonly=False, depth
     else:
         parent = _app.activeWindow()
 
+    caller_frame = sys._getframe(depth + 1)
+    if display_caller_info:
+        caller_info = getframeinfo(caller_frame)
+    else:
+        caller_info = None
+
     if obj is None:
-        caller_frame = sys._getframe(depth + 1)
         global_vars = caller_frame.f_globals
         local_vars = caller_frame.f_locals
         obj = OrderedDict()
@@ -126,10 +135,11 @@ def edit(obj=None, title='', minvalue=None, maxvalue=None, readonly=False, depth
     if obj is REOPEN_LAST_FILE or isinstance(obj, (str, la.Session)):
         dlg = MappingEditor(parent)
         assert minvalue is None and maxvalue is None
-        setup_ok = dlg.setup_and_check(obj, title=title, readonly=readonly)
+        setup_ok = dlg.setup_and_check(obj, title=title, readonly=readonly, caller_info=caller_info)
     else:
         dlg = ArrayEditor(parent)
-        setup_ok = dlg.setup_and_check(obj, title=title, readonly=readonly, minvalue=minvalue, maxvalue=maxvalue)
+        setup_ok = dlg.setup_and_check(obj, title=title, readonly=readonly, minvalue=minvalue, maxvalue=maxvalue,
+                                       caller_info=caller_info)
 
     if setup_ok:
         dlg.show()
@@ -138,7 +148,7 @@ def edit(obj=None, title='', minvalue=None, maxvalue=None, readonly=False, depth
     restore_except_hook()
 
 
-def view(obj=None, title='', depth=0):
+def view(obj=None, title='', depth=0, display_caller_info=True):
     """
     Opens a new viewer window. Arrays are loaded in readonly mode and their content cannot be modified.
 
@@ -153,6 +163,9 @@ def view(obj=None, title='', depth=0):
         object).
     depth : int, optional
         Stack depth where to look for variables. Defaults to 0 (where this function was called).
+    display_caller_info: bool, optional
+        Whether or not to display the filename and line number where the Editor has been called.
+        Defaults to True.
 
     Examples
     --------
@@ -164,7 +177,7 @@ def view(obj=None, title='', depth=0):
     >>> # will open a viewer showing only a1
     >>> view(a1)                                                                                       # doctest: +SKIP
     """
-    edit(obj, title=title, readonly=True, depth=depth + 1)
+    edit(obj, title=title, readonly=True, depth=depth + 1, display_caller_info=display_caller_info)
 
 
 def compare(*args, **kwargs):
@@ -182,6 +195,9 @@ def compare(*args, **kwargs):
         namespace which correspond to the passed objects.
     depth : int, optional
         Stack depth where to look for variables. Defaults to 0 (where this function was called).
+    display_caller_info: bool, optional
+        Whether or not to display the filename and line number where the Editor has been called.
+        Defaults to True.
 
     Examples
     --------
@@ -195,13 +211,20 @@ def compare(*args, **kwargs):
     title = kwargs.pop('title', '')
     names = kwargs.pop('names', None)
     depth = kwargs.pop('depth', 0)
+    display_caller_info = kwargs.pop('display_caller_info', True)
     _app = QApplication.instance()
     if _app is None:
         _app = qapplication()
         parent = None
     else:
         parent = _app.activeWindow()
 
+    caller_frame = sys._getframe(depth + 1)
+    if display_caller_info:
+        caller_info = getframeinfo(caller_frame)
+    else:
+        caller_info = None
+
     if any(isinstance(a, la.Session) for a in args):
         from larray_editor.comparator import SessionComparator
         dlg = SessionComparator(parent)
@@ -221,7 +244,7 @@ def get_name(i, obj, depth=0):
     else:
         assert isinstance(names, list) and len(names) == len(args)
 
-    if dlg.setup_and_check(args, names=names, title=title):
+    if dlg.setup_and_check(args, names=names, title=title, caller_info=caller_info):
         dlg.show()
         _app.exec_()
 
diff --git a/larray_editor/editor.py b/larray_editor/editor.py
@@ -73,7 +73,7 @@ def __init__(self, parent=None, editable=False, file_menu=False, help_menu=False
         if editable:
             self.edit_undo_stack = QUndoStack(self)
 
-    def setup_and_check(self, data, title='', readonly=False, **kwargs):
+    def setup_and_check(self, data, title='', readonly=False, caller_info=None, **kwargs):
         """Return False if data is not supported, True otherwise"""
         # set icon
         icon = ima.icon('larray')
@@ -88,7 +88,11 @@ def setup_and_check(self, data, title='', readonly=False, **kwargs):
         self._title = title
         self.setWindowTitle(title)
 
-        # display status message
+        # permanently display caller info in the status bar
+        if caller_info is not None:
+            caller_info = 'launched from file {} at line {}'.format(caller_info.filename, caller_info.lineno)
+            self.statusBar().addPermanentWidget(QLabel(caller_info))
+        # display welcome message
         self.statusBar().showMessage("Welcome to the {}".format(self.name), 4000)
 
         # set central widget
@@ -99,7 +103,7 @@ def setup_and_check(self, data, title='', readonly=False, **kwargs):
         self._setup_and_check(widget, data, title, readonly, **kwargs)
 
         # resize
-        self.resize(800, 600)
+        self.resize(1000, 600)
         # This is more or less the minimum space required to display a 1D array
         self.setMinimumSize(300, 180)
         return True
@@ -303,7 +307,7 @@ def __init__(self, parent=None):
 
         self.setup_menu_bar()
 
-    def _setup_and_check(self, widget, data, title, readonly):
+    def _setup_and_check(self, widget, data, title, readonly, **kwargs):
         """Setup MappingEditor"""
         layout = QVBoxLayout()
         widget.setLayout(layout)
diff --git a/larray_editor/start.py b/larray_editor/start.py
@@ -9,7 +9,7 @@ def main():
     if os.name == 'nt':
         sys.stdout = open(os.devnull, "w")
         sys.stderr = open(os.path.join(os.getenv("TEMP"), "stderr-" + os.path.basename(sys.argv[0])), "w")
-    edit(*sys.argv[1:])
+    edit(*sys.argv[1:], display_caller_info=False)
 
 
 if __name__ == '__main__':
