[Python-checkins] cpython (merge 3.4 -> default): Issue #22576: Fix signatures of FTP.storbinary() and FTP.storlines() methods.

berker.peksag python-checkins at python.org
Wed Oct 8 12:15:57 CEST 2014


https://hg.python.org/cpython/rev/f21f0de30544
changeset:   92877:f21f0de30544
parent:      92875:ab2ea07db612
parent:      92876:4cc584d47c7d
user:        Berker Peksag <berker.peksag at gmail.com>
date:        Wed Oct 08 13:15:36 2014 +0300
summary:
  Issue #22576: Fix signatures of FTP.storbinary() and FTP.storlines() methods.

The correct parameter name is "fp", not "file".

files:
  Doc/library/ftplib.rst |  8 ++++----
  1 files changed, 4 insertions(+), 4 deletions(-)


diff --git a/Doc/library/ftplib.rst b/Doc/library/ftplib.rst
--- a/Doc/library/ftplib.rst
+++ b/Doc/library/ftplib.rst
@@ -262,10 +262,10 @@
    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 @@
       *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.
 

-- 
Repository URL: https://hg.python.org/cpython


More information about the Python-checkins mailing list