Rename ResponseBody.__iter__() to iterchunks() (fixes issue 190).

djc · djc · commit 8019cd270edf · 2012-09-21T09:41:23.000+02:00
The __iter__ name is misleading because it's different from iterators over
other kinds of file-like objects. iterchunks() should make it clear this is
only intended for chunked encoding and asserts for non-chunked responses.
diff --git a/couchdb/client.py b/couchdb/client.py
@@ -881,7 +881,7 @@ def update_doc(self, name, docid=None, **options):
 
     def _changes(self, **opts):
         _, _, data = self.resource.get('_changes', **opts)
-        lines = iter(data)
+        lines = data.iterchunks()
         for ln in lines:
             if not ln: # skip heartbeats
                 continue
diff --git a/couchdb/http.py b/couchdb/http.py
@@ -187,7 +187,7 @@ def close(self):
             self.callback()
             self.callback = None
 
-    def __iter__(self):
+    def iterchunks(self):
         assert self.resp.msg.get('transfer-encoding') == 'chunked'
         while True:
             if self.resp.isclosed():
diff --git a/couchdb/tests/http.py b/couchdb/tests/http.py
@@ -63,8 +63,8 @@ def isclosed(self):
         data = '\n'.join([hex(len(data))[2:], data])
         response = http.ResponseBody(TestHttpResp(StringIO(data)),
                                      lambda *a, **k: None)
-        self.assertEqual(list(response), ['foobarbaz'])
-        self.assertEqual(list(response), [])
+        self.assertEqual(list(response.iterchunks()), ['foobarbaz'])
+        self.assertEqual(list(response.iterchunks()), [])
 
 
 class CacheTestCase(testutil.TempDatabaseMixin, unittest.TestCase):
