]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
Provide default for blocksize on retrbinary (Skip Montanaro).
authorGuido van Rossum <guido@python.org>
Wed, 3 Dec 1997 19:34:14 +0000 (19:34 +0000)
committerGuido van Rossum <guido@python.org>
Wed, 3 Dec 1997 19:34:14 +0000 (19:34 +0000)
Doc/lib/libftplib.tex
Doc/libftplib.tex
Lib/ftplib.py

index dfbaa2be071d5a76d4c1a6953c41b75b426a0f41..a89c6a9ecb83ba78c25a2aad9f2cca795ba01620 100644 (file)
@@ -125,14 +125,15 @@ Return nothing if a response code in the range 200--299 is received.
 Raise an exception otherwise.
 \end{funcdesc}
 
-\begin{funcdesc}{retrbinary}{command\, callback\, maxblocksize}
+\begin{funcdesc}{retrbinary}{command\, callback\optional{\, maxblocksize}}
 Retrieve a file in binary transfer mode.  \var{command} should be an
 appropriate \samp{RETR} command, i.e.\ \code{"RETR \var{filename}"}.
 The \var{callback} function is called for each block of data received,
 with a single string argument giving the data block.
-The \var{maxblocksize} argument specifies the maximum block size
-(which may not be the actual size of the data blocks passed to
-\var{callback}).
+The optional \var{maxblocksize} argument specifies the maximum chunk size to
+read on the low-level socket object created to do the actual transfer
+(which will also be the largest size of the data blocks passed to
+\var{callback}).  A reasonable default is chosen.
 \end{funcdesc}
 
 \begin{funcdesc}{retrlines}{command\optional{\, callback}}
index dfbaa2be071d5a76d4c1a6953c41b75b426a0f41..a89c6a9ecb83ba78c25a2aad9f2cca795ba01620 100644 (file)
@@ -125,14 +125,15 @@ Return nothing if a response code in the range 200--299 is received.
 Raise an exception otherwise.
 \end{funcdesc}
 
-\begin{funcdesc}{retrbinary}{command\, callback\, maxblocksize}
+\begin{funcdesc}{retrbinary}{command\, callback\optional{\, maxblocksize}}
 Retrieve a file in binary transfer mode.  \var{command} should be an
 appropriate \samp{RETR} command, i.e.\ \code{"RETR \var{filename}"}.
 The \var{callback} function is called for each block of data received,
 with a single string argument giving the data block.
-The \var{maxblocksize} argument specifies the maximum block size
-(which may not be the actual size of the data blocks passed to
-\var{callback}).
+The optional \var{maxblocksize} argument specifies the maximum chunk size to
+read on the low-level socket object created to do the actual transfer
+(which will also be the largest size of the data blocks passed to
+\var{callback}).  A reasonable default is chosen.
 \end{funcdesc}
 
 \begin{funcdesc}{retrlines}{command\optional{\, callback}}
index ec7d4791ddbf7f814315da78308d55823cdfc3b3..024a0faea4b51f390aaa9c542fc469ecbbbd5208 100644 (file)
@@ -317,7 +317,7 @@ class FTP:
                        raise error_reply, resp
                return resp
 
-       def retrbinary(self, cmd, callback, blocksize):
+       def retrbinary(self, cmd, callback, blocksize=8192):
                '''Retrieve data in binary mode.
                The argument is a RETR command.
                The callback function is called for each block.