bpo-38066: Hide internal Stream methods (GH-15762)
feed_eof(), feed_data(), set_exception(), and set_transport() are prefixed with underscore now.
https://bugs.python.org/issue38066
(cherry picked from commit 12c122ae958a55c9874ed4c7d7805ceb084411d7)
Co-authored-by: Andrew Svetlov <andrew.svetlov@gmail.com>
diff --git a/Lib/asyncio/streams.py b/Lib/asyncio/streams.py
index 1d3e487..01aa6ff 100644
--- a/Lib/asyncio/streams.py
+++ b/Lib/asyncio/streams.py
@@ -1133,9 +1133,9 @@
stream = self._stream
if stream is not None:
if exc is None:
- stream.feed_eof()
+ stream._feed_eof()
else:
- stream.set_exception(exc)
+ stream._set_exception(exc)
if not self._closed.done():
if exc is None:
self._closed.set_result(None)
@@ -1147,12 +1147,12 @@
def data_received(self, data):
stream = self._stream
if stream is not None:
- stream.feed_data(data)
+ stream._feed_data(data)
def eof_received(self):
stream = self._stream
if stream is not None:
- stream.feed_eof()
+ stream._feed_eof()
if self._over_ssl:
# Prevent a warning in SSLProtocol.eof_received:
# "returning true from eof_received()
@@ -1219,7 +1219,7 @@
stream = self._stream
if stream is None:
return
- stream.set_transport(transport)
+ stream._set_transport(transport)
stream._protocol = self
def connection_lost(self, exc):
@@ -1351,6 +1351,11 @@
@property
def transport(self):
+ warnings.warn("Stream.transport attribute is deprecated "
+ "since Python 3.8 and is scheduled for removal in 3.10; "
+ "it is an internal API",
+ DeprecationWarning,
+ stacklevel=2)
return self._transport
def write(self, data):
@@ -1366,7 +1371,7 @@
def _fast_drain(self):
# The helper tries to use fast-path to return already existing
# complete future object if underlying transport is not paused
- #and actual waiting for writing resume is not needed
+ # and actual waiting for writing resume is not needed
exc = self.exception()
if exc is not None:
fut = self._loop.create_future()
@@ -1450,6 +1455,14 @@
return self._exception
def set_exception(self, exc):
+ warnings.warn("Stream.set_exception() is deprecated "
+ "since Python 3.8 and is scheduled for removal in 3.10; "
+ "it is an internal API",
+ DeprecationWarning,
+ stacklevel=2)
+ self._set_exception(exc)
+
+ def _set_exception(self, exc):
self._exception = exc
waiter = self._waiter
@@ -1467,6 +1480,14 @@
waiter.set_result(None)
def set_transport(self, transport):
+ warnings.warn("Stream.set_transport() is deprecated "
+ "since Python 3.8 and is scheduled for removal in 3.10; "
+ "it is an internal API",
+ DeprecationWarning,
+ stacklevel=2)
+ self._set_transport(transport)
+
+ def _set_transport(self, transport):
if transport is self._transport:
return
assert self._transport is None, 'Transport already set'
@@ -1478,6 +1499,14 @@
self._transport.resume_reading()
def feed_eof(self):
+ warnings.warn("Stream.feed_eof() is deprecated "
+ "since Python 3.8 and is scheduled for removal in 3.10; "
+ "it is an internal API",
+ DeprecationWarning,
+ stacklevel=2)
+ self._feed_eof()
+
+ def _feed_eof(self):
self._eof = True
self._wakeup_waiter()
@@ -1486,6 +1515,14 @@
return self._eof and not self._buffer
def feed_data(self, data):
+ warnings.warn("Stream.feed_data() is deprecated "
+ "since Python 3.8 and is scheduled for removal in 3.10; "
+ "it is an internal API",
+ DeprecationWarning,
+ stacklevel=2)
+ self._feed_data(data)
+
+ def _feed_data(self, data):
_ensure_can_read(self._mode)
assert not self._eof, 'feed_data after feed_eof'
diff --git a/Lib/asyncio/subprocess.py b/Lib/asyncio/subprocess.py
index e6bec71..e6c1c8b 100644
--- a/Lib/asyncio/subprocess.py
+++ b/Lib/asyncio/subprocess.py
@@ -50,7 +50,7 @@
limit=self._limit,
loop=self._loop,
_asyncio_internal=True)
- self.stdout.set_transport(stdout_transport)
+ self.stdout._set_transport(stdout_transport)
self._pipe_fds.append(1)
stderr_transport = transport.get_pipe_transport(2)
@@ -61,7 +61,7 @@
limit=self._limit,
loop=self._loop,
_asyncio_internal=True)
- self.stderr.set_transport(stderr_transport)
+ self.stderr._set_transport(stderr_transport)
self._pipe_fds.append(2)
stdin_transport = transport.get_pipe_transport(0)
@@ -80,7 +80,7 @@
else:
reader = None
if reader is not None:
- reader.feed_data(data)
+ reader._feed_data(data)
def pipe_connection_lost(self, fd, exc):
if fd == 0:
@@ -101,9 +101,9 @@
reader = None
if reader is not None:
if exc is None:
- reader.feed_eof()
+ reader._feed_eof()
else:
- reader.set_exception(exc)
+ reader._set_exception(exc)
if fd in self._pipe_fds:
self._pipe_fds.remove(fd)