diff --git a/synapse/http/client.py b/synapse/http/client.py
index f7a07f0466..5f40f16e24 100644
--- a/synapse/http/client.py
+++ b/synapse/http/client.py
@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
# Copyright 2014-2016 OpenMarket Ltd
# Copyright 2018 New Vector Ltd
#
@@ -34,6 +33,7 @@ import treq
from canonicaljson import encode_canonical_json
from netaddr import AddrFormatError, IPAddress, IPSet
from prometheus_client import Counter
+from typing_extensions import Protocol
from zope.interface import implementer, provider
from OpenSSL import SSL
@@ -755,6 +755,16 @@ def _timeout_to_request_timed_out_error(f: Failure):
return f
+class ByteWriteable(Protocol):
+ """The type of object which must be passed into read_body_with_max_size.
+
+ Typically this is a file object.
+ """
+
+ def write(self, data: bytes) -> int:
+ pass
+
+
class BodyExceededMaxSize(Exception):
"""The maximum allowed size of the HTTP body was exceeded."""
@@ -791,7 +801,7 @@ class _ReadBodyWithMaxSizeProtocol(protocol.Protocol):
transport = None # type: Optional[ITCPTransport]
def __init__(
- self, stream: BinaryIO, deferred: defer.Deferred, max_size: Optional[int]
+ self, stream: ByteWriteable, deferred: defer.Deferred, max_size: Optional[int]
):
self.stream = stream
self.deferred = deferred
@@ -831,7 +841,7 @@ class _ReadBodyWithMaxSizeProtocol(protocol.Protocol):
def read_body_with_max_size(
- response: IResponse, stream: BinaryIO, max_size: Optional[int]
+ response: IResponse, stream: ByteWriteable, max_size: Optional[int]
) -> defer.Deferred:
"""
Read a HTTP response body to a file-object. Optionally enforcing a maximum file size.
|
