diff options
author | Gregory P. Smith <greg@mad-scientist.com> | 2008-01-26 18:51:05 (GMT) |
---|---|---|
committer | Gregory P. Smith <greg@mad-scientist.com> | 2008-01-26 18:51:05 (GMT) |
commit | d006380fe1b0fc53af06946bddf52c7e54e37e21 (patch) | |
tree | 475acdcf9130ea5573ca6076ecfd57cbe84de035 /Doc/library/ftplib.rst | |
parent | a2af21262a13510b12d45cf67d92a563da4cf1b5 (diff) | |
download | cpython-d006380fe1b0fc53af06946bddf52c7e54e37e21.zip cpython-d006380fe1b0fc53af06946bddf52c7e54e37e21.tar.gz cpython-d006380fe1b0fc53af06946bddf52c7e54e37e21.tar.bz2 |
Update docs for new callpack params added in r60188
Diffstat (limited to 'Doc/library/ftplib.rst')
-rw-r--r-- | Doc/library/ftplib.rst | 26 |
1 files changed, 18 insertions, 8 deletions
diff --git a/Doc/library/ftplib.rst b/Doc/library/ftplib.rst index 60e88cf..1040908 100644 --- a/Doc/library/ftplib.rst +++ b/Doc/library/ftplib.rst @@ -182,11 +182,12 @@ followed by ``lines`` for the text version or ``binary`` for the binary version. .. method:: FTP.retrlines(command[, callback]) - Retrieve a file or directory listing in ASCII transfer mode. *command* should be - an appropriate ``RETR`` command (see :meth:`retrbinary`) or a ``LIST`` command - (usually just the string ``'LIST'``). The *callback* function is called for - each line, with the trailing CRLF stripped. The default *callback* prints the - line to ``sys.stdout``. + Retrieve a file or directory listing in ASCII transfer mode. *command* + should be an appropriate ``RETR`` command (see :meth:`retrbinary`) or a + command such as ``LIST``, ``NLST`` or ``MLSD`` (usually just the string + ``'LIST'``). The *callback* function is called for each line, with the + trailing CRLF stripped. The default *callback* prints the line to + ``sys.stdout``. .. method:: FTP.set_pasv(boolean) @@ -196,23 +197,32 @@ followed by ``lines`` for the text version or ``binary`` for the binary version. it is on by default.) -.. method:: FTP.storbinary(command, file[, blocksize]) +.. method:: FTP.storbinary(command, file[, blocksize, callback]) Store a file in binary transfer mode. *command* should be an appropriate ``STOR`` command: ``"STOR filename"``. *file* is an open file object which is read until EOF using its :meth:`read` method in blocks of size *blocksize* to provide the data to be stored. The *blocksize* argument defaults to 8192. + *callback* is an optional single parameter callable that is called + on each block of data after it is sent. .. versionchanged:: 2.1 default for *blocksize* added. + .. versionchanged:: 2.6 + *callback* parameter added. + -.. method:: FTP.storlines(command, file) +.. method:: FTP.storlines(command, file[, callback]) Store a file in ASCII transfer mode. *command* should be an appropriate ``STOR`` command (see :meth:`storbinary`). Lines are read until EOF from the open file object *file* using its :meth:`readline` method to provide the data to - be stored. + be stored. *callback* is an optional single parameter callable + that is called on each line after it is sent. + + .. versionchanged:: 2.6 + *callback* parameter added. .. method:: FTP.transfercmd(cmd[, rest]) |