dulwich.index : API documentation

Function	pathsplit	Split a /-delimited path into a directory part and a basename.
Function	pathjoin	Join a /-delimited path.
Function	read_cache_time	Read a cache time.
Function	write_cache_time	Write a cache time.
Function	read_cache_entry	Read an entry from a cache file.
Function	write_cache_entry	Write an index entry to a file.
Function	read_index	Read an index file, yielding the individual entries.
Function	read_index_dict	Read an index file and return it as a dictionary.
Function	write_index	Write an index file.
Function	write_index_dict	Write an index file based on the contents of a dictionary.
Function	cleanup_mode	Cleanup a mode value.
Class	Index	A Git Index file.
Function	commit_tree	Commit a new tree.
Function	commit_index	Create a new tree from an index.
Function	changes_from_tree	Find the differences between the contents of a tree and a working copy.
Function	index_entry_from_stat	Create a new index entry from a stat value.
Function	build_file_from_blob	Build a file or symlink on disk based on a Git object.
Function	validate_path_element_default	Undocumented
Function	validate_path_element_ntfs	Undocumented
Function	validate_path	Default path validator that just checks for .git/.
Function	build_index_from_tree	Generate and materialize index from a tree
Function	blob_from_path_and_stat	Create a blob from a path and a stat object.
Function	read_submodule_head	Read the head commit of a submodule.
Function	get_unstaged_changes	Walk through an index and check for differences against working tree.
Function	index_entry_from_path	Create an index from a filesystem path.
Function	iter_fresh_entries	Iterate over current versions of index entries on disk.
Function	iter_fresh_blobs	Iterate over versions of blobs on disk referenced by index.
Function	iter_fresh_objects	Iterate over versions of objecs on disk referenced by index.
Function	refresh_index	Refresh the contents of an index.
Function	_tree_to_fs_path	Convert a git tree path to a file system path.
Function	_fs_to_tree_path	Convert a file system path to a git tree path.

def pathsplit(path):

Split a /-delimited path into a directory part and a basename.

Parameters	path	The path to split.
Returns	Tuple with directory name and basename

def pathjoin(*args):

Join a /-delimited path.

def read_cache_time(f):

Read a cache time.

Parameters	f	File-like object to read from
Returns	Tuple with seconds and nanoseconds

def write_cache_time(f, t):

Write a cache time.

Parameters	f	File-like object to write to
	t	Time to write (as int, float or tuple with secs and nsecs)

def read_cache_entry(f):

Read an entry from a cache file.

Parameters	f	File-like object to read from
Returns	tuple with: device, inode, mode, uid, gid, size, sha, flags

def write_cache_entry(f, entry):

Write an index entry to a file.

Parameters	f	File object
	entry	Entry to write, tuple with: (name, ctime, mtime, dev, ino, mode, uid, gid, size, sha, flags)

def read_index(f):

Read an index file, yielding the individual entries.

def read_index_dict(f):

Read an index file and return it as a dictionary.

Parameters f File object to read from

def write_index(f, entries):

Write an index file.

Parameters	f	File-like object to write to
	entries	Iterable over the entries to write

def write_index_dict(f, entries):

Write an index file based on the contents of a dictionary.

def cleanup_mode(mode):

Cleanup a mode value.

This will return a mode that can be stored in a tree object.

Parameters mode Mode to clean up.

def commit_tree(object_store, blobs):

Commit a new tree.

Parameters	object_store	Object store to add trees to
	blobs	Iterable over blob path, sha, mode entries
Returns	SHA1 of the created tree.

def commit_index(object_store, index):

Create a new tree from an index.

Parameters	object_store	Object store to save the tree in
	index	Index file
Returns	Root tree sha.
Note	This function is deprecated, use index.commit() instead.

def changes_from_tree(names, lookup_entry, object_store, tree, want_unchanged=False):

Find the differences between the contents of a tree and a working copy.

