FEAT: added support for Path objects in edit() and view() (see larray-project/larray#896)

gdementen · gdementen · commit bb77a65154d6 · 2022-10-14T15:00:04.000+02:00
diff --git a/doc/source/changes/version_0_34.rst.inc b/doc/source/changes/version_0_34.rst.inc
@@ -43,6 +43,9 @@ Miscellaneous improvements
 * when displaying an expression (computed array), the window title includes the actual expression
   instead of using '<expr>'.
 
+* added support for Path objects (in addition to str representing paths) in :py:obj:`view()` and :py:obj:`edit()`.
+  See :issue:`896`.
+
 * When the editor displays currently defined variables (via `debug()` `edit()` or
   `view()` without argument within user code or via an exception when run_editor_on_exception is active),
   LArray functions are not made available systematically in the console anymore (what is available in the console is
diff --git a/larray_editor/api.py b/larray_editor/api.py
@@ -2,6 +2,7 @@
 import sys
 import traceback
 from inspect import getframeinfo
+from pathlib import Path
 
 from qtpy.QtWidgets import QApplication
 import larray as la
@@ -125,7 +126,7 @@ def _edit_dialog(parent, obj=None, title='', minvalue=None, maxvalue=None, reado
     if not title and obj is not REOPEN_LAST_FILE:
         title = _get_title(obj, depth=depth + 1)
 
-    if obj is REOPEN_LAST_FILE or isinstance(obj, (str, la.Session)):
+    if obj is REOPEN_LAST_FILE or isinstance(obj, (str, Path, la.Session)):
         dlg = MappingEditor(parent)
         assert minvalue is None and maxvalue is None
         setup_ok = dlg.setup_and_check(obj, title=title, readonly=readonly, caller_info=caller_info,
@@ -147,8 +148,8 @@ def edit(obj=None, title='', minvalue=None, maxvalue=None, readonly=False, depth
 
     Parameters
     ----------
-    obj : np.ndarray, Array, Session, dict, str, REOPEN_LAST_FILE or None, optional
-        Object to visualize. If string, array(s) will be loaded from the file given as argument.
+    obj : np.ndarray, Array, Session, dict, str, Path, REOPEN_LAST_FILE or None, optional
+        Object to visualize. If string or Path, array(s) will be loaded from the file given as argument.
         Passing the constant REOPEN_LAST_FILE loads the last opened file.
         Defaults to None, which gathers all variables (global and local) where the function was called.
     title : str, optional
@@ -190,8 +191,8 @@ def view(obj=None, title='', depth=0, display_caller_info=True, add_larray_funct
 
     Parameters
     ----------
-    obj : np.ndarray, Array, Session, dict or str, optional
-        Object to visualize. If string, array(s) will be loaded from the file given as argument.
+    obj : np.ndarray, Array, Session, dict, str or Path, optional
+        Object to visualize. If string or Path, array(s) will be loaded from the file given as argument.
         Defaults to the collection of all local variables where the function was called.
     title : str, optional
         Title for the current object. Defaults to the name of the first object found in the caller namespace which
diff --git a/larray_editor/editor.py b/larray_editor/editor.py
@@ -475,7 +475,7 @@ def void_formatter(array, *args, **kwargs):
                 data = la.Session()
 
         # load file if any
-        if isinstance(data, str):
+        if isinstance(data, (str, Path)):
             if os.path.isfile(data):
                 self._open_file(data)
             else:
diff --git a/larray_editor/tests/test_api_larray.py b/larray_editor/tests/test_api_larray.py
@@ -1,6 +1,7 @@
 """Array editor test"""
 
 import logging
+from pathlib import Path
 
 import numpy as np
 import larray as la
@@ -135,6 +136,7 @@ def make_demo(width=20, ball_radius=5, path_radius=5, steps=30):
 #                'c:\\tmp\\edit.profile')
 # debug()
 edit()
+# edit(Path('../test_object.h5'))
 # edit(ses)
 # edit(file)
 # edit('fake_path')
