Diff¶

A diff shows the changes between trees, an index or the working dir.

Repository.diff(a=None, b=None, cached=False, flags=0, context_lines=3, interhunk_lines=0)¶

Show changes between the working tree and the index or a tree, changes between the index and a tree, changes between two trees, or changes between two blobs.

Keyword arguments:

cached

use staged changes instead of workdir

flag

a GIT_DIFF_* constant

context_lines

the number of unchanged lines that define the boundary of a hunk (and to display before and after)

interhunk_lines

the maximum number of unchanged lines between hunk boundaries before the hunks will be merged into a one

Examples:

# Changes in the working tree not yet staged for the next commit
>>> diff()

# Changes between the index and your last commit
>>> diff(cached=True)

# Changes in the working tree since your last commit
>>> diff('HEAD')

# Changes between commits
>>> t0 = revparse_single('HEAD')
>>> t1 = revparse_single('HEAD^')
>>> diff(t0, t1)
>>> diff('HEAD', 'HEAD^') # equivalent

If you want to diff a tree against an empty tree, use the low level API (Tree.diff_to_tree()) directly.

Examples

# Changes between commits
>>> t0 = revparse_single('HEAD')
>>> t1 = revparse_single('HEAD^')
>>> repo.diff(t0, t1)
>>> t0.diff(t1)           # equivalent
>>> repo.diff('HEAD', 'HEAD^') # equivalent

# Get all patches for a diff
>>> diff = repo.diff('HEAD^', 'HEAD~3')
>>> patches = [p for p in diff]

# Diffing the empty tree
>>> tree = revparse_single('HEAD').tree
>>> tree.diff_to_tree()

# Diff empty tree to a tree
>>> tree = revparse_single('HEAD').tree
>>> tree.diff_to_tree(swap=True)