annotate Lib/socket.py @ 70303:2d760cb20e1e 2.6

Replay changeset 70249:b571c7a8cf2e from fubar branch. Original commit message: Merging post 2.6.7rc2 changes from Subversion.
author Barry Warsaw <barry@python.org>
date Mon, 23 May 2011 15:27:52 -0400
parents 787b969d37f0
children b36cb4602e21
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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
54513
ba8222839938 Merged revisions 73138 via svnmerge from
Mark Dickinson <dickinsm@gmail.com>
parents: 52936
diff changeset
19 getprotobyname() -- map a protocol name (e.g. 'tcp') to a number
14007
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:
47898
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
82 from cStringIO import StringIO
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
83 except ImportError:
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
84 from StringIO import StringIO
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
85
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
86 try:
61875
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
87 import errno
28890
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:
61875
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
89 errno = None
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
90 EBADF = getattr(errno, 'EBADF', 9)
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
91 EINTR = getattr(errno, 'EINTR', 4)
28890
39f4b97ce828 Extract the errno value to use from the errno module if possible.
Fred Drake <fdrake@acm.org>
parents: 28888
diff changeset
92
52936
5b01fe513f92 Merged revisions 71329 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 48195
diff changeset
93 __all__ = ["getfqdn", "create_connection"]
16613
f68dbffff927 bunch more __all__ lists
Skip Montanaro <skip@pobox.com>
parents: 15872
diff changeset
94 __all__.extend(os._get_exports_list(_socket))
43008
4771639fc049 This contains a number of things:
Bill Janssen <janssen@parc.com>
parents: 42828
diff changeset
95
16613
f68dbffff927 bunch more __all__ lists
Skip Montanaro <skip@pobox.com>
parents: 15872
diff changeset
96
24661
2f411f2d791a Another refactoring. Changed 'socket' from being a factory function
Guido van Rossum <guido@python.org>
parents: 24656
diff changeset
97 _realsocket = socket
14007
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
98
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
99 # WSA error codes
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
100 if sys.platform.lower().startswith("win"):
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
101 errorTab = {}
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
102 errorTab[10004] = "The operation was interrupted."
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
103 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
104 errorTab[10013] = "Permission denied."
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
105 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
106 errorTab[10022] = "An invalid operation was attempted."
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
107 errorTab[10035] = "The socket operation would block"
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
108 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
109 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
110 errorTab[10054] = "The connection has been reset."
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
111 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
112 errorTab[10060] = "The operation timed out."
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
113 errorTab[10061] = "Connection refused."
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
114 errorTab[10063] = "The name is too long."
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
115 errorTab[10064] = "The host is down."
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
116 errorTab[10065] = "The host is unreachable."
17071
b45ae8c467aa add errorTab to __all__ on win*
Skip Montanaro <skip@pobox.com>
parents: 16949
diff changeset
117 __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
118
14007
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
119
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
120
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
121 def getfqdn(name=''):
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
122 """Get fully qualified domain name from name.
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 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
125
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
126 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
127 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
128 from gethostname() is returned.
14007
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
129 """
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
130 name = name.strip()
14014
3d68d5bccd40 updated occurences of fqdn algorithm (closes patch #101197)
Peter Schneider-Kamp <nowonder@nowonder.de>
parents: 14007
diff changeset
131 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
132 name = gethostname()
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
133 try:
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
134 hostname, aliases, ipaddrs = gethostbyaddr(name)
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
135 except error:
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
136 pass
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
137 else:
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
138 aliases.insert(0, hostname)
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
139 for name in aliases:
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
140 if '.' in name:
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
141 break
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
142 else:
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
143 name = hostname
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
144 return name
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
145
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
146
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
147 _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
148 '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
149 'getpeername', 'getsockname', 'getsockopt', 'setsockopt',
28888
d3164a304598 Regain throughput lost with the _socketobject wrapper. The
Skip Montanaro <skip@pobox.com>
parents: 28818
diff changeset
150 'sendall', 'setblocking',
23715
c2733e8f6612 SF patch 555085 (timeout socket implementation) by Michael Gilfix.
Guido van Rossum <guido@python.org>
parents: 21971
diff changeset
151 'settimeout', 'gettimeout', 'shutdown')
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
152
44478
73bc002252bf socket.ioctl is only available on Windows
Christian Heimes <christian@cheimes.de>
parents: 44474
diff changeset
153 if os.name == "nt":
73bc002252bf socket.ioctl is only available on Windows
Christian Heimes <christian@cheimes.de>
parents: 44474
diff changeset
154 _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
155
29066
90342f395721 Patch #734231: Update RiscOS support. In particular, correct
Martin v. Löwis <martin@v.loewis.de>
parents: 28890
diff changeset
156 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
157 _socketmethods = _socketmethods + ('sleeptaskw',)
90342f395721 Patch #734231: Update RiscOS support. In particular, correct
Martin v. Löwis <martin@v.loewis.de>
parents: 28890
diff changeset
158
38976
c547f6e91c58 Release all forwarded functions in .close. Fixes #1513223.
Martin v. Löwis <martin@v.loewis.de>
parents: 38580
diff changeset
159 # 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
160 # 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
161 _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
162 "send", "sendto")
c547f6e91c58 Release all forwarded functions in .close. Fixes #1513223.
Martin v. Löwis <martin@v.loewis.de>
parents: 38580
diff changeset
163
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
164 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
165 __slots__ = []
28888
d3164a304598 Regain throughput lost with the _socketobject wrapper. The
Skip Montanaro <skip@pobox.com>
parents: 28818
diff changeset
166 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
167 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
168 # 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
169 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
170 __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
171
42385
e9916a4e06a4 Bug #978833: Close https sockets by releasing the _ssl object.
Martin v. Löwis <martin@v.loewis.de>
parents: 41532
diff changeset
172 # 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
173 # 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
174 # 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
175 # 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
176 class _socketobject(object):
2f411f2d791a Another refactoring. Changed 'socket' from being a factory function
Guido van Rossum <guido@python.org>
parents: 24656
diff changeset
177
2f411f2d791a Another refactoring. Changed 'socket' from being a factory function
Guido van Rossum <guido@python.org>
parents: 24656
diff changeset
178 __doc__ = _realsocket.__doc__
14007
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
179
38976
c547f6e91c58 Release all forwarded functions in .close. Fixes #1513223.
Martin v. Löwis <martin@v.loewis.de>
parents: 38580
diff changeset
180 __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
181
2f411f2d791a Another refactoring. Changed 'socket' from being a factory function
Guido van Rossum <guido@python.org>
parents: 24656
diff changeset
182 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
183 if _sock is None:
24662
a61893d7cef2 Oops, stupid tabs. Sorry again.
Guido van Rossum <guido@python.org>
parents: 24661
diff changeset
184 _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
185 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
186 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
187 setattr(self, method, getattr(_sock, method))
14007
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
188
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
189 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
190 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
191 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
192 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
193 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
194 close.__doc__ = _realsocket.close.__doc__
14007
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
195
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
196 def accept(self):
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
197 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
198 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
199 accept.__doc__ = _realsocket.accept.__doc__
14007
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
200
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
201 def dup(self):
24661
2f411f2d791a Another refactoring. Changed 'socket' from being a factory function
Guido van Rossum <guido@python.org>
parents: 24656
diff changeset
202 """dup() -> socket object
2f411f2d791a Another refactoring. Changed 'socket' from being a factory function
Guido van Rossum <guido@python.org>
parents: 24656
diff changeset
203
2f411f2d791a Another refactoring. Changed 'socket' from being a factory function
Guido van Rossum <guido@python.org>
parents: 24656
diff changeset
204 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
205 return _socketobject(_sock=self._sock)
14007
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
206
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
207 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
208 """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
209
2f411f2d791a Another refactoring. Changed 'socket' from being a factory function
Guido van Rossum <guido@python.org>
parents: 24656
diff changeset
210 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
211 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
212 return _fileobject(self._sock, mode, bufsize)
37136
71c5694e3423 Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 37123
diff changeset
213
37123
251ecec04f1b Correct API design mistake from rev. 43126: make socket attributes readonly properties.
Georg Brandl <georg@python.org>
parents: 37069
diff changeset
214 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
215 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
216 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
217
24661
2f411f2d791a Another refactoring. Changed 'socket' from being a factory function
Guido van Rossum <guido@python.org>
parents: 24656
diff changeset
218 _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
219 "%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
220 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
221 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
222 del _m, _s
14007
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
223
28443
161b8bd8a226 The socket module now always uses the _socketobject wrapper class, even on
Skip Montanaro <skip@pobox.com>
parents: 24944
diff changeset
224 socket = SocketType = _socketobject
14007
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
225
24661
2f411f2d791a Another refactoring. Changed 'socket' from being a factory function
Guido van Rossum <guido@python.org>
parents: 24656
diff changeset
226 class _fileobject(object):
24656
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work
Guido van Rossum <guido@python.org>
parents: 24649
diff changeset
227 """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
228
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work
Guido van Rossum <guido@python.org>
parents: 24649
diff changeset
229 default_bufsize = 8192
24661
2f411f2d791a Another refactoring. Changed 'socket' from being a factory function
Guido van Rossum <guido@python.org>
parents: 24656
diff changeset
230 name = "<socket>"
2f411f2d791a Another refactoring. Changed 'socket' from being a factory function
Guido van Rossum <guido@python.org>
parents: 24656
diff changeset
231
2f411f2d791a Another refactoring. Changed 'socket' from being a factory function
Guido van Rossum <guido@python.org>
parents: 24656
diff changeset
232 __slots__ = ["mode", "bufsize", "softspace",
2f411f2d791a Another refactoring. Changed 'socket' from being a factory function
Guido van Rossum <guido@python.org>
parents: 24656
diff changeset
233 # "closed" is a property, see below
55643
f91c1d288343 Merged revisions 73145 via svnmerge from
Gregory P. Smith <greg@mad-scientist.com>
parents: 54513
diff changeset
234 "_sock", "_rbufsize", "_wbufsize", "_rbuf", "_wbuf", "_wbuf_len",
40684
2fa6e82b1f17 Patch #1627441: close sockets properly in urllib2.
Georg Brandl <georg@python.org>
parents: 39190
diff changeset
235 "_close"]
14007
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
236
40684
2fa6e82b1f17 Patch #1627441: close sockets properly in urllib2.
Georg Brandl <georg@python.org>
parents: 39190
diff changeset
237 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
238 self._sock = sock
24661
2f411f2d791a Another refactoring. Changed 'socket' from being a factory function
Guido van Rossum <guido@python.org>
parents: 24656
diff changeset
239 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
240 if bufsize < 0:
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work
Guido van Rossum <guido@python.org>
parents: 24649
diff changeset
241 bufsize = self.default_bufsize
24662
a61893d7cef2 Oops, stupid tabs. Sorry again.
Guido van Rossum <guido@python.org>
parents: 24661
diff changeset
242 self.bufsize = bufsize
a61893d7cef2 Oops, stupid tabs. Sorry again.
Guido van Rossum <guido@python.org>
parents: 24661
diff changeset
243 self.softspace = False
47898
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
244 # _rbufsize is the suggested recv buffer size. It is *strictly*
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
245 # obeyed within readline() for recv calls. If it is larger than
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
246 # 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
247 if bufsize == 0:
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work
Guido van Rossum <guido@python.org>
parents: 24649
diff changeset
248 self._rbufsize = 1
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work
Guido van Rossum <guido@python.org>
parents: 24649
diff changeset
249 elif bufsize == 1:
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work
Guido van Rossum <guido@python.org>
parents: 24649
diff changeset
250 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
251 else:
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work
Guido van Rossum <guido@python.org>
parents: 24649
diff changeset
252 self._rbufsize = bufsize
14007
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
253 self._wbufsize = bufsize
47898
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
254 # We use StringIO for the read buffer to avoid holding a list
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
255 # of variously sized string objects which have been known to
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
256 # fragment the heap due to how they are malloc()ed and often
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
257 # realloc()ed down much smaller than their original allocation.
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
258 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
259 self._wbuf = [] # A list of strings
55643
f91c1d288343 Merged revisions 73145 via svnmerge from
Gregory P. Smith <greg@mad-scientist.com>
parents: 54513
diff changeset
260 self._wbuf_len = 0
40684
2fa6e82b1f17 Patch #1627441: close sockets properly in urllib2.
Georg Brandl <georg@python.org>
parents: 39190
diff changeset
261 self._close = close
14007
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
262
24661
2f411f2d791a Another refactoring. Changed 'socket' from being a factory function
Guido van Rossum <guido@python.org>
parents: 24656
diff changeset
263 def _getclosed(self):
31833
a910b822b12c SF bug 924242: socket._fileobject._getclosed() returns wrong value
Tim Peters <tim.peters@gmail.com>
parents: 29465
diff changeset
264 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
265 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
266
14007
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
267 def close(self):
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
268 try:
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
269 if self._sock:
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
270 self.flush()
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
271 finally:
40684
2fa6e82b1f17 Patch #1627441: close sockets properly in urllib2.
Georg Brandl <georg@python.org>
parents: 39190
diff changeset
272 if self._close:
2fa6e82b1f17 Patch #1627441: close sockets properly in urllib2.
Georg Brandl <georg@python.org>
parents: 39190
diff changeset
273 self._sock.close()
23715
c2733e8f6612 SF patch 555085 (timeout socket implementation) by Michael Gilfix.
Guido van Rossum <guido@python.org>
parents: 21971
diff changeset
274 self._sock = None
14007
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
275
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
276 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
277 try:
ed70779f6402 I saw errors from _fileobject.__del__ about missing self._sock. This
Guido van Rossum <guido@python.org>
parents: 29066
diff changeset
278 self.close()
ed70779f6402 I saw errors from _fileobject.__del__ about missing self._sock. This
Guido van Rossum <guido@python.org>
parents: 29066
diff changeset
279 except:
ed70779f6402 I saw errors from _fileobject.__del__ about missing self._sock. This
Guido van Rossum <guido@python.org>
parents: 29066
diff changeset
280 # 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
281 pass
14007
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
282
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
283 def flush(self):
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
284 if self._wbuf:
61875
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
285 data = "".join(self._wbuf)
24656
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work
Guido van Rossum <guido@python.org>
parents: 24649
diff changeset
286 self._wbuf = []
55643
f91c1d288343 Merged revisions 73145 via svnmerge from
Gregory P. Smith <greg@mad-scientist.com>
parents: 54513
diff changeset
287 self._wbuf_len = 0
61875
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
288 buffer_size = max(self._rbufsize, self.default_bufsize)
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
289 data_size = len(data)
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
290 write_offset = 0
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
291 try:
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
292 while write_offset < data_size:
63639
4c0b37d869ca Merged revisions 75407,75409-75413,75415,75419-75421 via svnmerge from
Ezio Melotti <ezio.melotti@gmail.com>
parents: 61875
diff changeset
293 with warnings.catch_warnings():
4c0b37d869ca Merged revisions 75407,75409-75413,75415,75419-75421 via svnmerge from
Ezio Melotti <ezio.melotti@gmail.com>
parents: 61875
diff changeset
294 if sys.py3kwarning:
4c0b37d869ca Merged revisions 75407,75409-75413,75415,75419-75421 via svnmerge from
Ezio Melotti <ezio.melotti@gmail.com>
parents: 61875
diff changeset
295 warnings.filterwarnings("ignore", ".*buffer",
4c0b37d869ca Merged revisions 75407,75409-75413,75415,75419-75421 via svnmerge from
Ezio Melotti <ezio.melotti@gmail.com>
parents: 61875
diff changeset
296 DeprecationWarning)
4c0b37d869ca Merged revisions 75407,75409-75413,75415,75419-75421 via svnmerge from
Ezio Melotti <ezio.melotti@gmail.com>
parents: 61875
diff changeset
297 self._sock.sendall(buffer(data, write_offset, buffer_size))
61875
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
298 write_offset += buffer_size
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
299 finally:
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
300 if write_offset < data_size:
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
301 remainder = data[write_offset:]
63937
5343f5714fee #9543: Fix regression introduced in r83624.
Ezio Melotti <ezio.melotti@gmail.com>
parents: 63639
diff changeset
302 del data # explicit free
61875
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
303 self._wbuf.append(remainder)
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
304 self._wbuf_len = len(remainder)
14007
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
305
23844
bd37eb4daf3b Cleanup a little
Neal Norwitz <nnorwitz@gmail.com>
parents: 23715
diff changeset
306 def fileno(self):
14007
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
307 return self._sock.fileno()
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
308
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
309 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
310 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
311 if not data:
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work
Guido van Rossum <guido@python.org>
parents: 24649
diff changeset
312 return
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work
Guido van Rossum <guido@python.org>
parents: 24649
diff changeset
313 self._wbuf.append(data)
55643
f91c1d288343 Merged revisions 73145 via svnmerge from
Gregory P. Smith <greg@mad-scientist.com>
parents: 54513
diff changeset
314 self._wbuf_len += len(data)
24656
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work
Guido van Rossum <guido@python.org>
parents: 24649
diff changeset
315 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
316 self._wbufsize == 1 and '\n' in data or
55643
f91c1d288343 Merged revisions 73145 via svnmerge from
Gregory P. Smith <greg@mad-scientist.com>
parents: 54513
diff changeset
317 self._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
318 self.flush()
14007
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
319
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
320 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
321 # 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
322 # XXX Should really reject non-string non-buffers
55643
f91c1d288343 Merged revisions 73145 via svnmerge from
Gregory P. Smith <greg@mad-scientist.com>
parents: 54513
diff changeset
323 lines = filter(None, map(str, list))
f91c1d288343 Merged revisions 73145 via svnmerge from
Gregory P. Smith <greg@mad-scientist.com>
parents: 54513
diff changeset
324 self._wbuf_len += sum(map(len, lines))
f91c1d288343 Merged revisions 73145 via svnmerge from
Gregory P. Smith <greg@mad-scientist.com>
parents: 54513
diff changeset
325 self._wbuf.extend(lines)
24656
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work
Guido van Rossum <guido@python.org>
parents: 24649
diff changeset
326 if (self._wbufsize <= 1 or
55643
f91c1d288343 Merged revisions 73145 via svnmerge from
Gregory P. Smith <greg@mad-scientist.com>
parents: 54513
diff changeset
327 self._wbuf_len >= self._wbufsize):
24656
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work
Guido van Rossum <guido@python.org>
parents: 24649
diff changeset
328 self.flush()
14007
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
329
24656
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work
Guido van Rossum <guido@python.org>
parents: 24649
diff changeset
330 def _get_wbuf_len(self):
55643
f91c1d288343 Merged revisions 73145 via svnmerge from
Gregory P. Smith <greg@mad-scientist.com>
parents: 54513
diff changeset
331 return self._wbuf_len
23715
c2733e8f6612 SF patch 555085 (timeout socket implementation) by Michael Gilfix.
Guido van Rossum <guido@python.org>
parents: 21971
diff changeset
332
c2733e8f6612 SF patch 555085 (timeout socket implementation) by Michael Gilfix.
Guido van Rossum <guido@python.org>
parents: 21971
diff changeset
333 def read(self, size=-1):
47898
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
334 # Use max, disallow tiny reads in a loop as they are very inefficient.
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
335 # We never leave read() with any leftover data from a new recv() call
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
336 # in our internal buffer.
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
337 rbufsize = max(self._rbufsize, self.default_bufsize)
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
338 # Our use of StringIO rather than lists of string objects returned by
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
339 # recv() minimizes memory usage and fragmentation that occurs when
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
340 # rbufsize is large compared to the typical return value of recv().
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
341 buf = self._rbuf
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
342 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
343 if size < 0:
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work
Guido van Rossum <guido@python.org>
parents: 24649
diff changeset
344 # Read until EOF
47898
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
345 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
346 while True:
61875
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
347 try:
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
348 data = self._sock.recv(rbufsize)
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
349 except error, e:
63639
4c0b37d869ca Merged revisions 75407,75409-75413,75415,75419-75421 via svnmerge from
Ezio Melotti <ezio.melotti@gmail.com>
parents: 61875
diff changeset
350 if e.args[0] == EINTR:
61875
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
351 continue
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
352 raise
24656
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work
Guido van Rossum <guido@python.org>
parents: 24649
diff changeset
353 if not data:
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work
Guido van Rossum <guido@python.org>
parents: 24649
diff changeset
354 break
47898
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
355 buf.write(data)
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
356 return buf.getvalue()
24656
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work
Guido van Rossum <guido@python.org>
parents: 24649
diff changeset
357 else:
24664
6a6d02be321c Another refactoring of read() and readline(), this time based on the
Guido van Rossum <guido@python.org>
parents: 24663
diff changeset
358 # Read until size bytes or EOF seen, whichever comes first
47898
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
359 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
360 if buf_len >= size:
47898
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
361 # Already have size bytes in our buffer? Extract and return.
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
362 buf.seek(0)
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
363 rv = buf.read(size)
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
364 self._rbuf = StringIO()
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
365 self._rbuf.write(buf.read())
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
366 return rv
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
367
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
368 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
369 while True:
6a6d02be321c Another refactoring of read() and readline(), this time based on the
Guido van Rossum <guido@python.org>
parents: 24663
diff changeset
370 left = size - buf_len
47898
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
371 # recv() will malloc the amount of memory given as its
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
372 # parameter even though it often returns much less data
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
373 # than that. The returned data string is short lived
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
374 # as we copy it into a StringIO and free it. This avoids
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
375 # fragmentation issues on many platforms.
61875
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
376 try:
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
377 data = self._sock.recv(left)
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
378 except error, e:
63639
4c0b37d869ca Merged revisions 75407,75409-75413,75415,75419-75421 via svnmerge from
Ezio Melotti <ezio.melotti@gmail.com>
parents: 61875
diff changeset
379 if e.args[0] == EINTR:
61875
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
380 continue
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
381 raise
24656
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work
Guido van Rossum <guido@python.org>
parents: 24649
diff changeset
382 if not data:
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work
Guido van Rossum <guido@python.org>
parents: 24649
diff changeset
383 break
24664
6a6d02be321c Another refactoring of read() and readline(), this time based on the
Guido van Rossum <guido@python.org>
parents: 24663
diff changeset
384 n = len(data)
47898
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
385 if n == size and not buf_len:
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
386 # Shortcut. Avoid buffer data copies when:
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
387 # - We have no data in our buffer.
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
388 # AND
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
389 # - Our call to recv returned exactly the
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
390 # number of bytes we were asked to read.
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
391 return data
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
392 if n == left:
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
393 buf.write(data)
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
394 del data # explicit free
24664
6a6d02be321c Another refactoring of read() and readline(), this time based on the
Guido van Rossum <guido@python.org>
parents: 24663
diff changeset
395 break
47898
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
396 assert n <= left, "recv(%d) returned %d bytes" % (left, n)
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
397 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
398 buf_len += n
47898
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
399 del data # explicit free
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
400 #assert buf_len == buf.tell()
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
401 return buf.getvalue()
14007
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
402
23715
c2733e8f6612 SF patch 555085 (timeout socket implementation) by Michael Gilfix.
Guido van Rossum <guido@python.org>
parents: 21971
diff changeset
403 def readline(self, size=-1):
47898
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
404 buf = self._rbuf
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
405 buf.seek(0, 2) # seek end
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
406 if buf.tell() > 0:
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
407 # check if we already have it in our buffer
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
408 buf.seek(0)
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
409 bline = buf.readline(size)
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
410 if bline.endswith('\n') or len(bline) == size:
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
411 self._rbuf = StringIO()
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
412 self._rbuf.write(buf.read())
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
413 return bline
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
414 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
415 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
416 # 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
417 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
418 # Speed up unbuffered case
47898
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
419 buf.seek(0)
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
420 buffers = [buf.read()]
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
421 self._rbuf = StringIO() # reset _rbuf. we consume it via buf.
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
422 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
423 recv = self._sock.recv
61875
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
424 while True:
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
425 try:
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
426 while data != "\n":
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
427 data = recv(1)
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
428 if not data:
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
429 break
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
430 buffers.append(data)
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
431 except error, e:
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
432 # The try..except to catch EINTR was moved outside the
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
433 # recv loop to avoid the per byte overhead.
63639
4c0b37d869ca Merged revisions 75407,75409-75413,75415,75419-75421 via svnmerge from
Ezio Melotti <ezio.melotti@gmail.com>
parents: 61875
diff changeset
434 if e.args[0] == EINTR:
61875
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
435 continue
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
436 raise
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
437 break
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
438 return "".join(buffers)
47898
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
439
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
440 buf.seek(0, 2) # seek end
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
441 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
442 while True:
61875
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
443 try:
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
444 data = self._sock.recv(self._rbufsize)
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
445 except error, e:
63639
4c0b37d869ca Merged revisions 75407,75409-75413,75415,75419-75421 via svnmerge from
Ezio Melotti <ezio.melotti@gmail.com>
parents: 61875
diff changeset
446 if e.args[0] == EINTR:
61875
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
447 continue
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
448 raise
24664
6a6d02be321c Another refactoring of read() and readline(), this time based on the
Guido van Rossum <guido@python.org>
parents: 24663
diff changeset
449 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
450 break
6a6d02be321c Another refactoring of read() and readline(), this time based on the
Guido van Rossum <guido@python.org>
parents: 24663
diff changeset
451 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
452 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
453 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
454 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
455 self._rbuf.write(data[nl:])
47898
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
456 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
457 break
47898
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
458 buf.write(data)
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
459 return buf.getvalue()
23715
c2733e8f6612 SF patch 555085 (timeout socket implementation) by Michael Gilfix.
Guido van Rossum <guido@python.org>
parents: 21971
diff changeset
460 else:
24664
6a6d02be321c Another refactoring of read() and readline(), this time based on the
Guido van Rossum <guido@python.org>
parents: 24663
diff changeset
461 # Read until size bytes or \n or EOF seen, whichever comes first
47898
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
462 buf.seek(0, 2) # seek end
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
463 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
464 if buf_len >= size:
47898
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
465 buf.seek(0)
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
466 rv = buf.read(size)
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
467 self._rbuf = StringIO()
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
468 self._rbuf.write(buf.read())
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
469 return rv
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
470 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
471 while True:
61875
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
472 try:
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
473 data = self._sock.recv(self._rbufsize)
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
474 except error, e:
63639
4c0b37d869ca Merged revisions 75407,75409-75413,75415,75419-75421 via svnmerge from
Ezio Melotti <ezio.melotti@gmail.com>
parents: 61875
diff changeset
475 if e.args[0] == EINTR:
61875
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
476 continue
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
477 raise
24664
6a6d02be321c Another refactoring of read() and readline(), this time based on the
Guido van Rossum <guido@python.org>
parents: 24663
diff changeset
478 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
479 break
6a6d02be321c Another refactoring of read() and readline(), this time based on the
Guido van Rossum <guido@python.org>
parents: 24663
diff changeset
480 left = size - buf_len
47898
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
481 # 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
482 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
483 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
484 nl += 1
47898
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
485 # 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
486 self._rbuf.write(data[nl:])
47898
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
487 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
488 buf.write(data[:nl])
47898
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
489 break
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
490 else:
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
491 # Shortcut. Avoid data copy through buf when returning
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
492 # a substring of our first recv().
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
493 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
494 n = len(data)
47898
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
495 if n == size and not buf_len:
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
496 # Shortcut. Avoid data copy through buf when
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
497 # returning exactly all of our first recv().
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
498 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
499 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
500 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
501 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
502 break
47898
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
503 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
504 buf_len += n
47898
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
505 #assert buf_len == buf.tell()
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
506 return buf.getvalue()
23715
c2733e8f6612 SF patch 555085 (timeout socket implementation) by Michael Gilfix.
Guido van Rossum <guido@python.org>
parents: 21971
diff changeset
507
c2733e8f6612 SF patch 555085 (timeout socket implementation) by Michael Gilfix.
Guido van Rossum <guido@python.org>
parents: 21971
diff changeset
508 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
509 total = 0
14007
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
510 list = []
24664
6a6d02be321c Another refactoring of read() and readline(), this time based on the
Guido van Rossum <guido@python.org>
parents: 24663
diff changeset
511 while True:
14007
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
512 line = self.readline()
23844
bd37eb4daf3b Cleanup a little
Neal Norwitz <nnorwitz@gmail.com>
parents: 23715
diff changeset
513 if not line:
bd37eb4daf3b Cleanup a little
Neal Norwitz <nnorwitz@gmail.com>
parents: 23715
diff changeset
514 break
14007
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
515 list.append(line)
14682
295126433856 Support sizehint in _fileobject.readlines, as documented.
Martin v. Löwis <martin@v.loewis.de>
parents: 14592
diff changeset
516 total += len(line)
295126433856 Support sizehint in _fileobject.readlines, as documented.
Martin v. Löwis <martin@v.loewis.de>
parents: 14592
diff changeset
517 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
518 break
14007
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
519 return list
24656
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work
Guido van Rossum <guido@python.org>
parents: 24649
diff changeset
520
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work
Guido van Rossum <guido@python.org>
parents: 24649
diff changeset
521 # Iterator protocols
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work
Guido van Rossum <guido@python.org>
parents: 24649
diff changeset
522
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work
Guido van Rossum <guido@python.org>
parents: 24649
diff changeset
523 def __iter__(self):
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work
Guido van Rossum <guido@python.org>
parents: 24649
diff changeset
524 return self
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work
Guido van Rossum <guido@python.org>
parents: 24649
diff changeset
525
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work
Guido van Rossum <guido@python.org>
parents: 24649
diff changeset
526 def next(self):
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work
Guido van Rossum <guido@python.org>
parents: 24649
diff changeset
527 line = self.readline()
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work
Guido van Rossum <guido@python.org>
parents: 24649
diff changeset
528 if not line:
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work
Guido van Rossum <guido@python.org>
parents: 24649
diff changeset
529 raise StopIteration
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work
Guido van Rossum <guido@python.org>
parents: 24649
diff changeset
530 return line
41288
a73aa0b821ca Added a 'create_connect()' function to socket.py, which creates a
Facundo Batista <facundobatista@gmail.com>
parents: 41285
diff changeset
531
47372
e2c5ae30cffe Fixed the semantic of timeout for socket.create_connection and
Facundo Batista <facundobatista@gmail.com>
parents: 46684
diff changeset
532 _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
533
47372
e2c5ae30cffe Fixed the semantic of timeout for socket.create_connection and
Facundo Batista <facundobatista@gmail.com>
parents: 46684
diff changeset
534 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
535 """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
536
47372
e2c5ae30cffe Fixed the semantic of timeout for socket.create_connection and
Facundo Batista <facundobatista@gmail.com>
parents: 46684
diff changeset
537 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
538 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
539 *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
540 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
541 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
542 is used.
41288
a73aa0b821ca Added a 'create_connect()' function to socket.py, which creates a
Facundo Batista <facundobatista@gmail.com>
parents: 41285
diff changeset
543 """
41532
4b9fa8092e82 Whitespace normalization. Ugh, we really need to do this more often.
Neal Norwitz <nnorwitz@gmail.com>
parents: 41288
diff changeset
544
41288
a73aa0b821ca Added a 'create_connect()' function to socket.py, which creates a
Facundo Batista <facundobatista@gmail.com>
parents: 41285
diff changeset
545 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
546 host, port = address
a73aa0b821ca Added a 'create_connect()' function to socket.py, which creates a
Facundo Batista <facundobatista@gmail.com>
parents: 41285
diff changeset
547 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
548 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
549 sock = None
a73aa0b821ca Added a 'create_connect()' function to socket.py, which creates a
Facundo Batista <facundobatista@gmail.com>
parents: 41285
diff changeset
550 try:
a73aa0b821ca Added a 'create_connect()' function to socket.py, which creates a
Facundo Batista <facundobatista@gmail.com>
parents: 41285
diff changeset
551 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
552 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
553 sock.settimeout(timeout)
a73aa0b821ca Added a 'create_connect()' function to socket.py, which creates a
Facundo Batista <facundobatista@gmail.com>
parents: 41285
diff changeset
554 sock.connect(sa)
a73aa0b821ca Added a 'create_connect()' function to socket.py, which creates a
Facundo Batista <facundobatista@gmail.com>
parents: 41285
diff changeset
555 return sock
41532
4b9fa8092e82 Whitespace normalization. Ugh, we really need to do this more often.
Neal Norwitz <nnorwitz@gmail.com>
parents: 41288
diff changeset
556
41288
a73aa0b821ca Added a 'create_connect()' function to socket.py, which creates a
Facundo Batista <facundobatista@gmail.com>
parents: 41285
diff changeset
557 except error, msg:
a73aa0b821ca Added a 'create_connect()' function to socket.py, which creates a
Facundo Batista <facundobatista@gmail.com>
parents: 41285
diff changeset
558 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
559 sock.close()
a73aa0b821ca Added a 'create_connect()' function to socket.py, which creates a
Facundo Batista <facundobatista@gmail.com>
parents: 41285
diff changeset
560
a73aa0b821ca Added a 'create_connect()' function to socket.py, which creates a
Facundo Batista <facundobatista@gmail.com>
parents: 41285
diff changeset
561 raise error, msg