Merge lp:~jelmer/brz/objects into lp:brz

[Jelmer Vernooij]

Add a TreeChange object that can serve as alternative to a tuple returned by Tree.iter_changes.

Add a TreeChange object that can serve as alternative to a tuple returned by Tree.iter_changes.

This allows addition of extra fields in the future, and not relying on indexing
but attribute names when accessing iter_changes results.

[Martin Packman (gz)]

Looks sensible, see one inline comment about slice still.

review: Approve

=== modified file 'breezy/bzr/_dirstate_helpers_pyx.pyx'
--- breezy/bzr/_dirstate_helpers_pyx.pyx	2019-01-27 18:53:46 +0000
+++ breezy/bzr/_dirstate_helpers_pyx.pyx	2019-06-15 12:02:54 +0000
@@ -31,6 +31,7 @@
 from .. import cache_utf8, errors, osutils
 from .dirstate import DirState, DirstateCorrupt
 from ..osutils import parent_directories, pathjoin, splitpath, is_inside_any, is_inside
+from ..tree import TreeChange
 
 
 # This is the Windows equivalent of ENOTDIR
@@ -1293,7 +1294,7 @@
                     else:
                         path_u = self.utf8_decode(path)[0]
                 source_kind = _minikind_to_kind(source_minikind)
