visidata 3.0.1__py3-none-any.whl → 3.1__py3-none-any.whl

visidata/rename_col.py

@@ -1,4 +1,4 @@
-from visidata import vd, Sheet
+from visidata import vd, VisiData, Sheet
 
 @Sheet.api
 def hint_rename_col(sheet):
@@ -6,6 +6,23 @@ def hint_rename_col(sheet):
         return 5, f"[:hint]The current column can't be used in an expression because [:code]{sheet.cursorCol.name}[/] is not a valid Python identifier. [:onclick rename-col]Rename the column[/] with `^`.[/]"
 
 
+@VisiData.api
+def addUndoColNames(vd, cols):
+    oldnames = [(c, c.name) for c in cols]
+    def _undo():
+        for c, name in oldnames:
+            c.name = name
+    vd.addUndo(_undo)
+
+
+@Sheet.api
+def updateColNames(sheet, rows, cols, overwrite=False):
+    vd.addUndoColNames(cols)
+    for c in cols:
+        if not c._name or overwrite:
+            c.name = "\n".join(c.getDisplayValue(r) for r in rows)
+
+
 Sheet.addCommand('^', 'rename-col', 'vd.addUndoColNames([cursorCol]); cursorCol.name = editCell(cursorVisibleColIndex, -1, value=cleanName(cursorCol.name))', 'rename current column')
 Sheet.addCommand('z^', 'rename-col-selected', 'updateColNames(selectedRows or [cursorRow], [sheet.cursorCol], overwrite=True)', 'rename current column to combined contents of current cell in selected rows (or current row)')
 Sheet.addCommand('g^', 'rename-cols-row', 'updateColNames(selectedRows or [cursorRow], sheet.visibleCols)', 'rename all unnamed visible columns to contents of selected rows (or current row)')

visidata/save.py

@@ -3,7 +3,7 @@ import os
 from copy import copy
 
 from visidata import vd
-from visidata import Sheet, BaseSheet, VisiData, IndexSheet, Path, Progress, TypedExceptionWrapper
+from visidata import Sheet, BaseSheet, VisiData, IndexSheet, Path, Progress, TypedExceptionWrapper, TypedWrapper, UNLOADED
 
 vd.option('safe_error', '#ERR', 'error string to use while saving', replay=True)
 vd.option('save_encoding', 'utf-8', 'encoding passed to codecs.open when saving a file', replay=True, help=vd.help_encoding)
@@ -13,12 +13,15 @@ def safe_trdict(vs):
     'returns string.translate dictionary for replacing tabs and newlines'
     if vs.options.safety_first:
         delim = vs.options.delimiter
