Extend decorator: user output, convert arg to Path

Author: ChanceNCounter

bak/__main__.py

@@ -16,14 +16,20 @@ def __print_help():
         click.echo(bak.get_help(ctx))
 
 
-def check_file_reference(args_key: str = 'filename'):
+def normalize_path(args_key: str = 'filename'):
     def on_decorator(func):
         @functools.wraps(func)
         def on_call(*args, **kwargs):
             try:
-                if Path(kwargs[args_key]).expanduser().resolve().is_dir():
-                    raise IsADirectoryError('{} is a directory'.format(kwargs[args_key]))
-            except IndexError:
+                # expand path
+                arg = Path(kwargs[args_key]).expanduser().resolve()
+                if arg.is_dir():
+                    click.echo(f"Error: bak cannot operate on directories ({arg})")
+                    return
+                else:
+                    kwargs[args_key] = arg
+            # Account for optional params and params that default to None or False
+            except (IndexError, KeyError, TypeError):
                 pass
             return func(*args, **kwargs)
         return on_call
@@ -40,7 +46,7 @@ def bak():
 
 
 @bak.command("\0", hidden=True)
-@check_file_reference()
+@normalize_path()
 @click.option("--version", required=False, is_flag=True)
 @click.argument("filename", required=False, type=click.Path(exists=True))
 # Ensures that 'bak --help' is printed if it doesn't get a filename
@@ -55,7 +61,7 @@ def create(filename, version):
 
 
 @bak.command("up", help="Replace a .bakfile with a fresh copy of the parent file")
-@check_file_reference()
+@normalize_path()
 @click.argument("filename", required=True, type=click.Path(exists=True))
 def bak_up(filename):
     if not filename:
@@ -102,7 +108,7 @@ def bak_off(filename, quietly):
 @click.option("--using", "--in", "--with",
               help="Program to open (default: $PAGER or less)",
               required=False, hidden=True)
-@check_file_reference()
+@normalize_path()
 @click.argument("filename", required=True, type=click.Path(exists=True))
 def bak_print(filename, using):
     filename = Path(filename).expanduser().resolve()
@@ -116,7 +122,7 @@ def bak_print(filename, using):
 @click.argument("to_where_you_once_belonged",
                 required=True,
                 type=click.Path(exists=True))
-@check_file_reference()
+@normalize_path()
 def bak_get(to_where_you_once_belonged):
     to_where_you_once_belonged = Path(to_where_you_once_belonged).expanduser().resolve()
     commands.bak_getfile_cmd(to_where_you_once_belonged)
@@ -127,7 +133,7 @@ def bak_get(to_where_you_once_belonged):
 @click.option("--using", "--with",
               help="Program to use instead of system diff",
               required=False)
-@check_file_reference()
+@normalize_path()
 @click.argument("filename", required=True, type=click.Path(exists=True))
 def bak_diff(filename, using):
     filename = Path(filename).expanduser().resolve()
@@ -145,15 +151,12 @@ def bak_diff(filename, using):
                 #   help="List a particular file's .bakfiles",
                 required=False,
                 type=click.Path(exists=True))
-@check_file_reference()
+@normalize_path()
 def bak_list(relpaths, filename):
     if filename:
         filename = Path(filename).expanduser().resolve()
     commands.show_bak_list(filename=filename or None, relative_paths=relpaths)
 
 
 if __name__ == "__main__":
-    try:
-        bak()
-    except IsADirectoryError as e:
-        print('Must pass a file, not a directory to bak: {}'.format(e))
+    bak()

bak/commands/__init__.py

@@ -67,8 +67,8 @@ def _assemble_bakfile(filename: Path):
 def _get_bakfile_entry(filename: Path,
                        select_prompt=default_select_prompt,
                        err=True):
-    entries = db_handler.get_bakfile_entries(filename.resolve())
-    if (entries is False) or len(entries) == 0:
+    entries = db_handler.get_bakfile_entries(filename)
+    if not entries:
         return None
     # If there's only one bakfile corresponding to filename, return that.
     # If there's more than one, disambiguate.
@@ -166,7 +166,7 @@ def show_bak_list(filename: Optional[Path] = None,
     i = 1
     for _bakfile in bakfiles:
         table.add_row(str(i),
-                      (filename.resolve()) if
+                      os.path.relpath(filename) if
                       relative_paths else
                       _bakfile.orig_abspath,
                       _bakfile.date_created.split('.')[0],
@@ -355,13 +355,13 @@ def bak_diff_cmd(filename: (bakfile.BakFile, Path), command='diff'):
     console = Console()
 
     bak_to_diff = filename if isinstance(filename, bakfile.BakFile) else \
-        _get_bakfile_entry(filename.resolve(),
+        _get_bakfile_entry(filename,
                            select_prompt=(
                                ("Enter a number to diff a .bakfile, or:\n(V)iew (L)ist (C)ancel", "C")))
     if not command:
         command = cfg['bak_diff_exec'] or 'diff'
     if bak_to_diff is None:
-        console.print(f"No bakfiles found for {filename.resolve()}")
+        console.print(f"No bakfiles found for {filename}")
         return
     if not bak_to_diff:
         return