gh-121423: Improve import time of socket by writing socket.errorTab as a constant and lazy import modules #121424
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
Filter by extension
Viewed files
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| Expand Up | @@ -52,7 +52,9 @@ | |
| import _socket | ||
| from _socket import * | ||
|
|
||
| import io | ||
| import os | ||
| import sys | ||
| from enum import IntEnum, IntFlag | ||
|
|
||
| try: | ||
| Expand Down Expand Up | @@ -110,102 +112,103 @@ def _intenum_converter(value, enum_klass): | |
|
|
||
| # WSA error codes | ||
| if sys.platform.lower().startswith("win"): | ||
| errorTab = { | ||
| 6: "Specified event object handle is invalid.", | ||
| 8: "Insufficient memory available.", | ||
| 87: "One or more parameters are invalid.", | ||
| 995: "Overlapped operation aborted.", | ||
| 996: "Overlapped I/O event object not in signaled state.", | ||
| 997: "Overlapped operation will complete later.", | ||
| 10004: "The operation was interrupted.", | ||
| 10009: "A bad file handle was passed.", | ||
| 10013: "Permission denied.", | ||
| 10014: "A fault occurred on the network??", | ||
| 10022: "An invalid operation was attempted.", | ||
| 10024: "Too many open files.", | ||
| 10035: "The socket operation would block.", | ||
| 10036: "A blocking operation is already in progress.", | ||
| 10037: "Operation already in progress.", | ||
| 10038: "Socket operation on nonsocket.", | ||
| 10039: "Destination address required.", | ||
| 10040: "Message too long.", | ||
| 10041: "Protocol wrong type for socket.", | ||
| 10042: "Bad protocol option.", | ||
| 10043: "Protocol not supported.", | ||
| 10044: "Socket type not supported.", | ||
| 10045: "Operation not supported.", | ||
| 10046: "Protocol family not supported.", | ||
| 10047: "Address family not supported by protocol family.", | ||
| 10048: "The network address is in use.", | ||
| 10049: "Cannot assign requested address.", | ||
| 10050: "Network is down.", | ||
| 10051: "Network is unreachable.", | ||
| 10052: "Network dropped connection on reset.", | ||
| 10053: "Software caused connection abort.", | ||
| 10054: "The connection has been reset.", | ||
| 10055: "No buffer space available.", | ||
| 10056: "Socket is already connected.", | ||
| 10057: "Socket is not connected.", | ||
| 10058: "The network has been shut down.", | ||
| 10059: "Too many references.", | ||
| 10060: "The operation timed out.", | ||
| 10061: "Connection refused.", | ||
| 10062: "Cannot translate name.", | ||
| 10063: "The name is too long.", | ||
| 10064: "The host is down.", | ||
| 10065: "The host is unreachable.", | ||
| 10066: "Directory not empty.", | ||
| 10067: "Too many processes.", | ||
| 10068: "User quota exceeded.", | ||
| 10069: "Disk quota exceeded.", | ||
| 10070: "Stale file handle reference.", | ||
| 10071: "Item is remote.", | ||
| 10091: "Network subsystem is unavailable.", | ||
| 10092: "Winsock.dll version out of range.", | ||
| 10093: "Successful WSAStartup not yet performed.", | ||
| 10101: "Graceful shutdown in progress.", | ||
| 10102: "No more results from WSALookupServiceNext.", | ||
| 10103: "Call has been canceled.", | ||
| 10104: "Procedure call table is invalid.", | ||
| 10105: "Service provider is invalid.", | ||
| 10106: "Service provider failed to initialize.", | ||
| 10107: "System call failure.", | ||
| 10108: "Service not found.", | ||
| 10109: "Class type not found.", | ||
| 10110: "No more results from WSALookupServiceNext.", | ||
| 10111: "Call was canceled.", | ||
| 10112: "Database query was refused.", | ||
| 11001: "Host not found.", | ||
| 11002: "Nonauthoritative host not found.", | ||
| 11003: "This is a nonrecoverable error.", | ||
| 11004: "Valid name, no data record requested type.", | ||
| 11005: "QoS receivers.", | ||
| 11006: "QoS senders.", | ||
| 11007: "No QoS senders.", | ||
| 11008: "QoS no receivers.", | ||
| 11009: "QoS request confirmed.", | ||
| 11010: "QoS admission error.", | ||
| 11011: "QoS policy failure.", | ||
| 11012: "QoS bad style.", | ||
| 11013: "QoS bad object.", | ||
| 11014: "QoS traffic control error.", | ||
| 11015: "QoS generic error.", | ||
| 11016: "QoS service type error.", | ||
| 11017: "QoS flowspec error.", | ||
| 11018: "Invalid QoS provider buffer.", | ||
| 11019: "Invalid QoS filter style.", | ||
| 11020: "Invalid QoS filter style.", | ||
| 11021: "Incorrect QoS filter count.", | ||
| 11022: "Invalid QoS object length.", | ||
| 11023: "Incorrect QoS flow count.", | ||
| 11024: "Unrecognized QoS object.", | ||
| 11025: "Invalid QoS policy object.", | ||
| 11026: "Invalid QoS flow descriptor.", | ||
| 11027: "Invalid QoS provider-specific flowspec.", | ||
| 11028: "Invalid QoS provider-specific filterspec.", | ||
| 11029: "Invalid QoS shape discard mode object.", | ||
| 11030: "Invalid QoS shaping rate object.", | ||
| 11031: "Reserved policy QoS element type." | ||
| } | ||
| __all__.append("errorTab") | ||
|
|
||
|
|
||
| Expand Down Expand Up | @@ -348,6 +351,9 @@ def makefile(self, mode="r", buffering=None, *, | |
| if hasattr(os, 'sendfile'): | ||
|
|
||
| def _sendfile_use_sendfile(self, file, offset=0, count=None): | ||
| # Lazy import to improve module import time | ||
| import selectors | ||
|
Comment thread
Copy link
Copy Markdown
Member
There was a problem hiding this comment. I suggest to use a global variable to avoid the import at each call: global selectors
if selectors is None:
import selectorsYou can define the selectors variable to None at the top of the file with a comment: # module imported lazily
selectors = None
Sorry, something went wrong.
Copy link
Copy Markdown
Contributor
There was a problem hiding this comment. I checked several recent PRs making module loading lazy, but most of them do not use the pattern with a global variable (I suspect for readability reasons). @vstinner Are there any other reasons besides the small performance improvement for using the global variable?
Sorry, something went wrong.
Copy link
Copy Markdown
Member
There was a problem hiding this comment. @serhiy-storchaka: Do you think that it's still useful in 2024 to use a global variable to avoid import selectors at each function call?
Sorry, something went wrong.
Copy link
Copy Markdown
Member
There was a problem hiding this comment. I'd just do the import. It's a mere dict lookup without a conditional when the import has already happened.
Sorry, something went wrong.
Copy link
Copy Markdown
Member
There was a problem hiding this comment. Just measure. It is more than a mere dict lookup (we also need to check that the module is not partially initialized, this adds 2 more dict lookups or like). In this case, I think that the difference may be small even in comparison with a single os.fstat() call. The idiom proposed by @vstinner may be used when the whole function is very fast.
Sorry, something went wrong. |
||
|
|
||
| self._check_sendfile_params(file, offset, count) | ||
| sockno = self.fileno() | ||
| try: | ||
| Expand Down Expand Up | @@ -549,27 +555,27 @@ def fromfd(fd, family, type, proto=0): | |
| return socket(family, type, proto, nfd) | ||
|
|
||
| if hasattr(_socket.socket, "sendmsg"): | ||
| def send_fds(sock, buffers, fds, flags=0, address=None): | ||
| """ send_fds(sock, buffers, fds[, flags[, address]]) -> integer | ||
|
|
||
| Send the list of file descriptors fds over an AF_UNIX socket. | ||
| """ | ||
| import array | ||
|
|
||
| return sock.sendmsg(buffers, [(_socket.SOL_SOCKET, | ||
| _socket.SCM_RIGHTS, array.array("i", fds))]) | ||
| __all__.append("send_fds") | ||
|
|
||
| if hasattr(_socket.socket, "recvmsg"): | ||
| def recv_fds(sock, bufsize, maxfds, flags=0): | ||
| """ recv_fds(sock, bufsize, maxfds[, flags]) -> (data, list of file | ||
| descriptors, msg_flags, address) | ||
|
|
||
| Receive up to maxfds file descriptors returning the message | ||
| data and a list containing the descriptors. | ||
| """ | ||
| import array | ||
|
|
||
| # Array of ints | ||
| fds = array.array("i") | ||
| msg, ancdata, flags, addr = sock.recvmsg(bufsize, | ||
| Expand Down | ||
|
Comment thread
Copy link
Copy Markdown
Member
There was a problem hiding this comment. Please rename to Misc/NEWS.d/next/Library/2024-07-06-12-37-10.gh-issue-118761.vnxrl4.rst (containing gh-issue-118761) and we're ready to merge :)
Sorry, something went wrong.
Copy link
Copy Markdown
Member
There was a problem hiding this comment. #121423 is the right issue.
Sorry, something went wrong. |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| Improve import time of :mod:`socket` by lazy importing modules and | ||
| writing :data:`!socket.errorTab` as a constant. |
Uh oh!
There was an error while loading. Please reload this page.