Changeset 260:cdf294440605

Timestamp:

11/25/07 16:54:31 (20 months ago)

Author:

gh

Message:

Closes: #212
Implemented context managers.

Files:

• doc/includes/sqlite3/ctx_manager.py (added)
• doc/usage-guide.txt (modified) (2 diffs)
• pysqlite2/test/__init__.py (modified) (1 diff)
• pysqlite2/test/py25tests.py (added)
• pysqlite2/test/transactions.py (modified) (1 diff)
• src/connection.c (modified) (2 diffs)

doc/usage-guide.txt

@@ -28 +28 @@
 |   `3.6 Setting an authorizer callback`_
 |   `3.7 Setting a progress handler`_
+|   `3.8 Using the connection as a context manager`_
 | `4. SQLite and Python types`_
 |   `4.1 Introduction`_
@@ -712 +713 @@
    :source-file: includes/sqlite3/progress.py
 
+3.8 Using the connection as a context manager
+---------------------------------------------
+
+With Python 2.5 or higher, pysqlite's connection objects can be used as context
+managers that automatically commit or rollback transactions.  In the event of
+an exception, the transaction is rolled back; otherwise, the transaction is
+committed:
+
+  .. code-block::
+    :language: Python
+    :source-file: includes/sqlite3/ctx_manager.py
+
 4. SQLite and Python types
 ==========================

pysqlite2/test/__init__.py

@@ -38 +38 @@
 
 def suite():
-    return unittest.TestSuite(
-        (dbapi.suite(), types.suite(), userfunctions.suite(), factory.suite(),\
-         transactions.suite(), hooks.suite(), regression.suite()))
+    tests = [dbapi.suite(), types.suite(), userfunctions.suite(),
+      factory.suite(), transactions.suite(), hooks.suite(), regression.suite()]
+    if sys.version_info >= (2, 5, 0):
+        from pysqlite2.test import py25tests
+        tests.append(py25tests.suite())
+
+    return unittest.TestSuite(tuple(tests))
 
 def test():

pysqlite2/test/transactions.py

@@ -22 +22 @@
 # 3. This notice may not be removed or altered from any source distribution.
 
+import sys
 import os, unittest
 import pysqlite2.dbapi2 as sqlite

src/connection.c

@@ -1257 +1257 @@
 }
 
+/* Called when the connection is used as a context manager. Returns itself as a
+ * convenience to the caller. */
+static PyObject *
+pysqlite_connection_enter(pysqlite_Connection* self, PyObject* args)
+{
+    Py_INCREF(self);
+    return (PyObject*)self;
+}
+
+/** Called when the connection is used as a context manager. If there was any
+ * exception, a rollback takes place; otherwise we commit. */
+static PyObject *
+pysqlite_connection_exit(pysqlite_Connection* self, PyObject* args)
+{
+    PyObject* exc_type, *exc_value, *exc_tb;
+    char* method_name;
+    PyObject* result;
+
+    if (!PyArg_ParseTuple(args, "OOO", &exc_type, &exc_value, &exc_tb)) {
+        return NULL;
+    }
+
+    if (exc_type == Py_None && exc_value == Py_None && exc_tb == Py_None) {
+        method_name = "commit";
+    } else {
+        method_name = "rollback";
+    }
+
+    result = PyObject_CallMethod((PyObject*)self, method_name, "");
+    if (!result) {
+        return NULL;
+    }
+    Py_DECREF(result);
+
+    Py_INCREF(Py_False);
+    return Py_False;
+}
+
 static char connection_doc[] =
 PyDoc_STR("SQLite database connection object.");
@@ -1293 +1331 @@
     {"interrupt", (PyCFunction)pysqlite_connection_interrupt, METH_NOARGS,
         PyDoc_STR("Abort any pending database operation. Non-standard.")},
+    {"__enter__", (PyCFunction)pysqlite_connection_enter, METH_NOARGS,
+        PyDoc_STR("For context manager. Non-standard.")},
+    {"__exit__", (PyCFunction)pysqlite_connection_exit, METH_VARARGS,
+        PyDoc_STR("For context manager. Non-standard.")},
     {NULL, NULL}
 };