Path for zfs diff bug and add move V feature

zfs diff has an issue that spaces in file names are replaced with \0040. Added patch to correct this condition. Also added feature to have a move flag for diffs (V). By default zfs diff returns R for Rename and Move but new flag on get_diffs allows for distinction between rename (R) and move (V).

Author: JavaScriptDude

README.md

@@ -133,6 +133,9 @@ See examples folder for code examples
     #  - +       The path has been created
     #  - M       The path has been modified
     #  - R       The path has been renamed
+    #  - V       The path has moved
+    # get_move - Derrive the V flag for paths that have moved. 
+    #            By default zfs returns R for renamed and moved paths.
 ```
 
 ### `<Snapshot>.snap_path`

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "zfslib"
-version = "0.12.0"
+version = "0.13.0"
 description = "ZFS Utilities For Python3"
 license = "MIT"
 authors = ["Timothy C. Quinn"]

src/zfslib/zfslib.py

@@ -578,7 +578,8 @@ def __init__(self, pool, name, parent=None):
     #  - +       The path has been created
     #  - M       The path has been modified
     #  - R       The path has been renamed
-    def get_diffs(self, snap_from, snap_to=None, include=None, exclude=None, file_type=None, chg_type=None):
+    #  - V       The path has been moved
+    def get_diffs(self, snap_from, snap_to=None, include=None, exclude=None, file_type=None, chg_type=None, get_move:bool=False):
         self.assertHaveMounts()
         assert self.mounted, "Cannot get diffs for Unmounted Dataset. Verify mounted flag on Dataset before calling"
 
@@ -597,6 +598,7 @@ def __tv(k, v):
             if isinstance(v, list): return v
             raise AssertionError(f"{k} can only be a str or list. Got: {type(v)}")
 
+        if chg_type == 'V': get_move = True
 
         file_type = __tv('file_type', file_type)
         chg_type = __tv('chg_type', chg_type)
@@ -631,7 +633,7 @@ def __row(s):
         for i, row in enumerate(rows):
             # if i == 429:
             #     print("HERE")
-            d = Diff(row, snap_left, snap_right)
+            d = Diff(row, snap_left, snap_right, get_move=get_move)
             if d.path_full.find('(on_delete_queue)') > 0:
                 # It looks to be an artefact of ZFS that does not actually exist in FS
                 # https://github.com/openzfs/zfs/blob/master/lib/libzfs/libzfs_diff.c
@@ -798,8 +800,9 @@ class Diff():
        ,'+': 'The path has been created'
        ,'M': 'The path has been modified'
        ,'R': 'The path has been renamed'
+       ,'V': 'The path has been moved'
     }
-    def __init__(self, row, snap_left, snap_right):
+    def __init__(self, row, snap_left, snap_right, get_move:bool=False):
         self.no_from_snap=False
         self.to_present=False
         if isinstance(snap_left, str) and snap_left == '(na-first)':
@@ -829,6 +832,13 @@ def __init__(self, row, snap_left, snap_right):
         else:
             raise Exception(f"Unexpected len: {len(row)}. Row = {row}")
 
+        # Derrive Move change type
+        if get_move and chg_type == 'R' and path_new is not None:
+            chg_type = 'V'
+
+        # Fix issue related to https://github.com/openzfs/zfs/issues/6318
+        path = path.replace("\\0040", " ")
+
         chg_time = datetime.fromtimestamp(int(inode_ts[:inode_ts.find('.')]))
         self.chg_ts = inode_ts
         self.chg_time = chg_time
@@ -871,7 +881,7 @@ def _get_snap_path_right(self):
         if self.to_present:
             return self.path_full
         snap_path = self.snap_right.snap_path
-        path_full = self.path_full_new if self.chg_type == 'R' else self.path_full
+        path_full = self.path_full_new if self.chg_type in ('R','V') else self.path_full
         return "{}{}".format(snap_path, path_full.replace(self.snap_left.dataset.mountpoint, ''))
     snap_path_right = property(_get_snap_path_right)