Merge pull request #409 from nvie/add-incremental-blame-support

Add incremental blame support

Author: Byron

git/compat.py

@@ -8,6 +8,7 @@
 # flake8: noqa
 
 importsys
+importsix
 
 fromgitdb.utils.compatimport (
 PY3,
@@ -46,6 +47,20 @@ def mviter(d):
 defmviter(d):
 returnd.itervalues()
 
+PRE_PY27=sys.version_info< (2, 7)
+
+
+defsafe_decode(s):
+"""Safely decodes a binary string to unicode"""
+ifisinstance(s, six.text_type):
+returns
+elifisinstance(s, six.binary_type):
+ifPRE_PY27:
+returns.decode(defenc) # we're screwed
+else:
+returns.decode(defenc, errors='replace')
+raiseTypeError('Expected bytes or text, but got %r'% (s,))
+
 
 defwith_metaclass(meta, *bases):
 """copied from https://github.com/Byron/bcore/blob/master/src/python/butility/future.py#L15"""

git/repo/base.py

@@ -52,12 +52,14 @@
 fromgit.compatimport (
 text_type,
 defenc,
-PY3
+PY3,
+safe_decode,
 )
 
 importos
 importsys
 importre
+fromsix.movesimportrange
 
 DefaultDBType=GitCmdObjectDB
 ifsys.version_info[:2] < (2, 5): # python 2.4 compatiblity
@@ -655,7 +657,64 @@ def active_branch(self):
  :return: Head to the active branch"""
 returnself.head.reference
 
-defblame(self, rev, file):
+defblame_incremental(self, rev, file, **kwargs):
+"""Iterator for blame information for the given file at the given revision.
+
+ Unlike .blame(), this does not return the actual file's contents, only
+ a stream of (commit, range) tuples.
+
+ :parm rev: revision specifier, see git-rev-parse for viable options.
+ :return: lazy iterator of (git.Commit, range) tuples, where the commit
+ indicates the commit to blame for the line, and range
+ indicates a span of line numbers in the resulting file.
+
+ If you combine all line number ranges outputted by this command, you
+ should get a continuous range spanning all line numbers in the file.
+ """
+data=self.git.blame(rev, '--', file, p=True, incremental=True, stdout_as_string=False, **kwargs)
+commits=dict()
+
+stream=iter(data.splitlines())
+whileTrue:
+line=next(stream) # when exhausted, casues a StopIteration, terminating this function
+
+hexsha, _, lineno, num_lines=line.split()
+lineno=int(lineno)
+num_lines=int(num_lines)
+ifhexshanotincommits:
+# Now read the next few lines and build up a dict of properties
+# for this commit
+props=dict()
+whileTrue:
+line=next(stream)
+ifline==b'boundary':
+# "boundary" indicates a root commit and occurs
+# instead of the "previous" tag
+continue
+
+tag, value=line.split(b' ', 1)
+props[tag] =value
+iftag==b'filename':
+# "filename" formally terminates the entry for --incremental
+break
+
+c=Commit(self, hex_to_bin(hexsha),
+author=Actor(safe_decode(props[b'author']),
+safe_decode(props[b'author-mail'].lstrip(b'<').rstrip(b'>'))),
+authored_date=int(props[b'author-time']),
+committer=Actor(safe_decode(props[b'committer']),
+safe_decode(props[b'committer-mail'].lstrip(b'<').rstrip(b'>'))),
+committed_date=int(props[b'committer-time']),
+message=safe_decode(props[b'summary']))
+commits[hexsha] =c
+else:
+# Discard the next line (it's a filename end tag)
+line=next(stream)
+assertline.startswith(b'filename'), 'Unexpected git blame output'
+
+yieldcommits[hexsha], range(lineno, lineno+num_lines)
+
+defblame(self, rev, file, incremental=False, **kwargs):
 """The blame information for the given file at the given revision.
 
  :parm rev: revision specifier, see git-rev-parse for viable options.
@@ -664,7 +723,10 @@ def blame(self, rev, file):
  A list of tuples associating a Commit object with a list of lines that
  changed within the given commit. The Commit objects will be given in order
  of appearance."""
-data=self.git.blame(rev, '--', file, p=True, stdout_as_string=False)
+ifincremental:
+returnself.blame_incremental(rev, file, **kwargs)
+
+data=self.git.blame(rev, '--', file, p=True, stdout_as_string=False, **kwargs)
 commits=dict()
 blames=list()
 info=None

git/test/fixtures/blame_incremental

@@ -0,0 +1,30 @@
+82b8902e033430000481eb355733cd7065342037 2 2 1
+author Sebastian Thiel
+author-mail <[email protected]>
+author-time 1270634931
+author-tz +0200
+committer Sebastian Thiel
+committer-mail <[email protected]>
+committer-time 1270634931
+committer-tz +0200
+summary Used this release for a first beta of the 0.2 branch of development
+previous 501bf602abea7d21c3dbb409b435976e92033145 AUTHORS
+filename AUTHORS
+82b8902e033430000481eb355733cd7065342037 14 14 1
+filename AUTHORS
+c76852d0bff115720af3f27acdb084c59361e5f6 1 1 1
+author Michael Trier
+author-mail <[email protected]>
+author-time 1232829627
+author-tz -0500
+committer Michael Trier
+committer-mail <[email protected]>
+committer-time 1232829627
+committer-tz -0500
+summary Lots of spring cleaning and added in Sphinx documentation.
+previous bcd57e349c08bd7f076f8d6d2f39b702015358c1 AUTHORS
+filename AUTHORS
+c76852d0bff115720af3f27acdb084c59361e5f6 2 3 11
+filename AUTHORS
+c76852d0bff115720af3f27acdb084c59361e5f6 13 15 2
+filename AUTHORS

git/test/test_repo.py

@@ -50,6 +50,16 @@
 fromnoseimportSkipTest
 
 
+defiter_flatten(lol):
+foritemsinlol:
+foriteminitems:
+yielditem
+
+
+defflatten(lol):
+returnlist(iter_flatten(lol))
+
+
 classTestRepo(TestBase):
 
 @raises(InvalidGitRepositoryError)
@@ -323,6 +333,20 @@ def test_blame_real(self):
 assertc, "Should have executed at least one blame command"
 assertnml, "There should at least be one blame commit that contains multiple lines"
 
+@patch.object(Git, '_call_process')
+deftest_blame_incremental(self, git):
+git.return_value=fixture('blame_incremental')
+blame_output=self.rorepo.blame_incremental('9debf6b0aafb6f7781ea9d1383c86939a1aacde3', 'AUTHORS')
+blame_output=list(blame_output)
+assertlen(blame_output) ==5
+
+# Check all outputted line numbers
+ranges=flatten([line_numbersfor_, line_numbersinblame_output])
+assertranges==flatten([range(2, 3), range(14, 15), range(1, 2), range(3, 14), range(15, 17)]), str(ranges)
+
+commits= [c.hexsha[:7] forc, _inblame_output]
+assertcommits== ['82b8902', '82b8902', 'c76852d', 'c76852d', 'c76852d'], str(commits)
+
 @patch.object(Git, '_call_process')
 deftest_blame_complex_revision(self, git):
 git.return_value=fixture('blame_complex_revision')