improve types according to test/test_filter.py

Author: BenediktSeidl

pygit2/_pygit2.pyi

@@ -52,6 +52,7 @@ from .enums import (
     ResetMode,
     SortMode,
 )
+from .filter import Filter
 from .remotes import Remote
 from .repository import BaseRepository
 from .submodules import SubmoduleCollection
@@ -522,6 +523,7 @@ class DiffStats:
 
 class FilterSource:
     # probably incomplete
+    repo: object
     pass
 
 class GitError(Exception): ...
@@ -1036,5 +1038,7 @@ def option(opt: Option, *args) -> None: ...
 def reference_is_valid_name(refname: str) -> bool: ...
 def tree_entry_cmp(a: Object, b: Object) -> int: ...
 def _cache_enums() -> None: ...
+def filter_register(name: str, filter: type[Filter]) -> None: ...
+def filter_unregister(name: str) -> None: ...
 
 _OidArg = str | Oid

pygit2/filter.py

@@ -58,7 +58,7 @@ class Filter:
     def nattrs(cls) -> int:
         return len(cls.attributes.split())
 
-    def check(self, src: FilterSource, attr_values: List[Optional[str]]):
+    def check(self, src: FilterSource, attr_values: List[Optional[str]]) -> None:
         """
         Check whether this filter should be applied to the given source.
 
@@ -77,7 +77,7 @@ def check(self, src: FilterSource, attr_values: List[Optional[str]]):
 
     def write(
         self, data: bytes, src: FilterSource, write_next: Callable[[bytes], None]
-    ):
+    ) -> None:
         """
         Write input `data` to this filter.
 
@@ -95,7 +95,7 @@ def write(
         """
         write_next(data)
 
-    def close(self, write_next: Callable[[bytes], None]):
+    def close(self, write_next: Callable[[bytes], None]) -> None:
         """
         Close this filter.
 

test/test_filter.py

@@ -1,40 +1,52 @@
 import codecs
 from io import BytesIO
+from typing import Callable, Generator
 
 import pytest
 
 import pygit2
+from pygit2 import Blob, Filter, FilterSource, Repository
 from pygit2.enums import BlobFilter
 from pygit2.errors import Passthrough
 
 
-def _rot13(data):
+def _rot13(data: bytes) -> bytes:
     return codecs.encode(data.decode('utf-8'), 'rot_13').encode('utf-8')
 
 
 class _Rot13Filter(pygit2.Filter):
     attributes = 'text'
 
-    def write(self, data, src, write_next):
+    def write(
+        self,
+        data: bytes,
+        src: FilterSource,
+        write_next: Callable[[bytes], None],
+    ) -> None:
         return super().write(_rot13(data), src, write_next)
 
 
 class _BufferedFilter(pygit2.Filter):
     attributes = 'text'
 
-    def __init__(self):
+    def __init__(self) -> None:
         super().__init__()
         self.buf = BytesIO()
 
-    def write(self, data, src, write_next):
+    def write(
+        self,
+        data: bytes,
+        src: FilterSource,
+        write_next: Callable[[bytes], None],
+    ) -> None:
         self.buf.write(data)
 
-    def close(self, write_next):
+    def close(self, write_next: Callable[[bytes], None]) -> None:
         write_next(_rot13(self.buf.getvalue()))
 
 
 class _PassthroughFilter(_Rot13Filter):
-    def check(self, src, attr_values):
+    def check(self, src: FilterSource, attr_values: list[str | None]) -> None:
         assert attr_values == [None]
         assert src.repo
         raise Passthrough
@@ -45,36 +57,37 @@ class _UnmatchedFilter(_Rot13Filter):
 
 
 @pytest.fixture
-def rot13_filter():
+def rot13_filter() -> Generator[None, None, None]:
     pygit2.filter_register('rot13', _Rot13Filter)
     yield
     pygit2.filter_unregister('rot13')
 
 
 @pytest.fixture
-def passthrough_filter():
+def passthrough_filter() -> Generator[None, None, None]:
     pygit2.filter_register('passthrough-rot13', _PassthroughFilter)
     yield
     pygit2.filter_unregister('passthrough-rot13')
 
 
 @pytest.fixture
-def buffered_filter():
+def buffered_filter() -> Generator[None, None, None]:
     pygit2.filter_register('buffered-rot13', _BufferedFilter)
     yield
     pygit2.filter_unregister('buffered-rot13')
 
 
 @pytest.fixture
-def unmatched_filter():
+def unmatched_filter() -> Generator[None, None, None]:
     pygit2.filter_register('unmatched-rot13', _UnmatchedFilter)
     yield
     pygit2.filter_unregister('unmatched-rot13')
 
 
-def test_filter(testrepo, rot13_filter):
+def test_filter(testrepo: Repository, rot13_filter: Filter) -> None:
     blob_oid = testrepo.create_blob_fromworkdir('bye.txt')
     blob = testrepo[blob_oid]
+    assert isinstance(blob, Blob)
     flags = BlobFilter.CHECK_FOR_BINARY | BlobFilter.ATTRIBUTES_FROM_HEAD
     assert b'olr jbeyq\n' == blob.data
     with pygit2.BlobIO(blob) as reader:
@@ -83,9 +96,10 @@ def test_filter(testrepo, rot13_filter):
         assert b'bye world\n' == reader.read()
 
 
-def test_filter_buffered(testrepo, buffered_filter):
+def test_filter_buffered(testrepo: Repository, buffered_filter: Filter) -> None:
     blob_oid = testrepo.create_blob_fromworkdir('bye.txt')
     blob = testrepo[blob_oid]
+    assert isinstance(blob, Blob)
     flags = BlobFilter.CHECK_FOR_BINARY | BlobFilter.ATTRIBUTES_FROM_HEAD
     assert b'olr jbeyq\n' == blob.data
     with pygit2.BlobIO(blob) as reader:
@@ -94,9 +108,10 @@ def test_filter_buffered(testrepo, buffered_filter):
         assert b'bye world\n' == reader.read()
 
 
-def test_filter_passthrough(testrepo, passthrough_filter):
+def test_filter_passthrough(testrepo: Repository, passthrough_filter: Filter) -> None:
     blob_oid = testrepo.create_blob_fromworkdir('bye.txt')
     blob = testrepo[blob_oid]
+    assert isinstance(blob, Blob)
     flags = BlobFilter.CHECK_FOR_BINARY | BlobFilter.ATTRIBUTES_FROM_HEAD
     assert b'bye world\n' == blob.data
     with pygit2.BlobIO(blob) as reader:
@@ -105,9 +120,10 @@ def test_filter_passthrough(testrepo, passthrough_filter):
         assert b'bye world\n' == reader.read()
 
 
-def test_filter_unmatched(testrepo, unmatched_filter):
+def test_filter_unmatched(testrepo: Repository, unmatched_filter: Filter) -> None:
     blob_oid = testrepo.create_blob_fromworkdir('bye.txt')
     blob = testrepo[blob_oid]
+    assert isinstance(blob, Blob)
     flags = BlobFilter.CHECK_FOR_BINARY | BlobFilter.ATTRIBUTES_FROM_HEAD
     assert b'bye world\n' == blob.data
     with pygit2.BlobIO(blob) as reader:
@@ -116,7 +132,7 @@ def test_filter_unmatched(testrepo, unmatched_filter):
         assert b'bye world\n' == reader.read()
 
 
-def test_filter_cleanup(dirtyrepo, rot13_filter):
+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()