Add enums BlobFilter, FilterFlag, FilterMode

Author: jorio

docs/filters.rst

@@ -38,7 +38,7 @@ setting.
             self.buffer = io.BytesIO()
 
         def check(self, src, attr_values):
-            if src.mode == GIT_FILTER_SMUDGE:
+            if src.mode == pygit2.enums.FilterMode.SMUDGE:
                 # attr_values contains the values of the 'text' and 'eol'
                 # attributes in that order (as they are defined in
                 # CRLFFilter.attributes
@@ -48,7 +48,7 @@ setting.
                     self.linesep = b'\r\n'
                 elif eol == 'lf':
                     self.linesep = b'\n'
-            else:  # src.mode == GIT_FILTER_CLEAN
+            else:  # src.mode == pygit2.enums.FilterMode.CLEAN
                 # always use LF line-endings when writing to the ODB
                 self.linesep = b'\n'
 

pygit2/__init__.py

@@ -43,6 +43,7 @@
     AttrCheck,
     ApplyLocation,
     BlameFlag,
+    BlobFilter,
     BranchType,
     CheckoutNotify,
     CheckoutStrategy,
@@ -55,6 +56,8 @@
     Feature,
     FetchPrune,
     FileMode,
+    FilterFlag,
+    FilterMode,
     ObjectType,
     Option,
     MergeAnalysis,

pygit2/blob.py

@@ -5,7 +5,8 @@
 from typing import Optional
 from queue import Queue
 
-from ._pygit2 import GIT_BLOB_FILTER_CHECK_FOR_BINARY, Blob, Oid
+from ._pygit2 import Blob, Oid
+from .enums import BlobFilter
 
 
 class _BlobIO(io.RawIOBase):
@@ -20,7 +21,7 @@ def __init__(
         self,
         blob: Blob,
         as_path: Optional[str] = None,
-        flags: int = GIT_BLOB_FILTER_CHECK_FOR_BINARY,
+        flags: BlobFilter = BlobFilter.CHECK_FOR_BINARY,
         commit_id: Optional[Oid] = None,
     ):
         super().__init__()
