dulwich.patch

module documentation

Classes for dealing with git am-style patches.

These patches are basically unified diffs with some extra metadata tacked on.

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

def gen_diff_header(paths, modes, shas): ¶

Write a blob diff header.

def get_summary(commit): ¶

Determine the summary line for use in a filename.

Returns: Summary string

Parameters
commit	Commit

def git_am_patch_split(f, encoding=None): ¶

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

Returns: Tuple with commit object, diff contents and git version

Parameters
f	File-like object to parse
encoding	Encoding to use when creating Git objects

def is_binary(content): ¶

See if the first few bytes contain any null characters.

Parameters
content	Bytestring to check for binary content

def parse_patch_message(msg, encoding=None): ¶

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

Returns: Tuple with commit object, diff contents and git version

Parameters
msg	An email message (email.message.Message)
encoding	Encoding to use to encode Git commits

def patch_filename(p, root): ¶

Undocumented

def shortid(hexsha): ¶

Undocumented

def unified_diff(a, b, fromfile='', tofile='', fromfiledate='', tofiledate='', n=3, lineterm='\n', tree_encoding='utf-8', output_encoding='utf-8'): ¶

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 write_blob_diff(f, old_file, new_file): ¶

Write blob diff.

Note: The use of write_object_diff is recommended over this function.

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)

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

Write a individual file patch.

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

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

Write the diff for an object.

Note: the tuple elements should be None for nonexistent files

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().

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

Write tree diff.

Parameters
f	File-like object to write to.
store	Undocumented
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().

FIRST_FEW_BYTES: int = ¶

Undocumented

Value

def _format_range_unified(start, stop): ¶

Convert range to the "ed" format