Skip to content

Commit

Permalink
Issue #22576: Fix signatures of FTP.storbinary() and FTP.storlines() …
Browse files Browse the repository at this point in the history
…methods.

The correct parameter name is "fp", not "file".
  • Loading branch information
berkerpeksag committed Oct 8, 2014
1 parent 2ce95d7 commit b2fdafe
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions Doc/library/ftplib.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.

Expand Down

0 comments on commit b2fdafe

Please sign in to comment.