Replace BinaryIO with IO[bytes]

aiodocker/images.py

@@ -4,7 +4,6 @@
 from typing import (
     Any,
     AsyncIterator,
-    BinaryIO,
     Dict,
     List,
     Mapping,
@@ -17,6 +16,7 @@
 from typing_extensions import Literal
 
 from .jsonstream import json_stream_list, json_stream_stream
+from .types import SupportsRead
 from .utils import clean_map, compose_auth_header
 
 
@@ -226,7 +226,7 @@ async def delete(
         return await self.docker._query_json(f"images/{name}", "DELETE", params=params)
 
     @staticmethod
-    async def _stream(fileobj: BinaryIO) -> AsyncIterator[bytes]:
+    async def _stream(fileobj: SupportsRead[bytes]) -> AsyncIterator[bytes]:
         chunk = fileobj.read(io.DEFAULT_BUFFER_SIZE)
         while chunk:
             yield chunk
@@ -237,7 +237,7 @@ async def build(
         self,
         *,
         remote: Optional[str] = None,
-        fileobj: Optional[BinaryIO] = None,
+        fileobj: Optional[SupportsRead[bytes]] = None,
         path_dockerfile: Optional[str] = None,
         tag: Optional[str] = None,
         quiet: bool = False,
@@ -257,7 +257,7 @@ def build(
         self,
         *,
         remote: Optional[str] = None,
-        fileobj: Optional[BinaryIO] = None,
+        fileobj: Optional[SupportsRead[bytes]] = None,
         path_dockerfile: Optional[str] = None,
         tag: Optional[str] = None,
         quiet: bool = False,
@@ -276,7 +276,7 @@ def build(
         self,
         *,
         remote: Optional[str] = None,
-        fileobj: Optional[BinaryIO] = None,
+        fileobj: Optional[SupportsRead[bytes]] = None,
         path_dockerfile: Optional[str] = None,
         tag: Optional[str] = None,
         quiet: bool = False,

aiodocker/types.py

@@ -0,0 +1,11 @@
+from typing import (
+    Protocol,
+    TypeVar,
+)
+
+
+_T_co = TypeVar("_T_co", covariant=True)
+
+
+class SupportsRead(Protocol[_T_co]):
+    def read(self, length: int = ..., /) -> _T_co: ...

aiodocker/utils.py

@@ -7,7 +7,6 @@
 from typing import (
     IO,
     Any,
-    BinaryIO,
     Iterable,
     Mapping,
     MutableMapping,
@@ -220,7 +219,7 @@ def clean_filters(filters: Optional[Mapping] = None) -> str:
     return json.dumps(filters)
 
 
-def mktar_from_dockerfile(fileobject: BinaryIO) -> IO:
+def mktar_from_dockerfile(fileobj: Union[BytesIO, IO[bytes]]) -> IO[bytes]:
     """
     Create a zipped tar archive from a Dockerfile
     **Remember to close the file object**
@@ -233,14 +232,14 @@ def mktar_from_dockerfile(fileobject: BinaryIO) -> IO:
     f = tempfile.NamedTemporaryFile()
     t = tarfile.open(mode="w:gz", fileobj=f)
 
-    if isinstance(fileobject, BytesIO):
+    if isinstance(fileobj, BytesIO):
         dfinfo = tarfile.TarInfo("Dockerfile")
-        dfinfo.size = len(fileobject.getvalue())
-        fileobject.seek(0)
+        dfinfo.size = len(fileobj.getvalue())
+        fileobj.seek(0)
     else:
-        dfinfo = t.gettarinfo(fileobj=fileobject, arcname="Dockerfile")
+        dfinfo = t.gettarinfo(fileobj=fileobj, arcname="Dockerfile")
 
-    t.addfile(dfinfo, fileobject)
+    t.addfile(dfinfo, fileobj)
     t.close()
     f.seek(0)
     return f