[Python-checkins] r54580 - python/trunk/Doc/lib/libftplib.tex

facundo.batista python-checkins at python.org
Mon Mar 26 22:18:34 CEST 2007


Author: facundo.batista
Date: Mon Mar 26 22:18:31 2007
New Revision: 54580

Modified:
   python/trunk/Doc/lib/libftplib.tex
Log:

Added an optional timeout to FTP class. Also I started a test_ftplib.py
file to test the ftp lib (right now I included a basic test, the timeout
one, and nothing else).


Modified: python/trunk/Doc/lib/libftplib.tex
==============================================================================
--- python/trunk/Doc/lib/libftplib.tex	(original)
+++ python/trunk/Doc/lib/libftplib.tex	Mon Mar 26 22:18:31 2007
@@ -37,12 +37,15 @@
 The module defines the following items:
 
 \begin{classdesc}{FTP}{\optional{host\optional{, user\optional{,
-                       passwd\optional{, acct}}}}}
+                       passwd\optional{, acct\optional{, timeout}}}}}}
 Return a new instance of the \class{FTP} class.  When
 \var{host} is given, the method call \code{connect(\var{host})} is
 made.  When \var{user} is given, additionally the method call
 \code{login(\var{user}, \var{passwd}, \var{acct})} is made (where
 \var{passwd} and \var{acct} default to the empty string when not given).
+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).
 \end{classdesc}
 
 \begin{datadesc}{all_errors}


More information about the Python-checkins mailing list