shelephant_diff: unify and simplify implementation

Author: tdegeus

docs/copying.rst

@@ -179,4 +179,4 @@ and you would like to keep a backup of certain files (e.g. ``*.h5``) in
 
             shelephant_diff containerinfo.yaml localinfo.yaml
 
-        (You can also use ``shelephant_cp`` to copy. In that case the copy-plan can be based purely on *sha256*.)
+        (You can also use ``shelephant_cp`` to copy. In that case the copy-plan can be based purely on *sha256* if you set ``--mode=sha256``.)

shelephant/cli.py

@@ -9,7 +9,6 @@
 
 import click
 import numpy as np
-import prettytable
 
 from . import dataset
 from . import local
@@ -342,6 +341,7 @@ def shelephant_cp(args: list[str], paths: list[str] = None, filter_paths: bool =
     if suffix_source != pathlib.Path(""):
         files = [os.path.relpath(p, suffix_source) for p in files]
 
+    # interaction not directly with command-line
     if len(paths) > 0:
         if (common_prefix / deepest) != pathlib.Path(""):
             strip = common_prefix / deepest
@@ -660,7 +660,17 @@ def _shelephant_diff_parser():
             shelephant_diff <sourceinfo.yaml> <destinfo.yaml> --filter "?=, !="
             shelephant_diff <sourceinfo.yaml> <destinfo.yaml> -o <diff.yaml>
 
-        Note that if filter contains only one operation the output YAML-file will be a list.
+        .. note::
+
+            ``--filter`` allows to output only a limited number of directions.
+            For convenience, and to bypass syntax limitations, the following aliases are available:
+
+            -   ``<``: ``<-``
+            -   ``>``: ``->``
+            -   ``!``: ``!=``
+            -   ``~``: ``!=``
+            -   ``?``: ``?=``
+            -   ``=``: ``==``
         """
     )
 
@@ -679,14 +689,13 @@ class MyFmt(
     parser.add_argument(
         "--mode", type=str, help="Use 'sha256', 'rsync', or 'basic'.", default="sha256"
     )
-    parser.add_argument("--sort", type=str, help="Sort printed table by column.")
-    parser.add_argument("--table", type=str, default="SINGLE_BORDER", help="Select print style.")
-    parser.add_argument("--filter", type=str, help="Filter to direction (separated by ',').")
-    parser.add_argument("-o", "--output", type=pathlib.Path, help="Dump as YAML file.")
-    parser.add_argument("-f", "--force", action="store_true", help="Force overwrite output.")
+    parser.add_argument("--list", action="store_true", help="Output list instead of dictionary")
+    parser.add_argument("--filter", type=str, help="Filter to directions separated by ','")
+    parser.add_argument("-o", "--output", type=pathlib.Path, help="Dump as YAML file")
+    parser.add_argument("-f", "--force", action="store_true", help="Force overwrite output file")
     parser.add_argument("--version", action="version", version=version)
-    parser.add_argument("source", type=pathlib.Path, help="Source information.")
-    parser.add_argument("dest", type=pathlib.Path, help="Destination directory/information.")
+    parser.add_argument("source", type=pathlib.Path, help="Source information")
+    parser.add_argument("dest", type=pathlib.Path, help="Destination directory/information")
     return parser
 
 
@@ -704,17 +713,17 @@ def shelephant_diff(args: list[str]):
     assert len(args.mode) == 1, "Only one mode allowed."
     assert shutil.which("rsync") is not None or "rsync" not in args.mode, "rsync not available."
 
-    source = dataset.Location.from_yaml(args.source)
-    files = source.files(info=False)
-
     if args.dest.is_file():
         dest = dataset.Location.from_yaml(args.dest)
     else:
         dest = dataset.Location(root=args.dest, ssh=args.ssh)
 
+    source = dataset.Location.from_yaml(args.source)
+
     if "sha256" in args.mode:
         status = source.diff(dest)
     elif "rsync" in args.mode:
+        files = source.files(info=False)
         left = source.diff(dest)["<-"]
         [files.remove(file) for file in left]
         status = rsync.diff(source.hostpath, dest.hostpath, files)
@@ -726,51 +735,26 @@ def shelephant_diff(args: list[str]):
         raise ValueError(f"Unknown mode '{args.mode}'.")
 
     if args.filter:
-        keys = [key.strip() for key in args.filter.split(",")]
+        alias = {">": "->", "<": "<-", "!": "!=", "~": "!=", "?": "?=", "=": "=="}
+        alias = {**alias, **{v: v for v in alias.values()}}
+        filters = [alias[i.strip()] for i in args.filter.split(",")]
+        keys = [key.strip() for key in filters]
         keys = [key for key in keys if key in status]
         status = {key: status[key] for key in keys}
 
     for key in list(status.keys()):
         if len(status[key]) == 0:
             del status[key]
 
+    if args.list:
+        assert len(status) == 1, "--list output only works if only one direction is selected."
+        status = status[list(status.keys())[0]]
+
     if args.output:
-        if len(status) == 1:
-            status = status[list(status.keys())[0]]
         yaml.dump(args.output, status, force=args.force)
         return
 
-    out = prettytable.PrettyTable()
-    if args.table == "PLAIN_COLUMNS":
-        out.set_style(prettytable.PLAIN_COLUMNS)
-    elif args.table == "SINGLE_BORDER":
-        out.set_style(prettytable.SINGLE_BORDER)
-    out.field_names = ["source", "sync", "dest"]
-    out.align["source"] = "l"
-    out.align["sync"] = "c"
-    out.align["dest"] = "l"
-
-    left = status.pop("->", [])
-    right = status.pop("<-", [])
-    equal = status.pop("==", [])
-
-    for key in status:
-        for item in status[key]:
-            out.add_row([item, key, item])
-
-    for item in left:
-        out.add_row([item, "->", ""])
-
-    for item in right:
-        out.add_row(["", "<-", item])
-
-    for item in equal:
-        out.add_row([item, "==", item])
-
-    if args.sort is None:
-        print(out.get_string())
-    else:
-        print(out.get_string(sortby=args.sort))
+    output.diff(status, colors=args.colors)
 
 
 def _shelephant_main_parser():

shelephant/output.py

@@ -192,6 +192,13 @@ def diff(
     color = _theme(colors.lower())
     sio = io.StringIO()
 
+    if isinstance(status, list):
+        sio.write("\n".join(status))
+        if not display:
+            return sio.getvalue()
+        else:
+            autoprint(sio.getvalue())
+
     skip = status.pop("==", [])
     right = status.pop("->", [])
     left = status.pop("<-", [])
@@ -256,5 +263,5 @@ def diff(
 
     if not display:
         return sio.getvalue()
-
-    autoprint(sio.getvalue())
+    else:
+        autoprint(sio.getvalue())

shelephant/rsync.py

@@ -49,7 +49,6 @@ def copy(
             cmd = 'rsync {options:s} --files-from="{files:s}" "{src:s}" "{dest:s}"'.format(
                 options=options, src=str(source_dir), dest=str(dest_dir), files=temp_file
             )
-
             return exec_cmd(cmd, verbose)
 
         # Run while printing output

tests/test_cli.py

@@ -636,7 +636,7 @@ def test_output_filter_list(self):
                 shelephant_dump(["-i"] + files)
                 shelephant_hostinfo(["../dest", "-d", "--info"])
                 args = [f_dump, f_hostinfo]
-                shelephant_diff(args + ["-o", "foo.yaml", "--filter", "<-"])
+                shelephant_diff(args + ["-o", "foo.yaml", "--filter", "<-", "--list"])
                 data = shelephant.yaml.read("foo.yaml")
 
         self.assertEqual(data, ["receive.txt"])
@@ -650,27 +650,28 @@ def test_table(self):
             pathlib.Path("dest").mkdir()
 
             with cwd("dest"):
-                create_dummy_files(["foo.txt"])
-                create_dummy_files(["bar.txt"], keep=slice(2, None, None))
-                create_dummy_files(["receive.txt"], keep=slice(6, None, None))
-                shelephant_dump(["-i", "foo.txt", "bar.txt", "receive.txt"])
+                files = ["foo.txt", "bar.txt", "receive.txt"]
+                create_dummy_files([files[0]])
+                create_dummy_files([files[1]], keep=slice(2, None, None))
+                create_dummy_files([files[2]], keep=slice(6, None, None))
+                shelephant_dump(["-i"] + files)
 
             with cwd("src"):
                 files = ["foo.txt", "bar.txt", "more.txt", "even_more.txt"]
                 create_dummy_files(files)
                 shelephant_dump(["-i"] + files)
                 shelephant_hostinfo(["../dest", "-d"])
-                shelephant_diff([f_dump, f_hostinfo, "--table", "PLAIN_COLUMNS"])
+                shelephant_diff([f_dump, f_hostinfo, "--colors", "none"])
 
         expect = [
             "bar.txt != bar.txt",
-            "even_more.txt ->",
-            "more.txt ->",
-            "<- receive.txt",
+            "receive.txt <- receive.txt",
+            "even_more.txt -> even_more.txt",
+            "more.txt -> more.txt",
             "foo.txt == foo.txt",
         ]
 
-        ret = _plain(sio.getvalue())[1:]
+        ret = _plain(sio.getvalue())
         self.assertEqual(ret, expect)