Added versionchanged flag to all the methods which received

a new optional timeout parameter, and a versionadded flag to
the socket.create_connection function.
This commit is contained in:
Facundo Batista 2007-06-11 16:27:08 +00:00
parent 410c3b58c9
commit 3ed365be0e
7 changed files with 17 additions and 0 deletions

View File

@ -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 The optional \var{timeout} parameter specifies a timeout in seconds for the
connection attempt (if is not specified, or passed as None, the global connection attempt (if is not specified, or passed as None, the global
default timeout setting will be used). default timeout setting will be used).
\versionchanged[\var{timeout} was added]{2.6}
\end{classdesc} \end{classdesc}
\begin{datadesc}{all_errors} \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 object timeout is used (the timeout that you passed when instantiating the
class); if the object timeout is also None, the global default timeout class); if the object timeout is also None, the global default timeout
setting will be used. setting will be used.
\versionchanged[\var{timeout} was added]{2.6}
\end{methoddesc} \end{methoddesc}
\begin{methoddesc}[FTP]{getwelcome}{} \begin{methoddesc}[FTP]{getwelcome}{}

View File

@ -49,6 +49,7 @@ the server at the same host and port:
>>> h3 = httplib.HTTPConnection('www.cwi.nl', 80, timeout=10) >>> h3 = httplib.HTTPConnection('www.cwi.nl', 80, timeout=10)
\end{verbatim} \end{verbatim}
\versionadded{2.0} \versionadded{2.0}
\versionchanged[\var{timeout} was added]{2.6}
\end{classdesc} \end{classdesc}
\begin{classdesc}{HTTPSConnection}{host\optional{, port\optional{, \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!} \warning{This does not do any certificate verification!}
\versionadded{2.0} \versionadded{2.0}
\versionchanged[\var{timeout} was added]{2.6}
\end{classdesc} \end{classdesc}
\begin{classdesc}{HTTPResponse}{sock\optional{, debuglevel=0}\optional{, strict=0}} \begin{classdesc}{HTTPResponse}{sock\optional{, debuglevel=0}\optional{, strict=0}}

View File

@ -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 The optional \var{timeout} parameter specifies a timeout in seconds for the
connection attempt (if not specified, or passed as None, the global default connection attempt (if not specified, or passed as None, the global default
timeout setting will be used). timeout setting will be used).
\versionchanged[\var{timeout} was added]{2.6}
\end{classdesc} \end{classdesc}
\begin{classdesc}{POP3_SSL}{host\optional{, port\optional{, keyfile\optional{, certfile}}}} \begin{classdesc}{POP3_SSL}{host\optional{, port\optional{, keyfile\optional{, certfile}}}}

View File

@ -29,6 +29,8 @@ default timeout setting will be used).
For normal use, you should only require the initialization/connect, For normal use, you should only require the initialization/connect,
\method{sendmail()}, and \method{quit()} methods. An example is \method{sendmail()}, and \method{quit()} methods. An example is
included below. included below.
\versionchanged[\var{timeout} was added]{2.6}
\end{classdesc} \end{classdesc}
\begin{classdesc}{SMTP_SSL}{\optional{host\optional{, port\optional{, \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 The optional \var{timeout} parameter specifies a timeout in seconds for the
connection attempt (if not specified, or passed as None, the global connection attempt (if not specified, or passed as None, the global
default timeout setting will be used). default timeout setting will be used).
\versionchanged[\var{timeout} was added]{2.6}
\end{classdesc} \end{classdesc}
\begin{classdesc}{LMTP}{\optional{host\optional{, port\optional{, \begin{classdesc}{LMTP}{\optional{host\optional{, port\optional{,

View File

@ -177,6 +177,7 @@ higher-level protocols, it is not normally used directly from
application-level code. Passing the optional \var{timeout} parameter application-level code. Passing the optional \var{timeout} parameter
will set the timeout on the socket instance (if it is not given or will set the timeout on the socket instance (if it is not given or
\code{None}, the global default timeout setting is used). \code{None}, the global default timeout setting is used).
\versionadded{2.6}
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{getaddrinfo}{host, port\optional{, family\optional{, \begin{funcdesc}{getaddrinfo}{host, port\optional{, family\optional{,

View File

@ -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, raise \exception{EOFError} when the end of the connection is read,
because they can return an empty string for other reasons. See the because they can return an empty string for other reasons. See the
individual descriptions below. individual descriptions below.
\versionchanged[\var{timeout} was added]{2.6}
\end{classdesc} \end{classdesc}
@ -123,6 +124,7 @@ connection attempt (if not specified, or passed as None, the global default
timeout setting will be used). timeout setting will be used).
Do not try to reopen an already connected instance. Do not try to reopen an already connected instance.
\versionchanged[\var{timeout} was added]{2.6}
\end{methoddesc} \end{methoddesc}
\begin{methoddesc}[Telnet]{msg}{msg\optional{, *args}} \begin{methoddesc}[Telnet]{msg}{msg\optional{, *args}}

View File

@ -45,6 +45,8 @@ Raises \exception{URLError} on errors.
Note that \code{None} may be returned if no handler handles the Note that \code{None} may be returned if no handler handles the
request (though the default installed global \class{OpenerDirector} request (though the default installed global \class{OpenerDirector}
uses \class{UnknownHandler} to ensure this never happens). uses \class{UnknownHandler} to ensure this never happens).
\versionchanged[\var{timeout} was added]{2.6}
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{install_opener}{opener} \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 setting will be used; this actually only work for HTTP, HTTPS, FTP
and FTPS connections). and FTPS connections).
\versionchanged[\var{timeout} was added]{2.6}
\end{methoddesc} \end{methoddesc}
\begin{methoddesc}[OpenerDirector]{error}{proto\optional{, \begin{methoddesc}[OpenerDirector]{error}{proto\optional{,