Update type annotations to reflect behavior when null buffer is passe…

…d to `write`
encode · Mar 25, 2022 · f9a9847 · f9a9847
1 parent d3b888b
commit f9a9847
Show file tree

Hide file tree

Showing 5 changed files with 7 additions and 7 deletions.
diff --git a/httpcore/backends/asyncio.py b/httpcore/backends/asyncio.py
@@ -32,7 +32,7 @@ async def read(self, max_bytes: int, timeout: float = None) -> bytes:
                 except anyio.EndOfStream:  # pragma: nocover
                     return b""
 
-    async def write(self, buffer: bytes, timeout: float = None) -> None:
+    async def write(self, buffer: typing.Optional[bytes], timeout: float = None) -> None:
         if not buffer:
             return
 

diff --git a/httpcore/backends/base.py b/httpcore/backends/base.py
@@ -7,7 +7,7 @@ class NetworkStream:
     def read(self, max_bytes: int, timeout: float = None) -> bytes:
         raise NotImplementedError()  # pragma: nocover
 
-    def write(self, buffer: bytes, timeout: float = None) -> None:
+    def write(self, buffer: typing.Optional[bytes], timeout: float = None) -> None:
         raise NotImplementedError()  # pragma: nocover
 
     def close(self) -> None:
@@ -42,7 +42,7 @@ class AsyncNetworkStream:
     async def read(self, max_bytes: int, timeout: float = None) -> bytes:
         raise NotImplementedError()  # pragma: nocover
 
-    async def write(self, buffer: bytes, timeout: float = None) -> None:
+    async def write(self, buffer: typing.Optional[bytes], timeout: float = None) -> None:
         raise NotImplementedError()  # pragma: nocover
 
     async def aclose(self) -> None:

diff --git a/httpcore/backends/mock.py b/httpcore/backends/mock.py
@@ -22,7 +22,7 @@ def read(self, max_bytes: int, timeout: float = None) -> bytes:
             return b""
         return self._buffer.pop(0)
 
-    def write(self, buffer: bytes, timeout: float = None) -> None:
+    def write(self, buffer: typing.Optional[bytes], timeout: float = None) -> None:
         pass
 
     def close(self) -> None:
@@ -67,7 +67,7 @@ async def read(self, max_bytes: int, timeout: float = None) -> bytes:
             return b""
         return self._buffer.pop(0)
 
-    async def write(self, buffer: bytes, timeout: float = None) -> None:
+    async def write(self, buffer: typing.Optional[bytes], timeout: float = None) -> None:
         pass
 
     async def aclose(self) -> None:

diff --git a/httpcore/backends/sync.py b/httpcore/backends/sync.py
@@ -25,7 +25,7 @@ def read(self, max_bytes: int, timeout: float = None) -> bytes:
             self._sock.settimeout(timeout)
             return self._sock.recv(max_bytes)
 
-    def write(self, buffer: bytes, timeout: float = None) -> None:
+    def write(self, buffer: typing.Optional[bytes], timeout: float = None) -> None:
         if not buffer:
             return
 

diff --git a/httpcore/backends/trio.py b/httpcore/backends/trio.py
@@ -26,7 +26,7 @@ async def read(self, max_bytes: int, timeout: float = None) -> bytes:
             with trio.fail_after(timeout_or_inf):
                 return await self._stream.receive_some(max_bytes=max_bytes)
 
-    async def write(self, buffer: bytes, timeout: float = None) -> None:
+    async def write(self, buffer: typing.Optional[bytes], timeout: float = None) -> None:
         if not buffer:
             return