|
3 | 3 | New features |
4 | 4 | ^^^^^^^^^^^^ |
5 | 5 |
|
6 | | -* allow displaying *many* more different kinds of objects, and not only arrays |
7 | | - from larray. One specific goal when developing this new feature was speed. |
| 6 | +* allow displaying **many** more different kinds of objects, and not only arrays |
| 7 | + from LArray. One specific goal when developing this new feature was speed. |
8 | 8 | Most of these viewers should be fast (when at all possible), even on (very) |
9 | 9 | large datasets. We only support displaying (not editing) all the new types. |
10 | 10 |
|
11 | 11 | The following types are supported so far (but adding more is relatively easy): |
12 | 12 |
|
13 | | - * Python builtin objects: |
14 | | - - tuple (including named tuple), list (sequences), dict (mappings), |
15 | | - dict views, memoryview and array |
| 13 | + * Python **builtin** objects: |
| 14 | + |
| 15 | + - ``tuple`` (including named tuple), ``list`` (sequences), ``dict`` |
| 16 | + (mappings), dict views, ``memoryview`` and ``array`` |
16 | 17 | - text and binary files |
17 | | - * Python stdlib objects: |
18 | | - - pathlib.Path |
| 18 | + |
| 19 | + * Python **standard library** objects: |
| 20 | + |
| 21 | + - ``pathlib.Path`` |
| 22 | + |
19 | 23 | * if the path points to a directory, it will display the content of the |
20 | 24 | directory |
21 | 25 | * if the path points to a file, it will try to display it, if we |
22 | 26 | implemented support for that file type (see below for the list |
23 | 27 | of supported types). |
24 | | - - sqlite3.Connection (and their tables) |
25 | | - - pstats.Stats (results of Python's profiler) |
26 | | - - zipfile.ZipFile and zipfile.Path |
27 | | - * new objects from LArray: Axis, Excel Workbook (what you get from |
28 | | - larray.open_excel()), Sheets and Range |
29 | | - * IODE "collections" objects: Comments, Equations, Identities, Lists, Tables, |
30 | | - Scalars and Variables, as well as Table objects |
31 | | - * Pandas: DataFrame, Series and DataFrameGroupBy |
32 | | - * Polars: DataFrame and LazyFrame |
33 | | - * Numpy: ndarray |
34 | | - * PyArrow: Array, Table, RecordBatchFileReader (reader object for feather |
35 | | - files) and ParquetFile |
36 | | - * Narwhals: DataFrame and LazyFrame |
37 | | - * PyTables: File, Group (with special support for Pandas DataFrames written |
38 | | - in HDF files), Array and Table |
39 | | - * IBIS: Table |
40 | | - * DuckDB: DuckDBPyConnection and DuckDBPyRelation (what you receive from any |
41 | | - query) |
42 | | -
|
43 | | - File types (extensions) currently supported: |
44 | | - - Iode files: .ac, .ae, .ai, .al, .as, .at, .av, .cmt, .eqs, .idt, .lst, |
45 | | - .scl, .tbl, .var |
46 | | - - Text files: .bat, .c, .cfg, .cpp, .h, .htm, .html, .ini, .log, .md, |
47 | | - .py, .pyx, .pxd, .rep, .rst, .sh, .sql, .toml, .txt, .wsgi, |
48 | | - .yaml, .yml |
49 | | - - HDF5 files: .h5, .hdf |
50 | | - - Parquet files: .parquet |
51 | | - - Stata files: .dta |
52 | | - - Feather files: .feather |
53 | | - - SAS files: .sas7bdat |
54 | | - It is limited to the first few thousand rows (the exact number depends on |
55 | | - the number of columns), because reading later rows get increasingly slow, |
56 | | - to the point of being unusable. |
57 | | - - CSV files: .csv |
58 | | - - Gzipped CSV files: .csv.gz |
59 | | - - Excel files: .xls, .xlsx |
60 | | - - Zip files: .zip |
61 | | - - DuckDB files: .ddb, .duckdb |
62 | | -
|
63 | | -* the editor now features a new "File Explorer" (accessible from the "File" |
| 28 | + - ``sqlite3.Connection`` (and their tables) |
| 29 | + - ``pstats.Stats`` (results of Python's profiler) |
| 30 | + - ``zipfile.ZipFile`` and ``zipfile.Path`` |
| 31 | +
|
| 32 | + * new objects from **LArray**: ``Axis``, Excel ``Workbook`` (what you get from |
| 33 | + larray.open_excel()), ``Sheet`` and ``Range`` |
| 34 | + * **IODE** "collections" objects: ``Comments``, ``Equations``, ``Identities``, |
| 35 | + ``Lists``, ``Tables``, ``Scalars`` and ``Variables``, as well as ``Table`` |
| 36 | + objects |
| 37 | + * **Pandas** objects: ``DataFrame``, ``Series`` and ``DataFrameGroupBy`` |
| 38 | + * **Polars** objects: ``DataFrame`` and ``LazyFrame`` |
| 39 | + * **Numpy** objects: ``ndarray`` |
| 40 | + * **PyArrow** objects: ``Array``, ``Table``, ``RecordBatchFileReader`` |
| 41 | + (reader object for feather files) and ``ParquetFile`` |
| 42 | + * **Narwhals** objects: ``DataFrame`` and ``LazyFrame`` |
| 43 | + * **PyTables** objects: ``File``, ``Group`` (with special support for Pandas |
| 44 | + DataFrames written in HDF files), ``Array`` and ``Table`` |
| 45 | + * **IBIS** objects: ``Table`` |
| 46 | + * **DuckDB** objects: ``DuckDBPyConnection`` and ``DuckDBPyRelation`` (what |
| 47 | + you receive from any query) |
| 48 | +
|
| 49 | +File types (extensions) currently supported: |
| 50 | +
|
| 51 | + - **IODE** files: .ac, .ae, .ai, .al, .as, .at, .av, .cmt, .eqs, .idt, .lst, |
| 52 | + .scl, .tbl, .var |
| 53 | + - **Text** files: .bat, .c, .cfg, .cpp, .h, .htm, .html, .ini, .log, .md, |
| 54 | + .py, .pyx, .pxd, .rep, .rst, .sh, .sql, .toml, .txt, .wsgi, .yaml, .yml |
| 55 | + - **HDF5** files: .h5, .hdf |
| 56 | + - **Parquet** files: .parquet |
| 57 | + - **Stata** files: .dta |
| 58 | + - **Feather** files: .feather |
| 59 | + - **SAS** files: .sas7bdat |
| 60 | + It is limited to the first few thousand rows (the exact number depends on |
| 61 | + the number of columns), because reading later rows get increasingly slow, |
| 62 | + to the point of being unusable. |
| 63 | + - **CSV** files: .csv |
| 64 | + - Gzipped CSV files: .csv.gz |
| 65 | + - **Excel** files: .xls, .xlsx |
| 66 | + - **Zip** files: .zip |
| 67 | + - **DuckDB** files: .ddb, .duckdb |
| 68 | +
|
| 69 | +* the editor now features a new "**File Explorer**" (accessible from the "File" |
64 | 70 | menu) so that one can more easily make use of all the above file viewers. |
65 | 71 |
|
66 | | -* added a new SQL Console (next to the iPython console) for querying Polars |
| 72 | +* added a new **SQL Console** (next to the iPython console) for querying Polars |
67 | 73 | structures (DataFrame, LazyFrame and Series) as SQL tables. The console |
68 | 74 | features auto-completion for SQL keywords, table names and column names |
69 | 75 | and stores the last 1000 queries (even across sessions). Recalling a query |
70 | 76 | from history is done with the up and down arrows and like in the iPython |
71 | 77 | console, it searches through history with the current command as prefix. |
72 | 78 | This console will only be present if the polars module is installed. |
73 | 79 |
|
74 | | -* allow sorting some objects by column by pressing on an horizontal label. |
| 80 | +* allow **sorting** some objects by column by pressing on an horizontal label. |
75 | 81 | This is currently implemented for the following objects: |
| 82 | +
|
76 | 83 | - python built-in sequences (e.g. tuples and lists) |
77 | 84 | - python pathlib.Path objects representing directories |
78 | 85 | - LArray (only for 2D arrays) |
79 | | - - Pandas DataFrame |
80 | | - - Polars DataFrame and LazyFrame |
81 | | - - Narwhals LazyFrame |
| 86 | + - Pandas ``DataFrame`` |
| 87 | + - Polars ``DataFrame and ``LazyFrame`` |
| 88 | + - Narwhals ``LazyFrame`` |
82 | 89 | - SQLite tables |
83 | 90 | - DuckDB relations |
84 | 91 |
|
85 | | -* allow filtering some objects by pressing on an horizontal label. |
| 92 | +* allow **filtering** some objects by pressing on an horizontal label. |
86 | 93 | This is currently implemented for the following objects: |
87 | | - - Pandas DataFrame |
88 | | - - Polars DataFrame and LazyFrame |
| 94 | +
|
| 95 | + - Pandas ``DataFrame`` |
| 96 | + - Polars ``DataFrame`` and ``LazyFrame`` |
89 | 97 | - DuckDB relations |
90 | 98 |
|
91 | 99 | * allow comparing arrays/sessions with different axes in :py:obj:`compare()`. |
92 | 100 | The function gained ``align`` and ``fill_value`` arguments and the interface |
93 | 101 | has a new combobox to change the alignment method during the comparison: |
94 | | - - outer: will use a label if it is in any array (ordered like the first array). |
95 | | - This is the default as it results in no information loss. |
96 | | - - inner: will use a label if it is in all arrays (ordered like the first array). |
97 | | - - left: will use the first array axis labels. |
98 | | - - right: will use the last array axis labels. |
99 | | - - exact: raise an error when axes are not equal. |
| 102 | +
|
| 103 | + - *outer*: will use a label if it is in any array (ordered like the first array). |
| 104 | + This is the default as it results in no information loss. |
| 105 | + - *inner*: will use a label if it is in all arrays (ordered like the first array). |
| 106 | + - *left*: will use the first array axis labels. |
| 107 | + - *right*: will use the last array axis labels. |
| 108 | + - *exact*: raise an error when axes are not equal. |
| 109 | +
|
100 | 110 | Closes :editor_issue:`214` and :editor_issue:`251`. |
101 | 111 |
|
102 | 112 | * double-clicking on a name in the variable list will open it in a new window |
|
0 commit comments