cpython-lru_cache-weakref: Lib/socket.py annotate

annotate Lib/socket.py @ 51330:ca423008fa4a legacy-trunk

#5144: document that PySys_SetArgv prepends the script directory (or the empty string) to sys.path.

author	Georg Brandl <georg@python.org>
date	Thu, 05 Feb 2009 10:37:07 +0000
parents	65901ffffc6a
children	5b01fe513f92

rev	line source
14007 eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	1 # Wrapper module for _socket, providing some additional facilities
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	2 # implemented in Python.
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	3
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	4 """\
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	5 This module provides socket operations and some related functions.
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	6 On Unix, it supports IP (Internet Protocol) and Unix domain sockets.
15872 3685ef2a55a4 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 14935 diff changeset	7 On other systems, it only supports IP. Functions specific for a
14935 13488539f02b Mention in the module's doc string that other functions of the socket API Martin v. Löwis <martin@v.loewis.de> parents: 14682 diff changeset	8 socket are available as methods of the socket object.
14007 eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	9
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	10 Functions:
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	11
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	12 socket() -- create a new socket object
33063 90da70986407 Patch #1003700: Add socketpair function to socket module. Dave Cole <djc@object-craft.com.au> parents: 32160 diff changeset	13 socketpair() -- create a pair of new socket objects [*]
14007 eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	14 fromfd() -- create a socket object from an open file descriptor [*]
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	15 gethostname() -- return the current hostname
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	16 gethostbyname() -- map a hostname to its IP number
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	17 gethostbyaddr() -- map an IP number or hostname to DNS info
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	18 getservbyname() -- map a service name and a protocol name to a port number
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	19 getprotobyname() -- mape a protocol name (e.g. 'tcp') to a number
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	20 ntohs(), ntohl() -- convert 16, 32 bit int from network to host byte order
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	21 htons(), htonl() -- convert 16, 32 bit int from host to network byte order
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	22 inet_aton() -- convert IP addr string (123.45.67.89) to 32-bit packed format
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	23 inet_ntoa() -- convert 32-bit packed format IP to string (123.45.67.89)
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	24 ssl() -- secure socket layer support (only available if configured)
24293 640370f08e2a Add default timeout functionality. This adds setdefaulttimeout() and Guido van Rossum <guido@python.org> parents: 23844 diff changeset	25 socket.getdefaulttimeout() -- get the default timeout value
640370f08e2a Add default timeout functionality. This adds setdefaulttimeout() and Guido van Rossum <guido@python.org> parents: 23844 diff changeset	26 socket.setdefaulttimeout() -- set the default timeout value
41532 4b9fa8092e82 Whitespace normalization. Ugh, we really need to do this more often. Neal Norwitz <nnorwitz@gmail.com> parents: 41288 diff changeset	27 create_connection() -- connects to an address, with an optional timeout
14007 eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	28
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	29 [*] not available on all platforms!
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	30
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	31 Special objects:
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	32
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	33 SocketType -- type object for socket objects
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	34 error -- exception raised for I/O errors
28818 57e61588571b Patch by Jp Calderone: Guido van Rossum <guido@python.org> parents: 28443 diff changeset	35 has_ipv6 -- boolean value indicating if IPv6 is supported
14007 eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	36
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	37 Integer constants:
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	38
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	39 AF_INET, AF_UNIX -- socket domains (first argument to socket() call)
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	40 SOCK_STREAM, SOCK_DGRAM, SOCK_RAW -- socket types (second argument)
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	41
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	42 Many other constants may be defined; these may be used in calls to
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	43 the setsockopt() and getsockopt() methods.
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	44 """
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	45
21971 fce7278d46b0 Repair so that importing socket doesn't blow up on platforms that lack Tim Peters <tim.peters@gmail.com> parents: 21962 diff changeset	46 import _socket
14007 eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	47 from _socket import *
21971 fce7278d46b0 Repair so that importing socket doesn't blow up on platforms that lack Tim Peters <tim.peters@gmail.com> parents: 21962 diff changeset	48
21959 3957d155f8c5 Break SSL support out of _socket module and place it into a new Marc-André Lemburg <mal@egenix.com> parents: 21473 diff changeset	49 try:
24663 b265e76bab88 Extend __all__ with the exports list of the _ssl module. Guido van Rossum <guido@python.org> parents: 24662 diff changeset	50 import _ssl
21959 3957d155f8c5 Break SSL support out of _socket module and place it into a new Marc-André Lemburg <mal@egenix.com> parents: 21473 diff changeset	51 except ImportError:
43008 4771639fc049 This contains a number of things: Bill Janssen <janssen@parc.com> parents: 42828 diff changeset	52 # no SSL support
24661 2f411f2d791a Another refactoring. Changed 'socket' from being a factory function Guido van Rossum <guido@python.org> parents: 24656 diff changeset	53 pass
43008 4771639fc049 This contains a number of things: Bill Janssen <janssen@parc.com> parents: 42828 diff changeset	54 else:
4771639fc049 This contains a number of things: Bill Janssen <janssen@parc.com> parents: 42828 diff changeset	55 def ssl(sock, keyfile=None, certfile=None):
4771639fc049 This contains a number of things: Bill Janssen <janssen@parc.com> parents: 42828 diff changeset	56 # we do an internal import here because the ssl
4771639fc049 This contains a number of things: Bill Janssen <janssen@parc.com> parents: 42828 diff changeset	57 # module imports the socket module
4771639fc049 This contains a number of things: Bill Janssen <janssen@parc.com> parents: 42828 diff changeset	58 import ssl as _realssl
43325 193020bf52dc More work on SSL support. Bill Janssen <janssen@parc.com> parents: 43008 diff changeset	59 warnings.warn("socket.ssl() is deprecated. Use ssl.wrap_socket() instead.",
43008 4771639fc049 This contains a number of things: Bill Janssen <janssen@parc.com> parents: 42828 diff changeset	60 DeprecationWarning, stacklevel=2)
4771639fc049 This contains a number of things: Bill Janssen <janssen@parc.com> parents: 42828 diff changeset	61 return _realssl.sslwrap_simple(sock, keyfile, certfile)
14007 eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	62
43008 4771639fc049 This contains a number of things: Bill Janssen <janssen@parc.com> parents: 42828 diff changeset	63 # we need to import the same constants we used to...
43325 193020bf52dc More work on SSL support. Bill Janssen <janssen@parc.com> parents: 43008 diff changeset	64 from _ssl import SSLError as sslerror
43008 4771639fc049 This contains a number of things: Bill Janssen <janssen@parc.com> parents: 42828 diff changeset	65 from _ssl import \
4771639fc049 This contains a number of things: Bill Janssen <janssen@parc.com> parents: 42828 diff changeset	66 RAND_add, \
4771639fc049 This contains a number of things: Bill Janssen <janssen@parc.com> parents: 42828 diff changeset	67 RAND_egd, \
4771639fc049 This contains a number of things: Bill Janssen <janssen@parc.com> parents: 42828 diff changeset	68 RAND_status, \
4771639fc049 This contains a number of things: Bill Janssen <janssen@parc.com> parents: 42828 diff changeset	69 SSL_ERROR_ZERO_RETURN, \
4771639fc049 This contains a number of things: Bill Janssen <janssen@parc.com> parents: 42828 diff changeset	70 SSL_ERROR_WANT_READ, \
4771639fc049 This contains a number of things: Bill Janssen <janssen@parc.com> parents: 42828 diff changeset	71 SSL_ERROR_WANT_WRITE, \
4771639fc049 This contains a number of things: Bill Janssen <janssen@parc.com> parents: 42828 diff changeset	72 SSL_ERROR_WANT_X509_LOOKUP, \
4771639fc049 This contains a number of things: Bill Janssen <janssen@parc.com> parents: 42828 diff changeset	73 SSL_ERROR_SYSCALL, \
4771639fc049 This contains a number of things: Bill Janssen <janssen@parc.com> parents: 42828 diff changeset	74 SSL_ERROR_SSL, \
4771639fc049 This contains a number of things: Bill Janssen <janssen@parc.com> parents: 42828 diff changeset	75 SSL_ERROR_WANT_CONNECT, \
4771639fc049 This contains a number of things: Bill Janssen <janssen@parc.com> parents: 42828 diff changeset	76 SSL_ERROR_EOF, \
4771639fc049 This contains a number of things: Bill Janssen <janssen@parc.com> parents: 42828 diff changeset	77 SSL_ERROR_INVALID_ERROR_CODE
4771639fc049 This contains a number of things: Bill Janssen <janssen@parc.com> parents: 42828 diff changeset	78
4771639fc049 This contains a number of things: Bill Janssen <janssen@parc.com> parents: 42828 diff changeset	79 import os, sys, warnings
14007 eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	80
28890 39f4b97ce828 Extract the errno value to use from the errno module if possible. Fred Drake <fdrake@acm.org> parents: 28888 diff changeset	81 try:
46623 54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	82 from cStringIO import StringIO
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	83 except ImportError:
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	84 from StringIO import StringIO
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	85
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	86 try:
28890 39f4b97ce828 Extract the errno value to use from the errno module if possible. Fred Drake <fdrake@acm.org> parents: 28888 diff changeset	87 from errno import EBADF
39f4b97ce828 Extract the errno value to use from the errno module if possible. Fred Drake <fdrake@acm.org> parents: 28888 diff changeset	88 except ImportError:
39f4b97ce828 Extract the errno value to use from the errno module if possible. Fred Drake <fdrake@acm.org> parents: 28888 diff changeset	89 EBADF = 9
39f4b97ce828 Extract the errno value to use from the errno module if possible. Fred Drake <fdrake@acm.org> parents: 28888 diff changeset	90
16613 f68dbffff927 bunch more __all__ lists Skip Montanaro <skip@pobox.com> parents: 15872 diff changeset	91 __all__ = ["getfqdn"]
f68dbffff927 bunch more __all__ lists Skip Montanaro <skip@pobox.com> parents: 15872 diff changeset	92 __all__.extend(os._get_exports_list(_socket))
43008 4771639fc049 This contains a number of things: Bill Janssen <janssen@parc.com> parents: 42828 diff changeset	93
16613 f68dbffff927 bunch more __all__ lists Skip Montanaro <skip@pobox.com> parents: 15872 diff changeset	94
24661 2f411f2d791a Another refactoring. Changed 'socket' from being a factory function Guido van Rossum <guido@python.org> parents: 24656 diff changeset	95 _realsocket = socket
14007 eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	96
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	97 # WSA error codes
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	98 if sys.platform.lower().startswith("win"):
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	99 errorTab = {}
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	100 errorTab[10004] = "The operation was interrupted."
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	101 errorTab[10009] = "A bad file handle was passed."
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	102 errorTab[10013] = "Permission denied."
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	103 errorTab[10014] = "A fault occurred on the network??" # WSAEFAULT
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	104 errorTab[10022] = "An invalid operation was attempted."
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	105 errorTab[10035] = "The socket operation would block"
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	106 errorTab[10036] = "A blocking operation is already in progress."
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	107 errorTab[10048] = "The network address is in use."
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	108 errorTab[10054] = "The connection has been reset."
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	109 errorTab[10058] = "The network has been shut down."
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	110 errorTab[10060] = "The operation timed out."
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	111 errorTab[10061] = "Connection refused."
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	112 errorTab[10063] = "The name is too long."
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	113 errorTab[10064] = "The host is down."
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	114 errorTab[10065] = "The host is unreachable."
17071 b45ae8c467aa add errorTab to __all__ on win* Skip Montanaro <skip@pobox.com> parents: 16949 diff changeset	115 __all__.append("errorTab")
24663 b265e76bab88 Extend __all__ with the exports list of the _ssl module. Guido van Rossum <guido@python.org> parents: 24662 diff changeset	116
14007 eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	117
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	118
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	119 def getfqdn(name=''):
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	120 """Get fully qualified domain name from name.
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	121
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	122 An empty argument is interpreted as meaning the local host.
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	123
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	124 First the hostname returned by gethostbyaddr() is checked, then
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	125 possibly existing aliases. In case no FQDN is available, hostname
34733 e83309d43a82 Fix test for socket.getfqdn() to also include the name returned by Brett Cannon <bcannon@gmail.com> parents: 33063 diff changeset	126 from gethostname() is returned.
14007 eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	127 """
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	128 name = name.strip()
14014 3d68d5bccd40 updated occurences of fqdn algorithm (closes patch #101197) Peter Schneider-Kamp <nowonder@nowonder.de> parents: 14007 diff changeset	129 if not name or name == '0.0.0.0':
14007 eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	130 name = gethostname()
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	131 try:
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	132 hostname, aliases, ipaddrs = gethostbyaddr(name)
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	133 except error:
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	134 pass
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	135 else:
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	136 aliases.insert(0, hostname)
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	137 for name in aliases:
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	138 if '.' in name:
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	139 break
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	140 else:
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	141 name = hostname
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	142 return name
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	143
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	144
19364 b738428238f1 When the socket is closed, don't just assign 0 to self._sock. Guido van Rossum <guido@python.org> parents: 17245 diff changeset	145 _socketmethods = (
b738428238f1 When the socket is closed, don't just assign 0 to self._sock. Guido van Rossum <guido@python.org> parents: 17245 diff changeset	146 'bind', 'connect', 'connect_ex', 'fileno', 'listen',
b738428238f1 When the socket is closed, don't just assign 0 to self._sock. Guido van Rossum <guido@python.org> parents: 17245 diff changeset	147 'getpeername', 'getsockname', 'getsockopt', 'setsockopt',
28888 d3164a304598 Regain throughput lost with the _socketobject wrapper. The Skip Montanaro <skip@pobox.com> parents: 28818 diff changeset	148 'sendall', 'setblocking',
44478 73bc002252bf socket.ioctl is only available on Windows Christian Heimes <christian@cheimes.de> parents: 44474 diff changeset	149 'settimeout', 'gettimeout', 'shutdown')
73bc002252bf socket.ioctl is only available on Windows Christian Heimes <christian@cheimes.de> parents: 44474 diff changeset	150
73bc002252bf socket.ioctl is only available on Windows Christian Heimes <christian@cheimes.de> parents: 44474 diff changeset	151 if os.name == "nt":
73bc002252bf socket.ioctl is only available on Windows Christian Heimes <christian@cheimes.de> parents: 44474 diff changeset	152 _socketmethods = _socketmethods + ('ioctl',)
19364 b738428238f1 When the socket is closed, don't just assign 0 to self._sock. Guido van Rossum <guido@python.org> parents: 17245 diff changeset	153
29066 90342f395721 Patch #734231: Update RiscOS support. In particular, correct Martin v. Löwis <martin@v.loewis.de> parents: 28890 diff changeset	154 if sys.platform == "riscos":
90342f395721 Patch #734231: Update RiscOS support. In particular, correct Martin v. Löwis <martin@v.loewis.de> parents: 28890 diff changeset	155 _socketmethods = _socketmethods + ('sleeptaskw',)
90342f395721 Patch #734231: Update RiscOS support. In particular, correct Martin v. Löwis <martin@v.loewis.de> parents: 28890 diff changeset	156
38976 c547f6e91c58 Release all forwarded functions in .close. Fixes #1513223. Martin v. Löwis <martin@v.loewis.de> parents: 38580 diff changeset	157 # All the method names that must be delegated to either the real socket
c547f6e91c58 Release all forwarded functions in .close. Fixes #1513223. Martin v. Löwis <martin@v.loewis.de> parents: 38580 diff changeset	158 # object or the _closedsocket object.
c547f6e91c58 Release all forwarded functions in .close. Fixes #1513223. Martin v. Löwis <martin@v.loewis.de> parents: 38580 diff changeset	159 _delegate_methods = ("recv", "recvfrom", "recv_into", "recvfrom_into",
c547f6e91c58 Release all forwarded functions in .close. Fixes #1513223. Martin v. Löwis <martin@v.loewis.de> parents: 38580 diff changeset	160 "send", "sendto")
c547f6e91c58 Release all forwarded functions in .close. Fixes #1513223. Martin v. Löwis <martin@v.loewis.de> parents: 38580 diff changeset	161
24666 4fbf534211b9 The _socketobject class has no need for a __del__ method: all it did was Guido van Rossum <guido@python.org> parents: 24665 diff changeset	162 class _closedsocket(object):
4fbf534211b9 The _socketobject class has no need for a __del__ method: all it did was Guido van Rossum <guido@python.org> parents: 24665 diff changeset	163 __slots__ = []
28888 d3164a304598 Regain throughput lost with the _socketobject wrapper. The Skip Montanaro <skip@pobox.com> parents: 28818 diff changeset	164 def _dummy(*args):
28890 39f4b97ce828 Extract the errno value to use from the errno module if possible. Fred Drake <fdrake@acm.org> parents: 28888 diff changeset	165 raise error(EBADF, 'Bad file descriptor')
38976 c547f6e91c58 Release all forwarded functions in .close. Fixes #1513223. Martin v. Löwis <martin@v.loewis.de> parents: 38580 diff changeset	166 # All _delegate_methods must also be initialized here.
c547f6e91c58 Release all forwarded functions in .close. Fixes #1513223. Martin v. Löwis <martin@v.loewis.de> parents: 38580 diff changeset	167 send = recv = recv_into = sendto = recvfrom = recvfrom_into = _dummy
c547f6e91c58 Release all forwarded functions in .close. Fixes #1513223. Martin v. Löwis <martin@v.loewis.de> parents: 38580 diff changeset	168 __getattr__ = _dummy
24666 4fbf534211b9 The _socketobject class has no need for a __del__ method: all it did was Guido van Rossum <guido@python.org> parents: 24665 diff changeset	169
42385 e9916a4e06a4 Bug #978833: Close https sockets by releasing the _ssl object. Martin v. Löwis <martin@v.loewis.de> parents: 41532 diff changeset	170 # Wrapper around platform socket objects. This implements
e9916a4e06a4 Bug #978833: Close https sockets by releasing the _ssl object. Martin v. Löwis <martin@v.loewis.de> parents: 41532 diff changeset	171 # a platform-independent dup() functionality. The
e9916a4e06a4 Bug #978833: Close https sockets by releasing the _ssl object. Martin v. Löwis <martin@v.loewis.de> parents: 41532 diff changeset	172 # implementation currently relies on reference counting
e9916a4e06a4 Bug #978833: Close https sockets by releasing the _ssl object. Martin v. Löwis <martin@v.loewis.de> parents: 41532 diff changeset	173 # to close the underlying socket object.
24661 2f411f2d791a Another refactoring. Changed 'socket' from being a factory function Guido van Rossum <guido@python.org> parents: 24656 diff changeset	174 class _socketobject(object):
2f411f2d791a Another refactoring. Changed 'socket' from being a factory function Guido van Rossum <guido@python.org> parents: 24656 diff changeset	175
2f411f2d791a Another refactoring. Changed 'socket' from being a factory function Guido van Rossum <guido@python.org> parents: 24656 diff changeset	176 __doc__ = _realsocket.__doc__
14007 eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	177
38976 c547f6e91c58 Release all forwarded functions in .close. Fixes #1513223. Martin v. Löwis <martin@v.loewis.de> parents: 38580 diff changeset	178 __slots__ = ["_sock", "__weakref__"] + list(_delegate_methods)
24661 2f411f2d791a Another refactoring. Changed 'socket' from being a factory function Guido van Rossum <guido@python.org> parents: 24656 diff changeset	179
2f411f2d791a Another refactoring. Changed 'socket' from being a factory function Guido van Rossum <guido@python.org> parents: 24656 diff changeset	180 def __init__(self, family=AF_INET, type=SOCK_STREAM, proto=0, _sock=None):
2f411f2d791a Another refactoring. Changed 'socket' from being a factory function Guido van Rossum <guido@python.org> parents: 24656 diff changeset	181 if _sock is None:
24662 a61893d7cef2 Oops, stupid tabs. Sorry again. Guido van Rossum <guido@python.org> parents: 24661 diff changeset	182 _sock = _realsocket(family, type, proto)
24661 2f411f2d791a Another refactoring. Changed 'socket' from being a factory function Guido van Rossum <guido@python.org> parents: 24656 diff changeset	183 self._sock = _sock
38976 c547f6e91c58 Release all forwarded functions in .close. Fixes #1513223. Martin v. Löwis <martin@v.loewis.de> parents: 38580 diff changeset	184 for method in _delegate_methods:
c547f6e91c58 Release all forwarded functions in .close. Fixes #1513223. Martin v. Löwis <martin@v.loewis.de> parents: 38580 diff changeset	185 setattr(self, method, getattr(_sock, method))
14007 eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	186
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	187 def close(self):
24666 4fbf534211b9 The _socketobject class has no need for a __del__ method: all it did was Guido van Rossum <guido@python.org> parents: 24665 diff changeset	188 self._sock = _closedsocket()
38976 c547f6e91c58 Release all forwarded functions in .close. Fixes #1513223. Martin v. Löwis <martin@v.loewis.de> parents: 38580 diff changeset	189 dummy = self._sock._dummy
c547f6e91c58 Release all forwarded functions in .close. Fixes #1513223. Martin v. Löwis <martin@v.loewis.de> parents: 38580 diff changeset	190 for method in _delegate_methods:
c547f6e91c58 Release all forwarded functions in .close. Fixes #1513223. Martin v. Löwis <martin@v.loewis.de> parents: 38580 diff changeset	191 setattr(self, method, dummy)
24661 2f411f2d791a Another refactoring. Changed 'socket' from being a factory function Guido van Rossum <guido@python.org> parents: 24656 diff changeset	192 close.__doc__ = _realsocket.close.__doc__
14007 eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	193
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	194 def accept(self):
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	195 sock, addr = self._sock.accept()
24661 2f411f2d791a Another refactoring. Changed 'socket' from being a factory function Guido van Rossum <guido@python.org> parents: 24656 diff changeset	196 return _socketobject(_sock=sock), addr
2f411f2d791a Another refactoring. Changed 'socket' from being a factory function Guido van Rossum <guido@python.org> parents: 24656 diff changeset	197 accept.__doc__ = _realsocket.accept.__doc__
14007 eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	198
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	199 def dup(self):
24661 2f411f2d791a Another refactoring. Changed 'socket' from being a factory function Guido van Rossum <guido@python.org> parents: 24656 diff changeset	200 """dup() -> socket object
2f411f2d791a Another refactoring. Changed 'socket' from being a factory function Guido van Rossum <guido@python.org> parents: 24656 diff changeset	201
2f411f2d791a Another refactoring. Changed 'socket' from being a factory function Guido van Rossum <guido@python.org> parents: 24656 diff changeset	202 Return a new socket object connected to the same system resource."""
2f411f2d791a Another refactoring. Changed 'socket' from being a factory function Guido van Rossum <guido@python.org> parents: 24656 diff changeset	203 return _socketobject(_sock=self._sock)
14007 eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	204
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	205 def makefile(self, mode='r', bufsize=-1):
24661 2f411f2d791a Another refactoring. Changed 'socket' from being a factory function Guido van Rossum <guido@python.org> parents: 24656 diff changeset	206 """makefile([mode[, bufsize]]) -> file object
2f411f2d791a Another refactoring. Changed 'socket' from being a factory function Guido van Rossum <guido@python.org> parents: 24656 diff changeset	207
2f411f2d791a Another refactoring. Changed 'socket' from being a factory function Guido van Rossum <guido@python.org> parents: 24656 diff changeset	208 Return a regular file object corresponding to the socket. The mode
2f411f2d791a Another refactoring. Changed 'socket' from being a factory function Guido van Rossum <guido@python.org> parents: 24656 diff changeset	209 and bufsize arguments are as for the built-in open() function."""
14007 eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	210 return _fileobject(self._sock, mode, bufsize)
37136 71c5694e3423 Whitespace normalization. Tim Peters <tim.peters@gmail.com> parents: 37123 diff changeset	211
37123 251ecec04f1b Correct API design mistake from rev. 43126: make socket attributes readonly properties. Georg Brandl <georg@python.org> parents: 37069 diff changeset	212 family = property(lambda self: self._sock.family, doc="the socket family")
251ecec04f1b Correct API design mistake from rev. 43126: make socket attributes readonly properties. Georg Brandl <georg@python.org> parents: 37069 diff changeset	213 type = property(lambda self: self._sock.type, doc="the socket type")
251ecec04f1b Correct API design mistake from rev. 43126: make socket attributes readonly properties. Georg Brandl <georg@python.org> parents: 37069 diff changeset	214 proto = property(lambda self: self._sock.proto, doc="the socket protocol")
37069 dd49847a60d3 RFE #567972: Socket objects' family, type and proto properties are Georg Brandl <georg@python.org> parents: 34733 diff changeset	215
24661 2f411f2d791a Another refactoring. Changed 'socket' from being a factory function Guido van Rossum <guido@python.org> parents: 24656 diff changeset	216 _s = ("def %s(self, args): return self._sock.%s(args)\n\n"
2f411f2d791a Another refactoring. Changed 'socket' from being a factory function Guido van Rossum <guido@python.org> parents: 24656 diff changeset	217 "%s.__doc__ = _realsocket.%s.__doc__\n")
19364 b738428238f1 When the socket is closed, don't just assign 0 to self._sock. Guido van Rossum <guido@python.org> parents: 17245 diff changeset	218 for _m in _socketmethods:
24661 2f411f2d791a Another refactoring. Changed 'socket' from being a factory function Guido van Rossum <guido@python.org> parents: 24656 diff changeset	219 exec _s % (_m, _m, _m, _m)
24673 3796d39f0b80 Delete junk attributes left behind by _socketobject class construction. Tim Peters <tim.peters@gmail.com> parents: 24666 diff changeset	220 del _m, _s
14007 eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	221
28443 161b8bd8a226 The socket module now always uses the _socketobject wrapper class, even on Skip Montanaro <skip@pobox.com> parents: 24944 diff changeset	222 socket = SocketType = _socketobject
14007 eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	223
24661 2f411f2d791a Another refactoring. Changed 'socket' from being a factory function Guido van Rossum <guido@python.org> parents: 24656 diff changeset	224 class _fileobject(object):
24656 e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work Guido van Rossum <guido@python.org> parents: 24649 diff changeset	225 """Faux file object attached to a socket object."""
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work Guido van Rossum <guido@python.org> parents: 24649 diff changeset	226
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work Guido van Rossum <guido@python.org> parents: 24649 diff changeset	227 default_bufsize = 8192
24661 2f411f2d791a Another refactoring. Changed 'socket' from being a factory function Guido van Rossum <guido@python.org> parents: 24656 diff changeset	228 name = "<socket>"
2f411f2d791a Another refactoring. Changed 'socket' from being a factory function Guido van Rossum <guido@python.org> parents: 24656 diff changeset	229
2f411f2d791a Another refactoring. Changed 'socket' from being a factory function Guido van Rossum <guido@python.org> parents: 24656 diff changeset	230 __slots__ = ["mode", "bufsize", "softspace",
2f411f2d791a Another refactoring. Changed 'socket' from being a factory function Guido van Rossum <guido@python.org> parents: 24656 diff changeset	231 # "closed" is a property, see below
40684 2fa6e82b1f17 Patch #1627441: close sockets properly in urllib2. Georg Brandl <georg@python.org> parents: 39190 diff changeset	232 "_sock", "_rbufsize", "_wbufsize", "_rbuf", "_wbuf",
2fa6e82b1f17 Patch #1627441: close sockets properly in urllib2. Georg Brandl <georg@python.org> parents: 39190 diff changeset	233 "_close"]
14007 eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	234
40684 2fa6e82b1f17 Patch #1627441: close sockets properly in urllib2. Georg Brandl <georg@python.org> parents: 39190 diff changeset	235 def __init__(self, sock, mode='rb', bufsize=-1, close=False):
14007 eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	236 self._sock = sock
24661 2f411f2d791a Another refactoring. Changed 'socket' from being a factory function Guido van Rossum <guido@python.org> parents: 24656 diff changeset	237 self.mode = mode # Not actually used in this version
24656 e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work Guido van Rossum <guido@python.org> parents: 24649 diff changeset	238 if bufsize < 0:
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work Guido van Rossum <guido@python.org> parents: 24649 diff changeset	239 bufsize = self.default_bufsize
24662 a61893d7cef2 Oops, stupid tabs. Sorry again. Guido van Rossum <guido@python.org> parents: 24661 diff changeset	240 self.bufsize = bufsize
a61893d7cef2 Oops, stupid tabs. Sorry again. Guido van Rossum <guido@python.org> parents: 24661 diff changeset	241 self.softspace = False
46623 54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	242 # _rbufsize is the suggested recv buffer size. It is strictly
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	243 # obeyed within readline() for recv calls. If it is larger than
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	244 # default_bufsize it will be used for recv calls within read().
24656 e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work Guido van Rossum <guido@python.org> parents: 24649 diff changeset	245 if bufsize == 0:
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work Guido van Rossum <guido@python.org> parents: 24649 diff changeset	246 self._rbufsize = 1
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work Guido van Rossum <guido@python.org> parents: 24649 diff changeset	247 elif bufsize == 1:
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work Guido van Rossum <guido@python.org> parents: 24649 diff changeset	248 self._rbufsize = self.default_bufsize
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work Guido van Rossum <guido@python.org> parents: 24649 diff changeset	249 else:
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work Guido van Rossum <guido@python.org> parents: 24649 diff changeset	250 self._rbufsize = bufsize
14007 eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	251 self._wbufsize = bufsize
46623 54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	252 # We use StringIO for the read buffer to avoid holding a list
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	253 # of variously sized string objects which have been known to
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	254 # fragment the heap due to how they are malloc()ed and often
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	255 # realloc()ed down much smaller than their original allocation.
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	256 self._rbuf = StringIO()
24664 6a6d02be321c Another refactoring of read() and readline(), this time based on the Guido van Rossum <guido@python.org> parents: 24663 diff changeset	257 self._wbuf = [] # A list of strings
40684 2fa6e82b1f17 Patch #1627441: close sockets properly in urllib2. Georg Brandl <georg@python.org> parents: 39190 diff changeset	258 self._close = close
14007 eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	259
24661 2f411f2d791a Another refactoring. Changed 'socket' from being a factory function Guido van Rossum <guido@python.org> parents: 24656 diff changeset	260 def _getclosed(self):
31833 a910b822b12c SF bug 924242: socket._fileobject._getclosed() returns wrong value Tim Peters <tim.peters@gmail.com> parents: 29465 diff changeset	261 return self._sock is None
24661 2f411f2d791a Another refactoring. Changed 'socket' from being a factory function Guido van Rossum <guido@python.org> parents: 24656 diff changeset	262 closed = property(_getclosed, doc="True if the file is closed")
2f411f2d791a Another refactoring. Changed 'socket' from being a factory function Guido van Rossum <guido@python.org> parents: 24656 diff changeset	263
14007 eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	264 def close(self):
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	265 try:
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	266 if self._sock:
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	267 self.flush()
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	268 finally:
40684 2fa6e82b1f17 Patch #1627441: close sockets properly in urllib2. Georg Brandl <georg@python.org> parents: 39190 diff changeset	269 if self._close:
2fa6e82b1f17 Patch #1627441: close sockets properly in urllib2. Georg Brandl <georg@python.org> parents: 39190 diff changeset	270 self._sock.close()
23715 c2733e8f6612 SF patch 555085 (timeout socket implementation) by Michael Gilfix. Guido van Rossum <guido@python.org> parents: 21971 diff changeset	271 self._sock = None
14007 eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	272
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	273 def __del__(self):
29311 ed70779f6402 I saw errors from _fileobject.__del__ about missing self._sock. This Guido van Rossum <guido@python.org> parents: 29066 diff changeset	274 try:
ed70779f6402 I saw errors from _fileobject.__del__ about missing self._sock. This Guido van Rossum <guido@python.org> parents: 29066 diff changeset	275 self.close()
ed70779f6402 I saw errors from _fileobject.__del__ about missing self._sock. This Guido van Rossum <guido@python.org> parents: 29066 diff changeset	276 except:
ed70779f6402 I saw errors from _fileobject.__del__ about missing self._sock. This Guido van Rossum <guido@python.org> parents: 29066 diff changeset	277 # close() may fail if __init__ didn't complete
ed70779f6402 I saw errors from _fileobject.__del__ about missing self._sock. This Guido van Rossum <guido@python.org> parents: 29066 diff changeset	278 pass
14007 eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	279
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	280 def flush(self):
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	281 if self._wbuf:
24656 e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work Guido van Rossum <guido@python.org> parents: 24649 diff changeset	282 buffer = "".join(self._wbuf)
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work Guido van Rossum <guido@python.org> parents: 24649 diff changeset	283 self._wbuf = []
23715 c2733e8f6612 SF patch 555085 (timeout socket implementation) by Michael Gilfix. Guido van Rossum <guido@python.org> parents: 21971 diff changeset	284 self._sock.sendall(buffer)
14007 eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	285
23844 bd37eb4daf3b Cleanup a little Neal Norwitz <nnorwitz@gmail.com> parents: 23715 diff changeset	286 def fileno(self):
14007 eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	287 return self._sock.fileno()
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	288
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	289 def write(self, data):
24656 e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work Guido van Rossum <guido@python.org> parents: 24649 diff changeset	290 data = str(data) # XXX Should really reject non-string non-buffers
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work Guido van Rossum <guido@python.org> parents: 24649 diff changeset	291 if not data:
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work Guido van Rossum <guido@python.org> parents: 24649 diff changeset	292 return
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work Guido van Rossum <guido@python.org> parents: 24649 diff changeset	293 self._wbuf.append(data)
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work Guido van Rossum <guido@python.org> parents: 24649 diff changeset	294 if (self._wbufsize == 0 or
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work Guido van Rossum <guido@python.org> parents: 24649 diff changeset	295 self._wbufsize == 1 and '\n' in data or
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work Guido van Rossum <guido@python.org> parents: 24649 diff changeset	296 self._get_wbuf_len() >= self._wbufsize):
23715 c2733e8f6612 SF patch 555085 (timeout socket implementation) by Michael Gilfix. Guido van Rossum <guido@python.org> parents: 21971 diff changeset	297 self.flush()
14007 eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	298
eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	299 def writelines(self, list):
24656 e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work Guido van Rossum <guido@python.org> parents: 24649 diff changeset	300 # XXX We could do better here for very long lists
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work Guido van Rossum <guido@python.org> parents: 24649 diff changeset	301 # XXX Should really reject non-string non-buffers
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work Guido van Rossum <guido@python.org> parents: 24649 diff changeset	302 self._wbuf.extend(filter(None, map(str, list)))
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work Guido van Rossum <guido@python.org> parents: 24649 diff changeset	303 if (self._wbufsize <= 1 or
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work Guido van Rossum <guido@python.org> parents: 24649 diff changeset	304 self._get_wbuf_len() >= self._wbufsize):
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work Guido van Rossum <guido@python.org> parents: 24649 diff changeset	305 self.flush()
14007 eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	306
24656 e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work Guido van Rossum <guido@python.org> parents: 24649 diff changeset	307 def _get_wbuf_len(self):
23715 c2733e8f6612 SF patch 555085 (timeout socket implementation) by Michael Gilfix. Guido van Rossum <guido@python.org> parents: 21971 diff changeset	308 buf_len = 0
24656 e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work Guido van Rossum <guido@python.org> parents: 24649 diff changeset	309 for x in self._wbuf:
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work Guido van Rossum <guido@python.org> parents: 24649 diff changeset	310 buf_len += len(x)
23715 c2733e8f6612 SF patch 555085 (timeout socket implementation) by Michael Gilfix. Guido van Rossum <guido@python.org> parents: 21971 diff changeset	311 return buf_len
c2733e8f6612 SF patch 555085 (timeout socket implementation) by Michael Gilfix. Guido van Rossum <guido@python.org> parents: 21971 diff changeset	312
c2733e8f6612 SF patch 555085 (timeout socket implementation) by Michael Gilfix. Guido van Rossum <guido@python.org> parents: 21971 diff changeset	313 def read(self, size=-1):
46623 54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	314 # Use max, disallow tiny reads in a loop as they are very inefficient.
46684 2729e977fdd9 Fix a bug introduced in r62627. see issue2760 and issue2632. Gregory P. Smith <greg@mad-scientist.com> parents: 46623 diff changeset	315 # We never leave read() with any leftover data from a new recv() call
2729e977fdd9 Fix a bug introduced in r62627. see issue2760 and issue2632. Gregory P. Smith <greg@mad-scientist.com> parents: 46623 diff changeset	316 # in our internal buffer.
46623 54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	317 rbufsize = max(self._rbufsize, self.default_bufsize)
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	318 # Our use of StringIO rather than lists of string objects returned by
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	319 # recv() minimizes memory usage and fragmentation that occurs when
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	320 # rbufsize is large compared to the typical return value of recv().
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	321 buf = self._rbuf
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	322 buf.seek(0, 2) # seek end
24656 e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work Guido van Rossum <guido@python.org> parents: 24649 diff changeset	323 if size < 0:
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work Guido van Rossum <guido@python.org> parents: 24649 diff changeset	324 # Read until EOF
46623 54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	325 self._rbuf = StringIO() # reset _rbuf. we consume it via buf.
24664 6a6d02be321c Another refactoring of read() and readline(), this time based on the Guido van Rossum <guido@python.org> parents: 24663 diff changeset	326 while True:
46623 54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	327 data = self._sock.recv(rbufsize)
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	328 if not data:
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	329 break
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	330 buf.write(data)
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	331 return buf.getvalue()
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	332 else:
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	333 # Read until size bytes or EOF seen, whichever comes first
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	334 buf_len = buf.tell()
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	335 if buf_len >= size:
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	336 # Already have size bytes in our buffer? Extract and return.
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	337 buf.seek(0)
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	338 rv = buf.read(size)
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	339 self._rbuf = StringIO()
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	340 self._rbuf.write(buf.read())
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	341 return rv
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	342
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	343 self._rbuf = StringIO() # reset _rbuf. we consume it via buf.
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	344 while True:
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	345 left = size - buf_len
46684 2729e977fdd9 Fix a bug introduced in r62627. see issue2760 and issue2632. Gregory P. Smith <greg@mad-scientist.com> parents: 46623 diff changeset	346 # recv() will malloc the amount of memory given as its
2729e977fdd9 Fix a bug introduced in r62627. see issue2760 and issue2632. Gregory P. Smith <greg@mad-scientist.com> parents: 46623 diff changeset	347 # parameter even though it often returns much less data
2729e977fdd9 Fix a bug introduced in r62627. see issue2760 and issue2632. Gregory P. Smith <greg@mad-scientist.com> parents: 46623 diff changeset	348 # than that. The returned data string is short lived
2729e977fdd9 Fix a bug introduced in r62627. see issue2760 and issue2632. Gregory P. Smith <greg@mad-scientist.com> parents: 46623 diff changeset	349 # as we copy it into a StringIO and free it. This avoids
2729e977fdd9 Fix a bug introduced in r62627. see issue2760 and issue2632. Gregory P. Smith <greg@mad-scientist.com> parents: 46623 diff changeset	350 # fragmentation issues on many platforms.
2729e977fdd9 Fix a bug introduced in r62627. see issue2760 and issue2632. Gregory P. Smith <greg@mad-scientist.com> parents: 46623 diff changeset	351 data = self._sock.recv(left)
24656 e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work Guido van Rossum <guido@python.org> parents: 24649 diff changeset	352 if not data:
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work Guido van Rossum <guido@python.org> parents: 24649 diff changeset	353 break
46623 54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	354 n = len(data)
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	355 if n == size and not buf_len:
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	356 # Shortcut. Avoid buffer data copies when:
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	357 # - We have no data in our buffer.
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	358 # AND
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	359 # - Our call to recv returned exactly the
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	360 # number of bytes we were asked to read.
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	361 return data
46684 2729e977fdd9 Fix a bug introduced in r62627. see issue2760 and issue2632. Gregory P. Smith <greg@mad-scientist.com> parents: 46623 diff changeset	362 if n == left:
2729e977fdd9 Fix a bug introduced in r62627. see issue2760 and issue2632. Gregory P. Smith <greg@mad-scientist.com> parents: 46623 diff changeset	363 buf.write(data)
46623 54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	364 del data # explicit free
24656 e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work Guido van Rossum <guido@python.org> parents: 24649 diff changeset	365 break
46684 2729e977fdd9 Fix a bug introduced in r62627. see issue2760 and issue2632. Gregory P. Smith <greg@mad-scientist.com> parents: 46623 diff changeset	366 assert n <= left, "recv(%d) returned %d bytes" % (left, n)
46623 54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	367 buf.write(data)
24664 6a6d02be321c Another refactoring of read() and readline(), this time based on the Guido van Rossum <guido@python.org> parents: 24663 diff changeset	368 buf_len += n
46623 54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	369 del data # explicit free
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	370 #assert buf_len == buf.tell()
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	371 return buf.getvalue()
14007 eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	372
23715 c2733e8f6612 SF patch 555085 (timeout socket implementation) by Michael Gilfix. Guido van Rossum <guido@python.org> parents: 21971 diff changeset	373 def readline(self, size=-1):
46623 54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	374 buf = self._rbuf
46684 2729e977fdd9 Fix a bug introduced in r62627. see issue2760 and issue2632. Gregory P. Smith <greg@mad-scientist.com> parents: 46623 diff changeset	375 buf.seek(0, 2) # seek end
2729e977fdd9 Fix a bug introduced in r62627. see issue2760 and issue2632. Gregory P. Smith <greg@mad-scientist.com> parents: 46623 diff changeset	376 if buf.tell() > 0:
2729e977fdd9 Fix a bug introduced in r62627. see issue2760 and issue2632. Gregory P. Smith <greg@mad-scientist.com> parents: 46623 diff changeset	377 # check if we already have it in our buffer
46623 54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	378 buf.seek(0)
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	379 bline = buf.readline(size)
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	380 if bline.endswith('\n') or len(bline) == size:
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	381 self._rbuf = StringIO()
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	382 self._rbuf.write(buf.read())
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	383 return bline
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	384 del bline
24664 6a6d02be321c Another refactoring of read() and readline(), this time based on the Guido van Rossum <guido@python.org> parents: 24663 diff changeset	385 if size < 0:
6a6d02be321c Another refactoring of read() and readline(), this time based on the Guido van Rossum <guido@python.org> parents: 24663 diff changeset	386 # Read until \n or EOF, whichever comes first
24665 d25cf94d20b1 OK, one more hack: speed up the case of readline() in unbuffered mode. Guido van Rossum <guido@python.org> parents: 24664 diff changeset	387 if self._rbufsize <= 1:
d25cf94d20b1 OK, one more hack: speed up the case of readline() in unbuffered mode. Guido van Rossum <guido@python.org> parents: 24664 diff changeset	388 # Speed up unbuffered case
46684 2729e977fdd9 Fix a bug introduced in r62627. see issue2760 and issue2632. Gregory P. Smith <greg@mad-scientist.com> parents: 46623 diff changeset	389 buf.seek(0)
2729e977fdd9 Fix a bug introduced in r62627. see issue2760 and issue2632. Gregory P. Smith <greg@mad-scientist.com> parents: 46623 diff changeset	390 buffers = [buf.read()]
2729e977fdd9 Fix a bug introduced in r62627. see issue2760 and issue2632. Gregory P. Smith <greg@mad-scientist.com> parents: 46623 diff changeset	391 self._rbuf = StringIO() # reset _rbuf. we consume it via buf.
46623 54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	392 data = None
24665 d25cf94d20b1 OK, one more hack: speed up the case of readline() in unbuffered mode. Guido van Rossum <guido@python.org> parents: 24664 diff changeset	393 recv = self._sock.recv
d25cf94d20b1 OK, one more hack: speed up the case of readline() in unbuffered mode. Guido van Rossum <guido@python.org> parents: 24664 diff changeset	394 while data != "\n":
d25cf94d20b1 OK, one more hack: speed up the case of readline() in unbuffered mode. Guido van Rossum <guido@python.org> parents: 24664 diff changeset	395 data = recv(1)
d25cf94d20b1 OK, one more hack: speed up the case of readline() in unbuffered mode. Guido van Rossum <guido@python.org> parents: 24664 diff changeset	396 if not data:
d25cf94d20b1 OK, one more hack: speed up the case of readline() in unbuffered mode. Guido van Rossum <guido@python.org> parents: 24664 diff changeset	397 break
d25cf94d20b1 OK, one more hack: speed up the case of readline() in unbuffered mode. Guido van Rossum <guido@python.org> parents: 24664 diff changeset	398 buffers.append(data)
d25cf94d20b1 OK, one more hack: speed up the case of readline() in unbuffered mode. Guido van Rossum <guido@python.org> parents: 24664 diff changeset	399 return "".join(buffers)
46623 54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	400
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	401 buf.seek(0, 2) # seek end
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	402 self._rbuf = StringIO() # reset _rbuf. we consume it via buf.
24664 6a6d02be321c Another refactoring of read() and readline(), this time based on the Guido van Rossum <guido@python.org> parents: 24663 diff changeset	403 while True:
6a6d02be321c Another refactoring of read() and readline(), this time based on the Guido van Rossum <guido@python.org> parents: 24663 diff changeset	404 data = self._sock.recv(self._rbufsize)
6a6d02be321c Another refactoring of read() and readline(), this time based on the Guido van Rossum <guido@python.org> parents: 24663 diff changeset	405 if not data:
6a6d02be321c Another refactoring of read() and readline(), this time based on the Guido van Rossum <guido@python.org> parents: 24663 diff changeset	406 break
6a6d02be321c Another refactoring of read() and readline(), this time based on the Guido van Rossum <guido@python.org> parents: 24663 diff changeset	407 nl = data.find('\n')
6a6d02be321c Another refactoring of read() and readline(), this time based on the Guido van Rossum <guido@python.org> parents: 24663 diff changeset	408 if nl >= 0:
6a6d02be321c Another refactoring of read() and readline(), this time based on the Guido van Rossum <guido@python.org> parents: 24663 diff changeset	409 nl += 1
48195 65901ffffc6a Remove buffer() usage in the socket module by just slicing directly on the Brett Cannon <bcannon@gmail.com> parents: 47372 diff changeset	410 buf.write(data[:nl])
65901ffffc6a Remove buffer() usage in the socket module by just slicing directly on the Brett Cannon <bcannon@gmail.com> parents: 47372 diff changeset	411 self._rbuf.write(data[nl:])
46623 54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	412 del data
24664 6a6d02be321c Another refactoring of read() and readline(), this time based on the Guido van Rossum <guido@python.org> parents: 24663 diff changeset	413 break
46623 54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	414 buf.write(data)
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	415 return buf.getvalue()
23715 c2733e8f6612 SF patch 555085 (timeout socket implementation) by Michael Gilfix. Guido van Rossum <guido@python.org> parents: 21971 diff changeset	416 else:
24664 6a6d02be321c Another refactoring of read() and readline(), this time based on the Guido van Rossum <guido@python.org> parents: 24663 diff changeset	417 # Read until size bytes or \n or EOF seen, whichever comes first
46684 2729e977fdd9 Fix a bug introduced in r62627. see issue2760 and issue2632. Gregory P. Smith <greg@mad-scientist.com> parents: 46623 diff changeset	418 buf.seek(0, 2) # seek end
46623 54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	419 buf_len = buf.tell()
24664 6a6d02be321c Another refactoring of read() and readline(), this time based on the Guido van Rossum <guido@python.org> parents: 24663 diff changeset	420 if buf_len >= size:
46623 54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	421 buf.seek(0)
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	422 rv = buf.read(size)
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	423 self._rbuf = StringIO()
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	424 self._rbuf.write(buf.read())
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	425 return rv
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	426 self._rbuf = StringIO() # reset _rbuf. we consume it via buf.
24664 6a6d02be321c Another refactoring of read() and readline(), this time based on the Guido van Rossum <guido@python.org> parents: 24663 diff changeset	427 while True:
6a6d02be321c Another refactoring of read() and readline(), this time based on the Guido van Rossum <guido@python.org> parents: 24663 diff changeset	428 data = self._sock.recv(self._rbufsize)
6a6d02be321c Another refactoring of read() and readline(), this time based on the Guido van Rossum <guido@python.org> parents: 24663 diff changeset	429 if not data:
6a6d02be321c Another refactoring of read() and readline(), this time based on the Guido van Rossum <guido@python.org> parents: 24663 diff changeset	430 break
6a6d02be321c Another refactoring of read() and readline(), this time based on the Guido van Rossum <guido@python.org> parents: 24663 diff changeset	431 left = size - buf_len
46623 54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	432 # did we just receive a newline?
24664 6a6d02be321c Another refactoring of read() and readline(), this time based on the Guido van Rossum <guido@python.org> parents: 24663 diff changeset	433 nl = data.find('\n', 0, left)
6a6d02be321c Another refactoring of read() and readline(), this time based on the Guido van Rossum <guido@python.org> parents: 24663 diff changeset	434 if nl >= 0:
6a6d02be321c Another refactoring of read() and readline(), this time based on the Guido van Rossum <guido@python.org> parents: 24663 diff changeset	435 nl += 1
46623 54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	436 # save the excess data to _rbuf
48195 65901ffffc6a Remove buffer() usage in the socket module by just slicing directly on the Brett Cannon <bcannon@gmail.com> parents: 47372 diff changeset	437 self._rbuf.write(data[nl:])
46623 54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	438 if buf_len:
48195 65901ffffc6a Remove buffer() usage in the socket module by just slicing directly on the Brett Cannon <bcannon@gmail.com> parents: 47372 diff changeset	439 buf.write(data[:nl])
46623 54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	440 break
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	441 else:
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	442 # Shortcut. Avoid data copy through buf when returning
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	443 # a substring of our first recv().
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	444 return data[:nl]
24664 6a6d02be321c Another refactoring of read() and readline(), this time based on the Guido van Rossum <guido@python.org> parents: 24663 diff changeset	445 n = len(data)
46623 54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	446 if n == size and not buf_len:
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	447 # Shortcut. Avoid data copy through buf when
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	448 # returning exactly all of our first recv().
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	449 return data
24664 6a6d02be321c Another refactoring of read() and readline(), this time based on the Guido van Rossum <guido@python.org> parents: 24663 diff changeset	450 if n >= left:
48195 65901ffffc6a Remove buffer() usage in the socket module by just slicing directly on the Brett Cannon <bcannon@gmail.com> parents: 47372 diff changeset	451 buf.write(data[:left])
65901ffffc6a Remove buffer() usage in the socket module by just slicing directly on the Brett Cannon <bcannon@gmail.com> parents: 47372 diff changeset	452 self._rbuf.write(data[left:])
24664 6a6d02be321c Another refactoring of read() and readline(), this time based on the Guido van Rossum <guido@python.org> parents: 24663 diff changeset	453 break
46623 54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	454 buf.write(data)
24664 6a6d02be321c Another refactoring of read() and readline(), this time based on the Guido van Rossum <guido@python.org> parents: 24663 diff changeset	455 buf_len += n
46623 54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	456 #assert buf_len == buf.tell()
54606ea9f4c7 This should fix issue2632. A long description of the two competing Gregory P. Smith <greg@mad-scientist.com> parents: 45475 diff changeset	457 return buf.getvalue()
23715 c2733e8f6612 SF patch 555085 (timeout socket implementation) by Michael Gilfix. Guido van Rossum <guido@python.org> parents: 21971 diff changeset	458
c2733e8f6612 SF patch 555085 (timeout socket implementation) by Michael Gilfix. Guido van Rossum <guido@python.org> parents: 21971 diff changeset	459 def readlines(self, sizehint=0):
14682 295126433856 Support sizehint in _fileobject.readlines, as documented. Martin v. Löwis <martin@v.loewis.de> parents: 14592 diff changeset	460 total = 0
14007 eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	461 list = []
24664 6a6d02be321c Another refactoring of read() and readline(), this time based on the Guido van Rossum <guido@python.org> parents: 24663 diff changeset	462 while True:
14007 eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	463 line = self.readline()
23844 bd37eb4daf3b Cleanup a little Neal Norwitz <nnorwitz@gmail.com> parents: 23715 diff changeset	464 if not line:
bd37eb4daf3b Cleanup a little Neal Norwitz <nnorwitz@gmail.com> parents: 23715 diff changeset	465 break
14007 eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	466 list.append(line)
14682 295126433856 Support sizehint in _fileobject.readlines, as documented. Martin v. Löwis <martin@v.loewis.de> parents: 14592 diff changeset	467 total += len(line)
295126433856 Support sizehint in _fileobject.readlines, as documented. Martin v. Löwis <martin@v.loewis.de> parents: 14592 diff changeset	468 if sizehint and total >= sizehint:
295126433856 Support sizehint in _fileobject.readlines, as documented. Martin v. Löwis <martin@v.loewis.de> parents: 14592 diff changeset	469 break
14007 eda09f824a9f Revise the wrapper structure for the socket module: Fred Drake <fdrake@acm.org> parents: diff changeset	470 return list
24656 e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work Guido van Rossum <guido@python.org> parents: 24649 diff changeset	471
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work Guido van Rossum <guido@python.org> parents: 24649 diff changeset	472 # Iterator protocols
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work Guido van Rossum <guido@python.org> parents: 24649 diff changeset	473
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work Guido van Rossum <guido@python.org> parents: 24649 diff changeset	474 def __iter__(self):
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work Guido van Rossum <guido@python.org> parents: 24649 diff changeset	475 return self
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work Guido van Rossum <guido@python.org> parents: 24649 diff changeset	476
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work Guido van Rossum <guido@python.org> parents: 24649 diff changeset	477 def next(self):
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work Guido van Rossum <guido@python.org> parents: 24649 diff changeset	478 line = self.readline()
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work Guido van Rossum <guido@python.org> parents: 24649 diff changeset	479 if not line:
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work Guido van Rossum <guido@python.org> parents: 24649 diff changeset	480 raise StopIteration
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work Guido van Rossum <guido@python.org> parents: 24649 diff changeset	481 return line
41288 a73aa0b821ca Added a 'create_connect()' function to socket.py, which creates a Facundo Batista <facundobatista@gmail.com> parents: 41285 diff changeset	482
47372 e2c5ae30cffe Fixed the semantic of timeout for socket.create_connection and Facundo Batista <facundobatista@gmail.com> parents: 46684 diff changeset	483 _GLOBAL_DEFAULT_TIMEOUT = object()
41288 a73aa0b821ca Added a 'create_connect()' function to socket.py, which creates a Facundo Batista <facundobatista@gmail.com> parents: 41285 diff changeset	484
47372 e2c5ae30cffe Fixed the semantic of timeout for socket.create_connection and Facundo Batista <facundobatista@gmail.com> parents: 46684 diff changeset	485 def create_connection(address, timeout=_GLOBAL_DEFAULT_TIMEOUT):
e2c5ae30cffe Fixed the semantic of timeout for socket.create_connection and Facundo Batista <facundobatista@gmail.com> parents: 46684 diff changeset	486 """Connect to address and return the socket object.
41288 a73aa0b821ca Added a 'create_connect()' function to socket.py, which creates a Facundo Batista <facundobatista@gmail.com> parents: 41285 diff changeset	487
47372 e2c5ae30cffe Fixed the semantic of timeout for socket.create_connection and Facundo Batista <facundobatista@gmail.com> parents: 46684 diff changeset	488 Convenience function. Connect to address (a 2-tuple ``(host,
e2c5ae30cffe Fixed the semantic of timeout for socket.create_connection and Facundo Batista <facundobatista@gmail.com> parents: 46684 diff changeset	489 port)``) and return the socket object. Passing the optional
e2c5ae30cffe Fixed the semantic of timeout for socket.create_connection and Facundo Batista <facundobatista@gmail.com> parents: 46684 diff changeset	490 timeout parameter will set the timeout on the socket instance
e2c5ae30cffe Fixed the semantic of timeout for socket.create_connection and Facundo Batista <facundobatista@gmail.com> parents: 46684 diff changeset	491 before attempting to connect. If no timeout is supplied, the
e2c5ae30cffe Fixed the semantic of timeout for socket.create_connection and Facundo Batista <facundobatista@gmail.com> parents: 46684 diff changeset	492 global default timeout setting returned by :func:`getdefaulttimeout`
e2c5ae30cffe Fixed the semantic of timeout for socket.create_connection and Facundo Batista <facundobatista@gmail.com> parents: 46684 diff changeset	493 is used.
41288 a73aa0b821ca Added a 'create_connect()' function to socket.py, which creates a Facundo Batista <facundobatista@gmail.com> parents: 41285 diff changeset	494 """
41532 4b9fa8092e82 Whitespace normalization. Ugh, we really need to do this more often. Neal Norwitz <nnorwitz@gmail.com> parents: 41288 diff changeset	495
41288 a73aa0b821ca Added a 'create_connect()' function to socket.py, which creates a Facundo Batista <facundobatista@gmail.com> parents: 41285 diff changeset	496 msg = "getaddrinfo returns an empty list"
a73aa0b821ca Added a 'create_connect()' function to socket.py, which creates a Facundo Batista <facundobatista@gmail.com> parents: 41285 diff changeset	497 host, port = address
a73aa0b821ca Added a 'create_connect()' function to socket.py, which creates a Facundo Batista <facundobatista@gmail.com> parents: 41285 diff changeset	498 for res in getaddrinfo(host, port, 0, SOCK_STREAM):
a73aa0b821ca Added a 'create_connect()' function to socket.py, which creates a Facundo Batista <facundobatista@gmail.com> parents: 41285 diff changeset	499 af, socktype, proto, canonname, sa = res
a73aa0b821ca Added a 'create_connect()' function to socket.py, which creates a Facundo Batista <facundobatista@gmail.com> parents: 41285 diff changeset	500 sock = None
a73aa0b821ca Added a 'create_connect()' function to socket.py, which creates a Facundo Batista <facundobatista@gmail.com> parents: 41285 diff changeset	501 try:
a73aa0b821ca Added a 'create_connect()' function to socket.py, which creates a Facundo Batista <facundobatista@gmail.com> parents: 41285 diff changeset	502 sock = socket(af, socktype, proto)
47372 e2c5ae30cffe Fixed the semantic of timeout for socket.create_connection and Facundo Batista <facundobatista@gmail.com> parents: 46684 diff changeset	503 if timeout is not _GLOBAL_DEFAULT_TIMEOUT:
41288 a73aa0b821ca Added a 'create_connect()' function to socket.py, which creates a Facundo Batista <facundobatista@gmail.com> parents: 41285 diff changeset	504 sock.settimeout(timeout)
a73aa0b821ca Added a 'create_connect()' function to socket.py, which creates a Facundo Batista <facundobatista@gmail.com> parents: 41285 diff changeset	505 sock.connect(sa)
a73aa0b821ca Added a 'create_connect()' function to socket.py, which creates a Facundo Batista <facundobatista@gmail.com> parents: 41285 diff changeset	506 return sock
41532 4b9fa8092e82 Whitespace normalization. Ugh, we really need to do this more often. Neal Norwitz <nnorwitz@gmail.com> parents: 41288 diff changeset	507
41288 a73aa0b821ca Added a 'create_connect()' function to socket.py, which creates a Facundo Batista <facundobatista@gmail.com> parents: 41285 diff changeset	508 except error, msg:
a73aa0b821ca Added a 'create_connect()' function to socket.py, which creates a Facundo Batista <facundobatista@gmail.com> parents: 41285 diff changeset	509 if sock is not None:
a73aa0b821ca Added a 'create_connect()' function to socket.py, which creates a Facundo Batista <facundobatista@gmail.com> parents: 41285 diff changeset	510 sock.close()
a73aa0b821ca Added a 'create_connect()' function to socket.py, which creates a Facundo Batista <facundobatista@gmail.com> parents: 41285 diff changeset	511
a73aa0b821ca Added a 'create_connect()' function to socket.py, which creates a Facundo Batista <facundobatista@gmail.com> parents: 41285 diff changeset	512 raise error, msg

Mercurial > cpython-lru_cache-weakref

annotate Lib/socket.py @ 51330:ca423008fa4a legacy-trunk