add typing to blob.py and fix _pygit2.pyi

Author: DinhHuy2010

pygit2/_pygit2.pyi

@@ -1,11 +1,14 @@
-from io import IOBase
+import queue
+import threading
+from io import DEFAULT_BUFFER_SIZE, IOBase
 from typing import Any, Callable, Iterator, Literal, Optional, TypeAlias, overload
 
 from pygit2.filter import Filter
 
 from . import Index
 from .enums import (
     ApplyLocation,
+    BlobFilter,
     BranchType,
     DeltaStatus,
     DiffFind,
@@ -363,6 +366,16 @@ class Blob(Object):
         old_as_path: str = ...,
         buffer_as_path: str = ...,
     ) -> Patch: ...
+    def _write_to_queue(
+        self,
+        queue: queue.Queue[bytes | None],
+        closed: threading.Event,
+        chunk_size: int = DEFAULT_BUFFER_SIZE,
+        *,
+        as_path: str | None = None,
+        flags: BlobFilter = BlobFilter.CHECK_FOR_BINARY,
+        commit_id: Oid | None = None,
+    ) -> None: ...
 
 class Branch(Reference):
     branch_name: str

pygit2/blob.py

@@ -1,13 +1,19 @@
+from __future__ import annotations
+
 import io
 import threading
 import time
 from contextlib import AbstractContextManager
 from queue import Queue
-from typing import Optional
+from types import TracebackType
+from typing import TYPE_CHECKING, Any, Optional, overload
 
 from ._pygit2 import Blob, Oid
 from .enums import BlobFilter
 
+if TYPE_CHECKING:
+    from _typeshed import WriteableBuffer
+
 
 class _BlobIO(io.RawIOBase):
     """Low-level wrapper for streaming blob content.
@@ -26,7 +32,7 @@ def __init__(
     ):
         super().__init__()
         self._blob = blob
-        self._queue = Queue(maxsize=1)
+        self._queue: Queue[bytes | None] | None = Queue(maxsize=1)
         self._ready = threading.Event()
         self._writer_closed = threading.Event()
         self._chunk: Optional[bytes] = None
@@ -42,10 +48,15 @@ def __init__(
         )
         self._thread.start()
 
-    def __exit__(self, exc_type, exc_value, traceback):
+    def __exit__(
+        self,
+        exc_type: type[BaseException] | None,
+        exc_value: BaseException | None,
+        traceback: TracebackType | None,
+    ) -> None:
         self.close()
 
-    def isatty():
+    def isatty(self):
         return False
 
     def readable(self):
@@ -57,7 +68,14 @@ def writable(self):
     def seekable(self):
         return False
 
-    def readinto(self, b, /):
+    # workaround for type checking
+    if TYPE_CHECKING:
+        @overload
+        def readinto(self, b: WriteableBuffer, /) -> int: ...  # type: ignore
+
+    def readinto(self, b: Any, /) -> int:
+        if not self._queue:
+            raise RuntimeError('Blob I/O is closed')
         try:
             while self._chunk is None:
                 self._ready.wait()
@@ -96,7 +114,7 @@ def close(self):
         self._queue = None
 
 
-class BlobIO(io.BufferedReader, AbstractContextManager):
+class BlobIO(io.BufferedReader, AbstractContextManager['BlobIO']):
     """Read-only wrapper for streaming blob content.
 
     Supports reading both raw and filtered blob content.
@@ -147,7 +165,12 @@ def __init__(
         raw = _BlobIO(blob, as_path=as_path, flags=flags, commit_id=commit_id)
         super().__init__(raw)
 
-    def __exit__(self, exc_type, exc_value, traceback):
+    def __exit__(
+        self,
+        exc_type: type[BaseException] | None,
+        exc_value: BaseException | None,
+        traceback: TracebackType | None,
+    ) -> None:
         self.close()