Add enum BlameFlag

Author: jorio

docs/blame.rst

@@ -39,11 +39,11 @@ Getters:
 Constants
 =========
 
-.. py:data:: GIT_BLAME_NORMAL
-.. py:data:: GIT_BLAME_TRACK_COPIES_SAME_FILE
-.. py:data:: GIT_BLAME_TRACK_COPIES_SAME_COMMIT_MOVES
-.. py:data:: GIT_BLAME_TRACK_COPIES_SAME_COMMIT_COPIES
-.. py:data:: GIT_BLAME_TRACK_COPIES_ANY_COMMIT_COPIES
-.. py:data:: GIT_BLAME_FIRST_PARENT
-.. py:data:: GIT_BLAME_USE_MAILMAP
-.. py:data:: GIT_BLAME_IGNORE_WHITESPACE
+.. py:data:: enums.BlameFlag.NORMAL
+.. py:data:: enums.BlameFlag.TRACK_COPIES_SAME_FILE
+.. py:data:: enums.BlameFlag.TRACK_COPIES_SAME_COMMIT_MOVES
+.. py:data:: enums.BlameFlag.TRACK_COPIES_SAME_COMMIT_COPIES
+.. py:data:: enums.BlameFlag.TRACK_COPIES_ANY_COMMIT_COPIES
+.. py:data:: enums.BlameFlag.FIRST_PARENT
+.. py:data:: enums.BlameFlag.USE_MAILMAP
+.. py:data:: enums.BlameFlag.IGNORE_WHITESPACE

pygit2/__init__.py

@@ -42,7 +42,7 @@
 from .enums import (
     AttrCheck,
     ApplyLocation,
-    AttrCheckFlags,
+    BlameFlag,
     BranchType,
     CheckoutNotify,
     CheckoutStrategy,

pygit2/_pygit2.pyi

@@ -9,14 +9,6 @@ from .enums import MergePreference
 from .enums import ReferenceFilter
 from .enums import SortMode
 
-GIT_BLAME_FIRST_PARENT: int
-GIT_BLAME_IGNORE_WHITESPACE: int
-GIT_BLAME_NORMAL: int
-GIT_BLAME_TRACK_COPIES_ANY_COMMIT_COPIES: int
-GIT_BLAME_TRACK_COPIES_SAME_COMMIT_COPIES: int
-GIT_BLAME_TRACK_COPIES_SAME_COMMIT_MOVES: int
-GIT_BLAME_TRACK_COPIES_SAME_FILE: int
-GIT_BLAME_USE_MAILMAP: int
 GIT_CONFIG_LEVEL_GLOBAL: int
 GIT_CONFIG_LEVEL_LOCAL: int
 GIT_CONFIG_LEVEL_SYSTEM: int

pygit2/enums.py

@@ -60,6 +60,36 @@ class AttrCheck(IntFlag):
     INCLUDE_COMMIT = C.GIT_ATTR_CHECK_INCLUDE_COMMIT
 
 
+class BlameFlag(IntFlag):
+    NORMAL = _pygit2.GIT_BLAME_NORMAL
+    "Normal blame, the default"
+
+    TRACK_COPIES_SAME_FILE = _pygit2.GIT_BLAME_TRACK_COPIES_SAME_FILE
+    "Not yet implemented and reserved for future use (as of libgit2 1.7.1)."
+
+    TRACK_COPIES_SAME_COMMIT_MOVES = _pygit2.GIT_BLAME_TRACK_COPIES_SAME_COMMIT_MOVES
+    "Not yet implemented and reserved for future use (as of libgit2 1.7.1)."
+
+    TRACK_COPIES_SAME_COMMIT_COPIES = _pygit2.GIT_BLAME_TRACK_COPIES_SAME_COMMIT_COPIES
+    "Not yet implemented and reserved for future use (as of libgit2 1.7.1)."
+
+    TRACK_COPIES_ANY_COMMIT_COPIES = _pygit2.GIT_BLAME_TRACK_COPIES_ANY_COMMIT_COPIES
+    "Not yet implemented and reserved for future use (as of libgit2 1.7.1)."
+
+    FIRST_PARENT = _pygit2.GIT_BLAME_FIRST_PARENT
+    "Restrict the search of commits to those reachable following only the first parents."
+
+    USE_MAILMAP = _pygit2.GIT_BLAME_USE_MAILMAP
+    """
+    Use mailmap file to map author and committer names and email addresses
+    to canonical real names and email addresses. The mailmap will be read
+    from the working directory, or HEAD in a bare repository.
+    """
+
+    IGNORE_WHITESPACE = _pygit2.GIT_BLAME_IGNORE_WHITESPACE
+    "Ignore whitespace differences"
+
+
 class BranchType(IntFlag):
     LOCAL = _pygit2.GIT_BRANCH_LOCAL
     REMOTE = _pygit2.GIT_BRANCH_REMOTE

pygit2/repository.py

@@ -43,6 +43,7 @@
 from .config import Config
 from .enums import (
     AttrCheck,
+    BlameFlag,
     BranchType,
     CheckoutStrategy,
     DiffOption,
@@ -534,7 +535,7 @@ def state_cleanup(self):
     #
     # blame
     #
-    def blame(self, path, flags=None, min_match_characters=None,
+    def blame(self, path, flags: BlameFlag = BlameFlag.NORMAL, min_match_characters=None,
               newest_commit=None, oldest_commit=None, min_line=None,
               max_line=None):
         """
@@ -546,7 +547,7 @@ def blame(self, path, flags=None, min_match_characters=None,
             Path to the file to blame.
 
         flags
-            A GIT_BLAME_* constant.
+            An enums.BlameFlag constant.
 
         min_match_characters
             The number of alphanum chars that must be detected as moving/copying
@@ -566,13 +567,13 @@ def blame(self, path, flags=None, min_match_characters=None,
 
         Examples::
 
-            repo.blame('foo.c', flags=GIT_BLAME_TRACK_COPIES_SAME_FILE)
+            repo.blame('foo.c', flags=enums.BlameFlag.IGNORE_WHITESPACE)
         """
 
         options = ffi.new('git_blame_options *')
         C.git_blame_options_init(options, C.GIT_BLAME_OPTIONS_VERSION)
         if flags:
-            options.flags = flags
+            options.flags = int(flags)
         if min_match_characters:
             options.min_match_characters = min_match_characters
         if newest_commit:

test/test_blame.py

@@ -27,7 +27,7 @@
 
 import pytest
 
-from pygit2 import Signature, Oid, GIT_BLAME_IGNORE_WHITESPACE
+from pygit2 import Signature, Oid, BlameFlag
 
 
 PATH = 'hello.txt'
@@ -63,7 +63,7 @@ def test_blame_index(testrepo):
 
 
 def test_blame_flags(blameflagsrepo):
-    blame = blameflagsrepo.blame(PATH, flags=GIT_BLAME_IGNORE_WHITESPACE)
+    blame = blameflagsrepo.blame(PATH, flags=BlameFlag.IGNORE_WHITESPACE)
 
     assert len(blame) == 3