dulwich.object_store.PackCapableObjectStore

class documentation

class PackCapableObjectStore(BaseObjectStore, PackedObjectContainer):

Known subclasses: dulwich.object_store.MemoryObjectStore, dulwich.object_store.PackBasedObjectStore

Constructor: PackCapableObjectStore(object_format)

Object store that supports pack operations.

This is a base class for object stores that can handle pack files, including both disk-based and memory-based stores.

Method	`add_pack`	Add a new pack to this object store.
Method	`add_pack_data`	Add pack data to this object store.
Method	`get_unpacked_object`	Get a raw unresolved object.
Method	`iterobjects_subset`	Iterate over a subset of objects.

Inherited from BaseObjectStore:

Method	`__contains__`	Check if a particular object is present by SHA1.
Method	`__getitem__`	Obtain an object by SHA1.
Method	`__init__`	Initialize object store.
Method	`__iter__`	Iterate over the SHAs that are present in this store.
Method	`add_object`	Add a single object to this object store.
Method	`add_objects`	Add a set of objects to this object store.
Method	`close`	Close any files opened by this object store.
Method	`contains_loose`	Check if a particular object is present by SHA1 and is loose.
Method	`contains_packed`	Check if a particular object is present by SHA1 and is packed.
Method	`determine_wants_all`	Determine which objects are wanted based on refs.
Method	`find_common_revisions`	Find which revisions this store has in common using graphwalker.
Method	`find_missing_objects`	Find the missing objects required for a set of revisions.
Method	`generate_pack_data`	Generate pack data objects for a set of wants/haves.
Method	`get_commit_graph`	Get the commit graph for this object store.
Method	`get_object_mtime`	Get the modification time of an object.
Method	`get_raw`	Obtain the raw text for an object.
Method	`get_reachability_provider`	Get a reachability provider for this object store.
Method	`iter_prefix`	Iterate over all SHA1s that start with a given prefix.
Method	`iter_tree_contents`	Iterate the contents of a tree and all subtrees.
Method	`iter_unpacked_subset`	Iterate over unpacked objects for a subset of SHAs.
Method	`peel_sha`	Peel all tags from a SHA.
Method	`prune`	Prune/clean up this object store.
Method	`tree_changes`	Find the differences between the contents of two trees.
Method	`write_commit_graph`	Write a commit graph file for this object store.
Instance Variable	`object_format`	Undocumented
Property	`packs`	Iterable of pack objects.
Method	`_get_depth`	Return the current available depth for the given head.

def add_pack(self) -> tuple[BinaryIO, Callable[[], None], Callable[[], None]]: ¶

overridden in dulwich.object_store.MemoryObjectStore, dulwich.object_store.PackBasedObjectStore

Add a new pack to this object store.

Returns: Tuple of (file, commit_func, abort_func)

def add_pack_data(self, count: int, unpacked_objects: Iterator[UnpackedObject], progress: Callable[..., None] | None = None) -> Pack | None: ¶

overridden in dulwich.object_store.MemoryObjectStore, dulwich.object_store.PackBasedObjectStore

Add pack data to this object store.

Parameters
count:`int`	Number of objects
unpacked_objects:`Iterator[UnpackedObject]`	Iterator over unpacked objects
progress:`Callable[..., None] \| None`	Optional progress callback

Returns
`Pack \| None`	Undocumented

def get_unpacked_object(self, sha1: ObjectID | RawObjectID, *, include_comp: bool = False) -> UnpackedObject: ¶

overrides dulwich.pack.PackedObjectContainer.get_unpacked_object

overridden in dulwich.object_store.PackBasedObjectStore

Get a raw unresolved object.

Parameters
sha1:`ObjectID \| RawObjectID`	SHA-1 hash of the object
include_comp:`bool`	Whether to include compressed data

Returns
`UnpackedObject`	UnpackedObject instance

def iterobjects_subset(self, shas: Iterable[ObjectID], *, allow_missing: bool = False) -> Iterator[ShaFile]: ¶

overrides dulwich.object_store.BaseObjectStore.iterobjects_subset

overridden in dulwich.object_store.PackBasedObjectStore

Iterate over a subset of objects.

Parameters
shas:`Iterable[ObjectID]`	Iterable of object SHAs to retrieve
allow_missing:`bool`	If True, skip missing objects

Returns
`Iterator[ShaFile]`	Iterator of ShaFile objects