dulwich.pack.PackIndex

class documentation

class PackIndex(object):

Known subclasses: dulwich.pack.FilePackIndex, dulwich.pack.MemoryPackIndex

View In Hierarchy

An index in to a packfile.

Given a sha id of an object a pack index can tell you the location in the packfile of that object if it has it.

Method __eq__ Undocumented
Method __iter__ Iterate over the SHAs in this pack.
Method __len__ Return the number of entries in this pack index.
Method __ne__ Undocumented
Method get_pack_checksum Return the SHA1 checksum stored for the corresponding packfile.
Method iterentries Iterate over the entries in this pack index.
Method object_index Return the index in to the corresponding packfile for the object.
Method object_sha1 Return the SHA1 corresponding to the index in the pack file.
Method objects_sha1 Return the hex SHA1 over all the shas of all objects in this pack.
Method _itersha Yield all the SHA1's of the objects in the index, sorted.
Method _object_index See object_index.
def __eq__(self, other):
overridden in dulwich.pack.FilePackIndex

Undocumented

def __iter__(self):

Iterate over the SHAs in this pack.

def __len__(self):
overridden in dulwich.pack.FilePackIndex, dulwich.pack.MemoryPackIndex

Return the number of entries in this pack index.

def __ne__(self, other):

Undocumented

def get_pack_checksum(self):
overridden in dulwich.pack.FilePackIndex, dulwich.pack.MemoryPackIndex

Return the SHA1 checksum stored for the corresponding packfile.

Returns: 20-byte binary digest

def iterentries(self):
overridden in dulwich.pack.FilePackIndex, dulwich.pack.MemoryPackIndex

Iterate over the entries in this pack index.

Returns: iterator over tuples with object name, offset in packfile and
crc32 checksum.
def object_index(self, sha):
overridden in dulwich.pack.FilePackIndex, dulwich.pack.MemoryPackIndex

Return the index in to the corresponding packfile for the object.

Given the name of an object it will return the offset that object lives at within the corresponding pack file. If the pack file doesn't have the object then None will be returned.

def object_sha1(self, index):
overridden in dulwich.pack.MemoryPackIndex

Return the SHA1 corresponding to the index in the pack file.

def objects_sha1(self):

Return the hex SHA1 over all the shas of all objects in this pack.

Note: This is used for the filename of the pack.

def _itersha(self):
overridden in dulwich.pack.FilePackIndex, dulwich.pack.MemoryPackIndex

Yield all the SHA1's of the objects in the index, sorted.

def _object_index(self, sha):
overridden in dulwich.pack.FilePackIndex

See object_index.

Parameters
shaA binary SHA string. (20 characters long)_