Parameters	names	Iterable of names in the working copy
	lookup_entry	Function to lookup an entry in the working copy
	object_store	Object store to use for retrieving tree contents
	tree	SHA1 of the root tree, or None for an empty tree
	want_unchanged	Whether unchanged files should be reported
Returns	Iterator over tuples with (oldpath, newpath), (oldmode, newmode), (oldsha, newsha)

def index_entry_from_stat(stat_val, hex_sha, flags, mode=None):

Create a new index entry from a stat value.

Parameters	stat_val	POSIX stat_result instance
	hex_sha	Hex sha of the object
	flags	Index flags

def build_file_from_blob(blob, mode, target_path, honor_filemode=True):

Build a file or symlink on disk based on a Git object.

Parameters	obj	The git object
	mode	File mode
	target_path	Path to write to
	honor_filemode	An optional flag to honor core.filemode setting in config file, default is core.filemode=True, change executable bit
Returns	stat object for the file

def validate_path_element_default(element):

Undocumented

def validate_path_element_ntfs(element):

Undocumented

def validate_path(path, element_validator=validate_path_element_default):

Default path validator that just checks for .git/.

def build_index_from_tree(root_path, index_path, object_store, tree_id, honor_filemode=True, validate_path_element=validate_path_element_default):

Generate and materialize index from a tree

:note:: existing index is wiped and contents are not merged: in a working dir. Suitable only for fresh clones.

Parameters	tree_id	Tree to materialize
	root_path	Target dir for materialized index files
	index_path	Target path for generated index
	object_store	Non-empty object store holding tree contents
	honor_filemode	An optional flag to honor core.filemode setting in config file, default is core.filemode=True, change executable bit
	validate_path_element	Function to validate path elements to check out; default just refuses .git and .. directories.

def blob_from_path_and_stat(fs_path, st):

Create a blob from a path and a stat object.

Parameters	fs_path	Full file system path to file
	st	A stat object
Returns	A `Blob` object

def read_submodule_head(path):

Read the head commit of a submodule.

Parameters	path	path to the submodule
Returns	HEAD sha, None if not a valid head/repository

def get_unstaged_changes(index, root_path):

Walk through an index and check for differences against working tree.

Parameters	index	index to check
	root_path	path in which to find files
Returns	iterator over paths with unstaged changes

def _tree_to_fs_path(root_path, tree_path):

Convert a git tree path to a file system path.

Parameters	root_path	Root filesystem path
	tree_path	Git tree path as bytes
Returns	File system path.

def _fs_to_tree_path(fs_path, fs_encoding=None):

Convert a file system path to a git tree path.

Parameters	fs_path	File system path.
	fs_encoding	File system encoding
Returns	Git tree path as bytes

def index_entry_from_path(path, object_store=None):

Create an index from a filesystem path.

This returns an index value for files, symlinks and tree references. for directories and non-existant files it returns None

Parameters	path	Path to create an index entry for
	object_store	Optional object store to save new blobs in
Returns	An index entry

def iter_fresh_entries(paths, root_path, object_store=None):

Iterate over current versions of index entries on disk.

Parameters	paths	Paths to iterate over
	root_path	Root path to access from
	store	Optional store to save new blobs in
Returns	Iterator over path, index_entry

def iter_fresh_blobs(index, root_path):

Iterate over versions of blobs on disk referenced by index.

Don't use this function; it removes missing entries from index.

Parameters	index	Index file
	root_path	Root path to access from
	include_deleted	Include deleted entries with sha and mode set to None
Returns	Iterator over path, sha, mode

def iter_fresh_objects(paths, root_path, include_deleted=False, object_store=None):

Iterate over versions of objecs on disk referenced by index.

Parameters	index	Index file
	root_path	Root path to access from
	include_deleted	Include deleted entries with sha and mode set to None
	object_store	Optional object store to report new items to
Returns	Iterator over path, sha, mode

def refresh_index(index, root_path):

Refresh the contents of an index.

This is the equivalent to running 'git commit -a'.

Parameters	index	Index to update
	root_path	Root filesystem path

dulwich.index module documentation

`dulwich.index` module documentation