dev

.github/workflows/ci.yml

@@ -15,7 +15,7 @@ jobs:
         with:
           # Pin ruff version to make sure we do not break our builds at the
           # worst times
-          version: "0.14.0"
+          version: "0.14.7"
 
   test:
     # name: Test (${{ matrix.python-version }}, ${{ matrix.os }})
@@ -34,14 +34,14 @@ jobs:
         shell: bash -l {0}
 
     steps:
-    - uses: actions/checkout@v5
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: conda-incubator/setup-miniconda@v3
-      with:
-        auto-update-conda: true
-        environment-file: environment.yml
-        python-version: ${{ matrix.python-version }}
-    - run: conda info
-    - run: conda list
-    - run: conda config --show
-    - run: pytest
+      - uses: actions/checkout@v5
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: conda-incubator/setup-miniconda@v3
+        with:
+          auto-update-conda: true
+          environment-file: environment.yml
+          python-version: ${{ matrix.python-version }}
+      - run: conda info
+      - run: conda list
+      - run: conda config --show
+      - run: pytest

condarecipe/larray-editor/meta.yaml

@@ -18,13 +18,18 @@ requirements:
   host:
     - python >=3.9
     - pip
+    - setuptools
 
   run:
     - python >=3.9
-    # requires larray >= 0.32 because of the LArray -> Array rename
+    # Technically, we should require larray >=0.35 because we need align_arrays
+    # for compare(), but to make larray-editor releasable, we cannot depend on
+    # larray X.Y when releasing larray-editor X.Y (see utils.py for more
+    # details)
+    # TODO: require 0.35 for next larray-editor version
     - larray >=0.32
     # it is indirectly pulled from larray, but let us be explicit about this
-    - numpy
+    - numpy >=1.22
     - matplotlib
     - pyqt >=5
     - qtpy >=2  # for Qt6 support

doc/source/changes/version_0_35.rst.inc

@@ -1,25 +1,96 @@
 .. py:currentmodule:: larray_editor
 
-Syntax changes
-^^^^^^^^^^^^^^
-
-* renamed ``MappingEditor.old_method_name()`` to :py:obj:`MappingEditor.new_method_name()` (closes :editor_issue:`1`).
-
-* renamed ``old_argument_name`` argument of :py:obj:`MappingEditor.method_name()` to ``new_argument_name``.
-
-
-Backward incompatible changes
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-* other backward incompatible changes
-
-
 New features
 ^^^^^^^^^^^^
 