@@ -34,7 +35,7 @@ def __init__(
             args=(self._queue, self._ready, self._writer_closed),
             kwargs={
                 "as_path": as_path,
-                "flags": flags,
+                "flags": int(flags),
                 "commit_id": commit_id,
             },
             daemon=True,
@@ -127,7 +128,7 @@ def __init__(
         self,
         blob: Blob,
         as_path: Optional[str] = None,
-        flags: int = GIT_BLOB_FILTER_CHECK_FOR_BINARY,
+        flags: BlobFilter = BlobFilter.CHECK_FOR_BINARY,
         commit_id: Optional[Oid] = None,
     ):
         """Wrap the specified blob.
@@ -137,10 +138,10 @@ def __init__(
             as_path: Filter the contents of the blob as if it had the specified
                 path. If `as_path` is None, the raw contents of the blob will
                 be read.
-            flags: GIT_BLOB_FILTER_* bitflags (only applicable when `as_path`
-                is set).
-            commit_oid: Commit to load attributes from when
-                GIT_BLOB_FILTER_ATTRIBUTES_FROM_COMMIT is specified in `flags`
+            flags: A combination of enums.BlobFilter constants
+                (only applicable when `as_path` is set).
+            commit_id: Commit to load attributes from when
+                ATTRIBUTES_FROM_COMMIT is specified in `flags`
                 (only applicable when `as_path` is set).
         """
         raw = _BlobIO(blob, as_path=as_path, flags=flags, commit_id=commit_id)

pygit2/enums.py

@@ -90,6 +90,20 @@ class BlameFlag(IntFlag):
     "Ignore whitespace differences"
 
 
+class BlobFilter(IntFlag):
+    CHECK_FOR_BINARY = _pygit2.GIT_BLOB_FILTER_CHECK_FOR_BINARY
+    "Do not apply filters to binary files."
+
+    NO_SYSTEM_ATTRIBUTES = _pygit2.GIT_BLOB_FILTER_NO_SYSTEM_ATTRIBUTES
+    "Filters will not load configuration from the system-wide `gitattributes` in `/etc` (or system equivalent)."
+
+    ATTRIBUTES_FROM_HEAD = _pygit2.GIT_BLOB_FILTER_ATTRIBUTES_FROM_HEAD
+    "Load filters from a `.gitattributes` file in the HEAD commit."
+
+    ATTRIBUTES_FROM_COMMIT = _pygit2.GIT_BLOB_FILTER_ATTRIBUTES_FROM_COMMIT
+    "Load filters from a `.gitattributes` file in the specified commit."
+
+
 class BranchType(IntFlag):
     LOCAL = _pygit2.GIT_BRANCH_LOCAL
     REMOTE = _pygit2.GIT_BRANCH_REMOTE
@@ -656,6 +670,38 @@ class FileStatus(IntFlag):
     CONFLICTED = _pygit2.GIT_STATUS_CONFLICTED
 
 
+class FilterFlag(IntFlag):
+    """ Filter option flags. """
+
+    DEFAULT = _pygit2.GIT_FILTER_DEFAULT
+
+    ALLOW_UNSAFE = _pygit2.GIT_FILTER_ALLOW_UNSAFE
+    "Don't error for `safecrlf` violations, allow them to continue."
+
+    NO_SYSTEM_ATTRIBUTES = _pygit2.GIT_FILTER_NO_SYSTEM_ATTRIBUTES
+    "Don't load `/etc/gitattributes` (or the system equivalent)"
+
+    ATTRIBUTES_FROM_HEAD = _pygit2.GIT_FILTER_ATTRIBUTES_FROM_HEAD
+    "Load attributes from `.gitattributes` in the root of HEAD"
+
+    ATTRIBUTES_FROM_COMMIT = _pygit2.GIT_FILTER_ATTRIBUTES_FROM_COMMIT
+    "Load attributes from `.gitattributes` in a given commit. This can only be specified in a `git_filter_options`."
+
+
+class FilterMode(IntEnum):
+    """
+    Filters are applied in one of two directions: smudging - which is
+    exporting a file from the Git object database to the working directory,
+    and cleaning - which is importing a file from the working directory to
+    the Git object database.  These values control which direction of
+    change is being applied.
+    """
+    TO_WORKTREE = _pygit2.GIT_FILTER_TO_WORKTREE
+    SMUDGE = _pygit2.GIT_FILTER_SMUDGE
+    TO_ODB = _pygit2.GIT_FILTER_TO_ODB
+    CLEAN = _pygit2.GIT_FILTER_CLEAN
+
+
 class MergeAnalysis(IntFlag):
     """ The results of `Repository.merge_analysis` indicate the merge opportunities. """
 

src/blob.c

@@ -226,7 +226,7 @@ static void blob_filter_stream_free(git_writestream *s)
 
 
 PyDoc_STRVAR(Blob__write_to_queue__doc__,
-  "_write_to_queue(queue: queue.Queue, closed: threading.Event, chunk_size: int = io.DEFAULT_BUFFER_SIZE, [as_path: str = None, flags: int = GIT_BLOB_FILTER_CHECK_FOR_BINARY, commit_id: oid = None]) -> None\n"
+  "_write_to_queue(queue: queue.Queue, closed: threading.Event, chunk_size: int = io.DEFAULT_BUFFER_SIZE, [as_path: str = None, flags: enums.BlobFilter = enums.BlobFilter.CHECK_FOR_BINARY, commit_id: oid = None]) -> None\n"
   "\n"
   "Write the contents of the blob in chunks to `queue`.\n"
   "If `as_path` is None, the raw contents of blob will be written to the queue,\n"
@@ -261,13 +261,12 @@ PyDoc_STRVAR(Blob__write_to_queue__doc__,
   "    When set, the blob contents will be filtered as if it had this\n"
   "    filename (used for attribute lookups).\n"
   "\n"
-  "flags : int\n"
-  "    GIT_BLOB_FILTER_* bitflags (only applicable when `as_path` is set).\n"
+  "flags : enums.BlobFilter\n"
+  "    A combination of BlobFilter constants (only applicable when `as_path` is set).\n"
   "\n"
   "commit_id : oid\n"
-  "    Commit to load attributes from when\n"
-  "    GIT_BLOB_FILTER_ATTRIBUTES_FROM_COMMIT is specified in `flags`\n"
-  "    (only applicable when `as_path` is set).\n");
+  "    Commit to load attributes from when ATTRIBUTES_FROM_COMMIT is\n"
+  "    specified in `flags` (only applicable when `as_path` is set).\n");
 
 PyObject *
 Blob__write_to_queue(Blob *self, PyObject *args, PyObject *kwds)

src/filter.c

@@ -85,7 +85,7 @@ FilterSource_filemode__get__(FilterSource *self)
 
 PyDoc_STRVAR(FilterSource_oid__doc__,
     "Oid of the source object. If the oid is unknown "
-    "(often the case with GIT_FILTER_CLEAN) then `oid` will be None.\n");
+    "(often the case with FilterMode.CLEAN) then `oid` will be None.\n");
 PyObject *
 FilterSource_oid__get__(FilterSource *self)
 {
@@ -96,7 +96,7 @@ FilterSource_oid__get__(FilterSource *self)
 }
 
 PyDoc_STRVAR(FilterSource_mode__doc__,
-    "Filter mode (either GIT_FILTER_CLEAN or GIT_FILTER_SMUDGE).\n");
+    "Filter mode (either FilterMode.CLEAN or FilterMode.SMUDGE).\n");
 
 PyObject *
 FilterSource_mode__get__(FilterSource *self)
