Merge pull request #1112 from saulpw/develop

v2.6

Author: saulpw

.gitignore

@@ -11,3 +11,5 @@ visidata.egg-info/
 *_build
 tags
 /tests/log/
+# Mac files
+.DS_Store

CHANGELOG.md

@@ -1,5 +1,66 @@
 # VisiData version history
 
+# 2.6 (2021-09-19)
+
+## Major feature
+
+- [menu] new hierarchical menu system
+    - `Alt+F`, `Alt+E`, etc to open submenus (`Alt+` underlined capital letter in toplevel menu)
+    - `Ctrl+H` to activate Help menu (manpage now at `gCtrl+H`)
+    - `q` or `Esc` to exit menu
+    - Enter to expand submenu item or execute command
+    - or left mouse click to activate and navigate menu
+    - only show commands available on current sheet
+    - sheet-specific commands highlighted with `options.color_menu_spec`
+    - new options:
+      - `disp_menu`: display menu if inactive (default True).  Can still activate menu with Ctrl+H/Alt+F
+      - `disp_menu_keys`: whether to display shortcuts inline (default True)
+      - `disp_menu_fmt`: upper right display on menu bar (like `disp_status_fmt`/`disp_rstatus_fmt`)
+      - theme colors: `color_menu` `color_menu_active` `color_menu_spec` `color_menu_help`
+      - theme chars: `disp_menu_boxchars` `disp_menu_more` `disp_menu_push` `disp_menu_input` `disp_menu_fmt`
+
+## Interface changes
+
+- [expand-col] only expand to one level
+- [slide] remove slide row/col with mouse
+- [macos] add bindings for Option+key to Alt+key
+- [modified] limit use of sheet protection (thanks @geekscrapy #1037)
+- [python] rebind g^X to new import-python command (what exec-python was mostly used for)
+- [npy] add `npy_allow_pickle` option (default False)
+- [join] rename join-sheets on IndexSheet to join-selected; bind both g& and & to join-selected
+- [loaders pandas] add error message for unpickling non-dataframes
+- [join] fail if no key columns on any sheet (thanks @geekscrapy #1061)
+- [loaders xlsx] enable access to cell metadata (thanks @hoclun-rigsep #1088)
+- many performance, progress bar, and UI responsiveness improvements
+
+## Bugfixes
+
+- [cli] issue warning if +sheet-position not found (thanks @geekscrapy #1046)
+- [clipboard] do not copy newline for syscopy-cell (thanks @geekscrapy #1064)
+- [column] detect existing column by row key instead of column name (thanks @geekscrapy #1058)
+- [color] set `color_current_row` to the same precedence as `color_current_column` (thanks @frosenrantz #1100)
+- [command] do not fail/abort on unknown command
+- [draw] Sort indicator on top of More indicator (thanks @geekscrapy #1071)
+- [join] fix multiple extend (thanks @cwarden)
+- [join] allow extended columns to be modified (thanks @cwarden)
+- [join] fix for rowdefs without bool (like pandas)
+- [loaders dirsheet] continue after exception in copyfile
+- [loaders fixed] fix fixed-format saver
+- [loaders fixed] save uses `global options.encoding` (thanks @geekscrapy #1060)
+- [loaders mysql] do not stop loading on first error (thanks @SuRaMoN #1085)
+- [loaders pandas] fix column rename
+- [loaders sqlite] save based on column names, not position
+- [loaders sqlite] allow changing value of cells that were NULL (thanks @mattenklicker #1052)
+- [loaders sqlite] add message on not currently supporting WITHOUT ROWID (thanks @stephancb #1111)
+- [multisave] fix breaking typo
+- [open_txt] load new blank sheet for 0 byte files (thanks @geekscrapy #1047)
+- [save] do not set a default for `options.save_filetype` (thanks @frosencrantz #1072)
+- [split-pane mouse] activate pane on click (thanks @frosencrantz #954)
+- [unfurl] handle unfurling exceptions (close #1053)
+- [quitguard] confirm quit when set on a specific sheet even if not precious or modified
+- [yaml] Fix yaml loader traces on no attribute `_colnames` (thanks @frosencrantz #1104)
+- [visidatarc] catch all visidatarc exceptions upon load
+
 # v2.5 (2021-07-08)
 
 - [social] #visidata has moved off of freenode to libera.chat

CODE_OF_CONDUCT.md

@@ -1 +1 @@
-don't be a dick
+Please don't be a dick ♥

README.md

@@ -1,5 +1,5 @@
 
-# VisiData v2.5 [![twitter @VisiData][1.1]][1] [![CircleCI](https://circleci.com/gh/saulpw/visidata/tree/stable.svg?style=svg)](https://circleci.com/gh/saulpw/visidata/tree/stable) [![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/saulpw/visidata)
+# VisiData v2.6 [![twitter @VisiData][1.1]][1] [![CircleCI](https://circleci.com/gh/saulpw/visidata/tree/stable.svg?style=svg)](https://circleci.com/gh/saulpw/visidata/tree/stable) [![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/saulpw/visidata)
 
 A terminal interface for exploring and arranging tabular data.
 

bin/viewtsv.py

@@ -5,8 +5,8 @@
 
 from visidata import Sheet, ColumnItem, asyncthread, options
 
-
-def open_tsv(p):
+@VisiData.api
+def open_tsv(vd, p):
     return MinimalTsvSheet(p.name, source=p)
 
 

dev/ROADMAP

@@ -5,7 +5,7 @@
   - [options] option enums
   - [options] user-defined option aliases
   - [splitpane] File preview in directory view
-  - [defermods] 'modified since last save' indicator on status bar
+  + [defermods] 'modified since last save' indicator on status bar
   - [scroll cell] zh/zl Left hand side of a cell with content hidden doesn't show ellipsis #751
 
 2. Persistence

dev/api.md

@@ -79,14 +79,14 @@ must come before ``@classmethod``.
 
 This acts just like the ``@property`` decorator, if it were defined inline to the class.
 
-.. autofunction:: visidata.Extensible.cached_property
+.. autofunction:: visidata.Extensible.lazy_property
 
 This works like ``@property``, except it only computes the value on first access, and then caches it for every subsequent usage.
 
 .. note::
 
     Because of how Python instantiates classes, extensions monkey-patched into a class are not also added to already-instantiated objects.
-    So global sheets defined by a plugin should be added to the VisiData object with ``cached_property``.
+    So global sheets defined by a plugin should be added to the VisiData object as a ``@VisiData.lazy_property``.
     This way, they are not created until their first use, which allows them to take advantage of Sheet extensions that were loaded after the plugin.
 
 
@@ -123,13 +123,26 @@ If *copy* is ``True``, then a copy is made of the member for the new instance.
 
 .. autofunction:: visidata.vd.global_api
 
-When a function is defined in a .py module in visidata, it is available as a global function in that module.
+All features (and plugins) should expose functions and classes to plugins in one of these ways:
 
-VisiData does an effective ``from X import *`` for each plugin and modular feature, so that its package (or global) scope gets all of the exposed symbols.  See :ref:`getGlobals() and addGlobals() <other-commands>`.
+1. with `@VisiData.api` (or @Sheet.api): for most methods
 
-Everything in a .py module is exported automatically, unless there is an ``__all__`` with a list of the names of the functions that should be exported, and it will export only those.
+These can be used in an execstr as though they were global (attributes on `vd` and `sheet` are both implicitly in scope in an execstr).
 
-Each VisiData feature and plugin should include an ``__all__``, either empty or with an explicit list of function names to be available to :ref:`commands <commands>` and `Expressions <>`__.
+Outside of an execstr, use `vd.funcname(...)` (or `sheet.funcname(...)`).
+
+Note that classes can be annotated with `@VisiData.api` also.
+
+2. with `addGlobals({"funcname": funcname})`: for classes and methods internal to VisiData
+
+These can be used via direct import:
+
+`from visidata import SomeInternalClass`
+`from plugins.myplugin import HelperClass`
+
+This is acceptable for commonly-used classes.
+
+See :ref:`getGlobals() and addGlobals() <other-commands>`.
 
 What to extend: ``Sheet``, ``Column``, ``VisiData``, or globals?
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

docs/api/extensible.rst

@@ -151,3 +151,34 @@ Examples
             # colors cells
             CellColorizer(3, None, lambda s,c,r,v: v.value if r and c in s.columns[1:3] and r.name.startswith('color_') else None)
         ]
+
+Menu System
+===========
+
+Features and plugins can add commands to the hierarchical menu system (new in v2.6).
+
+.. autofunction:: visidata.vd.runMenu
+.. autofunction:: visidata.vd.addMenu
+.. autofunction:: visidata.vd.addMenuItem
+
+.. autoclass:: visidata.Menu
+.. data:: visidata.vd.menus
+
+`vd.menus` contains the hierarchical list all Menu() objects, for exploration.
+
+Examples
+^^^^^^^^
+
+::
+
+    # add a single command to an existing menusubmenu with multiple commands
+    vd.addMenuItem('Column', 'Add column', 'enhance', 'enhance-col')
+
+    # add a submenu with multiple commands
+    vd.addMenu(Menu('Data', Menu('Enhance',
+        Menu('this column', 'enhance-col'),
+        Menu('all columns', 'enhance-cols'),
+    )))
+
+    # activate menu and navigate to Data»Enhance
+    vd.runMenu('Data', 'Enhance')

docs/api/interface.rst

@@ -239,7 +239,8 @@ This is a completely functional loader for the ``sas7bdat`` (SAS dataset file) f
 
     from visidata import Sheet, ItemColumn, Progress
 
-    def open_sas7bdat(p):
+    @VisiData.api
+    def open_sas7bdat(vd, p):
         return SasSheet(p.name, source=p)
 
     class SasSheet(Sheet):