Fix #11: Rename Connection.wait_closed to .ensure_closed

CHANGES.txt

@@ -8,6 +8,8 @@ x.x.x (XXXX-XX-XX)
 
 * Fixed sqlalchemy 1.0.0 support.
 
+* Fix #11: Rename Connection.wait_closed() to .ensure_closed()
+
 
 0.0.3 (2015-03-10)
 ^^^^^^^^^^^^^^^^^^

aiomysql/connection.py

@@ -240,7 +240,7 @@ def close(self):
         self._reader = None
 
     @asyncio.coroutine
-    def wait_closed(self):
+    def ensure_closed(self):
         """Send quit command and then close socket connection"""
         if self._writer is None:
             # connection has been closed

aiomysql/pool.py

@@ -66,7 +66,7 @@ def clear(self):
         with (yield from self._cond):
             while self._free:
                 conn = self._free.popleft()
-                yield from conn.wait_closed()
+                yield from conn.ensure_closed()
             self._cond.notify()
 
     def close(self):

docs/connection.rst

@@ -107,7 +107,7 @@ Example::
         Close the connection now (rather than whenever `del` is executed).
         The connection will be unusable from this point forward.
 
-   .. method:: wait_closed()
+   .. method:: ensure_closed()
 
         A :ref:`coroutine <coroutine>` ends quit command and then closes
         socket connection.

tests/base.py

@@ -34,7 +34,7 @@ def setUp(self):
 
     def tearDown(self):
         for connection in self.connections:
-            self.loop.run_until_complete(connection.wait_closed())
+            self.loop.run_until_complete(connection.ensure_closed())
         super(AIOPyMySQLTestCase, self).tearDown()
 
     @asyncio.coroutine

tests/test_connection.py

@@ -195,10 +195,10 @@ def test_connection_properties(self):
         conn.close()
 
     @run_until_complete
-    def test_connection_double_wait_closed(self):
+    def test_connection_double_ensure_closed(self):
         conn = yield from self.connect(no_delay=True)
         self.assertFalse(conn.closed)
-        yield from conn.wait_closed()
+        yield from conn.ensure_closed()
         self.assertTrue(conn.closed)
-        yield from conn.wait_closed()
+        yield from conn.ensure_closed()
         self.assertTrue(conn.closed)

tests/test_issues.py

@@ -64,7 +64,7 @@ def test_issue_6(self):
         c = yield from conn.cursor()
         self.assertEqual(conn.db, 'mysql')
         yield from c.execute("select * from user")
-        yield from conn.wait_closed()
+        yield from conn.ensure_closed()
 
     @run_until_complete
     def test_issue_8(self):
@@ -369,26 +369,26 @@ def test_issue_114(self):
         yield from c.execute("""select @@autocommit;""")
         r = yield from c.fetchone()
         self.assertFalse(r[0])
-        yield from conn.wait_closed()
+        yield from conn.ensure_closed()
         yield from conn.ping()
         yield from c.execute("""select @@autocommit;""")
         r = yield from c.fetchone()
         self.assertFalse(r[0])
-        yield from conn.wait_closed()
+        yield from conn.ensure_closed()
 
         # Ensure autocommit() is still working
         conn = yield from self.connect(charset="utf8")
         c = yield from conn.cursor()
         yield from c.execute("""select @@autocommit;""")
         r = yield from c.fetchone()
         self.assertFalse(r[0])
-        yield from conn.wait_closed()
+        yield from conn.ensure_closed()
         yield from conn.ping()
         yield from conn.autocommit(True)
         yield from c.execute("""select @@autocommit;""")
         r = yield from c.fetchone()
         self.assertTrue(r[0])
-        yield from conn.wait_closed()
+        yield from conn.ensure_closed()
 
     @run_until_complete
     def test_issue_175(self):

tests/test_pool.py

@@ -116,7 +116,7 @@ def go():
             pool = yield from self.create_pool()
             conn = yield from pool.acquire()
             self.assertEqual(9, pool.freesize)
-            yield from conn.wait_closed()
+            yield from conn.ensure_closed()
             pool.release(conn)
             self.assertEqual(9, pool.freesize)
             self.assertFalse(pool._used)