[Python-checkins] r76546 - in python/trunk: Doc/library/ftplib.rst Lib/ftplib.py Lib/test/test_ftplib.py Misc/NEWS

Fri Nov 27 14:18:35 CET 2009

Author: antoine.pitrou
Date: Fri Nov 27 14:18:34 2009
New Revision: 76546
Log:
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())
Modified:
 python/trunk/Doc/library/ftplib.rst
 python/trunk/Lib/ftplib.py
 python/trunk/Lib/test/test_ftplib.py
 python/trunk/Misc/NEWS
Modified: python/trunk/Doc/library/ftplib.rst
==============================================================================

--- python/trunk/Doc/library/ftplib.rst	(original)
+++ python/trunk/Doc/library/ftplib.rst	Fri Nov 27 14:18:34 2009
@@ -233,14 +233,15 @@
 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 @@
 .. versionchanged:: 2.6
 *callback* parameter added.
 
+ .. versionchanged:: 2.7
+ *rest* parameter added.
 
 .. method:: FTP.storlines(command, file[, callback])
 
Modified: python/trunk/Lib/ftplib.py
==============================================================================
--- python/trunk/Lib/ftplib.py	(original)
+++ python/trunk/Lib/ftplib.py	Fri Nov 27 14:18:34 2009
@@ -431,7 +431,7 @@
 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 @@
 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 @@
 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)
Modified: python/trunk/Lib/test/test_ftplib.py
==============================================================================
--- python/trunk/Lib/test/test_ftplib.py	(original)
+++ python/trunk/Lib/test/test_ftplib.py	Fri Nov 27 14:18:34 2009
@@ -55,6 +55,7 @@
 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 @@
 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 @@
 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 @@
 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)
Modified: python/trunk/Misc/NEWS
==============================================================================
--- python/trunk/Misc/NEWS	(original)
+++ python/trunk/Misc/NEWS	Fri Nov 27 14:18:34 2009
@@ -483,6 +483,10 @@
 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.
