annotate Lib/socket.py @ 80661:94de77bd0b4b 2.7

Issue #16194: document imp.load_dynamic problems when read several extension modules from the same binary object file.
author Andrew Svetlov <andrew.svetlov@gmail.com>
date Thu, 29 Nov 2012 19:51:28 +0200
parents b36cb4602e21
children 5be3fa83d436
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
58112
72e3e85bac8b Adds an optional source_address parameter to socket.create_connection().
Gregory P. Smith <greg@mad-scientist.com>
parents: 56521
diff changeset
27 create_connection() -- connects to an address, with an optional timeout and
72e3e85bac8b Adds an optional source_address parameter to socket.create_connection().
Gregory P. Smith <greg@mad-scientist.com>
parents: 56521
diff changeset
28 optional source address.
14007
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
29
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
30 [*] not available on all platforms!
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
31
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
32 Special objects:
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
33
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
34 SocketType -- type object for socket objects
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
35 error -- exception raised for I/O errors
28818
57e61588571b Patch by Jp Calderone:
Guido van Rossum <guido@python.org>
parents: 28443
diff changeset
36 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
37
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
38 Integer constants:
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
39
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
40 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
41 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
42
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
43 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
44 the setsockopt() and getsockopt() methods.
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
45 """
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
46
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
47 import _socket
14007
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
48 from _socket import *
53047
7e229ca0b92a remove unpleasant exec
Chris Withers <chris@simplistix.co.uk>
parents: 52936
diff changeset
49 from functools import partial
56521
9e718d8f71e8 Fix py3k warnings in the socket module
Antoine Pitrou <solipsis@pitrou.net>
parents: 55627
diff changeset
50 from types import MethodType
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
51
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
52 try:
24663
b265e76bab88 Extend __all__ with the exports list of the _ssl module.
Guido van Rossum <guido@python.org>
parents: 24662
diff changeset
53 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
54 except ImportError:
43008
4771639fc049 This contains a number of things:
Bill Janssen <janssen@parc.com>
parents: 42828
diff changeset
55 # no SSL support
24661
2f411f2d791a Another refactoring. Changed 'socket' from being a factory function
Guido van Rossum <guido@python.org>
parents: 24656
diff changeset
56 pass
43008
4771639fc049 This contains a number of things:
Bill Janssen <janssen@parc.com>
parents: 42828
diff changeset
57 else:
4771639fc049 This contains a number of things:
Bill Janssen <janssen@parc.com>
parents: 42828
diff changeset
58 def ssl(sock, keyfile=None, certfile=None):
4771639fc049 This contains a number of things:
Bill Janssen <janssen@parc.com>
parents: 42828
diff changeset
59 # 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
60 # module imports the socket module
4771639fc049 This contains a number of things:
Bill Janssen <janssen@parc.com>
parents: 42828
diff changeset
61 import ssl as _realssl
43325
193020bf52dc More work on SSL support.
Bill Janssen <janssen@parc.com>
parents: 43008
diff changeset
62 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
63 DeprecationWarning, stacklevel=2)
4771639fc049 This contains a number of things:
Bill Janssen <janssen@parc.com>
parents: 42828
diff changeset
64 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
65
43008
4771639fc049 This contains a number of things:
Bill Janssen <janssen@parc.com>
parents: 42828
diff changeset
66 # 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
67 from _ssl import SSLError as sslerror
43008
4771639fc049 This contains a number of things:
Bill Janssen <janssen@parc.com>
parents: 42828
diff changeset
68 from _ssl import \
4771639fc049 This contains a number of things:
Bill Janssen <janssen@parc.com>
parents: 42828
diff changeset
69 RAND_add, \
4771639fc049 This contains a number of things:
Bill Janssen <janssen@parc.com>
parents: 42828
diff changeset
70 RAND_egd, \
4771639fc049 This contains a number of things:
Bill Janssen <janssen@parc.com>
parents: 42828
diff changeset
71 RAND_status, \
4771639fc049 This contains a number of things:
Bill Janssen <janssen@parc.com>
parents: 42828
diff changeset
72 SSL_ERROR_ZERO_RETURN, \
4771639fc049 This contains a number of things:
Bill Janssen <janssen@parc.com>
parents: 42828
diff changeset
73 SSL_ERROR_WANT_READ, \
4771639fc049 This contains a number of things:
Bill Janssen <janssen@parc.com>
parents: 42828
diff changeset
74 SSL_ERROR_WANT_WRITE, \
4771639fc049 This contains a number of things:
Bill Janssen <janssen@parc.com>
parents: 42828
diff changeset
75 SSL_ERROR_WANT_X509_LOOKUP, \
4771639fc049 This contains a number of things:
Bill Janssen <janssen@parc.com>
parents: 42828
diff changeset
76 SSL_ERROR_SYSCALL, \
4771639fc049 This contains a number of things:
Bill Janssen <janssen@parc.com>
parents: 42828
diff changeset
77 SSL_ERROR_SSL, \
4771639fc049 This contains a number of things:
Bill Janssen <janssen@parc.com>
parents: 42828
diff changeset
78 SSL_ERROR_WANT_CONNECT, \
4771639fc049 This contains a number of things:
Bill Janssen <janssen@parc.com>
parents: 42828
diff changeset
79 SSL_ERROR_EOF, \
4771639fc049 This contains a number of things:
Bill Janssen <janssen@parc.com>
parents: 42828
diff changeset
80 SSL_ERROR_INVALID_ERROR_CODE
4771639fc049 This contains a number of things:
Bill Janssen <janssen@parc.com>
parents: 42828
diff changeset
81
4771639fc049 This contains a number of things:
Bill Janssen <janssen@parc.com>
parents: 42828
diff changeset
82 import os, sys, warnings
14007
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
83
28890
39f4b97ce828 Extract the errno value to use from the errno module if possible.
Fred Drake <fdrake@acm.org>
parents: 28888
diff changeset
84 try:
47898
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
85 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
86 except ImportError:
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
87 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
88
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
89 try:
61875
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
90 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
91 except ImportError:
61875
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
92 errno = None
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
93 EBADF = getattr(errno, 'EBADF', 9)
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
94 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
95
52936
5b01fe513f92 Merged revisions 71329 via svnmerge from
Benjamin Peterson <benjamin@python.org>
parents: 48195
diff changeset
96 __all__ = ["getfqdn", "create_connection"]
16613
f68dbffff927 bunch more __all__ lists
Skip Montanaro <skip@pobox.com>
parents: 15872
diff changeset
97 __all__.extend(os._get_exports_list(_socket))
43008
4771639fc049 This contains a number of things:
Bill Janssen <janssen@parc.com>
parents: 42828
diff changeset
98
16613
f68dbffff927 bunch more __all__ lists
Skip Montanaro <skip@pobox.com>
parents: 15872
diff changeset
99
24661
2f411f2d791a Another refactoring. Changed 'socket' from being a factory function
Guido van Rossum <guido@python.org>
parents: 24656
diff changeset
100 _realsocket = socket
14007
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
101
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
102 # WSA error codes
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
103 if sys.platform.lower().startswith("win"):
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
104 errorTab = {}
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
105 errorTab[10004] = "The operation was interrupted."
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
106 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
107 errorTab[10013] = "Permission denied."
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
108 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
109 errorTab[10022] = "An invalid operation was attempted."
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
110 errorTab[10035] = "The socket operation would block"
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
111 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
112 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
113 errorTab[10054] = "The connection has been reset."
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
114 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
115 errorTab[10060] = "The operation timed out."
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
116 errorTab[10061] = "Connection refused."
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
117 errorTab[10063] = "The name is too long."
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
118 errorTab[10064] = "The host is down."
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
119 errorTab[10065] = "The host is unreachable."
17071
b45ae8c467aa add errorTab to __all__ on win*
Skip Montanaro <skip@pobox.com>
parents: 16949
diff changeset
120 __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
121
14007
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
122
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 def getfqdn(name=''):
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
125 """Get fully qualified domain name from name.
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
126
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
127 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
128
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
129 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
130 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
131 from gethostname() is returned.
14007
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
132 """
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
133 name = name.strip()
14014
3d68d5bccd40 updated occurences of fqdn algorithm (closes patch #101197)
Peter Schneider-Kamp <nowonder@nowonder.de>
parents: 14007
diff changeset
134 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
135 name = gethostname()
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
136 try:
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
137 hostname, aliases, ipaddrs = gethostbyaddr(name)
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
138 except error:
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
139 pass
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
140 else:
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
141 aliases.insert(0, hostname)
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
142 for name in aliases:
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
143 if '.' in name:
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
144 break
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
145 else:
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
146 name = hostname
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
147 return name
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
148
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
149
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
150 _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
151 '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
152 'getpeername', 'getsockname', 'getsockopt', 'setsockopt',
28888
d3164a304598 Regain throughput lost with the _socketobject wrapper. The
Skip Montanaro <skip@pobox.com>
parents: 28818
diff changeset
153 'sendall', 'setblocking',
23715
c2733e8f6612 SF patch 555085 (timeout socket implementation) by Michael Gilfix.
Guido van Rossum <guido@python.org>
parents: 21971
diff changeset
154 '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
155
44478
73bc002252bf socket.ioctl is only available on Windows
Christian Heimes <christian@cheimes.de>
parents: 44474
diff changeset
156 if os.name == "nt":
73bc002252bf socket.ioctl is only available on Windows
Christian Heimes <christian@cheimes.de>
parents: 44474
diff changeset
157 _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
158
29066
90342f395721 Patch #734231: Update RiscOS support. In particular, correct
Martin v. Löwis <martin@v.loewis.de>
parents: 28890
diff changeset
159 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
160 _socketmethods = _socketmethods + ('sleeptaskw',)
90342f395721 Patch #734231: Update RiscOS support. In particular, correct
Martin v. Löwis <martin@v.loewis.de>
parents: 28890
diff changeset
161
38976
c547f6e91c58 Release all forwarded functions in .close. Fixes #1513223.
Martin v. Löwis <martin@v.loewis.de>
parents: 38580
diff changeset
162 # 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
163 # 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
164 _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
165 "send", "sendto")
c547f6e91c58 Release all forwarded functions in .close. Fixes #1513223.
Martin v. Löwis <martin@v.loewis.de>
parents: 38580
diff changeset
166
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
167 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
168 __slots__ = []
28888
d3164a304598 Regain throughput lost with the _socketobject wrapper. The
Skip Montanaro <skip@pobox.com>
parents: 28818
diff changeset
169 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
170 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
171 # 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
172 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
173 __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
174
42385
e9916a4e06a4 Bug #978833: Close https sockets by releasing the _ssl object.
Martin v. Löwis <martin@v.loewis.de>
parents: 41532
diff changeset
175 # 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
176 # 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
177 # 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
178 # 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
179 class _socketobject(object):
2f411f2d791a Another refactoring. Changed 'socket' from being a factory function
Guido van Rossum <guido@python.org>
parents: 24656
diff changeset
180
2f411f2d791a Another refactoring. Changed 'socket' from being a factory function
Guido van Rossum <guido@python.org>
parents: 24656
diff changeset
181 __doc__ = _realsocket.__doc__
14007
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
182
38976
c547f6e91c58 Release all forwarded functions in .close. Fixes #1513223.
Martin v. Löwis <martin@v.loewis.de>
parents: 38580
diff changeset
183 __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
184
2f411f2d791a Another refactoring. Changed 'socket' from being a factory function
Guido van Rossum <guido@python.org>
parents: 24656
diff changeset
185 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
186 if _sock is None:
24662
a61893d7cef2 Oops, stupid tabs. Sorry again.
Guido van Rossum <guido@python.org>
parents: 24661
diff changeset
187 _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
188 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
189 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
190 setattr(self, method, getattr(_sock, method))
14007
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
191
64334
4f2905ea7809 Issue #808164: Fixed socket.close to avoid references to globals, to
Daniel Stutzbach <daniel@stutzbachenterprises.com>
parents: 58112
diff changeset
192 def close(self, _closedsocket=_closedsocket,
4f2905ea7809 Issue #808164: Fixed socket.close to avoid references to globals, to
Daniel Stutzbach <daniel@stutzbachenterprises.com>
parents: 58112
diff changeset
193 _delegate_methods=_delegate_methods, setattr=setattr):
4f2905ea7809 Issue #808164: Fixed socket.close to avoid references to globals, to
Daniel Stutzbach <daniel@stutzbachenterprises.com>
parents: 58112
diff changeset
194 # This function should not reference any globals. See issue #808164.
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
195 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
196 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
197 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
198 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
199 close.__doc__ = _realsocket.close.__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 accept(self):
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
202 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
203 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
204 accept.__doc__ = _realsocket.accept.__doc__
14007
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
205
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
206 def dup(self):
24661
2f411f2d791a Another refactoring. Changed 'socket' from being a factory function
Guido van Rossum <guido@python.org>
parents: 24656
diff changeset
207 """dup() -> socket object
2f411f2d791a Another refactoring. Changed 'socket' from being a factory function
Guido van Rossum <guido@python.org>
parents: 24656
diff changeset
208
2f411f2d791a Another refactoring. Changed 'socket' from being a factory function
Guido van Rossum <guido@python.org>
parents: 24656
diff changeset
209 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
210 return _socketobject(_sock=self._sock)
14007
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
211
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
212 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
213 """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
214
2f411f2d791a Another refactoring. Changed 'socket' from being a factory function
Guido van Rossum <guido@python.org>
parents: 24656
diff changeset
215 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
216 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
217 return _fileobject(self._sock, mode, bufsize)
37136
71c5694e3423 Whitespace normalization.
Tim Peters <tim.peters@gmail.com>
parents: 37123
diff changeset
218
37123
251ecec04f1b Correct API design mistake from rev. 43126: make socket attributes readonly properties.
Georg Brandl <georg@python.org>
parents: 37069
diff changeset
219 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
220 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
221 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
222
53047
7e229ca0b92a remove unpleasant exec
Chris Withers <chris@simplistix.co.uk>
parents: 52936
diff changeset
223 def meth(name,self,*args):
7e229ca0b92a remove unpleasant exec
Chris Withers <chris@simplistix.co.uk>
parents: 52936
diff changeset
224 return getattr(self._sock,name)(*args)
7e229ca0b92a remove unpleasant exec
Chris Withers <chris@simplistix.co.uk>
parents: 52936
diff changeset
225
7e229ca0b92a remove unpleasant exec
Chris Withers <chris@simplistix.co.uk>
parents: 52936
diff changeset
226 for _m in _socketmethods:
7e229ca0b92a remove unpleasant exec
Chris Withers <chris@simplistix.co.uk>
parents: 52936
diff changeset
227 p = partial(meth,_m)
7e229ca0b92a remove unpleasant exec
Chris Withers <chris@simplistix.co.uk>
parents: 52936
diff changeset
228 p.__name__ = _m
7e229ca0b92a remove unpleasant exec
Chris Withers <chris@simplistix.co.uk>
parents: 52936
diff changeset
229 p.__doc__ = getattr(_realsocket,_m).__doc__
56521
9e718d8f71e8 Fix py3k warnings in the socket module
Antoine Pitrou <solipsis@pitrou.net>
parents: 55627
diff changeset
230 m = MethodType(p,None,_socketobject)
53047
7e229ca0b92a remove unpleasant exec
Chris Withers <chris@simplistix.co.uk>
parents: 52936
diff changeset
231 setattr(_socketobject,_m,m)
14007
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
232
28443
161b8bd8a226 The socket module now always uses the _socketobject wrapper class, even on
Skip Montanaro <skip@pobox.com>
parents: 24944
diff changeset
233 socket = SocketType = _socketobject
14007
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
234
24661
2f411f2d791a Another refactoring. Changed 'socket' from being a factory function
Guido van Rossum <guido@python.org>
parents: 24656
diff changeset
235 class _fileobject(object):
24656
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work
Guido van Rossum <guido@python.org>
parents: 24649
diff changeset
236 """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
237
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work
Guido van Rossum <guido@python.org>
parents: 24649
diff changeset
238 default_bufsize = 8192
24661
2f411f2d791a Another refactoring. Changed 'socket' from being a factory function
Guido van Rossum <guido@python.org>
parents: 24656
diff changeset
239 name = "<socket>"
2f411f2d791a Another refactoring. Changed 'socket' from being a factory function
Guido van Rossum <guido@python.org>
parents: 24656
diff changeset
240
2f411f2d791a Another refactoring. Changed 'socket' from being a factory function
Guido van Rossum <guido@python.org>
parents: 24656
diff changeset
241 __slots__ = ["mode", "bufsize", "softspace",
2f411f2d791a Another refactoring. Changed 'socket' from being a factory function
Guido van Rossum <guido@python.org>
parents: 24656
diff changeset
242 # "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
243 "_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
244 "_close"]
14007
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
245
40684
2fa6e82b1f17 Patch #1627441: close sockets properly in urllib2.
Georg Brandl <georg@python.org>
parents: 39190
diff changeset
246 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
247 self._sock = sock
24661
2f411f2d791a Another refactoring. Changed 'socket' from being a factory function
Guido van Rossum <guido@python.org>
parents: 24656
diff changeset
248 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
249 if bufsize < 0:
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work
Guido van Rossum <guido@python.org>
parents: 24649
diff changeset
250 bufsize = self.default_bufsize
24662
a61893d7cef2 Oops, stupid tabs. Sorry again.
Guido van Rossum <guido@python.org>
parents: 24661
diff changeset
251 self.bufsize = bufsize
a61893d7cef2 Oops, stupid tabs. Sorry again.
Guido van Rossum <guido@python.org>
parents: 24661
diff changeset
252 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
253 # _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
254 # 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
255 # 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
256 if bufsize == 0:
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work
Guido van Rossum <guido@python.org>
parents: 24649
diff changeset
257 self._rbufsize = 1
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work
Guido van Rossum <guido@python.org>
parents: 24649
diff changeset
258 elif bufsize == 1:
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work
Guido van Rossum <guido@python.org>
parents: 24649
diff changeset
259 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
260 else:
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work
Guido van Rossum <guido@python.org>
parents: 24649
diff changeset
261 self._rbufsize = bufsize
14007
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
262 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
263 # 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
264 # 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
265 # 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
266 # 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
267 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
268 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
269 self._wbuf_len = 0
40684
2fa6e82b1f17 Patch #1627441: close sockets properly in urllib2.
Georg Brandl <georg@python.org>
parents: 39190
diff changeset
270 self._close = close
14007
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
271
24661
2f411f2d791a Another refactoring. Changed 'socket' from being a factory function
Guido van Rossum <guido@python.org>
parents: 24656
diff changeset
272 def _getclosed(self):
31833
a910b822b12c SF bug 924242: socket._fileobject._getclosed() returns wrong value
Tim Peters <tim.peters@gmail.com>
parents: 29465
diff changeset
273 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
274 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
275
14007
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
276 def close(self):
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
277 try:
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
278 if self._sock:
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
279 self.flush()
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
280 finally:
40684
2fa6e82b1f17 Patch #1627441: close sockets properly in urllib2.
Georg Brandl <georg@python.org>
parents: 39190
diff changeset
281 if self._close:
2fa6e82b1f17 Patch #1627441: close sockets properly in urllib2.
Georg Brandl <georg@python.org>
parents: 39190
diff changeset
282 self._sock.close()
23715
c2733e8f6612 SF patch 555085 (timeout socket implementation) by Michael Gilfix.
Guido van Rossum <guido@python.org>
parents: 21971
diff changeset
283 self._sock = None
14007
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
284
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
285 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
286 try:
ed70779f6402 I saw errors from _fileobject.__del__ about missing self._sock. This
Guido van Rossum <guido@python.org>
parents: 29066
diff changeset
287 self.close()
ed70779f6402 I saw errors from _fileobject.__del__ about missing self._sock. This
Guido van Rossum <guido@python.org>
parents: 29066
diff changeset
288 except:
ed70779f6402 I saw errors from _fileobject.__del__ about missing self._sock. This
Guido van Rossum <guido@python.org>
parents: 29066
diff changeset
289 # 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
290 pass
14007
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
291
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
292 def flush(self):
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
293 if self._wbuf:
61875
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
294 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
295 self._wbuf = []
55643
f91c1d288343 Merged revisions 73145 via svnmerge from
Gregory P. Smith <greg@mad-scientist.com>
parents: 54513
diff changeset
296 self._wbuf_len = 0
61875
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
297 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
298 data_size = len(data)
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
299 write_offset = 0
56521
9e718d8f71e8 Fix py3k warnings in the socket module
Antoine Pitrou <solipsis@pitrou.net>
parents: 55627
diff changeset
300 view = memoryview(data)
61875
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
301 try:
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
302 while write_offset < data_size:
56521
9e718d8f71e8 Fix py3k warnings in the socket module
Antoine Pitrou <solipsis@pitrou.net>
parents: 55627
diff changeset
303 self._sock.sendall(view[write_offset:write_offset+buffer_size])
61875
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
304 write_offset += buffer_size
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
305 finally:
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
306 if write_offset < data_size:
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
307 remainder = data[write_offset:]
56521
9e718d8f71e8 Fix py3k warnings in the socket module
Antoine Pitrou <solipsis@pitrou.net>
parents: 55627
diff changeset
308 del view, data # explicit free
61875
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
309 self._wbuf.append(remainder)
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
310 self._wbuf_len = len(remainder)
14007
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
311
23844
bd37eb4daf3b Cleanup a little
Neal Norwitz <nnorwitz@gmail.com>
parents: 23715
diff changeset
312 def fileno(self):
14007
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
313 return self._sock.fileno()
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
314
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
315 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
316 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
317 if not data:
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work
Guido van Rossum <guido@python.org>
parents: 24649
diff changeset
318 return
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work
Guido van Rossum <guido@python.org>
parents: 24649
diff changeset
319 self._wbuf.append(data)
55643
f91c1d288343 Merged revisions 73145 via svnmerge from
Gregory P. Smith <greg@mad-scientist.com>
parents: 54513
diff changeset
320 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
321 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
322 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
323 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
324 self.flush()
14007
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
325
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
326 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
327 # 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
328 # 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
329 lines = filter(None, map(str, list))
f91c1d288343 Merged revisions 73145 via svnmerge from
Gregory P. Smith <greg@mad-scientist.com>
parents: 54513
diff changeset
330 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
331 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
332 if (self._wbufsize <= 1 or
55643
f91c1d288343 Merged revisions 73145 via svnmerge from
Gregory P. Smith <greg@mad-scientist.com>
parents: 54513
diff changeset
333 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
334 self.flush()
14007
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
335
23715
c2733e8f6612 SF patch 555085 (timeout socket implementation) by Michael Gilfix.
Guido van Rossum <guido@python.org>
parents: 21971
diff changeset
336 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
337 # 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
338 # 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
339 # 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
340 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
341 # 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
342 # 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
343 # 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
344 buf = self._rbuf
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
345 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
346 if size < 0:
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work
Guido van Rossum <guido@python.org>
parents: 24649
diff changeset
347 # 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
348 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
349 while True:
61875
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
350 try:
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
351 data = self._sock.recv(rbufsize)
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
352 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
353 if e.args[0] == EINTR:
61875
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
354 continue
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
355 raise
24656
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work
Guido van Rossum <guido@python.org>
parents: 24649
diff changeset
356 if not data:
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work
Guido van Rossum <guido@python.org>
parents: 24649
diff changeset
357 break
47898
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
358 buf.write(data)
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
359 return buf.getvalue()
24656
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work
Guido van Rossum <guido@python.org>
parents: 24649
diff changeset
360 else:
24664
6a6d02be321c Another refactoring of read() and readline(), this time based on the
Guido van Rossum <guido@python.org>
parents: 24663
diff changeset
361 # 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
362 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
363 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
364 # 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
365 buf.seek(0)
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
366 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
367 self._rbuf = StringIO()
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
368 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
369 return rv
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
370
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
371 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
372 while True:
6a6d02be321c Another refactoring of read() and readline(), this time based on the
Guido van Rossum <guido@python.org>
parents: 24663
diff changeset
373 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
374 # 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
375 # 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
376 # 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
377 # 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
378 # fragmentation issues on many platforms.
61875
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
379 try:
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
380 data = self._sock.recv(left)
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
381 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
382 if e.args[0] == EINTR:
61875
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
383 continue
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
384 raise
24656
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work
Guido van Rossum <guido@python.org>
parents: 24649
diff changeset
385 if not data:
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work
Guido van Rossum <guido@python.org>
parents: 24649
diff changeset
386 break
24664
6a6d02be321c Another refactoring of read() and readline(), this time based on the
Guido van Rossum <guido@python.org>
parents: 24663
diff changeset
387 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
388 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
389 # 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
390 # - 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
391 # AND
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
392 # - 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
393 # 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
394 return data
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
395 if n == left:
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
396 buf.write(data)
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
397 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
398 break
47898
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
399 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
400 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
401 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
402 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
403 #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
404 return buf.getvalue()
14007
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
405
23715
c2733e8f6612 SF patch 555085 (timeout socket implementation) by Michael Gilfix.
Guido van Rossum <guido@python.org>
parents: 21971
diff changeset
406 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
407 buf = self._rbuf
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, 2) # seek end
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
409 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
410 # 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
411 buf.seek(0)
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
412 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
413 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
414 self._rbuf = StringIO()
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
415 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
416 return bline
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
417 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
418 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
419 # 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
420 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
421 # 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
422 buf.seek(0)
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
423 buffers = [buf.read()]
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
424 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
425 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
426 recv = self._sock.recv
61875
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
427 while True:
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
428 try:
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
429 while data != "\n":
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
430 data = recv(1)
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
431 if not data:
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
432 break
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
433 buffers.append(data)
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
434 except error, e:
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
435 # 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
436 # 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
437 if e.args[0] == EINTR:
61875
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
438 continue
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
439 raise
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
440 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
441 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
442
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
443 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
444 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
445 while True:
61875
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
446 try:
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
447 data = self._sock.recv(self._rbufsize)
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
448 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
449 if e.args[0] == EINTR:
61875
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
450 continue
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
451 raise
24664
6a6d02be321c Another refactoring of read() and readline(), this time based on the
Guido van Rossum <guido@python.org>
parents: 24663
diff changeset
452 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
453 break
6a6d02be321c Another refactoring of read() and readline(), this time based on the
Guido van Rossum <guido@python.org>
parents: 24663
diff changeset
454 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
455 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
456 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
457 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
458 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
459 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
460 break
47898
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
461 buf.write(data)
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
462 return buf.getvalue()
23715
c2733e8f6612 SF patch 555085 (timeout socket implementation) by Michael Gilfix.
Guido van Rossum <guido@python.org>
parents: 21971
diff changeset
463 else:
24664
6a6d02be321c Another refactoring of read() and readline(), this time based on the
Guido van Rossum <guido@python.org>
parents: 24663
diff changeset
464 # 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
465 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
466 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
467 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
468 buf.seek(0)
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
469 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
470 self._rbuf = StringIO()
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
471 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
472 return rv
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
473 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
474 while True:
61875
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
475 try:
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
476 data = self._sock.recv(self._rbufsize)
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
477 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
478 if e.args[0] == EINTR:
61875
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
479 continue
dca3cb19dbdd Merged revisions 74426 via svnmerge from
Jean-Paul Calderone <exarkun@divmod.com>
parents: 55643
diff changeset
480 raise
24664
6a6d02be321c Another refactoring of read() and readline(), this time based on the
Guido van Rossum <guido@python.org>
parents: 24663
diff changeset
481 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
482 break
6a6d02be321c Another refactoring of read() and readline(), this time based on the
Guido van Rossum <guido@python.org>
parents: 24663
diff changeset
483 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
484 # 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
485 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
486 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
487 nl += 1
47898
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
488 # 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
489 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
490 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
491 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
492 break
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
493 else:
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
494 # 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
495 # 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
496 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
497 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
498 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
499 # 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
500 # 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
501 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
502 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
503 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
504 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
505 break
47898
a312e03a0633 Backport r62627 + r62744 from trunk to fix issue 2632.
Gregory P. Smith <greg@mad-scientist.com>
parents: 45476
diff changeset
506 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
507 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
508 #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
509 return buf.getvalue()
23715
c2733e8f6612 SF patch 555085 (timeout socket implementation) by Michael Gilfix.
Guido van Rossum <guido@python.org>
parents: 21971
diff changeset
510
c2733e8f6612 SF patch 555085 (timeout socket implementation) by Michael Gilfix.
Guido van Rossum <guido@python.org>
parents: 21971
diff changeset
511 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
512 total = 0
14007
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
513 list = []
24664
6a6d02be321c Another refactoring of read() and readline(), this time based on the
Guido van Rossum <guido@python.org>
parents: 24663
diff changeset
514 while True:
14007
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
515 line = self.readline()
23844
bd37eb4daf3b Cleanup a little
Neal Norwitz <nnorwitz@gmail.com>
parents: 23715
diff changeset
516 if not line:
bd37eb4daf3b Cleanup a little
Neal Norwitz <nnorwitz@gmail.com>
parents: 23715
diff changeset
517 break
14007
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
518 list.append(line)
14682
295126433856 Support sizehint in _fileobject.readlines, as documented.
Martin v. Löwis <martin@v.loewis.de>
parents: 14592
diff changeset
519 total += len(line)
295126433856 Support sizehint in _fileobject.readlines, as documented.
Martin v. Löwis <martin@v.loewis.de>
parents: 14592
diff changeset
520 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
521 break
14007
eda09f824a9f Revise the wrapper structure for the socket module:
Fred Drake <fdrake@acm.org>
parents:
diff changeset
522 return list
24656
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work
Guido van Rossum <guido@python.org>
parents: 24649
diff changeset
523
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work
Guido van Rossum <guido@python.org>
parents: 24649
diff changeset
524 # Iterator protocols
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 __iter__(self):
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work
Guido van Rossum <guido@python.org>
parents: 24649
diff changeset
527 return self
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work
Guido van Rossum <guido@python.org>
parents: 24649
diff changeset
528
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work
Guido van Rossum <guido@python.org>
parents: 24649
diff changeset
529 def next(self):
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work
Guido van Rossum <guido@python.org>
parents: 24649
diff changeset
530 line = self.readline()
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work
Guido van Rossum <guido@python.org>
parents: 24649
diff changeset
531 if not line:
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work
Guido van Rossum <guido@python.org>
parents: 24649
diff changeset
532 raise StopIteration
e61b118e9cab Major restructuring of _fileobject. Hopefully several things now work
Guido van Rossum <guido@python.org>
parents: 24649
diff changeset
533 return line
41288
a73aa0b821ca Added a 'create_connect()' function to socket.py, which creates a
Facundo Batista <facundobatista@gmail.com>
parents: 41285
diff changeset
534
47372
e2c5ae30cffe Fixed the semantic of timeout for socket.create_connection and
Facundo Batista <facundobatista@gmail.com>
parents: 46684
diff changeset
535 _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
536
58112
72e3e85bac8b Adds an optional source_address parameter to socket.create_connection().
Gregory P. Smith <greg@mad-scientist.com>
parents: 56521
diff changeset
537 def create_connection(address, timeout=_GLOBAL_DEFAULT_TIMEOUT,
72e3e85bac8b Adds an optional source_address parameter to socket.create_connection().
Gregory P. Smith <greg@mad-scientist.com>
parents: 56521
diff changeset
538 source_address=None):
47372
e2c5ae30cffe Fixed the semantic of timeout for socket.create_connection and
Facundo Batista <facundobatista@gmail.com>
parents: 46684
diff changeset
539 """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
540
47372
e2c5ae30cffe Fixed the semantic of timeout for socket.create_connection and
Facundo Batista <facundobatista@gmail.com>
parents: 46684
diff changeset
541 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
542 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
543 *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
544 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
545 global default timeout setting returned by :func:`getdefaulttimeout`
58112
72e3e85bac8b Adds an optional source_address parameter to socket.create_connection().
Gregory P. Smith <greg@mad-scientist.com>
parents: 56521
diff changeset
546 is used. If *source_address* is set it must be a tuple of (host, port)
72e3e85bac8b Adds an optional source_address parameter to socket.create_connection().
Gregory P. Smith <greg@mad-scientist.com>
parents: 56521
diff changeset
547 for the socket to bind as a source address before making the connection.
72e3e85bac8b Adds an optional source_address parameter to socket.create_connection().
Gregory P. Smith <greg@mad-scientist.com>
parents: 56521
diff changeset
548 An host of '' or port 0 tells the OS to use the default.
41288
a73aa0b821ca Added a 'create_connect()' function to socket.py, which creates a
Facundo Batista <facundobatista@gmail.com>
parents: 41285
diff changeset
549 """
41532
4b9fa8092e82 Whitespace normalization. Ugh, we really need to do this more often.
Neal Norwitz <nnorwitz@gmail.com>
parents: 41288
diff changeset
550
41288
a73aa0b821ca Added a 'create_connect()' function to socket.py, which creates a
Facundo Batista <facundobatista@gmail.com>
parents: 41285
diff changeset
551 host, port = address
64539
af414b29d467 Merged revisions 84597-84599 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 64334
diff changeset
552 err = None
41288
a73aa0b821ca Added a 'create_connect()' function to socket.py, which creates a
Facundo Batista <facundobatista@gmail.com>
parents: 41285
diff changeset
553 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
554 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
555 sock = None
a73aa0b821ca Added a 'create_connect()' function to socket.py, which creates a
Facundo Batista <facundobatista@gmail.com>
parents: 41285
diff changeset
556 try:
a73aa0b821ca Added a 'create_connect()' function to socket.py, which creates a
Facundo Batista <facundobatista@gmail.com>
parents: 41285
diff changeset
557 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
558 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
559 sock.settimeout(timeout)
58112
72e3e85bac8b Adds an optional source_address parameter to socket.create_connection().
Gregory P. Smith <greg@mad-scientist.com>
parents: 56521
diff changeset
560 if source_address:
72e3e85bac8b Adds an optional source_address parameter to socket.create_connection().
Gregory P. Smith <greg@mad-scientist.com>
parents: 56521
diff changeset
561 sock.bind(source_address)
41288
a73aa0b821ca Added a 'create_connect()' function to socket.py, which creates a
Facundo Batista <facundobatista@gmail.com>
parents: 41285
diff changeset
562 sock.connect(sa)
a73aa0b821ca Added a 'create_connect()' function to socket.py, which creates a
Facundo Batista <facundobatista@gmail.com>
parents: 41285
diff changeset
563 return sock
41532
4b9fa8092e82 Whitespace normalization. Ugh, we really need to do this more often.
Neal Norwitz <nnorwitz@gmail.com>
parents: 41288
diff changeset
564
64539
af414b29d467 Merged revisions 84597-84599 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 64334
diff changeset
565 except error as _:
af414b29d467 Merged revisions 84597-84599 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 64334
diff changeset
566 err = _
41288
a73aa0b821ca Added a 'create_connect()' function to socket.py, which creates a
Facundo Batista <facundobatista@gmail.com>
parents: 41285
diff changeset
567 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
568 sock.close()
a73aa0b821ca Added a 'create_connect()' function to socket.py, which creates a
Facundo Batista <facundobatista@gmail.com>
parents: 41285
diff changeset
569
64539
af414b29d467 Merged revisions 84597-84599 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 64334
diff changeset
570 if err is not None:
af414b29d467 Merged revisions 84597-84599 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 64334
diff changeset
571 raise err
af414b29d467 Merged revisions 84597-84599 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 64334
diff changeset
572 else:
af414b29d467 Merged revisions 84597-84599 via svnmerge from
Antoine Pitrou <solipsis@pitrou.net>
parents: 64334
diff changeset
573 raise error("getaddrinfo returns an empty list")