dulwich.walk.Walker(object)
class documentationdulwich.walk
(View In Hierarchy)
Object for performing a walk of commits in a store.
Walker objects are initialized with a store and other options and can then be treated as iterators of Commit objects.
Method | __init__ | Constructor. |
Method | __iter__ | Undocumented |
Method | _path_matches | Undocumented |
Method | _change_matches | Undocumented |
Method | _should_return | Determine if a walk entry should be returned.. |
Method | _next | Undocumented |
Method | _reorder | Possibly reorder a results iterator. |
Parameters | store | ObjectStore instance for looking up objects. |
include | Iterable of SHAs of commits to include along with their ancestors. | |
exclude | Iterable of SHAs of commits to exclude along with their ancestors, overriding includes. | |
order | ORDER_* constant specifying the order of results. Anything other than ORDER_DATE may result in O(n) memory usage. | |
reverse | If True, reverse the order of output, requiring O(n) memory. | |
max_entries | The maximum number of entries to yield, or None for no limit. | |
paths | Iterable of file or subtree paths to show entries for. | |
rename_detector | diff.RenameDetector object for detecting renames. | |
follow | If True, follow path across renames/copies. Forces a default rename_detector. | |
since | Timestamp to list commits after. | |
until | Timestamp to list commits before. | |
get_parents | Method to retrieve the parents of a commit | |
queue_cls | A class to use for a queue of commits, supporting the iterator protocol. The constructor takes a single argument, the Walker. |
Parameters | entry | The WalkEntry to consider. |
Returns | True if the WalkEntry should be returned by this walk, or False otherwise (e.g. if it doesn't match any requested paths). |