dulwich.patch : API documentation

Function	write_commit_patch	Write a individual file patch.
Function	get_summary	Determine the summary line for use in a filename.
Function	unified_diff	difflib.unified_diff that can detect "No newline at end of file" as original "git diff" does.
Function	is_binary	See if the first few bytes contain any null characters.
Function	shortid	Undocumented
Function	patch_filename	Undocumented
Function	write_object_diff	Write the diff for an object.
Function	gen_diff_header	Write a blob diff header.
Function	write_blob_diff	Write blob diff.
Function	write_tree_diff	Write tree diff.
Function	git_am_patch_split	Parse a git-am-style patch and split it up into bits.
Function	parse_patch_message	Extract a Commit object and patch from an e-mail message.
Function	_format_range_unified	Convert range to the "ed" format

def write_commit_patch(f, commit, contents, progress, version=None, encoding=None):

Write a individual file patch.

Parameters	commit	Commit object
	progress	Tuple with current patch number and total.
Returns	tuple with filename and contents

def get_summary(commit):

Determine the summary line for use in a filename.

Parameters	commit	Commit
Returns	Summary string

def _format_range_unified(start, stop):

Convert range to the "ed" format

def unified_diff(a, b, fromfile='', tofile='', fromfiledate='', tofiledate='', n=3, lineterm='\n'):

difflib.unified_diff that can detect "No newline at end of file" as original "git diff" does.

Based on the same function in Python2.7 difflib.py

def is_binary(content):

See if the first few bytes contain any null characters.

Parameters content Bytestring to check for binary content

def shortid(hexsha):

Undocumented

def patch_filename(p, root):

Undocumented

def write_object_diff(f, store, old_file, new_file, diff_binary=False):

Write the diff for an object.

Parameters	f	File-like object to write to
	store	Store to retrieve objects from, if necessary
	old_file	(path, mode, hexsha) tuple
	new_file	(path, mode, hexsha) tuple
	diff_binary	Whether to diff files even if they are considered binary files by is_binary().
Note	the tuple elements should be None for nonexistant files

def gen_diff_header(paths, modes, shas):

Write a blob diff header.

def write_blob_diff(f, old_file, new_file):

Write blob diff.

Parameters	f	File-like object to write to
	old_file	(path, mode, hexsha) tuple (None if nonexisting)
	new_file	(path, mode, hexsha) tuple (None if nonexisting)
Note	The use of write_object_diff is recommended over this function.

def write_tree_diff(f, store, old_tree, new_tree, diff_binary=False):

Write tree diff.

Parameters	f	File-like object to write to.
	old_tree	Old tree id
	new_tree	New tree id
	diff_binary	Whether to diff files even if they are considered binary files by is_binary().

def git_am_patch_split(f, encoding=None):

Parse a git-am-style patch and split it up into bits.

Parameters	f	File-like object to parse
	encoding	Encoding to use when creating Git objects
Returns	Tuple with commit object, diff contents and git version

def parse_patch_message(msg, encoding=None):

Extract a Commit object and patch from an e-mail message.

Parameters	msg	An email message (email.message.Message)
	encoding	Encoding to use to encode Git commits
Returns	Tuple with commit object, diff contents and git version

dulwich.patch module documentation