"""A utility class providing methods to alter the underlying cache in a list-like

__slots__ = ("_cache",)

def __init__(self, cache: List[TreeCacheTup]) -> None:

self._cache = cache

def _index_by_name(self, name: str) -> int:

""":return: index of an item with name, or -1 if not found"""

for i, t in enumerate(self._cache):

if t[2] == name:

return i

# END found item

# END for each item in cache

return -1

# { Interface

def set_done(self) -> "TreeModifier":

"""Call this method once you are done modifying the tree information.

self._cache.sort(key=lambda x: (x[2] + "/") if x[1] == Tree.tree_id << 12 else x[2])

return self

# } END interface

# { Mutators

def add(self, sha: bytes, mode: int, name: str, force: bool = False) -> "TreeModifier":

"""Add the given item to the tree.

_validate_tree_entry_name(name, mode)

if (mode >> 12) not in Tree._map_id_to_type:

raise ValueError("Invalid object type according to mode %o" % mode)

sha = to_bin_sha(sha)

index = self._index_by_name(name)

item = (sha, mode, name)

if index == -1:

self._cache.append(item)

else:

if force:

self._cache[index] = item

else:

ex_item = self._cache[index]

if ex_item[0] != sha or ex_item[1] != mode:

raise ValueError("Item %r existed with different properties" % name)

# END handle mismatch

# END handle force

# END handle name exists

return self

def add_unchecked(self, binsha: bytes, mode: int, name: str) -> None:

"""Add the given item to the tree. Its correctness is assumed, so it is the

assert isinstance(binsha, bytes) and isinstance(mode, int) and isinstance(name, str)

tree_cache = (binsha, mode, name)

self._cache.append(tree_cache)

def __delitem__(self, name: str) -> None:

"""Delete an item with the given name if it exists."""

index = self._index_by_name(name)

if index > -1:

del self._cache[index]

R"""Tree objects represent an ordered list of :class:`~git.objects.blob.Blob`\s and

type: Literal["tree"] = "tree"

__slots__ = ("_cache",)

# Actual integer IDs for comparison.

commit_id = 0o16 # Equals stat.S_IFDIR | stat.S_IFLNK - a directory link.

blob_id = 0o10

symlink_id = 0o12

tree_id = 0o04

_map_id_to_type: Dict[int, Type[IndexObjUnion]] = {

commit_id: Submodule,

blob_id: Blob,

symlink_id: Blob,

# Tree ID added once Tree is defined.

}

def __init__(

self,

repo: "Repo",

binsha: bytes,

mode: int = tree_id << 12,

path: Union[PathLike, None] = None,

):

super().__init__(repo, binsha, mode, path)

@classmethod

def _get_intermediate_items(

cls,

index_object: IndexObjUnion,

) -> Union[Tuple["Tree", ...], Tuple[()]]:

if index_object.type == "tree":

return tuple(index_object._iter_convert_to_object(index_object._cache))

return ()

def _set_cache_(self, attr: str) -> None:

if attr == "_cache":

# Set the data when we need it.

ostream = self.repo.odb.stream(self.binsha)

self._cache: List[TreeCacheTup] = tree_entries_from_data(ostream.read())

else:

super()._set_cache_(attr)

# END handle attribute

def _iter_convert_to_object(self, iterable: Iterable[TreeCacheTup]) -> Iterator[IndexObjUnion]:

"""Iterable yields tuples of (binsha, mode, name), which will be converted to

for binsha, mode, name in iterable:

path = join_path(self.path, name)

try:

yield self._map_id_to_type[mode >> 12](self.repo, binsha, mode, path)

except KeyError as e:

raise TypeError("Unknown mode %o found in tree data for path '%s'" % (mode, path)) from e

# END for each item

def join(self, file: PathLike) -> IndexObjUnion:

"""Find the named object in this tree's contents.

msg = "Blob or Tree named %r not found"

file = os.fspath(file)

if "/" in file:

tree = self

item = self

tokens = file.split("/")

for i, token in enumerate(tokens):

item = tree[token]

if item.type == "tree":

tree = item

else:

# Safety assertion - blobs are at the end of the path.

if i != len(tokens) - 1:

raise KeyError(msg % file)

return item

# END handle item type

# END for each token of split path

if item == self:

raise KeyError(msg % file)

return item

else:

for info in self._cache:

if info[2] == file: # [2] == name

return self._map_id_to_type[info[1] >> 12](

self.repo, info[0], info[1], join_path(self.path, info[2])

)

# END for each obj

raise KeyError(msg % file)

# END handle long paths

def __truediv__(self, file: PathLike) -> IndexObjUnion:

"""The ``/`` operator is another syntax for joining.

return self.join(file)

@property

def trees(self) -> List["Tree"]:

""":return: list(Tree, ...) List of trees directly below this tree"""

return [i for i in self if i.type == "tree"]

@property

def blobs(self) -> List[Blob]:

""":return: list(Blob, ...) List of blobs directly below this tree"""

return [i for i in self if i.type == "blob"]

@property

def cache(self) -> TreeModifier:

"""

return TreeModifier(self._cache)

def traverse(

self,

predicate: Callable[[Union[IndexObjUnion, TraversedTreeTup], int], bool] = lambda i, d: True,

prune: Callable[[Union[IndexObjUnion, TraversedTreeTup], int], bool] = lambda i, d: False,

depth: int = -1,

branch_first: bool = True,

visit_once: bool = False,

ignore_self: int = 1,

as_edge: bool = False,

) -> Union[Iterator[IndexObjUnion], Iterator[TraversedTreeTup]]:

"""For documentation, see

# # To typecheck instead of using cast.

# import itertools

# def is_tree_traversed(inp: Tuple) -> TypeGuard[Tuple[Iterator[Union['Tree', 'Blob', 'Submodule']]]]:

# return all(isinstance(x, (Blob, Tree, Submodule)) for x in inp[1])

# ret = super().traverse(predicate, prune, depth, branch_first, visit_once, ignore_self)

# ret_tup = itertools.tee(ret, 2)

# assert is_tree_traversed(ret_tup), f"Type is {[type(x) for x in list(ret_tup[0])]}"

# return ret_tup[0]

return cast(

Union[Iterator[IndexObjUnion], Iterator[TraversedTreeTup]],

super()._traverse(

predicate, # type: ignore[arg-type]

prune, # type: ignore[arg-type]

depth,

branch_first,

visit_once,

ignore_self,

),

)

def list_traverse(self, *args: Any, **kwargs: Any) -> IterableList[IndexObjUnion]:

"""

return super()._list_traverse(*args, **kwargs)

# List protocol

def __getslice__(self, i: int, j: int) -> List[IndexObjUnion]:

return list(self._iter_convert_to_object(self._cache[i:j]))

def __iter__(self) -> Iterator[IndexObjUnion]:

return self._iter_convert_to_object(self._cache)

def __len__(self) -> int:

return len(self._cache)

def __getitem__(self, item: Union[str, int, slice]) -> IndexObjUnion:

if isinstance(item, int):

info = self._cache[item]

return self._map_id_to_type[info[1] >> 12](self.repo, info[0], info[1], join_path(self.path, info[2]))

if isinstance(item, str):

# compatibility

return self.join(item)

# END index is basestring

raise TypeError("Invalid index type: %r" % item)

def __contains__(self, item: Union[IndexObjUnion, PathLike]) -> bool:

if isinstance(item, IndexObject):

for info in self._cache:

if item.binsha == info[0]:

return True

# END compare sha

# END for each entry

# END handle item is index object

# compatibility

# Treat item as repo-relative path.

else:

path = self.path

for info in self._cache:

if item == join_path(path, info[2]):

return True

# END for each item

return False

def __reversed__(self) -> Iterator[IndexObjUnion]:

return reversed(self._iter_convert_to_object(self._cache)) # type: ignore[call-overload]

def _serialize(self, stream: "BytesIO") -> "Tree":

"""Serialize this tree into the stream. Assumes sorted tree data.

tree_to_stream(self._cache, stream.write)

return self

def _deserialize(self, stream: "BytesIO") -> "Tree":

self._cache = tree_entries_from_data(stream.read())