Add FilterList, Repository.load_filter_list

Author: jorio

pygit2/_libgit2/ffi.pyi

@@ -177,6 +177,10 @@ class GitDescribeOptionsC:
 class GitDescribeResultC:
     pass
 
+class GitFilterListC:
+    # opaque struct
+    pass
+
 class GitIndexC:
     pass
 
@@ -318,6 +322,8 @@ def new(a: Literal['git_signature *']) -> GitSignatureC: ...
 @overload
 def new(a: Literal['git_signature **']) -> _Pointer[GitSignatureC]: ...
 @overload
+def new(a: Literal['git_filter_list **']) -> _Pointer[GitFilterListC]: ...
+@overload
 def new(a: Literal['int *']) -> int_c: ...
 @overload
 def new(a: Literal['int64_t *']) -> int64_t: ...

pygit2/_run.py

@@ -77,6 +77,7 @@
     'net.h',
     'refspec.h',
     'repository.h',
+    'filter.h',
     'commit.h',
     'revert.h',
     'stash.h',

pygit2/decl/filter.h

@@ -0,0 +1,26 @@
+typedef enum {
+	GIT_FILTER_TO_WORKTREE = ...,
+	GIT_FILTER_TO_ODB = ...,
+} git_filter_mode_t;
+
+typedef enum {
+	GIT_FILTER_DEFAULT = ...,
+	GIT_FILTER_ALLOW_UNSAFE = ...,
+	GIT_FILTER_NO_SYSTEM_ATTRIBUTES = ...,
+	GIT_FILTER_ATTRIBUTES_FROM_HEAD = ...,
+	GIT_FILTER_ATTRIBUTES_FROM_COMMIT = ...,
+} git_filter_flag_t;
+
+int git_filter_list_load(
+	git_filter_list **filters,
+	git_repository *repo,
+	git_blob *blob,
+	const char *path,
+	git_filter_mode_t mode,
+	uint32_t flags);
+
+int git_filter_list_contains(
+	git_filter_list *filters,
+	const char *name);
+
+void git_filter_list_free(git_filter_list *filters);

pygit2/decl/types.h

@@ -1,6 +1,8 @@
+typedef struct git_blob git_blob;
 typedef struct git_commit git_commit;
 typedef struct git_annotated_commit git_annotated_commit;
 typedef struct git_config git_config;
+typedef struct git_filter_list git_filter_list;
 typedef struct git_index git_index;
 typedef struct git_index_conflict_iterator git_index_conflict_iterator;
 typedef struct git_object git_object;

pygit2/filter.py

@@ -24,8 +24,14 @@
 # Boston, MA 02110-1301, USA.
 
 from collections.abc import Callable
+from typing import TYPE_CHECKING
 
 from ._pygit2 import FilterSource
+from .ffi import C, ffi
+from .utils import to_bytes
+
+if TYPE_CHECKING:
+    from ._libgit2.ffi import GitFilterListC
 
 
 class Filter:
@@ -107,3 +113,25 @@ def close(self, write_next: Callable[[bytes], None]) -> None:
                 Any remaining filtered output data must be written to
                 `write_next` before returning.
         """
+
+
+class FilterList:
+    _pointer: GitFilterListC
+
+    @classmethod
+    def _from_c(cls, ptr: GitFilterListC):
+        if ptr == ffi.NULL:
+            return None
+        fl = cls.__new__(cls)
+        fl._pointer = ptr
+        return fl
+
+    def __contains__(self, name: str) -> bool:
+        if not isinstance(name, str):
+            raise TypeError('argument must be str')
+        c_name = to_bytes(name)
+        result = C.git_filter_list_contains(self._pointer, c_name)
+        return bool(result)
+
+    def __del__(self):
+        C.git_filter_list_free(self._pointer)

pygit2/repository.py

@@ -64,6 +64,7 @@
     DescribeStrategy,
     DiffOption,
     FileMode,
+    FilterMode,
     MergeFavor,
     MergeFileFlag,
     MergeFlag,
@@ -73,6 +74,7 @@
 )
 from .errors import check_error
 from .ffi import C, ffi
+from .filter import FilterList
 from .index import Index, IndexEntry, MergeFileResult
 from .packbuilder import PackBuilder
 from .references import References
@@ -235,6 +237,31 @@ def hashfile(
         oid = Oid(raw=bytes(ffi.buffer(c_oid.id)[:]))
         return oid
 
+    def load_filter_list(
+        self, path: str, mode: FilterMode = FilterMode.TO_ODB
+    ) -> FilterList | None:
+        """
+        Load the filter list for a given path.
+        May return None if there are no filters to apply to this path.
+
+        Parameters:
+
+        path
+            Relative path of the file to be filtered
+
+        mode
+            Filtering direction: ODB to worktree (SMUDGE), or worktree to ODB
+            (CLEAN).
+        """
+        c_filters = ffi.new('git_filter_list **')
+        c_path = to_bytes(path)
+        c_mode = int(mode)
+
+        err = C.git_filter_list_load(c_filters, self._repo, ffi.NULL, c_path, c_mode, 0)
+        check_error(err)
+        fl = FilterList._from_c(c_filters[0])
+        return fl
+
     def __iter__(self) -> Iterator[Oid]:
         return iter(self.odb)
 

test/test_filter.py

@@ -136,3 +136,19 @@ def test_filter_cleanup(dirtyrepo: Repository, rot13_filter: Filter) -> None:
     # Indirectly test that pygit2_filter_cleanup has the GIL
     # before calling pygit2_filter_payload_free.
     dirtyrepo.diff()
+
+
+def test_filterlist_none(testrepo: Repository) -> None:
+    fl = testrepo.load_filter_list('hello.txt')
+    assert fl is None
+
+
+def test_filterlist_crlf(testrepo: Repository) -> None:
+    testrepo.config['core.autocrlf'] = True
+
+    fl = testrepo.load_filter_list('hello.txt')
+    assert fl is not None
+    assert 'crlf' in fl
+
+    with pytest.raises(TypeError):
+        1234 in fl  # type: ignore