-        return {
+        trdict = {
              0: '', #  strip NUL completely
-    ord(delim): vs.options.tsv_safe_tab, # \t
             10: vs.options.tsv_safe_newline,  # \n
             13: vs.options.tsv_safe_newline,  # \r
         }
+        if not delim or ord(delim) in trdict:
+            vd.fail(f'cannot use delimiter {repr(delim)} with safety_first')
+        trdict[ord(delim)] = vs.options.tsv_safe_tab # \t
+        return trdict
     return {}
 
 
@@ -29,12 +32,12 @@ def iterdispvals(sheet, *cols, format=False):
         cols = sheet.visibleCols
 
     transformers = collections.OrderedDict()  # list of transformers for each column in order
+    trdict = sheet.safe_trdict()
     for col in cols:
         transformers[col] = [ col.type ]
         if format:
             formatMaker = getattr(col, 'formatter_'+(col.formatter or sheet.options.disp_formatter))
             transformers[col].append(formatMaker(col._formatdict))
-        trdict = sheet.safe_trdict()
         if trdict:
             transformers[col].append(lambda v,trdict=trdict: v.translate(trdict))
 
@@ -46,7 +49,6 @@ def iterdispvals(sheet, *cols, format=False):
                 dispval = col.getValue(r)
 
             except Exception as e:
-                vd.exceptionCaught(e)
                 dispval = options_safe_error or str(e)
 
             try:
@@ -56,6 +58,9 @@ def iterdispvals(sheet, *cols, format=False):
                     elif isinstance(dispval, TypedExceptionWrapper):
                         dispval = options_safe_error or str(dispval)
                         break
+                    elif isinstance(dispval, TypedWrapper):
+                        dispval = ''
+                        break
                     else:
                         dispval = t(dispval)
 
@@ -89,7 +94,7 @@ def getDefaultSaveName(sheet):
 
 
 @VisiData.api
-def save_cols(vd, cols):
+def saveCols(vd, cols):
     sheet = cols[0].sheet
     vs = copy(sheet)
     vs.columns = list(cols)
@@ -109,8 +114,10 @@ def saveSheets(vd, givenpath, *vsheets, confirm_overwrite=True):
     if not vsheets: # blank tuple
         vd.warning('no sheets to save')
         return
+    unloaded = [ vs for vs in vsheets if vs.rows is UNLOADED ]
+    vd.sync(*vd.ensureLoaded(unloaded))
 
-    filetypes = [givenpath.ext, vd.options.save_filetype]
+    filetypes = [givenpath.ext.lower(), vd.options.save_filetype.lower()]
 
     vd.clearCaches()
 
@@ -203,8 +210,8 @@ BaseSheet.addCommand('', 'save-sheet-really', 'vd.saveSheets(Path(getDefaultSave
 BaseSheet.addCommand('', 'save-source', 'vd.saveSheets(rootSheet().source, rootSheet())', 'save root sheet to its source')
 BaseSheet.addCommand('g^S', 'save-all', 'vd.saveSheets(inputPath("save all sheets to: "), *vd.stackedSheets)', 'save all sheets to given file or directory)')
 IndexSheet.addCommand('g^S', 'save-selected', 'vd.saveSheets(inputPath("save %d sheets to: " % nSelectedRows, value="_".join(getattr(vs, "name", None) or "blank" for vs in selectedRows)), *selectedRows)', 'save all selected sheets to given file or directory')
-Sheet.addCommand('', 'save-col', 'save_cols([cursorCol])', 'save current column only to filename in format determined by extension (default .tsv)')
-Sheet.addCommand('', 'save-col-keys', 'save_cols(keyCols + [cursorCol])', 'save key columns and current column to filename in format determined by extension (default .tsv)')
+Sheet.addCommand('', 'save-col', 'saveCols([cursorCol])', 'save current column only to filename in format determined by extension (default .tsv)')
+Sheet.addCommand('', 'save-col-keys', 'saveCols(keyCols + [cursorCol])', 'save key columns and current column to filename in format determined by extension (default .tsv)')
 
 vd.addMenuItems('''
     File > Save > current sheet > save-sheet

visidata/search.py

@@ -91,10 +91,10 @@ def moveInputRegex(sheet, action:str, type="regex", **kwargs):
 
 @Sheet.api
 @asyncthread
-def search_expr(sheet, expr, reverse=False):
+def search_expr(sheet, expr, reverse=False, curcol=None):
     for i in rotateRange(len(sheet.rows), sheet.cursorRowIndex, reverse=reverse):
         try:
-            if sheet.evalExpr(expr, sheet.rows[i]):
+            if sheet.evalExpr(expr, sheet.rows[i], curcol=curcol):
                 sheet.cursorRowIndex=i
                 return
         except Exception as e:
@@ -111,8 +111,8 @@ Sheet.addCommand('N', 'searchr-next', 'vd.moveRegex(sheet, reverse=True)', 'go t
 
 Sheet.addCommand('g/', 'search-cols', 'moveInputRegex("g/", backward=False, columns="visibleCols")', 'search for regex forwards over all visible columns')
 Sheet.addCommand('g?', 'searchr-cols', 'moveInputRegex("g?", backward=True, columns="visibleCols")', 'search for regex backwards over all visible columns')
-Sheet.addCommand('z/', 'search-expr', 'search_expr(inputExpr("search by expr: ") or fail("no expr"))', 'search by Python expression forwards in current column (with column names as variables)')
-Sheet.addCommand('z?', 'searchr-expr', 'search_expr(inputExpr("searchr by expr: ") or fail("no expr"), reverse=True)', 'search by Python expression backwards in current column (with column names as variables)')
+Sheet.addCommand('z/', 'search-expr', 'search_expr(inputExpr("search by expr: ") or fail("no expr"), curcol=cursorCol)', 'search by Python expression forwards in current column (with column names as variables)')
+Sheet.addCommand('z?', 'searchr-expr', 'search_expr(inputExpr("searchr by expr: ") or fail("no expr"), curcol=cursorCol, reverse=True)', 'search by Python expression backwards in current column (with column names as variables)')
 
 vd.addMenuItems('''
     View > Search > current column > search-col

visidata/selection.py

@@ -1,5 +1,5 @@
 from copy import copy
-from visidata import vd, Sheet, Progress, asyncthread, options, rotateRange, Fanout, undoAttrCopyFunc, RowColorizer, GuideSheet
+from visidata import vd, Sheet, Progress, asyncthread, options, rotateRange, Fanout, undoAttrCopyFunc, RowColorizer
 
 vd.option('bulk_select_clear', False, 'clear selected rows before new bulk selections', replay=True)
 vd.option('some_selected_rows', False, 'if no rows selected, if True, someSelectedRows returns all rows; if False, fails')
@@ -13,54 +13,6 @@ Sheet.colorizers.append( RowColorizer(2, 'color_selected_row', lambda s,c,r,v:
     r is not None and s.isSelected(r))
 )
 
-class SelectionGuide(GuideSheet):
-    sheettype = Sheet
-    guide_text ='''# Selecting and filtering
-
-Some commands operate only on "selected rows".  For instance, a common command to filter is {help.commands.dup_selected}.
-
-Many g-prefixed commands are like this. For example, use {help.commands.edit_cell}, but use {help.commands.setcol_input}.  Search for "selected rows" in the [:onclick help-commands-all]commands list[/] or the [:onclick sysopen-help]manpage[/] for a full list.
-
-Rows on the **Frequency Table** or **Pivot Table** reference a group of rows from the source sheet.  Selecting a row on those sheets also selects the referenced rows on the underlying source sheet.
-
-Select and unselect rows with these commands:
-
-## One row at a time
-
-- {help.commands.select_row}
-- {help.commands.unselect_row}
-- {help.commands.stoggle_row}
-
-## All rows at the same time
-
-- {help.commands.select_rows}
-- {help.commands.unselect_rows}
-- {help.commands.stoggle_rows}
-
-## By matching patterns
-
-- {help.commands.select_col_regex}
-- {help.commands.unselect_col_regex}
-- {help.commands.select_cols_regex}
-- {help.commands.unselect_cols_regex}
-
-- {help.commands.select_equal_cell}
-- {help.commands.select_equal_row}
-
-## Select by Python expression
-
-Python expressions can use a column value by the column name, if the
-column name is a valid Python identifier (with only letters, digits, and underscores).
-
-- {help.commands.select_expr}
-- {help.commands.unselect_expr}
-
-## Options
-
-- {help.options.bulk_select_clear}
-- {help.options.some_selected_rows}
-'''
-
 @Sheet.api
 def isSelected(self, row):
     'Return True if *row* is selected.'
@@ -71,8 +23,10 @@ def isSelected(self, row):
 def toggle(self, rows):
     'Toggle selection of given *rows*.  Async.'
     self.addUndoSelection()
-    for r in Progress(rows, 'toggling', total=len(self.rows)):
-        if not self.unselectRow(r):
+    for r in Progress(rows, 'toggling', total=len(rows)):
+        if self.isSelected(r):  #1671
+            self.unselectRow(r)
+        else:
             self.selectRow(r)
 
 
@@ -87,7 +41,9 @@ def select_row(self, row):
 def toggle_row(self, row):
     'Toggle selection of given *row*.'
     self.addUndoSelection()
-    if not self.unselectRow(row):
+    if self.isSelected(row):
+        self.unselectRow(row)
+    else:
         self.selectRow(row)
 
 
@@ -240,8 +196,8 @@ Sheet.addCommand('g,', 'select-equal-row', 'select(gatherBy(lambda r,currow=curs
 Sheet.addCommand('z,', 'select-exact-cell', 'select(gatherBy(lambda r,c=cursorCol,v=cursorTypedValue: c.getTypedValue(r) == v), progress=False)', 'select rows matching current cell in current column')
 Sheet.addCommand('gz,', 'select-exact-row', 'select(gatherBy(lambda r,currow=cursorRow,vcols=visibleCols: all([c.getTypedValue(r) == c.getTypedValue(currow) for c in vcols])), progress=False)', 'select rows matching current row in all visible columns')
 
-Sheet.addCommand('z|', 'select-expr', 'expr=inputExpr("select by expr: "); select(gatherBy(lambda r, sheet=sheet, expr=expr: sheet.evalExpr(expr, r)), progress=False)', 'select rows matching Python expression in any visible column')
-Sheet.addCommand('z\\', 'unselect-expr', 'expr=inputExpr("unselect by expr: "); unselect(gatherBy(lambda r, sheet=sheet, expr=expr: sheet.evalExpr(expr, r)), progress=False)', 'unselect rows matching Python expression in any visible column')
+Sheet.addCommand('z|', 'select-expr', 'expr=inputExpr("select by expr: "); select(gatherBy(lambda r, sheet=sheet, expr=expr, curcol=cursorCol: sheet.evalExpr(expr, r, curcol=curcol)), progress=False)', 'select rows matching Python expression in any visible column')
+Sheet.addCommand('z\\', 'unselect-expr', 'expr=inputExpr("unselect by expr: "); unselect(gatherBy(lambda r, sheet=sheet, expr=expr, curcol=cursorCol: sheet.evalExpr(expr, r, curcol=curcol)), progress=False)', 'unselect rows matching Python expression in any visible column')
 
 Sheet.addCommand(None, 'select-error-col', 'select(gatherBy(lambda r,c=cursorCol: c.isError(r)), progress=False)', 'select rows with errors in current column')
 Sheet.addCommand(None, 'select-error', 'select(gatherBy(lambda r,vcols=visibleCols: isinstance(r, TypedExceptionWrapper) or any([c.isError(r) for c in vcols])), progress=False)', 'select rows with errors in any column')
@@ -266,5 +222,3 @@ vd.addMenuItems('''
     Row > Toggle select > from top > stoggle-before
     Row > Toggle select > to bottom > stoggle-after
 ''')
-
-vd.addGuide('SelectionGuide', SelectionGuide)

visidata/settings.py

@@ -84,7 +84,7 @@ class SettingsMgr(collections.OrderedDict):
         if d:
             for m in self._mappings(obj or vd.activeSheet):
                 v = d.get(self.objname(m))
-                if v:
+                if v is not None:
                     return v
 
     def iter(self, obj=None):
@@ -107,16 +107,17 @@ class SettingsMgr(collections.OrderedDict):
 
 
 class Command:
-    def __init__(self, longname, execstr, helpstr='', module='', deprecated=False):
+    def __init__(self, longname, execstr, helpstr='', module='', replay=True, deprecated=False):
         self.longname = longname
         self.execstr = execstr
         self.helpstr = helpstr
         self.module = module
         self.deprecated = deprecated
+        self.replayable = replay
 
 
 class Option:
-    def __init__(self, name, value, description='', module='', help='', max_help=10):
+    def __init__(self, name, value, description='', module='', help=''):
         # description gets shows on the manpage and the optionssheet; help is shown on the sidebar while editing
         self.name = name
         self.value = value
@@ -125,7 +126,6 @@ class Option:
         self.replayable = False
         self.sheettype = BaseSheet
         self.module = module
-        self.max_help = max_help
 
     def __str__(self):
         return str(self.value)
@@ -299,7 +299,7 @@ def _resolve_optalias(vd, optname, optval):
 
 
 @VisiData.api
-def option(vd, name, default, description, replay=False, sheettype=BaseSheet, help:str='', max_help=10):
+def option(vd, name, default, description, replay=False, sheettype=BaseSheet, help:str=''):
     '''Declare a new option.
 
    - `name`: name of option
@@ -312,7 +312,6 @@ def option(vd, name, default, description, replay=False, sheettype=BaseSheet, he
     opt.replayable = replay
     opt.sheettype=sheettype
     opt.extrahelp = help
-    opt.max_help = max_help
     return opt
 
 
@@ -320,12 +319,12 @@ def option(vd, name, default, description, replay=False, sheettype=BaseSheet, he
 def theme_option(vd, name, *args, **kwargs):
     if name.startswith('color_'):
         kwargs.setdefault('help', vd.help_color)
-    return vd.option(name, *args, **kwargs, max_help=-1)
+    return vd.option(name, *args, **kwargs)
 
 
 @BaseSheet.class_api
 @classmethod
-def addCommand(cls, keystrokes, longname, execstr, helpstr='', **kwargs):
+def addCommand(cls, keystrokes, longname, execstr, helpstr='', replay=True, **kwargs):
     '''Add a new command to *cls* sheet type.
 
     - *keystrokes*: default keybinding, including **prefixes**.
@@ -333,9 +332,10 @@ def addCommand(cls, keystrokes, longname, execstr, helpstr='', **kwargs):
     - *execstr*: Python statement to pass to `exec()`'ed when the command is executed.
     - *helpstr*: help string shown in the **Commands Sheet**.
     '''
-    vd.commands.set(longname, Command(longname, execstr, helpstr=helpstr, module=vd.importingModule, **kwargs), cls)
+    cmd = Command(longname, execstr, helpstr=helpstr, module=vd.importingModule, replay=replay, **kwargs)
+    vd.commands.set(longname, cmd, cls)
     if keystrokes:
-        vd.bindkeys.set(vd.prettykeys(keystrokes.replace(' ', '')), longname, cls)
+        vd.bindkey(keystrokes, longname, cls)
     return longname
 
 def _command(cls, binding, longname, helpstr, **kwargs):
@@ -346,12 +346,19 @@ def _command(cls, binding, longname, helpstr, **kwargs):
     return decorator
 
 BaseSheet.command = classmethod(_command)
-globalCommand = BaseSheet.addCommand
+globalCommand = BaseSheet.addCommand   # to be deprecated
+
+
+@VisiData.api
+def bindkey(vd, keystrokes, longname, obj='BaseSheet'):
+    'Bind *keystrokes* to *longname* on BaseSheet and unbind more-specific bindings of keystrokes.'
+    vd.bindkeys.set(vd.prettykeys(keystrokes.replace(' ', '')), longname, obj)
 
 @VisiData.api
-def bindkey(vd, keystrokes, longname):
+def unbindkey(vd, keystrokes, obj='BaseSheet'):
     'Bind *keystrokes* to *longname* on BaseSheet and unbind more-specific bindings of keystrokes.'
-    vd.bindkeys[vd.prettykeys(keystrokes)] = {'BaseSheet': longname}
+    vd.bindkeys.unset(vd.prettykeys(keystrokes.replace(' ', '')), obj)
+
 
 @BaseSheet.class_api
 @classmethod
@@ -360,14 +367,14 @@ def bindkey(cls, keystrokes, longname):
     oldlongname = vd.bindkeys._get(keystrokes, cls)
     if oldlongname:
         vd.warning('%s was already bound to %s' % (keystrokes, oldlongname))
-    vd.bindkeys.set(vd.prettykeys(keystrokes), longname, cls)
+    vd.bindkey(keystrokes, longname, cls)
 
 @BaseSheet.class_api
 @classmethod
 def unbindkey(cls, keystrokes):
     '''Unbind `keystrokes` on a `<SheetType>`.
     May be necessary to avoid a warning when overriding a binding on the same exact class.'''
-    vd.bindkeys.unset(vd.prettykeys(keystrokes), cls)
+    vd.unbindkey(keystrokes, cls)
 
 @BaseSheet.api
 def getCommand(sheet, cmd):
@@ -376,29 +383,32 @@ def getCommand(sheet, cmd):
         return cmd
 
     longname = cmd
-    while vd.bindkeys._get(longname, obj=sheet):
+    while vd.bindkeys._get(longname, obj=sheet) is not None:
         longname = vd.bindkeys._get(longname, obj=sheet)
 
     return vd.commands._get(longname, obj=sheet)
 
 
 @VisiData.api
-def loadConfigFile(vd, fn='', _globals=None):
+def loadConfigFile(vd, fn=''):
     p = visidata.Path(fn or vd.options.config)
-    if _globals is None:
-        _globals = vd.getGlobals()
     if p.exists():
+        newdefs = {}
         try:
             with open(p) as fd:
                 code = compile(fd.read(), str(p), 'exec')
             vd.importingModule = 'visidatarc'
-            exec(code, _globals)
+            exec(code, vd.getGlobals(), newdefs)
         except Exception as e:
             vd.exceptionCaught(e)
         finally:
             vd.importingModule = None
 
-    vd.addGlobals(_globals)
+        keys = newdefs.get('__all__', None)
+        if keys:
+            vd.addGlobals({k:newdefs[k] for k in keys})
+        else:
+            vd.addGlobals(newdefs)
 
 
 def addOptions(parser):
@@ -470,17 +480,21 @@ def loadConfigAndPlugins(vd, args=AttrDict()):
 
     # user customisations in config file in standard location
     if vd.options.config:
-        vd.loadConfigFile(vd.options.config, vd.getGlobals())
+        vd.loadConfigFile(vd.options.config)
 
 
 @VisiData.api
-def importModule(vd, pkgname):
+def importModule(vd, pkgname, symbols=[]):
     'Import the given *pkgname*, setting vd.importingModule to *pkgname* before import and resetting to None after.'
     modparts = pkgname.split('.')
     vd.importingModule = modparts[-1]
     r = importlib.import_module(pkgname)
     vd.importingModule = None
     vd.importedModules.append(r)
+    vd.addGlobals({pkgname:r})
+    if symbols:
+        vd.addGlobals({k:getattr(r, k) for k in symbols if hasattr(r, k)})
+
     return r
 
 
@@ -488,24 +502,12 @@ def importModule(vd, pkgname):
 def importSubmodules(vd, pkgname):
     'Import all files below the given *pkgname*'
     import pkgutil
-    import os.path
 
     m = vd.importModule(pkgname)
     for module in pkgutil.walk_packages(m.__path__):
         vd.importModule(pkgname + '.' + module.name)
 
 
-@VisiData.api
-def importStar(vd, pkgname):
-    'Add all symbols from *pkgname* into visidata globals.'
-    import pkgutil
-    import os.path
-
-    m = vd.importModule(pkgname)
-    vd.addGlobals({pkgname:m})
-    vd.addGlobals(m.__dict__)
-
-
 @VisiData.api
 def importExternal(vd, modname, pipmodname=''):
     pipmodname = pipmodname or modname