Impl. user config and asst. command fixes (#34)

Author: ChanceNCounter

MANIFEST.in

@@ -0,0 +1 @@
+include bak/default.cfg

bak/__main__.py

@@ -1,10 +1,12 @@
 import os
 from datetime import datetime
+from shutil import copy2
 
 import click
 from click_default_group import DefaultGroup
+import config
 
-from . import commands
+from bak import commands
 
 
 def __print_help():
@@ -43,13 +45,20 @@ def bak_up(filename):
 
 
 @bak.command("down", help="Restore from a .bakfile (.bakfiles deleted without '--keep')")
-@click.option("--keep", "-k", is_flag=True, default=False, help="Keep .bakfiles")
+@click.option("--keep", "-k",
+              is_flag=True,
+              default=False,
+              help="Keep .bakfiles")
+@click.option("--quietly", "-q",
+              is_flag=True,
+              default=False,
+              help="No confirmation prompt")
 @click.argument("filename", required=True, type=click.Path(exists=True))
-def bak_down(filename, keep):
+def bak_down(filename, keep, quietly):
     if not filename:
         click.echo("A filename or operation is required.\n"
                    "\tbak --help")
-    commands.bak_down_cmd(filename, keep)
+    commands.bak_down_cmd(filename, keep, quietly)
 
 
 @bak.command("off", help="Use when finished to delete .bakfiles")

bak/commands/__init__.py

@@ -9,6 +9,7 @@
 from warnings import warn
 
 import click
+from config import Config
 
 from bak.data import bakfile, bak_db
 
@@ -22,8 +23,14 @@
     config_dir = os.environ["XDG_CONFIG_HOME"]
 except KeyError:
     config_dir = os.path.expanduser("~/.config")
-bak_dir = os.path.join(data_dir, "bak", "bakfiles")
-bak_db_loc = os.path.join(data_dir, "bak", "bak.db")
+
+config_file = os.path.join(config_dir, 'bak.cfg')
+cfg = Config(config_file)
+
+bak_dir = cfg['bakfile_location'] or os.path.join(data_dir,
+                                                  "bak", "bakfiles")
+bak_db_loc = cfg['bak_database_location'] or \
+    os.path.join(data_dir, "bak", "bak.db")
 
 if not os.path.exists(bak_dir):
     os.makedirs(bak_dir)
@@ -38,14 +45,14 @@ def expandpath(i_path):
 def _assemble_bakfile(filename):
     time_now = datetime.now()
     splitname = os.path.split(expandpath(filename))
-    bakfile_name = "".join([".".join(i[1:].replace("/", "-") for i in splitname[:-1]) +
+    bakfile_name = "".join([".".join(i[1:].replace("/", "-")
+                                     for i in splitname[:-1]) +
                             '-' +
-                            splitname[-1],  # [os.path.split(filename)[-1],
+                            splitname[-1],
                             ".",
                             '-'.join(str(
                                 time_now.timestamp()).split('.')),
                             ".bak"]).replace(" ", "-")
-    # TODO #26 get bakfile directory from config
     bakfile_path = os.path.join(bak_dir, bakfile_name)
 
     new_bak_entry = bakfile.BakFile(os.path.basename(filename),
@@ -56,53 +63,71 @@ def _assemble_bakfile(filename):
     return new_bak_entry
 
 
-default_select_prompt = ("Enter a number, or: (V)iew (C)ancel", 'c')
+default_select_prompt = ("Enter a number, or: (V)iew (D)iff (C)ancel", 'c')
 
 
-def _get_bakfile_entry(filename, select_prompt=default_select_prompt, err=False):
+def _get_bakfile_entry(filename,
+                       select_prompt=default_select_prompt,
+                       err=False):
     entries = db_handler.get_bakfile_entries(expandpath(filename))
     if not entries or len(entries) == 0:
         return None
-    return entries[0] if len(entries) == 1 else _do_select_bakfile(entries, select_prompt, err)
+    # If there's only one bakfile corresponding to filename, return that.
+    # If there's more than one, disambiguate.
+    return entries[0] if len(entries) == 1 else \
+        _do_select_bakfile(entries, select_prompt, err)
 
 
 def _do_select_bakfile(bakfiles: List[bakfile.BakFile],
                        select_prompt=default_select_prompt,
                        err=False):
     click.echo(
-        f"Found {len(bakfiles)} bakfiles for file: {bakfiles[0].orig_abspath}", err=err)
+        f"Found {len(bakfiles)} bakfiles for file: {bakfiles[0].orig_abspath}",
+        err=err)
     click.echo("Please select from the following: ", err=err)
     _range = range(len(bakfiles))
     for i in _range:
         click.echo(
-            f"{i + 1}: .bakfile last modified at {bakfiles[i].date_modified}", err=err)
-    choice = click.prompt(*select_prompt, err=err)
-    # TODO add diff and print as choices here
-    # "Enter a number, or: (V)iew (C)ancel", default='c').lower()
-    if choice != "c":
-        view = False
-        try:
-            if choice == "v":
-                idx = int(click.prompt("View which .bakfile?", err=err)) - 1
-                # idx = int(click.prompt("View which .bakfile? (#)")) - 1
-                view = True
-            else:
-                idx = int(choice) - 1
-            if idx not in _range:
-                click.echo("Invalid selection. Aborting.", err=err)
-                return None
-            else:
-                if view:
-                    bak_print_cmd(bakfiles[idx])
-                    return
-                return bakfiles[idx]
-        except (ValueError, TypeError) as e:
-            warn(e)
-            click.echo("Invalid input. Aborting.", err=err)
+            f"{i + 1}: .bakfile last modified at {bakfiles[i].date_modified}",
+            err=err)
+
+    def get_choice():
+        return click.prompt(*select_prompt, err=err).lower()
+    choice = get_choice()
+
+    while True:
+        if choice == "c":
+            click.echo("Cancelled.", err=err)
             return None
-    else:
-        click.echo("Aborting.", err=err)
-        return None
+        else:
+            view = False
+            try:
+                if choice == "v":
+                    idx = int(click.prompt(
+                        "View which .bakfile?", err=err)) - 1
+                    view = True
+                elif choice == "d":
+                    idx = int(click.prompt(
+                        "Diff which .bakfile?", err=err)) - 1
+                    bak_diff_cmd(bakfiles[idx])
+                    choice = get_choice()
+                    continue
+                else:
+                    idx = int(choice) - 1
+                if idx not in _range:
+                    click.echo("Invalid selection. Aborting.", err=err)
+                    return None
+                elif view:
+                    bak_print_cmd(bakfiles[idx])
+                    choice = get_choice()
+                    continue
+                else:
+                    return bakfiles[idx]
+            except (ValueError, TypeError) as e:
+                warn(e)
+                click.echo("Invalid input. Aborting.", err=err)
+                return None
+            get_choice()
 
 
 def show_bak_list(filename: (None, str, os.path) = None):
@@ -140,7 +165,9 @@ def bak_up_cmd(filename: str):
         filename (str|os.path)
     """
     # Return Truthy things for failures that echo their own output,
-    # false for nonspecific or generic failures
+    # false for nonspecific or generic failures.
+    # Put differently, False is for complete failures. If this function
+    # handles a failure gracefully, it should return True.
 
     filename = expandpath(filename)
     old_bakfile = db_handler.get_bakfile_entries(filename)
@@ -151,19 +178,20 @@ def bak_up_cmd(filename: str):
     old_bakfile = old_bakfile[0] if len(old_bakfile) == 1 else \
         _do_select_bakfile(old_bakfile)
     if old_bakfile is None:
+        click.echo("Cancelled.")
         return True
     elif not isinstance(old_bakfile, bakfile.BakFile):
         return False
 
-    new_bakfile = _assemble_bakfile(filename)
-    new_bakfile.date_created = old_bakfile.date_created
-    copy2(new_bakfile.original_file, new_bakfile.bakfile_loc)
-    db_handler.update_bakfile_entry(old_bakfile, new_bakfile)
+    old_bakfile.date_modified = datetime.now()
+    copy2(old_bakfile.original_file, old_bakfile.bakfile_loc)
+    db_handler.update_bakfile_entry(old_bakfile)
     return True
 
 
 def bak_down_cmd(filename: str,
-                 keep_bakfile: bool = False):
+                 keep_bakfile: bool = False,
+                 quiet: bool = False):
     """ Restore `filename` from .bakfile. Prompts if ambiguous (such as
         when there are multiple .bakfiles of `filename`)
 
@@ -173,19 +201,37 @@ def bak_down_cmd(filename: str,
     """
     filename = expandpath(filename)
     bakfile_entries = db_handler.get_bakfile_entries(filename)
+    if not bakfile_entries:
+        click.echo(f"No bakfiles found for {filename}")
+        return
 
-    # TODO still only pulling first result
     bakfile_entry = _do_select_bakfile(bakfile_entries) if len(
         bakfile_entries) > 1 else bakfile_entries[0]
 
     if not bakfile_entry:
+        click.echo(f"No bakfiles found for {filename}")
         return
 
-    os.remove(filename)
-    copy2(bakfile_entry.bakfile_loc, filename)
+    if quiet:
+        confirm = 'y'
+    else:
+        confirm_prompt = f"Confirm: Restore {filename} and erase bakfiles?\n" \
+            if not keep_bakfile else \
+            f"Confirm: Restore {filename} and keep bakfiles?\n"
+        confirm_prompt += "(y/n)"
+        confirm = click.prompt(confirm_prompt, default='n')
+    if confirm.lower()[0] != 'y':
+        click.echo("Cancelled.")
+        return
+    # os.remove(filename)
+    # copy2(bakfile_entry.bakfile_loc, filename)
     if not keep_bakfile:
+        os.rename(bakfile_entry.bakfile_loc, filename)
         for entry in bakfile_entries:
-            os.remove(entry.bakfile_loc)
+            # bakfile_entry's bakfile has already been moved
+            # trying to rm it would print a failure
+            if entry != bakfile_entry:
+                os.remove(entry.bakfile_loc)
             db_handler.del_bakfile_entry(entry)
 
 
@@ -212,7 +258,8 @@ def bak_off_cmd(filename: (None, str, os.path),
     filename = expandpath(filename)
     bakfiles = db_handler.get_bakfile_entries(filename)
     if not bakfiles:
-        click.echo(f"No bakfiles found for {filename}")
+        click.echo(f"No bakfiles found for {os.path.abspath(filename)}")
+        return False
     confirm = input(
         f"Confirming: Remove {len(bakfiles)} .bakfiles for {filename}? "
         f"(y/N) ").lower() == 'y' if not quietly else True
@@ -223,32 +270,47 @@ def bak_off_cmd(filename: (None, str, os.path),
         return False
 
 
-def bak_print_cmd(bak_to_print: (str, bakfile.BakFile), using: (str, None) = None):
+def bak_print_cmd(bak_to_print: (str, bakfile.BakFile),
+                  using: (str, None) = None):
+    # if this thing is given a string, it needs to go find
+    # a corresponding bakfile
     if not isinstance(bak_to_print, bakfile.BakFile):
-        bak_to_print = _get_bakfile_entry(bak_to_print,
-                                          select_prompt=("View which .bakfile? (#)", "c"))
+        _bak_to_print = _get_bakfile_entry(bak_to_print,
+                                           select_prompt=(
+                                               "View which .bakfile? (#)",
+                                               "c"))
+        if not _bak_to_print:
+            click.echo(
+                f"No bakfiles found for {os.path.abspath(bak_to_print)}")
+        else:
+            bak_to_print = _bak_to_print
         if not isinstance(bak_to_print, bakfile.BakFile):
             return  # _get_bakfile_entry() handles failures, so just exit here
-    if using:
-        pager = using
-    else:
-        try:
-            pager = os.environ['PAGER']
-        except KeyError:
-            pager = 'less'
-    call([pager, bak_to_print.bakfile_loc])
+    pager = using if using else \
+        (cfg['bak_show_exec'] or os.environ['PAGER']) or 'less'
+    pager = pager.strip('"').strip("'").split(" ")
+    call(pager + [bak_to_print.bakfile_loc])
 
 
 def bak_getfile_cmd(bak_to_get: (str, bakfile.BakFile)):
     if not isinstance(bak_to_get, bakfile.BakFile):
+        filename = bak_to_get
         bak_to_get = _get_bakfile_entry(bak_to_get, err=True)
         if not bak_to_get:
+            click.echo(f"No bakfiles found for {os.path.abspath(filename)}")
             return  # _get_bakfile_entry() handles failures, so just exit
-        click.echo(bak_to_get.bakfile_loc)
+    click.echo(bak_to_get.bakfile_loc)
 
 
-def bak_diff_cmd(filename, command='diff'):
+def bak_diff_cmd(filename: str, command='diff'):
     # TODO write tests for this (mildly tricky)
-    bak_to_diff = _get_bakfile_entry(expandpath(filename))
-    call([command if command else 'diff',
-          bak_to_diff.bakfile_loc, bak_to_diff.orig_abspath])
+    bak_to_diff = filename if isinstance(filename, bakfile.BakFile) else \
+        _get_bakfile_entry(expandpath(filename))
+    if not command:
+        command = cfg['bak_diff_exec'] or 'diff'
+    if not bak_to_diff:
+        click.echo(f"No bakfiles found for {os.path.abspath(filename)}")
+        return
+    command = command.strip('"').strip("'").split(" ")
+    call(command +
+         [bak_to_diff.bakfile_loc, bak_to_diff.orig_abspath])

bak/data/bak_db.py

@@ -40,15 +40,18 @@ def del_bakfile_entry(self, bak_entry: BakFile):
 
     def update_bakfile_entry(self,
                              old_bakfile: BakFile,
-                             new_bakfile: BakFile):
+                             new_bakfile: (BakFile, None) = None):
         with sqlite3.connect(self.db_loc) as db_conn:
             db_conn.execute(
                 """
                 DELETE FROM bakfiles WHERE bakfile=:bakfile_loc
                 """, (old_bakfile.bakfile_loc,))
             db_conn.commit()
-            os.remove(old_bakfile.bakfile_loc)
-        self.create_bakfile_entry(new_bakfile)
+            if new_bakfile:
+                os.remove(old_bakfile.bakfile_loc)
+                self.create_bakfile_entry(new_bakfile)
+            else:
+                self.create_bakfile_entry(old_bakfile)
 
     # TODO handle disambiguation
     def get_bakfile_entries(self, filename):

bak/default.cfg

@@ -0,0 +1,16 @@
+# NOTE: enclose values in single quotes (see example)
+#
+# This is currently using CFG (pip install config) and adding
+# your own environment variables to these settings
+# requires some odd syntax.
+#
+# This will be addressed before release. For now, if you aren't
+# familiar with the module, stick to string values.
+
+bakfile_location: null # Default: $XDG_DATA_HOME/bak/bakfiles
+bak_database_location: null # Default: $XDG_DATA_HOME/bak/bak.db
+
+# Example:
+# bak_show_exec: 'less'
+bak_show_exec: null # Defaults to $PAGER
+bak_diff_exec: null # Defaults to system diff

requirements.txt

@@ -1,3 +1,4 @@
 click==7.1.2
 click-default-group==1.2.2
+config==0.5.0
 rich==9.1.0