-
-
Notifications
You must be signed in to change notification settings - Fork 34.5k
bpo-37027: Return a proxy socket object from transp.get_extra_info('socket') #13530
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.
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
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,206 @@ | ||
| import socket | ||
| import warnings | ||
|
|
||
|
|
||
| class TransportSocket: | ||
|
|
||
| """A socket-like wrapper for exposing real transport sockets. | ||
|
|
||
| These objects can be safely returned by APIs like | ||
| `transport.get_extra_info('socket')`. All potentially disruptive | ||
| operations (like "socket.close()") are banned. | ||
| """ | ||
|
|
||
| __slots__ = ('_sock',) | ||
|
|
||
| def __init__(self, sock: socket.socket): | ||
| self._sock = sock | ||
|
|
||
| def _na(self, what): | ||
| warnings.warn( | ||
| f"Using {what} on sockets returned from get_extra_info('socket') " | ||
| f"will be prohibited in asyncio 3.9. Please report your use case " | ||
| f"to bugs.python.org.", | ||
| DeprecationWarning, source=self) | ||
|
|
||
| @property | ||
| def family(self): | ||
| return self._sock.family | ||
|
|
||
| @property | ||
| def type(self): | ||
| return self._sock.type | ||
|
|
||
| @property | ||
| def proto(self): | ||
| return self._sock.proto | ||
|
|
||
| def __repr__(self): | ||
| s = ( | ||
| f"<asyncio.TransportSocket fd={self.fileno()}, " | ||
| f"family={self.family!s}, type={self.type!s}, " | ||
| f"proto={self.proto}" | ||
| ) | ||
|
|
||
| if self.fileno() != -1: | ||
| try: | ||
| laddr = self.getsockname() | ||
| if laddr: | ||
| s = f"{s}, laddr={laddr}" | ||
| except socket.error: | ||
| pass | ||
| try: | ||
| raddr = self.getpeername() | ||
| if raddr: | ||
| s = f"{s}, raddr={raddr}" | ||
| except socket.error: | ||
| pass | ||
|
|
||
| return f"{s}>" | ||
|
|
||
| def __getstate__(self): | ||
| raise TypeError("Cannot serialize asyncio.TransportSocket object") | ||
|
|
||
| def fileno(self): | ||
| return self._sock.fileno() | ||
|
|
||
| def dup(self): | ||
| return self._sock.dup() | ||
|
|
||
| def get_inheritable(self): | ||
| return self._sock.get_inheritable() | ||
|
|
||
| def shutdown(self, how): | ||
| # asyncio doesn't currently provide a high-level transport API | ||
| # to shutdown the connection. | ||
| self._sock.shutdown(how) | ||
|
|
||
| def getsockopt(self, *args, **kwargs): | ||
| return self._sock.getsockopt(*args, **kwargs) | ||
|
|
||
| def setsockopt(self, *args, **kwargs): | ||
| self._sock.setsockopt(*args, **kwargs) | ||
|
|
||
| def getpeername(self): | ||
| return self._sock.getpeername() | ||
|
|
||
| def getsockname(self): | ||
| return self._sock.getsockname() | ||
|
|
||
| def getsockbyname(self): | ||
| return self._sock.getsockbyname() | ||
|
|
||
| def accept(self): | ||
| self._na('accept() method') | ||
| return self._sock.accept() | ||
|
|
||
| def connect(self, *args, **kwargs): | ||
| self._na('connect() method') | ||
| return self._sock.connect(*args, **kwargs) | ||
|
|
||
| def connect_ex(self, *args, **kwargs): | ||
| self._na('connect_ex() method') | ||
| return self._sock.connect_ex(*args, **kwargs) | ||
|
|
||
| def bind(self, *args, **kwargs): | ||
| self._na('bind() method') | ||
| return self._sock.bind(*args, **kwargs) | ||
|
|
||
| def ioctl(self, *args, **kwargs): | ||
| self._na('ioctl() method') | ||
| return self._sock.ioctl(*args, **kwargs) | ||
|
|
||
| def listen(self, *args, **kwargs): | ||
| self._na('listen() method') | ||
| return self._sock.listen(*args, **kwargs) | ||
|
|
||
| def makefile(self): | ||
| self._na('makefile() method') | ||
| return self._sock.makefile() | ||
|
|
||
| def sendfile(self, *args, **kwargs): | ||
| self._na('sendfile() method') | ||
| return self._sock.sendfile(*args, **kwargs) | ||
|
|
||
| def close(self): | ||
| self._na('close() method') | ||
| return self._sock.close() | ||
|
|
||
| def detach(self): | ||
| self._na('detach() method') | ||
| return self._sock.detach() | ||
|
|
||
| def sendmsg_afalg(self, *args, **kwargs): | ||
| self._na('sendmsg_afalg() method') | ||
| return self._sock.sendmsg_afalg(*args, **kwargs) | ||
|
|
||
| def sendmsg(self, *args, **kwargs): | ||
| self._na('sendmsg() method') | ||
| return self._sock.sendmsg(*args, **kwargs) | ||
|
|
||
| def sendto(self, *args, **kwargs): | ||
| self._na('sendto() method') | ||
| return self._sock.sendto(*args, **kwargs) | ||
|
|
||
| def send(self, *args, **kwargs): | ||
| self._na('send() method') | ||
| return self._sock.send(*args, **kwargs) | ||
|
|
||
| def sendall(self, *args, **kwargs): | ||
| self._na('sendall() method') | ||
| return self._sock.sendall(*args, **kwargs) | ||
|
|
||
| def set_inheritable(self, *args, **kwargs): | ||
| self._na('set_inheritable() method') | ||
| return self._sock.set_inheritable(*args, **kwargs) | ||
|
|
||
| def share(self, process_id): | ||
| self._na('share() method') | ||
| return self._sock.share(process_id) | ||
|
|
||
| def recv_into(self, *args, **kwargs): | ||
| self._na('recv_into() method') | ||
| return self._sock.recv_into(*args, **kwargs) | ||
|
|
||
| def recvfrom_into(self, *args, **kwargs): | ||
| self._na('recvfrom_into() method') | ||
| return self._sock.recvfrom_into(*args, **kwargs) | ||
|
|
||
| def recvmsg_into(self, *args, **kwargs): | ||
| self._na('recvmsg_into() method') | ||
| return self._sock.recvmsg_into(*args, **kwargs) | ||
|
|
||
| def recvmsg(self, *args, **kwargs): | ||
| self._na('recvmsg() method') | ||
| return self._sock.recvmsg(*args, **kwargs) | ||
|
|
||
| def recvfrom(self, *args, **kwargs): | ||
| self._na('recvfrom() method') | ||
| return self._sock.recvfrom(*args, **kwargs) | ||
|
|
||
| def recv(self, *args, **kwargs): | ||
| self._na('recv() method') | ||
| return self._sock.recv(*args, **kwargs) | ||
|
|
||
| def settimeout(self, value): | ||
| if value == 0: | ||
| return | ||
| raise ValueError( | ||
| 'settimeout(): only 0 timeout is allowed on transport sockets') | ||
|
|
||
| def gettimeout(self): | ||
| return 0 | ||
|
|
||
| def setblocking(self, flag): | ||
| if not flag: | ||
| return | ||
| raise ValueError( | ||
| 'setblocking(): transport sockets cannot be blocking') | ||
|
|
||
| def __enter__(self): | ||
| self._na('context manager protocol') | ||
| return self._sock.__enter__() | ||
|
|
||
| def __exit__(self, *err): | ||
| self._na('context manager protocol') | ||
| return self._sock.__exit__(*err) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 2 additions & 0 deletions
2
Misc/NEWS.d/next/Library/2019-05-23-18-46-56.bpo-37027.iH4eut.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| Return safe to use proxy socket object from | ||
| transport.get_extra_info('socket') |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Technically there is
transport.write_eof()for closing writing.There is no API for closing reading though.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, and I know some people use
sock.shutdownfor that. Should we add an API to transports?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe, to make the transition to new Python smoother.
Not urgent, though. Minor thing.