diff options
author | Facundo Batista <facundobatista@gmail.com> | 2007-06-11 16:27:08 (GMT) |
---|---|---|
committer | Facundo Batista <facundobatista@gmail.com> | 2007-06-11 16:27:08 (GMT) |
commit | 3ed365be0ef7d87b84465e7accb8cf9b0581b37f (patch) | |
tree | 3635729a12f03a24512d944b8601847cbccfebe3 /Doc/lib | |
parent | 410c3b58c925698538452351b25d15d1b816a254 (diff) | |
download | cpython-3ed365be0ef7d87b84465e7accb8cf9b0581b37f.zip cpython-3ed365be0ef7d87b84465e7accb8cf9b0581b37f.tar.gz cpython-3ed365be0ef7d87b84465e7accb8cf9b0581b37f.tar.bz2 |
Added versionchanged flag to all the methods which received
a new optional timeout parameter, and a versionadded flag to
the socket.create_connection function.
Diffstat (limited to 'Doc/lib')
-rw-r--r-- | Doc/lib/libftplib.tex | 3 | ||||
-rw-r--r-- | Doc/lib/libhttplib.tex | 2 | ||||
-rw-r--r-- | Doc/lib/libpoplib.tex | 2 | ||||
-rw-r--r-- | Doc/lib/libsmtplib.tex | 4 | ||||
-rw-r--r-- | Doc/lib/libsocket.tex | 1 | ||||
-rw-r--r-- | Doc/lib/libtelnetlib.tex | 2 | ||||
-rw-r--r-- | Doc/lib/liburllib2.tex | 3 |
7 files changed, 17 insertions, 0 deletions
diff --git a/Doc/lib/libftplib.tex b/Doc/lib/libftplib.tex index 98d7e80..1ce5f9b 100644 --- a/Doc/lib/libftplib.tex +++ b/Doc/lib/libftplib.tex @@ -46,6 +46,7 @@ made. When \var{user} is given, additionally the method call The optional \var{timeout} parameter specifies a timeout in seconds for the connection attempt (if is not specified, or passed as None, the global default timeout setting will be used). +\versionchanged[\var{timeout} was added]{2.6} \end{classdesc} \begin{datadesc}{all_errors} @@ -117,6 +118,8 @@ the connection attempt. If is not specified, or passed as None, the object timeout is used (the timeout that you passed when instantiating the class); if the object timeout is also None, the global default timeout setting will be used. + +\versionchanged[\var{timeout} was added]{2.6} \end{methoddesc} \begin{methoddesc}[FTP]{getwelcome}{} diff --git a/Doc/lib/libhttplib.tex b/Doc/lib/libhttplib.tex index 7c9449d..37a442d 100644 --- a/Doc/lib/libhttplib.tex +++ b/Doc/lib/libhttplib.tex @@ -49,6 +49,7 @@ the server at the same host and port: >>> h3 = httplib.HTTPConnection('www.cwi.nl', 80, timeout=10) \end{verbatim} \versionadded{2.0} +\versionchanged[\var{timeout} was added]{2.6} \end{classdesc} \begin{classdesc}{HTTPSConnection}{host\optional{, port\optional{, @@ -63,6 +64,7 @@ key. \var{cert_file} is a PEM formatted certificate chain file. \warning{This does not do any certificate verification!} \versionadded{2.0} +\versionchanged[\var{timeout} was added]{2.6} \end{classdesc} \begin{classdesc}{HTTPResponse}{sock\optional{, debuglevel=0}\optional{, strict=0}} diff --git a/Doc/lib/libpoplib.tex b/Doc/lib/libpoplib.tex index 7b2c4a1..9ca5bbd 100644 --- a/Doc/lib/libpoplib.tex +++ b/Doc/lib/libpoplib.tex @@ -35,6 +35,8 @@ If \var{port} is omitted, the standard POP3 port (110) is used. The optional \var{timeout} parameter specifies a timeout in seconds for the connection attempt (if not specified, or passed as None, the global default timeout setting will be used). + +\versionchanged[\var{timeout} was added]{2.6} \end{classdesc} \begin{classdesc}{POP3_SSL}{host\optional{, port\optional{, keyfile\optional{, certfile}}}} diff --git a/Doc/lib/libsmtplib.tex b/Doc/lib/libsmtplib.tex index dfe8575..370b7ce 100644 --- a/Doc/lib/libsmtplib.tex +++ b/Doc/lib/libsmtplib.tex @@ -29,6 +29,8 @@ default timeout setting will be used). For normal use, you should only require the initialization/connect, \method{sendmail()}, and \method{quit()} methods. An example is included below. + +\versionchanged[\var{timeout} was added]{2.6} \end{classdesc} \begin{classdesc}{SMTP_SSL}{\optional{host\optional{, port\optional{, @@ -45,6 +47,8 @@ certificate chain file for the SSL connection. The optional \var{timeout} parameter specifies a timeout in seconds for the connection attempt (if not specified, or passed as None, the global default timeout setting will be used). + +\versionchanged[\var{timeout} was added]{2.6} \end{classdesc} \begin{classdesc}{LMTP}{\optional{host\optional{, port\optional{, diff --git a/Doc/lib/libsocket.tex b/Doc/lib/libsocket.tex index 99c629a..d9b3b79 100644 --- a/Doc/lib/libsocket.tex +++ b/Doc/lib/libsocket.tex @@ -177,6 +177,7 @@ higher-level protocols, it is not normally used directly from application-level code. Passing the optional \var{timeout} parameter will set the timeout on the socket instance (if it is not given or \code{None}, the global default timeout setting is used). +\versionadded{2.6} \end{funcdesc} \begin{funcdesc}{getaddrinfo}{host, port\optional{, family\optional{, diff --git a/Doc/lib/libtelnetlib.tex b/Doc/lib/libtelnetlib.tex index 0c51a09..5b32a5f 100644 --- a/Doc/lib/libtelnetlib.tex +++ b/Doc/lib/libtelnetlib.tex @@ -40,6 +40,7 @@ This class has many \method{read_*()} methods. Note that some of them raise \exception{EOFError} when the end of the connection is read, because they can return an empty string for other reasons. See the individual descriptions below. +\versionchanged[\var{timeout} was added]{2.6} \end{classdesc} @@ -123,6 +124,7 @@ connection attempt (if not specified, or passed as None, the global default timeout setting will be used). Do not try to reopen an already connected instance. +\versionchanged[\var{timeout} was added]{2.6} \end{methoddesc} \begin{methoddesc}[Telnet]{msg}{msg\optional{, *args}} diff --git a/Doc/lib/liburllib2.tex b/Doc/lib/liburllib2.tex index 5547b15..9d2c382 100644 --- a/Doc/lib/liburllib2.tex +++ b/Doc/lib/liburllib2.tex @@ -45,6 +45,8 @@ Raises \exception{URLError} on errors. Note that \code{None} may be returned if no handler handles the request (though the default installed global \class{OpenerDirector} uses \class{UnknownHandler} to ensure this never happens). + +\versionchanged[\var{timeout} was added]{2.6} \end{funcdesc} \begin{funcdesc}{install_opener}{opener} @@ -367,6 +369,7 @@ attempt (if not specified, or passed as None, the global default timeout setting will be used; this actually only work for HTTP, HTTPS, FTP and FTPS connections). +\versionchanged[\var{timeout} was added]{2.6} \end{methoddesc} \begin{methoddesc}[OpenerDirector]{error}{proto\optional{, |