@@ -105,7 +105,7 @@ FilterSource_mode__get__(FilterSource *self)
 }
 
 PyDoc_STRVAR(FilterSource_flags__doc__,
-    "GIT_FILTER_* flags to be applied to the data.\n");
+    "A combination of filter flags (enums.FilterFlag) to be applied to the data.\n");
 
 PyObject *
 FilterSource_flags__get__(FilterSource *self)

test/test_filter.py

@@ -3,6 +3,7 @@
 import pytest
 
 import pygit2
+from pygit2 import BlobFilter
 from pygit2.errors import Passthrough
 
 
@@ -77,10 +78,7 @@ def unmatched_filter():
 def test_filter(testrepo, rot13_filter):
     blob_oid = testrepo.create_blob_fromworkdir("bye.txt")
     blob = testrepo[blob_oid]
-    flags = (
-        pygit2.GIT_BLOB_FILTER_CHECK_FOR_BINARY
-        | pygit2.GIT_BLOB_FILTER_ATTRIBUTES_FROM_HEAD
-    )
+    flags = BlobFilter.CHECK_FOR_BINARY | BlobFilter.ATTRIBUTES_FROM_HEAD
     assert b'olr jbeyq\n' == blob.data
     with pygit2.BlobIO(blob) as reader:
         assert b'olr jbeyq\n' == reader.read()
@@ -91,10 +89,7 @@ def test_filter(testrepo, rot13_filter):
 def test_filter_buffered(testrepo, buffered_filter):
     blob_oid = testrepo.create_blob_fromworkdir("bye.txt")
     blob = testrepo[blob_oid]
-    flags = (
-        pygit2.GIT_BLOB_FILTER_CHECK_FOR_BINARY
-        | pygit2.GIT_BLOB_FILTER_ATTRIBUTES_FROM_HEAD
-    )
+    flags = BlobFilter.CHECK_FOR_BINARY | BlobFilter.ATTRIBUTES_FROM_HEAD
     assert b'olr jbeyq\n' == blob.data
     with pygit2.BlobIO(blob) as reader:
         assert b'olr jbeyq\n' == reader.read()
@@ -105,10 +100,7 @@ def test_filter_buffered(testrepo, buffered_filter):
 def test_filter_passthrough(testrepo, passthrough_filter):
     blob_oid = testrepo.create_blob_fromworkdir("bye.txt")
     blob = testrepo[blob_oid]
-    flags = (
-        pygit2.GIT_BLOB_FILTER_CHECK_FOR_BINARY
-        | pygit2.GIT_BLOB_FILTER_ATTRIBUTES_FROM_HEAD
-    )
+    flags = BlobFilter.CHECK_FOR_BINARY | BlobFilter.ATTRIBUTES_FROM_HEAD
     assert b'bye world\n' == blob.data
     with pygit2.BlobIO(blob) as reader:
         assert b'bye world\n' == reader.read()
@@ -119,10 +111,7 @@ def test_filter_passthrough(testrepo, passthrough_filter):
 def test_filter_unmatched(testrepo, unmatched_filter):
     blob_oid = testrepo.create_blob_fromworkdir("bye.txt")
     blob = testrepo[blob_oid]
-    flags = (
-        pygit2.GIT_BLOB_FILTER_CHECK_FOR_BINARY
-        | pygit2.GIT_BLOB_FILTER_ATTRIBUTES_FROM_HEAD
-    )
+    flags = BlobFilter.CHECK_FOR_BINARY | BlobFilter.ATTRIBUTES_FROM_HEAD
     assert b'bye world\n' == blob.data
     with pygit2.BlobIO(blob) as reader:
         assert b'bye world\n' == reader.read()