diff options
| author | Berker Peksag <berker.peksag@gmail.com> | 2014-10-08 10:15:04 (GMT) |
|---|---|---|
| committer | Berker Peksag <berker.peksag@gmail.com> | 2014-10-08 10:15:04 (GMT) |
| commit | b2fdafe3d2ac643b635d3b89429818e6036e8925 (patch) | |
| tree | 2bc4d86507c58c82704936fcacd2e10caf82c00a /Doc/library/ftplib.rst | |
| parent | 2ce95d7b7c6252a720a7174ea837f88092ff35f1 (diff) | |
| download | cpython-b2fdafe3d2ac643b635d3b89429818e6036e8925.zip cpython-b2fdafe3d2ac643b635d3b89429818e6036e8925.tar.gz cpython-b2fdafe3d2ac643b635d3b89429818e6036e8925.tar.bz2 | |
Issue #22576: Fix signatures of FTP.storbinary() and FTP.storlines() methods.
The correct parameter name is "fp", not "file".
Diffstat (limited to 'Doc/library/ftplib.rst')
| -rw-r--r-- | Doc/library/ftplib.rst | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/Doc/library/ftplib.rst b/Doc/library/ftplib.rst index bfec9b0..ede1b6c 100644 --- a/Doc/library/ftplib.rst +++ b/Doc/library/ftplib.rst @@ -262,10 +262,10 @@ followed by ``lines`` for the text version or ``binary`` for the binary version. Passive mode is on by default. -.. method:: FTP.storbinary(cmd, file, blocksize=8192, callback=None, rest=None) +.. method:: FTP.storbinary(cmd, fp, blocksize=8192, callback=None, rest=None) Store a file in binary transfer mode. *cmd* should be an appropriate - ``STOR`` command: ``"STOR filename"``. *file* is a :term:`file object` + ``STOR`` command: ``"STOR filename"``. *fp* is a :term:`file object` (opened in binary mode) which is read until EOF using its :meth:`~io.IOBase.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 @@ -276,11 +276,11 @@ followed by ``lines`` for the text version or ``binary`` for the binary version. *rest* parameter added. -.. method:: FTP.storlines(cmd, file, callback=None) +.. method:: FTP.storlines(cmd, fp, callback=None) Store a file in ASCII transfer mode. *cmd* should be an appropriate ``STOR`` command (see :meth:`storbinary`). Lines are read until EOF from the - :term:`file object` *file* (opened in binary mode) using its :meth:`~io.IOBase.readline` + :term:`file object` *fp* (opened in binary mode) using its :meth:`~io.IOBase.readline` method to provide the data to be stored. *callback* is an optional single parameter callable that is called on each line after it is sent. |