dulwich.object_store.DiskObjectStore : API documentation

Git-style object store that exists on disk.

Method	__init__	Open an object store.
Method	__repr__	Undocumented
Method	alternates	Undocumented
Method	add_alternate_path	Add an alternate path to this object store.
Method	add_thin_pack	Add a new thin pack to this object store.
Method	move_in_pack	Move a specific file containing a pack into the pack directory.
Method	add_pack	Add a new pack to this object store.
Method	add_object	Add a single object to this object store.
Class Method	init	Undocumented
Method	_read_alternate_paths	Undocumented
Method	_update_pack_cache	Undocumented
Method	_pack_cache_stale	Check whether the pack cache is stale.
Method	_get_shafile_path	Undocumented
Method	_iter_loose_objects	Iterate over the SHAs of all loose objects.
Method	_get_loose_object	Undocumented
Method	_remove_loose_object	Undocumented
Method	_remove_pack	Undocumented
Method	_get_pack_basepath	Undocumented
Method	_complete_thin_pack	Move a specific file containing a pack into the pack directory.

Inherited from BaseObjectStore (via PackBasedObjectStore):

Method	determine_wants_all	Undocumented
Method	iter_shas	Iterate over the objects for the specified shas.
Method	__getitem__	Obtain an object by SHA1.
Method	add_pack_data	Add pack data to this object store.
Method	tree_changes	Find the differences between the contents of two trees
Method	iter_tree_contents	Iterate the contents of a tree and all subtrees.
Method	find_missing_objects	Find the missing objects required for a set of revisions.
Method	find_common_revisions	Find which revisions this store has in common using graphwalker.
Method	generate_pack_contents	Iterate over the contents of a pack file.
Method	generate_pack_data	Generate pack data objects for a set of wants/haves.
Method	peel_sha	Peel all tags from a SHA.
Method	_collect_ancestors	Collect all ancestors of heads up to (excluding) those in common.

Inherited from BaseObjectStore (via PackBasedObjectStore):

Method	determine_wants_all	Undocumented
Method	iter_shas	Iterate over the objects for the specified shas.
Method	__getitem__	Obtain an object by SHA1.
Method	add_pack_data	Add pack data to this object store.
Method	tree_changes	Find the differences between the contents of two trees
Method	iter_tree_contents	Iterate the contents of a tree and all subtrees.
Method	find_missing_objects	Find the missing objects required for a set of revisions.
Method	find_common_revisions	Find which revisions this store has in common using graphwalker.
Method	generate_pack_contents	Iterate over the contents of a pack file.
Method	generate_pack_data	Generate pack data objects for a set of wants/haves.
Method	peel_sha	Peel all tags from a SHA.
Method	_collect_ancestors	Collect all ancestors of heads up to (excluding) those in common.

def __init__(self, path):

overrides dulwich.object_store.PackBasedObjectStore.__init__

Open an object store.

Parameters path Path of the object store.

def __repr__(self):

Undocumented

@property
def alternates(self):

overrides dulwich.object_store.PackBasedObjectStore.alternates

Undocumented

def _read_alternate_paths(self):

Undocumented

def add_alternate_path(self, path):

Add an alternate path to this object store.

def _update_pack_cache(self):

Undocumented

def _pack_cache_stale(self):

overrides dulwich.object_store.PackBasedObjectStore._pack_cache_stale

Check whether the pack cache is stale.

def _get_shafile_path(self, sha):

Undocumented

def _iter_loose_objects(self):

overrides dulwich.object_store.PackBasedObjectStore._iter_loose_objects

Iterate over the SHAs of all loose objects.

def _get_loose_object(self, sha):

overrides dulwich.object_store.PackBasedObjectStore._get_loose_object

Undocumented

def _remove_loose_object(self, sha):

overrides dulwich.object_store.PackBasedObjectStore._remove_loose_object

Undocumented

def _remove_pack(self, pack):

overrides dulwich.object_store.PackBasedObjectStore._remove_pack

Undocumented

def _get_pack_basepath(self, entries):

Undocumented

def _complete_thin_pack(self, f, path, copier, indexer):

Move a specific file containing a pack into the pack directory.

Parameters	f	Open file object for the pack.
	path	Path to the pack file.
	copier	A PackStreamCopier to use for writing pack data.
	indexer	A PackIndexer for indexing the pack.
Note	The file should be on the same file system as the packs directory.

def add_thin_pack(self, read_all, read_some):

Add a new thin pack to this object store.

Thin packs are packs that contain deltas with parents that exist outside the pack. They should never be placed in the object store directly, and always indexed and completed as they are copied.

Parameters	read_all	Read function that blocks until the number of requested bytes are read.
	read_some	Read function that returns at least one byte, but may not return the number of bytes requested.
Returns	A Pack object pointing at the now-completed thin pack in the objects/pack directory.

def move_in_pack(self, path):

Move a specific file containing a pack into the pack directory.

Parameters	path	Path to the pack file.
Note	The file should be on the same file system as the packs directory.

def add_pack(self):

Add a new pack to this object store.

Returns Fileobject to write to, a commit function to call when the pack is finished and an abort function.

def add_object(self, obj):

overrides dulwich.object_store.BaseObjectStore.add_object

Add a single object to this object store.

Parameters obj Object to add

@classmethod
def init(cls, path):

Undocumented

API Documentation for Dulwich, generated by pydoctor at 2018-11-17 19:05:54.

dulwich.object_store.DiskObjectStore(PackBasedObjectStore) class documentation

`dulwich.object_store.DiskObjectStore(PackBasedObjectStore)` class documentation