dulwich.walk

module documentation

General implementation of walking commits and their contents.

Class WalkEntry Object encapsulating a single result from a walk.
Class Walker Object for performing a walk of commits in a store.
Constant ALL_ORDERS Undocumented
Constant ORDER_DATE Undocumented
Constant ORDER_TOPO Undocumented
Class _CommitTimeQueue Priority queue of WalkEntry objects by commit time.
Function _topo_reorder Reorder an iterable of entries topologically.
Constant _MAX_EXTRA_COMMITS Undocumented
ALL_ORDERS =

Undocumented

Value
(ORDER_DATE, ORDER_TOPO)
ORDER_DATE: str =

Undocumented

Value
'date'
ORDER_TOPO: str =

Undocumented

Value
'topo'
def _topo_reorder(entries: Iterator[WalkEntry], get_parents: Callable[[Commit], list[ObjectID]] = lambda commit: commit.parents) -> Iterator[WalkEntry]:

Reorder an iterable of entries topologically.

This works best assuming the entries are already in almost-topological order, e.g. in commit time order.

Returns: iterator over WalkEntry objects from entries in FIFO order, except
where a parent would be yielded before any of its children.
Parameters
entries:Iterator[WalkEntry]An iterable of WalkEntry objects.
get_parents:Callable[[Commit], list[ObjectID]]Optional function for getting the parents of a commit.
Returns
Iterator[WalkEntry]Undocumented
_MAX_EXTRA_COMMITS: int =

Undocumented

Value
5