Issue #6845: Add restart support for binary upload in ftplib. The

`storbinary()` method of FTP and FTP_TLS objects gains an optional `rest`
argument.  Patch by Pablo Mouzo.

(note: the patch also adds a test for the rest argument in retrbinary())

diff --git a/Doc/library/ftplib.rst b/Doc/library/ftplib.rst
index f54c7fc5f9b13dcf0a6c88f8cdf41e119642468c..32fd6e8489b2ff76708e1d95553b511cb1aa9e02 100644 (file)
--- a/Doc/library/ftplib.rst
+++ b/Doc/library/ftplib.rst
@@ -233,14 +233,15 @@ followed by ``lines`` for the text version or ``binary`` for the binary version.
    it is on by default.)
 
 
-.. method:: FTP.storbinary(command, file[, blocksize, callback])
+.. method:: FTP.storbinary(command, file[, blocksize, callback, rest])
 
    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.
+   on each block of data after it is sent. *rest* means the same thing as in
+   the :meth:`transfercmd` method.
 
    .. versionchanged:: 2.1
       default for *blocksize* added.
@@ -248,6 +249,8 @@ followed by ``lines`` for the text version or ``binary`` for the binary version.
    .. versionchanged:: 2.6
       *callback* parameter added.
 
+   .. versionchanged:: 2.7
+      *rest* parameter added.
 
 .. method:: FTP.storlines(command, file[, callback])
 

diff --git a/Lib/ftplib.py b/Lib/ftplib.py
index 7d46d830983ec7dfe06281578b348fb0f3282846..ad00e310bd6dded4bebb19ca5f3fd66d42877995 100644 (file)
--- a/Lib/ftplib.py
+++ b/Lib/ftplib.py
@@ -431,7 +431,7 @@ class FTP:
         conn.close()
         return self.voidresp()
 
-    def storbinary(self, cmd, fp, blocksize=8192, callback=None):
+    def storbinary(self, cmd, fp, blocksize=8192, callback=None, rest=None):
         """Store a file in binary mode.  A new port is created for you.
 
         Args:
@@ -441,12 +441,13 @@ class FTP:
                      the connection at once.  [default: 8192]
           callback: An optional single parameter callable that is called on
                     on each block of data after it is sent.  [default: None]
+          rest: Passed to transfercmd().  [default: None]
 
         Returns:
           The response code.
         """
         self.voidcmd('TYPE I')
-        conn = self.transfercmd(cmd)
+        conn = self.transfercmd(cmd, rest)
         while 1:
             buf = fp.read(blocksize)
             if not buf: break
@@ -712,9 +713,9 @@ else:
                 conn.close()
             return self.voidresp()
 
-        def storbinary(self, cmd, fp, blocksize=8192, callback=None):
+        def storbinary(self, cmd, fp, blocksize=8192, callback=None, rest=None):
             self.voidcmd('TYPE I')
-            conn = self.transfercmd(cmd)
+            conn = self.transfercmd(cmd, rest)
             try:
                 while 1:
                     buf = fp.read(blocksize)

diff --git a/Lib/test/test_ftplib.py b/Lib/test/test_ftplib.py
index f8a5b9c12a866834e5ec233a8f5fc2b479600b15..fb9d55b2eed1c00765a52d158db0b1d1e58e5b55 100644 (file)
--- a/Lib/test/test_ftplib.py
+++ b/Lib/test/test_ftplib.py
@@ -55,6 +55,7 @@ class DummyFTPHandler(asynchat.async_chat):
         self.last_received_cmd = None
         self.last_received_data = ''
         self.next_response = ''
+        self.rest = None
         self.push('220 welcome')
 
     def collect_incoming_data(self, data):
@@ -168,10 +169,19 @@ class DummyFTPHandler(asynchat.async_chat):
     def cmd_stor(self, arg):
         self.push('125 stor ok')
 
+    def cmd_rest(self, arg):
+        self.rest = arg
+        self.push('350 rest ok')
+
     def cmd_retr(self, arg):
         self.push('125 retr ok')
-        self.dtp.push(RETR_DATA)
+        if self.rest is not None:
+            offset = int(self.rest)
+        else:
+            offset = 0
+        self.dtp.push(RETR_DATA[offset:])
         self.dtp.close_when_done()
+        self.rest = None
 
     def cmd_list(self, arg):
         self.push('125 list ok')
@@ -444,6 +454,15 @@ class TestFTPClass(TestCase):
         self.client.retrbinary('retr', received.append)
         self.assertEqual(''.join(received), RETR_DATA)
 
+    def test_retrbinary_rest(self):
+        for rest in (0, 10, 20):
+            received = []
+            self.client.retrbinary('retr', received.append, rest=rest)
+            self.assertEqual(''.join(received), RETR_DATA[rest:],
+                             msg='rest test case %d %d %d' % (rest,
+                                                              len(''.join(received)),
+                                                              len(RETR_DATA[rest:])))
+
     def test_retrlines(self):
         received = []
         self.client.retrlines('retr', received.append)
@@ -459,6 +478,13 @@ class TestFTPClass(TestCase):
         self.client.storbinary('stor', f, callback=lambda x: flag.append(None))
         self.assertTrue(flag)
 
+    def test_storbinary_rest(self):
+        f = StringIO.StringIO(RETR_DATA)
+        for r in (30, '30'):
+            f.seek(0)
+            self.client.storbinary('stor', f, rest=r)
+            self.assertEqual(self.server.handler.rest, str(r))
+
     def test_storlines(self):
         f = StringIO.StringIO(RETR_DATA.replace('\r\n', '\n'))
         self.client.storlines('stor', f)

diff --git a/Misc/NEWS b/Misc/NEWS
index 1c2f1611d7e904456ae0bd61206126d36a60f987..4aa52c9c6c0aacde7658c7b560f4ea5f9baae4ef 100644 (file)
--- a/Misc/NEWS
+++ b/Misc/NEWS
@@ -483,6 +483,10 @@ Core and Builtins
 Library
 -------
 
+- Issue #6845: Add restart support for binary upload in ftplib.  The
+  `storbinary()` method of FTP and FTP_TLS objects gains an optional `rest`
+  argument.  Patch by Pablo Mouzo.
+
 - Issue #5788: `datetime.timedelta` objects get a new `total_seconds()`
   method returning the total number of seconds in the duration.  Patch by
   Brian Quinlan.