Changeset 583:79fe7ae18727

Timestamp:

2006-10-19 17:28:15 (4 years ago)

Author:

Stefan Schwarzer <sschwarzer@…>

Branch:

add_stat_caching

convert_revision:

svn:778c30c8-61e0-0310-89d4-fe2f97a467b2/branches/add_stat_caching@609

Message:

Added iterator interface for `FTPFile`s.

Files:

• _test_ftputil.py (modified) (1 diff)
• ftp_file.py (modified) (1 diff)

_test_ftputil.py

@@ -325 +325 @@
         self.assertRaises(IndexError, operator.__getitem__, xrl_obj, 3)
 
+    def test_binary_iterator(self):
+        """Test the iterator interface of `FTPFile` objects."""
+        host = _test_base.ftp_host_factory(session_factory=ReadMockSession)
+        input_ = host.file('dummy')
+        input_iterator = iter(input_)
+        self.assertEqual(input_iterator.next(), "line 1\n")
+        self.assertEqual(input_iterator.next(), "another line\n")
+        self.assertEqual(input_iterator.next(), "yet another line")
+        self.assertRaises(StopIteration, input_iterator.next)
+        input_.close()
+
+    def test_ascii_iterator(self):
+        """Test the iterator interface of `FTPFile` objects."""
+        host = _test_base.ftp_host_factory(session_factory=ReadMockSession)
+        input_ = host.file('dummy', 'rb')
+        input_iterator = iter(input_)
+        self.assertEqual(input_iterator.next(), "line 1\r\n")
+        self.assertEqual(input_iterator.next(), "another line\r\n")
+        self.assertEqual(input_iterator.next(), "yet another line")
+        self.assertRaises(StopIteration, input_iterator.next)
+        input_.close()
+
     def test_read_unknown_file(self):
         """Test whether reading a file which isn't there fails."""

ftp_file.py

@@ -187 +187 @@
         return _XReadlines(self)
 
+    def __iter__(self):
+        """Return an file iterator."""
+        return self
+
+    def next(self):
+        """
+        Return the next line or raise `StopIteration`, if there are
+        no more.
+        """
+        # apply implicit line ending conversion
+        line = self.readline()
+        if line:
+            return line
+        else:
+            raise StopIteration
+
     def write(self, data):
         """Write data to file. Do linesep conversion for text mode."""