+* allow displaying *many* more different kinds of objects, and not only arrays
+  from larray. One specific goal when developing this new feature was speed.
+  Most of these viewers should be fast (when at all possible), even on (very)
+  large datasets. We only support displaying (not editing) all the new types.
+
+  The following types are supported so far (but adding more is relatively easy):
+
+  * Python builtin objects:
+    - tuple (including named tuple), list (sequences), dict (mappings),
+      dict views, memoryview and array
+    - text and binary files
+  * Python stdlib objects:
+    - pathlib.Path
+      * if the path points to a directory, it will display the content of the
+        directory
+      * if the path points to a file, it will try to display it, if we
+        implemented support for that file type (see below for the list
+        of supported types).
+    - sqlite3.Connection (and their tables)
+    - pstats.Stats (results of Python's profiler)
+    - zipfile.ZipFile and zipfile.Path
+  * new objects from LArray: Axis, Excel Workbook (what you get from
+    larray.open_excel()), Sheets and Range
+  * IODE "collections" objects: Comments, Equations, Identities, Lists, Tables,
+      Scalars and Variables, as well as Table objects
+  * Pandas: DataFrame, Series and DataFrameGroupBy
+  * Polars: DataFrame and LazyFrame
+  * Numpy: ndarray
+  * PyArrow: Array, Table, RecordBatchFileReader (reader object for feather
+    files) and ParquetFile
+  * Narwhals: DataFrame and LazyFrame
+  * PyTables: File, Group (with special support for Pandas DataFrames written
+    in HDF files), Array and Table
+  * IBIS: Table
+  * DuckDB: DuckDBPyConnection and DuckDBPyRelation (what you receive from any
+    query)
+
+  File types (extensions) currently supported:
+    - Iode files: .ac, .ae, .ai, .al, .as, .at, .av, .cmt, .eqs, .idt, .lst,
+                  .scl, .tbl, .var
+    - Text files: .bat, .c, .cfg, .cpp, .h, .htm, .html, .ini, .log, .md,
+                  .py, .pyx, .pxd, .rep, .rst, .sh, .sql, .toml, .txt, .wsgi,
+                  .yaml, .yml
+    - HDF5 files: .h5, .hdf
+    - Parquet files: .parquet
+    - Stata files: .dta
+    - Feather files: .feather
+    - SAS files: .sas7bdat
+      It is limited to the first few thousand rows (the exact number depends on
+      the number of columns), because reading later rows get increasingly slow,
+      to the point of being unusable.
+    - CSV files: .csv
+    - Gzipped CSV files: .csv.gz
+    - Excel files: .xls, .xlsx
+    - Zip files: .zip
+    - DuckDB files: .ddb, .duckdb
+
+* the editor now features a new "File Explorer" (accessible from the "File"
+  menu) so that one can more easily make use of all the above file viewers.
+
+* added a new SQL Console (next to the iPython console) for querying Polars
+  structures (DataFrame, LazyFrame and Series) as SQL tables. The console
+  features auto-completion for SQL keywords, table names and column names
+  and stores the last 1000 queries (even across sessions). Recalling a query
+  from history is done with the up and down arrows and like in the iPython
+  console, it searches through history with the current command as prefix.
+  This console will only be present if the polars module is installed.
+
+* allow sorting some objects by column by pressing on an horizontal label.
+  This is currently implemented for the following objects:
+    - python built-in sequences (e.g. tuples and lists)
+    - python pathlib.Path objects representing directories
+    - LArray (only for 2D arrays)
+    - Pandas DataFrame
+    - Polars DataFrame and LazyFrame
+    - Narwhals LazyFrame
+    - SQLite tables
+    - DuckDB relations
+
+* allow filtering some objects by pressing on an horizontal label.
+  This is currently implemented for the following objects:
+    - Pandas DataFrame
+    - Polars DataFrame and LazyFrame
+    - DuckDB relations
+
 * allow comparing arrays/sessions with different axes in :py:obj:`compare()`.
-  The function gained ``align`` and ``fill_value`` arguments and the interface has a new
-  combobox to change the alignment method during the comparison:
+  The function gained ``align`` and ``fill_value`` arguments and the interface
+  has a new combobox to change the alignment method during the comparison:
       - outer: will use a label if it is in any array (ordered like the first array).
                This is the default as it results in no information loss.
       - inner: will use a label if it is in all arrays (ordered like the first array).
@@ -28,28 +99,30 @@ New features
       - exact: raise an error when axes are not equal.
   Closes :editor_issue:`214` and :editor_issue:`251`.
 
-* double-clicking on an array name in the list will open it in a new window
+* double-clicking on a name in the variable list will open it in a new window
   (closes :editor_issue:`143`).
 
-  .. note::
-
-     - It works for foo bar !
-     - It does not work for foo baz !
-
 
 Miscellaneous improvements
 ^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-* made the editor interruptible by an outside program (i.e. made PyCharm stop & restart buttons work directly
-  instead of only when the editor receives the focus again). Closes :editor_issue:`257`.
+* made the editor interruptible by an outside program (i.e. made PyCharm stop &
+  restart buttons work directly instead of only when the editor receives the
+  focus again). Closes :editor_issue:`257`.
+
+* resize axes and vertical label columns automatically
 
-* when comparing sessions via :py:obj:`compare()`, the color of arrays in the list is now updated depending
-  on the tolerance. To reflect that the tolerance widget moved to the top of the interface.
-  Closes :editor_issue:`201`.
+* string values are left aligned instead of right aligned
 
-* typing the name of a variable holding a matplotlib figure (or axes) in the console shows it
-  (previously, only expressions were displayed and *not* simple variables).
-  For example: ::
+* when comparing sessions via :py:obj:`compare()`, the color of arrays in the
+  list is now updated depending on the tolerance. To reflect that the tolerance
+  widget moved to the top of the interface. Closes :editor_issue:`201`.
+
+* :py:obj:`compare()` max difference is colored red when the difference is not 0
+
+* typing the name of a variable holding a matplotlib figure (or axes) in the
+  console shows it (previously, only expressions were displayed and *not*
+  simple variables). For example: ::
 
      >>> arr.plot()
 
@@ -66,6 +139,10 @@ Miscellaneous improvements
 Fixes
 ^^^^^
 
-* fixed :py:obj:`compare()` colors when the only difference is nans on either side.
+* fixed :py:obj:`compare()` colors when the only difference is nans on either
+  side.
+
+* fixed :py:obj:`compare()` colors and max difference label when the only
+  differences are for rows where the value is 0 in the first array.
 
-* fixed something (closes :editor_issue:`1`).
+* fixed single column plot in viewer when ticks are not strings

larray_editor/api.py

@@ -159,7 +159,7 @@ def _get_title(obj, depth=0, maxnames=3):
 
 
 def create_edit_dialog(parent, obj=None, title='', minvalue=None, maxvalue=None, readonly=False, depth=0,
-                       display_caller_info=True, add_larray_functions=None):
+                       display_caller_info=True, add_larray_functions=None, **kwargs):
     """
     Open a new editor window.
 
@@ -198,7 +198,7 @@ def create_edit_dialog(parent, obj=None, title='', minvalue=None, maxvalue=None,
         return MappingEditorWindow(obj, title=title, readonly=readonly,
                                    caller_info=caller_info,
                                    add_larray_functions=add_larray_functions,
-                                   parent=parent)
+                                   parent=parent, **kwargs)
     else:
         return ArrayEditorWindow(obj, title=title, readonly=readonly,
                                  caller_info=caller_info,
@@ -212,11 +212,10 @@ def create_debug_dialog(parent, stack_summary, title='Debugger', stack_pos=None)
 
 
 def create_compare_dialog(parent, *args, title='', names=None, depth=0, display_caller_info=True, **kwargs):
-    caller_frame = sys._getframe(depth + 1)
-    if display_caller_info:
-        caller_info = getframeinfo(caller_frame)
-    else:
-        caller_info = None
+    if len(args) == 1 and isinstance(args[0], dict):
+        if names is None:
+            names = list(args[0].keys())
+        args = list(args[0].values())
 
     compare_sessions = any(isinstance(a, (la.Session, str, Path)) for a in args)
     default_name = 'session' if compare_sessions else 'array'
@@ -232,14 +231,21 @@ def get_name(i, obj, depth=0):
         # list comprehension used to create their own frame but are now
         # inlined in Python 3.12+
         extra_frame_for_comprehension = 0 if PY312 else 1
-        names = [get_name(i, a, depth=depth + 1 + extra_frame_for_comprehension) for i, a in enumerate(args)]
+        names = [get_name(i, a, depth=depth + 1 + extra_frame_for_comprehension)
+                 for i, a in enumerate(args)]
     else:
         assert isinstance(names, list) and len(names) == len(args)
 
     if compare_sessions:
         args = [la.Session(a) if not isinstance(a, la.Session) else a
                 for a in args]
 
+    if display_caller_info:
+        caller_frame = sys._getframe(depth + 1)
+        caller_info = getframeinfo(caller_frame)
+    else:
+        caller_info = None
+
     if compare_sessions:
         return SessionComparatorWindow(args, names=names, title=title,
                                        caller_info=caller_info, parent=parent,
@@ -381,7 +387,7 @@ def excepthook(type_, value, tback):
     return excepthook
 
 
-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, **kwargs):
     r"""
     Open a new editor window.
 
@@ -415,7 +421,7 @@ def edit(obj=None, title='', minvalue=None, maxvalue=None, readonly=False, depth
     >>> edit(a1)                                                                                       # doctest: +SKIP
     """
     _show_dialog("Viewer", create_edit_dialog, obj=obj, title=title, minvalue=minvalue, maxvalue=maxvalue,
-                 readonly=readonly, depth=depth + 1)
+                 readonly=readonly, depth=depth + 1, **kwargs)
 
 
 def view(obj=None, title='', depth=0):
@@ -470,8 +476,11 @@ def compare(*args, depth=0, **kwargs):
 
     Parameters
     ----------
-    *args : Arrays, Sessions, str or Path.
-        Arrays or sessions to compare. Strings or Path will be loaded as Sessions from the corresponding files.
+    *args : Arrays, Sessions, str or Path, or dict of them.
+        Arrays or sessions to compare. Strings or Path will be loaded as
+        Sessions from the corresponding files. If arrays or sessions are given
+        as a single dict, the keys of the dict will be used as names for the
+        arrays or sessions.
     title : str, optional
         Title for the window. Defaults to ''.
     names : list of str, optional