Add types to cmd.py CatFileContentStream

Yobmod · Yobmod · commit 39eb0e607f86 · 2021-05-12T18:16:40.000+01:00
diff --git a/git/cmd.py b/git/cmd.py
@@ -42,7 +42,7 @@
 
 # typing ---------------------------------------------------------------------------
 
-from typing import Any, BinaryIO, Callable, Dict, Mapping, Sequence, TYPE_CHECKING, Union
+from typing import Any, BinaryIO, Callable, Dict, List, Mapping, Sequence, TYPE_CHECKING, Union
 
 from git.types import PathLike, TBD
 
@@ -443,7 +443,7 @@ class CatFileContentStream(object):
 
         __slots__ = ('_stream', '_nbr', '_size')
 
-        def __init__(self, size, stream):
+        def __init__(self, size: int, stream: BinaryIO) -> None:
             self._stream = stream
             self._size = size
             self._nbr = 0           # num bytes read
@@ -454,7 +454,7 @@ def __init__(self, size, stream):
                 stream.read(1)
             # END handle empty streams
 
-        def read(self, size=-1):
+        def read(self, size: int = -1) -> bytes:
             bytes_left = self._size - self._nbr
             if bytes_left == 0:
                 return b''
@@ -474,7 +474,7 @@ def read(self, size=-1):
             # END finish reading
             return data
 
-        def readline(self, size=-1):
+        def readline(self, size: int = -1) -> bytes:
             if self._nbr == self._size:
                 return b''
 
@@ -496,7 +496,7 @@ def readline(self, size=-1):
 
             return data
 
-        def readlines(self, size=-1):
+        def readlines(self, size: int = -1) -> List[bytes]:
             if self._nbr == self._size:
                 return []
 
@@ -517,28 +517,28 @@ def readlines(self, size=-1):
             return out
 
         # skipcq: PYL-E0301
-        def __iter__(self):
+        def __iter__(self) -> 'Git.CatFileContentStream':
             return self
 
-        def __next__(self):
+        def __next__(self) -> bytes:
             return self.next()
 
-        def next(self):
+        def next(self) -> bytes:
             line = self.readline()
             if not line:
                 raise StopIteration
 
             return line
 
-        def __del__(self):
+        def __del__(self) -> None:
             bytes_left = self._size - self._nbr
             if bytes_left:
                 # read and discard - seeking is impossible within a stream
                 # includes terminating newline
                 self._stream.read(bytes_left + 1)
             # END handle incomplete read
 
-    def __init__(self, working_dir=None):
+    def __init__(self, working_dir: Union[None, PathLike]=None):
         """Initialize this instance with:
 
         :param working_dir:
