Skip to content

bpo-38066: Hide internal Stream methods #15762

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
miss-islington merged 4 commits into from
Sep 10, 2019
Merged

bpo-38066: Hide internal Stream methods #15762

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
90bed4a
bpo-38066: Hide internal Stream methods
asvetlov Sep 9, 2019
341bc82
Deprecate legacy methods
asvetlov Sep 9, 2019
fb28c62
Restore missing .set_exception()
asvetlov Sep 9, 2019
8d46f6b
Fix grammar
asvetlov Sep 10, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 43 additions & 6 deletions Lib/asyncio/streams.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1133,9 +1133,9 @@ def connection_lost(self, exc):
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)
Expand All @@ -1147,12 +1147,12 @@ def connection_lost(self, exc):
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()
Expand Down Expand Up @@ -1219,7 +1219,7 @@ def connection_made(self, transport):
stream = self._stream
if stream is None:
return
stream.set_transport(transport)
stream._set_transport(transport)
stream._protocol = self

def connection_lost(self, exc):
Expand Down Expand Up @@ -1351,6 +1351,11 @@ def is_server_side(self):

@property
def transport(self):
warnings.warn("Stream.transport attribute is deprecated "

@asvetlov asvetlov Sep 9, 2019 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

asyncio itself never uses this property, there is no need for readonly internal API version

"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):
Expand All @@ -1366,7 +1371,7 @@ def writelines(self, data):
def _fast_drain(self):
# The helper tries to use fast-path to return already existing
# complete future object if underlying transport is not paused

@aeros aeros Sep 10, 2019 •
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unrelated to the PR, but could make a minor grammar fix here? I could make further suggestions to the phrasing of the code comments for this method, but I figured this suggestion would be easier and uncontroversial.

Suggested change
# complete future object if underlying transport is not paused
# complete future object if the underlying transport is not paused

@asvetlov asvetlov Sep 10, 2019

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fast drain works with the single object, not multiple ones.

@aeros aeros Sep 10, 2019

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fast drain works with the single object, not multiple ones.

Oops, I'll adjust the suggestion.

#and actual waiting for writing resume is not needed
# and actual waiting for writing resume is not needed

@asvetlov asvetlov Sep 9, 2019

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's ok to fix this unrelated comment spacing here. Don't worth a separate PR

exc = self.exception()
if exc is not None:
fut = self._loop.create_future()
Expand Down Expand Up @@ -1450,6 +1455,14 @@ def exception(self):
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
Expand All @@ -1467,6 +1480,14 @@ def _wakeup_waiter(self):
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'
Expand All @@ -1478,6 +1499,14 @@ def _maybe_resume_transport(self):
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()

Expand All @@ -1486,6 +1515,14 @@ def at_eof(self):
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'

Expand Down
10 changes: 5 additions & 5 deletions Lib/asyncio/subprocess.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ def connection_made(self, transport):
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)
Expand All @@ -61,7 +61,7 @@ def connection_made(self, transport):
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)
Expand All @@ -80,7 +80,7 @@ def pipe_data_received(self, fd, data):
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:
Expand All @@ -101,9 +101,9 @@ def pipe_connection_lost(self, fd, exc):
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)
Expand Down
4 changes: 2 additions & 2 deletions Lib/test/test_asyncio/test_pep492.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,8 +96,8 @@ def test_readline(self):
stream = asyncio.Stream(mode=asyncio.StreamMode.READ,
loop=self.loop,
_asyncio_internal=True)
stream.feed_data(DATA)
stream.feed_eof()
stream._feed_data(DATA)
stream._feed_eof()

async def reader():
data = []
Expand Down
Loading