-                return (entry[0][2],
+                return TreeChange(entry[0][2],
                        (old_path_u, path_u),
                        content_change,
                        (True, True),
@@ -1326,7 +1327,7 @@
                         and S_IXUSR & path_info[3].st_mode)
                 else:
                     target_exec = target_details[3]
-                return (entry[0][2],
+                return TreeChange(entry[0][2],
                        (None, self.utf8_decode(path)[0]),
                        True,
                        (False, True),
@@ -1336,7 +1337,7 @@
                        (None, target_exec)), True
             else:
                 # Its a missing file, report it as such.
-                return (entry[0][2],
+                return TreeChange(entry[0][2],
                        (None, self.utf8_decode(path)[0]),
                        False,
                        (False, True),
@@ -1354,7 +1355,8 @@
             parent_id = self.state._get_entry(self.source_index, path_utf8=entry[0][0])[0][2]
             if parent_id == entry[0][2]:
                 parent_id = None
-            return (entry[0][2],
+            return TreeChange(
+                   entry[0][2],
                    (self.utf8_decode(old_path)[0], None),
                    True,
                    (True, False),

=== modified file 'breezy/bzr/dirstate.py'
--- breezy/bzr/dirstate.py	2019-03-04 00:16:27 +0000
+++ breezy/bzr/dirstate.py	2019-06-15 12:02:54 +0000
@@ -250,6 +250,7 @@
     viewitems,
     viewvalues,
     )
+from ..tree import TreeChange
 
 
 # This is the Windows equivalent of ENOTDIR
@@ -3768,15 +3769,16 @@
                     else:
                         path_u = self.utf8_decode(path)[0]
                 source_kind = DirState._minikind_to_kind[source_minikind]
-                return (entry[0][2],
-                        (old_path_u, path_u),
-                        content_change,
-                        (True, True),
-                        (source_parent_id, target_parent_id),
-                        (self.utf8_decode(old_basename)[
-                         0], self.utf8_decode(entry[0][1])[0]),
-                        (source_kind, target_kind),
-                        (source_exec, target_exec)), changed
+                return TreeChange(
+                    entry[0][2],
+                    (old_path_u, path_u),
+                    content_change,
+                    (True, True),
+                    (source_parent_id, target_parent_id),
+                    (self.utf8_decode(old_basename)[
+                     0], self.utf8_decode(entry[0][1])[0]),
+                    (source_kind, target_kind),
+                    (source_exec, target_exec)), changed
         elif source_minikind in b'a' and target_minikind in _fdlt:
             # looks like a new file
             path = pathjoin(entry[0][0], entry[0][1])
@@ -3796,24 +3798,26 @@
                         and stat.S_IEXEC & path_info[3].st_mode)
                 else:
                     target_exec = target_details[3]
-                return (entry[0][2],
-                        (None, self.utf8_decode(path)[0]),
-                        True,
-                        (False, True),
-                        (None, parent_id),
-                        (None, self.utf8_decode(entry[0][1])[0]),
-                        (None, path_info[2]),
-                        (None, target_exec)), True
+                return TreeChange(
+                    entry[0][2],
+                    (None, self.utf8_decode(path)[0]),
+                    True,
+                    (False, True),
+                    (None, parent_id),
+                    (None, self.utf8_decode(entry[0][1])[0]),
+                    (None, path_info[2]),
+                    (None, target_exec)), True
             else:
                 # Its a missing file, report it as such.
-                return (entry[0][2],
-                        (None, self.utf8_decode(path)[0]),
-                        False,
-                        (False, True),
-                        (None, parent_id),
-                        (None, self.utf8_decode(entry[0][1])[0]),
-                        (None, None),
-                        (None, False)), True
+                return TreeChange(
+                    entry[0][2],
+                    (None, self.utf8_decode(path)[0]),
+                    False,
+                    (False, True),
+                    (None, parent_id),
+                    (None, self.utf8_decode(entry[0][1])[0]),
+                    (None, None),
+                    (None, False)), True
         elif source_minikind in _fdlt and target_minikind in b'a':
             # unversioned, possibly, or possibly not deleted: we dont care.
             # if its still on disk, *and* theres no other entry at this
@@ -3825,14 +3829,15 @@
                 self.source_index, path_utf8=entry[0][0])[0][2]
             if parent_id == entry[0][2]:
                 parent_id = None
-            return (entry[0][2],
-                    (self.utf8_decode(old_path)[0], None),
-                    True,
-                    (True, False),
-                    (parent_id, None),
-                    (self.utf8_decode(entry[0][1])[0], None),
-                    (DirState._minikind_to_kind[source_minikind], None),
-                    (source_details[3], None)), True
+            return TreeChange(
+                entry[0][2],
+                (self.utf8_decode(old_path)[0], None),
+                True,
+                (True, False),
+                (parent_id, None),
+                (self.utf8_decode(entry[0][1])[0], None),
+                (DirState._minikind_to_kind[source_minikind], None),
+                (source_details[3], None)), True
         elif source_minikind in _fdlt and target_minikind in b'r':
             # a rename; could be a true rename, or a rename inherited from
             # a renamed parent. TODO: handle this efficiently. Its not
@@ -3966,15 +3971,16 @@
                 new_executable = bool(
                     stat.S_ISREG(root_dir_info[3].st_mode)
                     and stat.S_IEXEC & root_dir_info[3].st_mode)
-                yield (None,
-                       (None, current_root_unicode),
-                       True,
-                       (False, False),
-                       (None, None),
-                       (None, splitpath(current_root_unicode)[-1]),
-                       (None, root_dir_info[2]),
-                       (None, new_executable)
-                       )
+                yield TreeChange(
+                    None,
+                    (None, current_root_unicode),
+                    True,
+                    (False, False),
+                    (None, None),
+                    (None, splitpath(current_root_unicode)[-1]),
+                    (None, root_dir_info[2]),
+                    (None, new_executable)
+                    )
             initial_key = (current_root, b'', b'')
             block_index, _ = self.state._find_block_index_from_key(initial_key)
             if block_index == 0:
@@ -4048,16 +4054,15 @@
                                 new_executable = bool(
                                     stat.S_ISREG(current_path_info[3].st_mode)
                                     and stat.S_IEXEC & current_path_info[3].st_mode)
-                                yield (None,
-                                       (None, utf8_decode(
-                                           current_path_info[0])[0]),
-                                       True,
-                                       (False, False),
-                                       (None, None),
-                                       (None, utf8_decode(
-                                        current_path_info[1])[0]),
-                                       (None, current_path_info[2]),
-                                       (None, new_executable))
+                                yield TreeChange(
+                                    None,
+                                    (None, utf8_decode(current_path_info[0])[0]),
+                                    True,
+                                    (False, False),
+                                    (None, None),
+                                    (None, utf8_decode(current_path_info[1])[0]),
+                                    (None, current_path_info[2]),
+                                    (None, new_executable))
                             # dont descend into this unversioned path if it is
                             # a dir
                             if current_path_info[2] in ('directory',

=== modified file 'breezy/bzr/inventorytree.py'
--- breezy/bzr/inventorytree.py	2019-03-04 00:16:27 +0000
+++ breezy/bzr/inventorytree.py	2019-06-15 12:02:54 +0000
@@ -52,6 +52,7 @@
     FileTimestampUnavailable,
     InterTree,
     Tree,
+    TreeChange,
     )
 
 
@@ -920,14 +921,15 @@
                         entry.file_id not in specific_file_ids):
                     continue
                 if entry.file_id not in changed_file_ids:
-                    yield (entry.file_id,
-                           (relpath, relpath),  # Not renamed
-                           False,  # Not modified
-                           (True, True),  # Still  versioned
-                           (entry.parent_id, entry.parent_id),
-                           (entry.name, entry.name),
-                           (entry.kind, entry.kind),
-                           (entry.executable, entry.executable))
+                    yield TreeChange(
+                        entry.file_id,
+                        (relpath, relpath),  # Not renamed
+                        False,  # Not modified
+                        (True, True),  # Still  versioned
+                        (entry.parent_id, entry.parent_id),
+                        (entry.name, entry.name),
+                        (entry.kind, entry.kind),
+                        (entry.executable, entry.executable))
 
 
 InterTree.register_optimiser(InterCHKRevisionTree)

=== modified file 'breezy/git/tree.py'
--- breezy/git/tree.py	2019-06-03 03:10:29 +0000
+++ breezy/git/tree.py	2019-06-15 12:02:54 +0000
@@ -828,10 +828,11 @@
             oldkind == 'directory' and newkind == 'directory' and
                 oldpath_decoded == newpath_decoded):
             continue
-        yield (fileid, (oldpath_decoded, newpath_decoded), (oldsha != newsha),
-               (oldversioned, newversioned),
-               (oldparent, newparent), (oldname, newname),
-               (oldkind, newkind), (oldexe, newexe))
+        yield _mod_tree.TreeChange(
+            fileid, (oldpath_decoded, newpath_decoded), (oldsha != newsha),
+            (oldversioned, newversioned),
+            (oldparent, newparent), (oldname, newname),
+            (oldkind, newkind), (oldexe, newexe))
 
 
 class InterGitTrees(_mod_tree.InterTree):

=== modified file 'breezy/tree.py'
--- breezy/tree.py	2019-06-04 00:08:59 +0000
+++ breezy/tree.py	2019-06-15 12:02:54 +0000
@@ -112,6 +112,43 @@
         return '+'
 
 
+class TreeChange(object):
+    """Describes the changes between the same item in two different trees."""
+
+    __slots__ = ['file_id', 'path', 'changed_content', 'versioned', 'parent_id',
+                 'name', 'kind', 'executable']
+
+    def __init__(self, file_id, path, changed_content, versioned, parent_id,
+                 name, kind, executable):
+        self.file_id = file_id
+        self.path = path
+        self.changed_content = changed_content
+        self.versioned = versioned
+        self.parent_id = parent_id
+        self.name = name
+        self.kind = kind
+        self.executable = executable
+
+    def __len__(self):
+        return len(self.__slots__)
+
+    def __tuple__(self):
+        return (self.file_id, self.path, self.changed_content, self.versioned,
+                self.parent_id, self.name, self.kind, self.executable)
+
+    def __eq__(self, other):
+        if isinstance(other, TreeChange):
+            return tuple(self) == tuple(other)
+        if isinstance(other, tuple):
+            return tuple(self) == other
+        return False
+
+    def __getitem__(self, i):
+        if isinstance(i, slice):
+            return tuple(self).__getitem__(i)
+        return getattr(self, self.__slots__[i])
+
+
 class Tree(object):
     """Abstract file tree.
 
@@ -762,8 +799,9 @@
             changes = True
         else:
             changes = False
-        return (file_id, (source_path, target_path), changed_content,
-                versioned, parent, name, kind, executable), changes
+        return TreeChange(
+            file_id, (source_path, target_path), changed_content,
+            versioned, parent, name, kind, executable), changes
 
     def compare(self, want_unchanged=False, specific_files=None,
                 extra_trees=None, require_versioned=False, include_root=False,
@@ -882,11 +920,12 @@
                 target_kind, target_executable, target_stat = \
                     self.target._comparison_data(
                         fake_entry, unversioned_path[1])
-                yield (None, (None, unversioned_path[1]), True, (False, False),
-                       (None, None),
-                       (None, unversioned_path[0][-1]),
-                       (None, target_kind),
-                       (None, target_executable))
+                yield TreeChange(
+                    None, (None, unversioned_path[1]), True, (False, False),
+                    (None, None),
+                    (None, unversioned_path[0][-1]),
+                    (None, target_kind),
+                    (None, target_executable))
             source_path, source_entry = from_data.get(target_entry.file_id,
                                                       (None, None))
             result, changes = self._changes_from_entries(source_entry,
@@ -918,11 +957,12 @@
             unversioned_path = all_unversioned.popleft()
             to_kind, to_executable, to_stat = \
                 self.target._comparison_data(fake_entry, unversioned_path[1])
-            yield (None, (None, unversioned_path[1]), True, (False, False),
-                   (None, None),
-                   (None, unversioned_path[0][-1]),
-                   (None, to_kind),
-                   (None, to_executable))
+            yield TreeChange(
+                None, (None, unversioned_path[1]), True, (False, False),
+                (None, None),
+                (None, unversioned_path[0][-1]),
+                (None, to_kind),
+                (None, to_executable))
         # Yield all remaining source paths
         for path, from_entry in from_entries_by_dir:
             file_id = from_entry.file_id
@@ -943,8 +983,9 @@
             changed_content = from_kind is not None
             # the parent's path is necessarily known at this point.
             changed_file_ids.append(file_id)
-            yield(file_id, (path, to_path), changed_content, versioned, parent,
-                  name, kind, executable)
+            yield TreeChange(
+                file_id, (path, to_path), changed_content, versioned, parent,
+                name, kind, executable)
         changed_file_ids = set(changed_file_ids)
         if specific_files is not None:
             for result in self._handle_precise_ids(precise_file_ids,