import socket
import sys
+import warnings
import weakref
if hasattr(socket, 'AF_UNIX'):
"""
if loop is None:
loop = events.get_event_loop()
- reader = StreamReader(limit=limit, loop=loop)
- protocol = StreamReaderProtocol(reader, loop=loop)
+ reader = StreamReader(limit=limit, loop=loop,
+ _asyncio_internal=True)
+ protocol = StreamReaderProtocol(reader, loop=loop,
+ _asyncio_internal=True)
transport, _ = await loop.create_connection(
lambda: protocol, host, port, **kwds)
- writer = StreamWriter(transport, protocol, reader, loop)
+ writer = StreamWriter(transport, protocol, reader, loop,
+ _asyncio_internal=True)
return reader, writer
loop = events.get_event_loop()
def factory():
- reader = StreamReader(limit=limit, loop=loop)
+ reader = StreamReader(limit=limit, loop=loop,
+ _asyncio_internal=True)
protocol = StreamReaderProtocol(reader, client_connected_cb,
- loop=loop)
+ loop=loop,
+ _asyncio_internal=True)
return protocol
return await loop.create_server(factory, host, port, **kwds)
"""Similar to `open_connection` but works with UNIX Domain Sockets."""
if loop is None:
loop = events.get_event_loop()
- reader = StreamReader(limit=limit, loop=loop)
- protocol = StreamReaderProtocol(reader, loop=loop)
+ reader = StreamReader(limit=limit, loop=loop,
+ _asyncio_internal=True)
+ protocol = StreamReaderProtocol(reader, loop=loop,
+ _asyncio_internal=True)
transport, _ = await loop.create_unix_connection(
lambda: protocol, path, **kwds)
- writer = StreamWriter(transport, protocol, reader, loop)
+ writer = StreamWriter(transport, protocol, reader, loop,
+ _asyncio_internal=True)
return reader, writer
async def start_unix_server(client_connected_cb, path=None, *,
loop = events.get_event_loop()
def factory():
- reader = StreamReader(limit=limit, loop=loop)
+ reader = StreamReader(limit=limit, loop=loop,
+ _asyncio_internal=True)
protocol = StreamReaderProtocol(reader, client_connected_cb,
- loop=loop)
+ loop=loop,
+ _asyncio_internal=True)
return protocol
return await loop.create_unix_server(factory, path, **kwds)
StreamWriter.drain() must wait for _drain_helper() coroutine.
"""
- def __init__(self, loop=None):
+ def __init__(self, loop=None, *, _asyncio_internal=False):
if loop is None:
self._loop = events.get_event_loop()
else:
self._loop = loop
+ if not _asyncio_internal:
+ # NOTE:
+ # Avoid inheritance from FlowControlMixin
+ # Copy-paste the code to your project
+ # if you need flow control helpers
+ warnings.warn(f"{self.__class__} should be instaniated "
+ "by asyncio internals only, "
+ "please avoid its creation from user code",
+ DeprecationWarning)
self._paused = False
self._drain_waiter = None
self._connection_lost = False
_source_traceback = None
- def __init__(self, stream_reader, client_connected_cb=None, loop=None):
- super().__init__(loop=loop)
+ def __init__(self, stream_reader, client_connected_cb=None, loop=None,
+ *, _asyncio_internal=False):
+ super().__init__(loop=loop, _asyncio_internal=_asyncio_internal)
if stream_reader is not None:
self._stream_reader_wr = weakref.ref(stream_reader,
self._on_reader_gc)
if self._client_connected_cb is not None:
self._stream_writer = StreamWriter(transport, self,
reader,
- self._loop)
+ self._loop,
+ _asyncio_internal=True)
res = self._client_connected_cb(reader,
self._stream_writer)
if coroutines.iscoroutine(res):
directly.
"""
- def __init__(self, transport, protocol, reader, loop):
+ def __init__(self, transport, protocol, reader, loop,
+ *, _asyncio_internal=False):
+ if not _asyncio_internal:
+ warnings.warn(f"{self.__class__} should be instaniated "
+ "by asyncio internals only, "
+ "please avoid its creation from user code",
+ DeprecationWarning)
self._transport = transport
self._protocol = protocol
# drain() expects that the reader has an exception() method
_source_traceback = None
- def __init__(self, limit=_DEFAULT_LIMIT, loop=None):
+ def __init__(self, limit=_DEFAULT_LIMIT, loop=None,
+ *, _asyncio_internal=False):
+ if not _asyncio_internal:
+ warnings.warn(f"{self.__class__} should be instaniated "
+ "by asyncio internals only, "
+ "please avoid its creation from user code",
+ DeprecationWarning)
+
# The line length limit is a security feature;
# it also doubles as half the buffer limit.
@mock.patch('asyncio.streams.events')
def test_ctor_global_loop(self, m_events):
- stream = asyncio.StreamReader()
+ stream = asyncio.StreamReader(_asyncio_internal=True)
self.assertIs(stream._loop, m_events.get_event_loop.return_value)
def _basetest_open_connection(self, open_connection_fut):
self._basetest_open_connection_error(conn_fut)
def test_feed_empty_data(self):
- stream = asyncio.StreamReader(loop=self.loop)
+ stream = asyncio.StreamReader(loop=self.loop,
+ _asyncio_internal=True)
stream.feed_data(b'')
self.assertEqual(b'', stream._buffer)
def test_feed_nonempty_data(self):
- stream = asyncio.StreamReader(loop=self.loop)
+ stream = asyncio.StreamReader(loop=self.loop,
+ _asyncio_internal=True)
stream.feed_data(self.DATA)
self.assertEqual(self.DATA, stream._buffer)
def test_read_zero(self):
# Read zero bytes.
- stream = asyncio.StreamReader(loop=self.loop)
+ stream = asyncio.StreamReader(loop=self.loop,
+ _asyncio_internal=True)
stream.feed_data(self.DATA)
data = self.loop.run_until_complete(stream.read(0))
def test_read(self):
# Read bytes.
- stream = asyncio.StreamReader(loop=self.loop)
+ stream = asyncio.StreamReader(loop=self.loop,
+ _asyncio_internal=True)
read_task = asyncio.Task(stream.read(30), loop=self.loop)
def cb():
def test_read_line_breaks(self):
# Read bytes without line breaks.
- stream = asyncio.StreamReader(loop=self.loop)
+ stream = asyncio.StreamReader(loop=self.loop,
+ _asyncio_internal=True)
stream.feed_data(b'line1')
stream.feed_data(b'line2')
def test_read_eof(self):
# Read bytes, stop at eof.
- stream = asyncio.StreamReader(loop=self.loop)
+ stream = asyncio.StreamReader(loop=self.loop,
+ _asyncio_internal=True)
read_task = asyncio.Task(stream.read(1024), loop=self.loop)
def cb():
def test_read_until_eof(self):
# Read all bytes until eof.
- stream = asyncio.StreamReader(loop=self.loop)
+ stream = asyncio.StreamReader(loop=self.loop,
+ _asyncio_internal=True)
read_task = asyncio.Task(stream.read(-1), loop=self.loop)
def cb():
self.assertEqual(b'', stream._buffer)
def test_read_exception(self):
- stream = asyncio.StreamReader(loop=self.loop)
+ stream = asyncio.StreamReader(loop=self.loop,
+ _asyncio_internal=True)
stream.feed_data(b'line\n')
data = self.loop.run_until_complete(stream.read(2))
def test_invalid_limit(self):
with self.assertRaisesRegex(ValueError, 'imit'):
- asyncio.StreamReader(limit=0, loop=self.loop)
+ asyncio.StreamReader(limit=0, loop=self.loop,
+ _asyncio_internal=True)
with self.assertRaisesRegex(ValueError, 'imit'):
- asyncio.StreamReader(limit=-1, loop=self.loop)
+ asyncio.StreamReader(limit=-1, loop=self.loop,
+ _asyncio_internal=True)
def test_read_limit(self):
- stream = asyncio.StreamReader(limit=3, loop=self.loop)
+ stream = asyncio.StreamReader(limit=3, loop=self.loop,
+ _asyncio_internal=True)
stream.feed_data(b'chunk')
data = self.loop.run_until_complete(stream.read(5))
self.assertEqual(b'chunk', data)
def test_readline(self):
# Read one line. 'readline' will need to wait for the data
# to come from 'cb'
- stream = asyncio.StreamReader(loop=self.loop)
+ stream = asyncio.StreamReader(loop=self.loop,
+ _asyncio_internal=True)
stream.feed_data(b'chunk1 ')
read_task = asyncio.Task(stream.readline(), loop=self.loop)
# Read one line. The data is in StreamReader's buffer
# before the event loop is run.
- stream = asyncio.StreamReader(limit=3, loop=self.loop)
+ stream = asyncio.StreamReader(limit=3, loop=self.loop,
+ _asyncio_internal=True)
stream.feed_data(b'li')
stream.feed_data(b'ne1\nline2\n')
# The buffer should contain the remaining data after exception
self.assertEqual(b'line2\n', stream._buffer)
- stream = asyncio.StreamReader(limit=3, loop=self.loop)
+ stream = asyncio.StreamReader(limit=3, loop=self.loop,
+ _asyncio_internal=True)
stream.feed_data(b'li')
stream.feed_data(b'ne1')
stream.feed_data(b'li')
self.assertEqual(b'', stream._buffer)
def test_at_eof(self):
- stream = asyncio.StreamReader(loop=self.loop)
+ stream = asyncio.StreamReader(loop=self.loop,
+ _asyncio_internal=True)
self.assertFalse(stream.at_eof())
stream.feed_data(b'some data\n')
# Read one line. StreamReaders are fed with data after
# their 'readline' methods are called.
- stream = asyncio.StreamReader(limit=7, loop=self.loop)
+ stream = asyncio.StreamReader(limit=7, loop=self.loop,
+ _asyncio_internal=True)
def cb():
stream.feed_data(b'chunk1')
stream.feed_data(b'chunk2')
# a ValueError it should be empty.
self.assertEqual(b'', stream._buffer)
- stream = asyncio.StreamReader(limit=7, loop=self.loop)
+ stream = asyncio.StreamReader(limit=7, loop=self.loop,
+ _asyncio_internal=True)
def cb():
stream.feed_data(b'chunk1')
stream.feed_data(b'chunk2\n')
self.assertEqual(b'chunk3\n', stream._buffer)
# check strictness of the limit
- stream = asyncio.StreamReader(limit=7, loop=self.loop)
+ stream = asyncio.StreamReader(limit=7, loop=self.loop,
+ _asyncio_internal=True)
stream.feed_data(b'1234567\n')
line = self.loop.run_until_complete(stream.readline())
self.assertEqual(b'1234567\n', line)
def test_readline_nolimit_nowait(self):
# All needed data for the first 'readline' call will be
# in the buffer.
- stream = asyncio.StreamReader(loop=self.loop)
+ stream = asyncio.StreamReader(loop=self.loop,
+ _asyncio_internal=True)
stream.feed_data(self.DATA[:6])
stream.feed_data(self.DATA[6:])
self.assertEqual(b'line2\nline3\n', stream._buffer)
def test_readline_eof(self):
- stream = asyncio.StreamReader(loop=self.loop)
+ stream = asyncio.StreamReader(loop=self.loop,
+ _asyncio_internal=True)
stream.feed_data(b'some data')
stream.feed_eof()
self.assertEqual(b'some data', line)
def test_readline_empty_eof(self):
- stream = asyncio.StreamReader(loop=self.loop)
+ stream = asyncio.StreamReader(loop=self.loop,
+ _asyncio_internal=True)
stream.feed_eof()
line = self.loop.run_until_complete(stream.readline())
self.assertEqual(b'', line)
def test_readline_read_byte_count(self):
- stream = asyncio.StreamReader(loop=self.loop)
+ stream = asyncio.StreamReader(loop=self.loop,
+ _asyncio_internal=True)
stream.feed_data(self.DATA)
self.loop.run_until_complete(stream.readline())
self.assertEqual(b'ine3\n', stream._buffer)
def test_readline_exception(self):
- stream = asyncio.StreamReader(loop=self.loop)
+ stream = asyncio.StreamReader(loop=self.loop,
+ _asyncio_internal=True)
stream.feed_data(b'line\n')
data = self.loop.run_until_complete(stream.readline())
self.assertEqual(b'', stream._buffer)
def test_readuntil_separator(self):
- stream = asyncio.StreamReader(loop=self.loop)
+ stream = asyncio.StreamReader(loop=self.loop,
+ _asyncio_internal=True)
with self.assertRaisesRegex(ValueError, 'Separator should be'):
self.loop.run_until_complete(stream.readuntil(separator=b''))
def test_readuntil_multi_chunks(self):
- stream = asyncio.StreamReader(loop=self.loop)
+ stream = asyncio.StreamReader(loop=self.loop,
+ _asyncio_internal=True)
stream.feed_data(b'lineAAA')
data = self.loop.run_until_complete(stream.readuntil(separator=b'AAA'))
self.assertEqual(b'xxx', stream._buffer)
def test_readuntil_multi_chunks_1(self):
- stream = asyncio.StreamReader(loop=self.loop)
+ stream = asyncio.StreamReader(loop=self.loop,
+ _asyncio_internal=True)
stream.feed_data(b'QWEaa')
stream.feed_data(b'XYaa')
self.assertEqual(b'', stream._buffer)
def test_readuntil_eof(self):
- stream = asyncio.StreamReader(loop=self.loop)
+ stream = asyncio.StreamReader(loop=self.loop,
+ _asyncio_internal=True)
stream.feed_data(b'some dataAA')
stream.feed_eof()
self.assertEqual(b'', stream._buffer)
def test_readuntil_limit_found_sep(self):
- stream = asyncio.StreamReader(loop=self.loop, limit=3)
+ stream = asyncio.StreamReader(loop=self.loop, limit=3,
+ _asyncio_internal=True)
stream.feed_data(b'some dataAA')
with self.assertRaisesRegex(asyncio.LimitOverrunError,
def test_readexactly_zero_or_less(self):
# Read exact number of bytes (zero or less).
- stream = asyncio.StreamReader(loop=self.loop)
+ stream = asyncio.StreamReader(loop=self.loop,
+ _asyncio_internal=True)
stream.feed_data(self.DATA)
data = self.loop.run_until_complete(stream.readexactly(0))
def test_readexactly(self):
# Read exact number of bytes.
- stream = asyncio.StreamReader(loop=self.loop)
+ stream = asyncio.StreamReader(loop=self.loop,
+ _asyncio_internal=True)
n = 2 * len(self.DATA)
read_task = asyncio.Task(stream.readexactly(n), loop=self.loop)
self.assertEqual(self.DATA, stream._buffer)
def test_readexactly_limit(self):
- stream = asyncio.StreamReader(limit=3, loop=self.loop)
+ stream = asyncio.StreamReader(limit=3, loop=self.loop,
+ _asyncio_internal=True)
stream.feed_data(b'chunk')
data = self.loop.run_until_complete(stream.readexactly(5))
self.assertEqual(b'chunk', data)
def test_readexactly_eof(self):
# Read exact number of bytes (eof).
- stream = asyncio.StreamReader(loop=self.loop)
+ stream = asyncio.StreamReader(loop=self.loop,
+ _asyncio_internal=True)
n = 2 * len(self.DATA)
read_task = asyncio.Task(stream.readexactly(n), loop=self.loop)
self.assertEqual(b'', stream._buffer)
def test_readexactly_exception(self):
- stream = asyncio.StreamReader(loop=self.loop)
+ stream = asyncio.StreamReader(loop=self.loop,
+ _asyncio_internal=True)
stream.feed_data(b'line\n')
data = self.loop.run_until_complete(stream.readexactly(2))
ValueError, self.loop.run_until_complete, stream.readexactly(2))
def test_exception(self):
- stream = asyncio.StreamReader(loop=self.loop)
+ stream = asyncio.StreamReader(loop=self.loop,
+ _asyncio_internal=True)
self.assertIsNone(stream.exception())
exc = ValueError()
self.assertIs(stream.exception(), exc)
def test_exception_waiter(self):
- stream = asyncio.StreamReader(loop=self.loop)
+ stream = asyncio.StreamReader(loop=self.loop,
+ _asyncio_internal=True)
@asyncio.coroutine
def set_err():
self.assertRaises(ValueError, t1.result)
def test_exception_cancel(self):
- stream = asyncio.StreamReader(loop=self.loop)
+ stream = asyncio.StreamReader(loop=self.loop,
+ _asyncio_internal=True)
t = asyncio.Task(stream.readline(), loop=self.loop)
test_utils.run_briefly(self.loop)
args = [sys.executable, '-c', code, str(wfd)]
pipe = open(rfd, 'rb', 0)
- reader = asyncio.StreamReader(loop=self.loop, limit=1)
- protocol = asyncio.StreamReaderProtocol(reader, loop=self.loop)
+ reader = asyncio.StreamReader(loop=self.loop, limit=1,
+ _asyncio_internal=True)
+ protocol = asyncio.StreamReaderProtocol(reader, loop=self.loop,
+ _asyncio_internal=True)
transport, _ = self.loop.run_until_complete(
self.loop.connect_read_pipe(lambda: protocol, pipe))
# asyncio issue #184: Ensure that StreamReaderProtocol constructor
# retrieves the current loop if the loop parameter is not set
- reader = asyncio.StreamReader()
+ reader = asyncio.StreamReader(_asyncio_internal=True)
self.assertIs(reader._loop, self.loop)
def test_streamreaderprotocol_constructor(self):
# asyncio issue #184: Ensure that StreamReaderProtocol constructor
# retrieves the current loop if the loop parameter is not set
reader = mock.Mock()
- protocol = asyncio.StreamReaderProtocol(reader)
+ protocol = asyncio.StreamReaderProtocol(reader, _asyncio_internal=True)
self.assertIs(protocol._loop, self.loop)
def test_drain_raises(self):
thread.join()
def test___repr__(self):
- stream = asyncio.StreamReader(loop=self.loop)
+ stream = asyncio.StreamReader(loop=self.loop,
+ _asyncio_internal=True)
self.assertEqual("<StreamReader>", repr(stream))
def test___repr__nondefault_limit(self):
- stream = asyncio.StreamReader(loop=self.loop, limit=123)
+ stream = asyncio.StreamReader(loop=self.loop, limit=123,
+ _asyncio_internal=True)
self.assertEqual("<StreamReader limit=123>", repr(stream))
def test___repr__eof(self):
- stream = asyncio.StreamReader(loop=self.loop)
+ stream = asyncio.StreamReader(loop=self.loop,
+ _asyncio_internal=True)
stream.feed_eof()
self.assertEqual("<StreamReader eof>", repr(stream))
def test___repr__data(self):
- stream = asyncio.StreamReader(loop=self.loop)
+ stream = asyncio.StreamReader(loop=self.loop,
+ _asyncio_internal=True)
stream.feed_data(b'data')
self.assertEqual("<StreamReader 4 bytes>", repr(stream))
def test___repr__exception(self):
- stream = asyncio.StreamReader(loop=self.loop)
+ stream = asyncio.StreamReader(loop=self.loop,
+ _asyncio_internal=True)
exc = RuntimeError()
stream.set_exception(exc)
self.assertEqual("<StreamReader exception=RuntimeError()>",
repr(stream))
def test___repr__waiter(self):
- stream = asyncio.StreamReader(loop=self.loop)
+ stream = asyncio.StreamReader(loop=self.loop,
+ _asyncio_internal=True)
stream._waiter = asyncio.Future(loop=self.loop)
self.assertRegex(
repr(stream),
self.assertEqual("<StreamReader>", repr(stream))
def test___repr__transport(self):
- stream = asyncio.StreamReader(loop=self.loop)
+ stream = asyncio.StreamReader(loop=self.loop,
+ _asyncio_internal=True)
stream._transport = mock.Mock()
stream._transport.__repr__ = mock.Mock()
stream._transport.__repr__.return_value = "<Transport>"
self.loop.set_exception_handler(lambda loop, ctx: messages.append(ctx))
with test_utils.run_test_server() as httpd:
- rd = asyncio.StreamReader(loop=self.loop)
- pr = asyncio.StreamReaderProtocol(rd, loop=self.loop)
+ rd = asyncio.StreamReader(loop=self.loop,
+ _asyncio_internal=True)
+ pr = asyncio.StreamReaderProtocol(rd, loop=self.loop,
+ _asyncio_internal=True)
del rd
gc.collect()
tr, _ = self.loop.run_until_complete(
self.assertEqual(messages, [])
+ def test_stream_reader_create_warning(self):
+ with self.assertWarns(DeprecationWarning):
+ asyncio.StreamReader(loop=self.loop)
+
+ def test_stream_reader_protocol_create_warning(self):
+ reader = asyncio.StreamReader(loop=self.loop,
+ _asyncio_internal=True)
+ with self.assertWarns(DeprecationWarning):
+ asyncio.StreamReaderProtocol(reader, loop=self.loop)
+
+ def test_stream_writer_create_warning(self):
+ reader = asyncio.StreamReader(loop=self.loop,
+ _asyncio_internal=True)
+ proto = asyncio.StreamReaderProtocol(reader, loop=self.loop,
+ _asyncio_internal=True)
+ with self.assertWarns(DeprecationWarning):
+ asyncio.StreamWriter('transport', proto, reader, self.loop)
+
+
if __name__ == '__main__':
unittest.main()