Merge lp:~chromakode/drizzle-interface/dbapi into lp:drizzle-interface

[Max Goodhart]

Added typemaps and conversion code to output Python unicode objects wherever applicable. I'd like feedback on the "unicode" typedef+typemap approach. I didn't want to place a blanket "char *" typemap in case something truly needed to output bytes, but it doesn't seem like there's such an instance in the current SWIG code.

[lp:~chromakode/drizzle-interface/dbapi]

172. By Max Goodhart on 2010-03-21

Add exception classes to the Connection object, and tweak the extension hierarchy to place coded libdrizzle InterfaceErrors in their own subclass.

173. By Max Goodhart on 2010-03-22

Fix the rowcount test in the DBAPI test suite to accept a value of 0 for DDL statements (see bug #543885).

174. By Max Goodhart on 2010-03-22

Return None when in place of NULL values.

[Max Goodhart (chromakode)]

Alright, that fixes up the last of the failed unit tests that don't depend on threadsafety or paramstyle. Should be ready to merge and in sync with the upcoming Boots release.

review: Needs Resubmitting

[lp:~chromakode/drizzle-interface/dbapi]

175. By Max Goodhart on 2010-03-22

Add missing unicode.i -- oops!

=== modified file 'interface/globals.i'
--- interface/globals.i	2010-01-23 20:48:37 +0000
+++ interface/globals.i	2010-03-22 07:03:28 +0000
@@ -71,7 +71,7 @@
   drizzle_result_st *result;
 } row_buffer;
 
-
+typedef const char* unicode;
 %}
 
 %ignore drizzle_state_fn;

=== modified file 'interface/libdrizzle/column.i'
--- interface/libdrizzle/column.i	2009-10-27 08:45:31 +0000
+++ interface/libdrizzle/column.i	2010-03-22 07:03:28 +0000
@@ -45,29 +45,29 @@
     return drizzle_column_drizzle_result($self);
   }
 
-  const char *catalog()
-  {
-    return drizzle_column_catalog($self);
-  }
-
-  const char *db()
-  {
-    return drizzle_column_catalog($self);
-  }
-
-  const char *table()
+  unicode catalog()
+  {
+    return drizzle_column_catalog($self);
+  }
+
+  unicode db()
+  {
+    return drizzle_column_catalog($self);
+  }
+
+  unicode table()
   {
     return drizzle_column_table($self);
   }
-  const char *orig_table()
+  unicode orig_table()
   {
     return drizzle_column_orig_table($self);
   }
-  const char *name()
+  unicode name()
   {
     return drizzle_column_name(self);
   }
-  const char *orig_name()
+  unicode orig_name()
   {
     return drizzle_column_orig_name(self);
   }

=== modified file 'interface/libdrizzle/connection.i'
--- interface/libdrizzle/connection.i	2010-02-28 07:06:22 +0000
+++ interface/libdrizzle/connection.i	2010-03-22 07:03:28 +0000
@@ -34,7 +34,7 @@
 %extend Connection {
 
   /* Set options for a connection. */
-  const char *host()
+  unicode host()
   {
     return drizzle_con_host($self);
   }
@@ -49,7 +49,7 @@
     drizzle_con_set_tcp($self, host, port);
   }
 
-  const char *uds()
+  unicode uds()
   {
     return drizzle_con_uds($self);
   }
@@ -59,12 +59,12 @@
     drizzle_con_set_uds($self, uds);
   }
 
-  const char *user()
+  unicode user()
   {
     return drizzle_con_user($self);
   }
 
-  const char *password()
+  unicode password()
   {
     return drizzle_con_password($self);
   }
@@ -74,7 +74,7 @@
     drizzle_con_set_auth($self, user, password);
   }
 
-  const char *db()
+  unicode db()
   {
     return drizzle_con_db($self);
   }
@@ -122,7 +122,7 @@
     return drizzle_con_protocol_version($self);
   }
 
-  const char *server_version()
+  unicode server_version()
   {
     return drizzle_con_server_version($self);
   }

=== modified file 'interface/libdrizzle/drizzle.i'
--- interface/libdrizzle/drizzle.i	2010-01-26 07:43:15 +0000
+++ interface/libdrizzle/drizzle.i	2010-03-22 07:03:28 +0000
@@ -55,7 +55,7 @@
   }
 
   /* Return an error string for last library error encountered. */
-  const char *error()
+  unicode error()
   {
     return drizzle_error($self);
   }

=== modified file 'interface/libdrizzle/result.i'
--- interface/libdrizzle/result.i	2010-02-28 07:06:22 +0000
+++ interface/libdrizzle/result.i	2010-03-22 07:03:28 +0000
@@ -241,12 +241,12 @@
     return drizzle_result_eof($self);
   }
 
-  const char *info()
+  unicode info()
   {
     return drizzle_result_info($self);
   }
 
-  const char *error()
+  unicode error()
   {
     return drizzle_result_error($self);
   }

=== modified file 'interface/python/drizzle_exception.i'
--- interface/python/drizzle_exception.i	2010-02-28 07:06:22 +0000
+++ interface/python/drizzle_exception.i	2010-03-22 07:03:28 +0000
@@ -73,7 +73,7 @@
         exception = GET_pyexcept("CouldNotConnectError");
         break;
       default:
-        exception = GET_pyexcept("InterfaceError");
+        exception = GET_pyexcept("LibDrizzleError");
         break;
       }
       break;

=== modified file 'interface/python/libdrizzle.i'
--- interface/python/libdrizzle.i	2010-01-23 22:46:05 +0000
+++ interface/python/libdrizzle.i	2010-03-22 07:03:28 +0000
@@ -34,7 +34,6 @@
 %include "typemaps.i"
 
 
-
 %include "interface/globals.i"
 
 %include "interface/python/drizzle_exception.i"
@@ -43,6 +42,7 @@
 %include "interface/python/drizzle_row_t.i"
 %include "interface/python/value_return.i"
 %include "interface/python/row_buffered.i"
+%include "interface/python/unicode.i"
 
 %include "interface/libdrizzle/drizzle.i"
 %include "interface/libdrizzle/connection.i"

=== modified file 'interface/python/row_buffered.i'
--- interface/python/row_buffered.i	2010-01-23 20:48:37 +0000
+++ interface/python/row_buffered.i	2010-03-22 07:03:28 +0000
@@ -30,24 +30,49 @@
  */
 
 %{
-  PyObject *row_buffer_to_tuple(row_buffer *buffer) {
+  PyObject *convert_field(drizzle_field_t field, size_t size, drizzle_column_st *column)
+  {
+    if (size == 0)
+    {
+      Py_RETURN_NONE;
+    }
+    else
+    {
+      switch (drizzle_column_type(column))
+      {
+      case DRIZZLE_COLUMN_TYPE_TINY_BLOB:   
+      case DRIZZLE_COLUMN_TYPE_MEDIUM_BLOB:   
+      case DRIZZLE_COLUMN_TYPE_LONG_BLOB:
+      case DRIZZLE_COLUMN_TYPE_BLOB:
+      case DRIZZLE_COLUMN_TYPE_VAR_STRING:
+      case DRIZZLE_COLUMN_TYPE_STRING:
+        if ((drizzle_column_flags(column) & DRIZZLE_COLUMN_FLAGS_BINARY) == 1)
+          break;
+      case DRIZZLE_COLUMN_TYPE_VARCHAR:
+        /* Textual fields should be in unicode */
+        return PyUnicode_DecodeUTF8(field, size, NULL);
+      default:
+        return SWIG_FromCharPtrAndSize(field, size);
+      }
+    }
+  }
+
+  PyObject *row_buffer_to_tuple(row_buffer *buffer)
+  {
     if (buffer->row == NULL)
     {
       return Py_None;
     }
   
     PyObject *row_tuple= PyTuple_New((Py_ssize_t)(buffer->field_count));
-  
+    size_t *field_sizes= drizzle_row_field_sizes(buffer->result);
     uint16_t field;
-    size_t *field_sizes= drizzle_row_field_sizes(buffer->result);
-  
-    PyObject *field_buffer= NULL;
-  
     for (field= 0; field < buffer->field_count; field++)
     {
-      /* Create a Python string copy of the field  and add it to the tuple */
-      field_buffer= SWIG_FromCharPtrAndSize(buffer->row[field], field_sizes[field]);
-      PyTuple_SetItem(row_tuple, field, field_buffer);
+      /* Create a Python copy of the field and add it to the tuple */
+      drizzle_column_st *field_column= drizzle_column_index(buffer->result, field);
+      PyObject *field_obj= convert_field(buffer->row[field], field_sizes[field], field_column);
+      PyTuple_SetItem(row_tuple, field, field_obj);
     }
     
     return row_tuple;

=== added file 'interface/python/unicode.i'
--- interface/python/unicode.i	1970-01-01 00:00:00 +0000
+++ interface/python/unicode.i	2010-03-22 07:03:28 +0000
@@ -0,0 +1,35 @@
+/* -*- mode: c++; c-basic-offset: 2; indent-tabs-mode: nil; -*-
+ *  vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
+ *
+ * drizzle-interface: Interface Wrappers for Drizzle
+ * Copyright (c) 2009 Sun Microsystems
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ * 3. The name of the author may not be used to endorse or promote products
+ *    derived from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+%typemap(out) unicode
+%{
+  return PyUnicode_DecodeUTF8($1, strlen($1), NULL);
+%}
\ No newline at end of file

=== modified file 'python/drizzle/db.py'
--- python/drizzle/db.py	2010-03-21 19:05:56 +0000
+++ python/drizzle/db.py	2010-03-22 07:03:28 +0000
@@ -32,7 +32,6 @@
 from drizzle.errors import *
 from drizzle.column_types import *
 
-
 libdrizzle = _libdrizzle.Drizzle()
 
 apilevel = "2.0"
@@ -67,7 +66,7 @@
                                 precision, scale, null_ok))
     return description
 
-class Connection(object):    
+class Connection(object):
     def __init__(self, host=None, username=None, password=None, database=None, port=None):
         self.host = host
         self.port = port
@@ -141,6 +140,17 @@
         self._check_connected()
         return self._drizzle_connection.protocol_version()
 
+# DB-API Extension: exception classes as members of Connection object
+Connection.Warning = Warning
+Connection.Error = Error
+Connection.InterfaceError = InterfaceError
+Connection.DatabaseError = DatabaseError
+Connection.OperationalError = OperationalError
+Connection.IntegrityError = IntegrityError
+Connection.InternalError = InternalError
+Connection.ProgrammingError = ProgrammingError
+Connection.NotSupportedError = NotSupportedError
+
 class Cursor(object):
     def __init__(self, connection, convert=True):
         self._connection = connection

=== modified file 'python/drizzle/errors.py'
--- python/drizzle/errors.py	2010-03-21 19:05:56 +0000
+++ python/drizzle/errors.py	2010-03-22 07:03:28 +0000
@@ -48,7 +48,7 @@
     """Exception raised for important warnings."""
     pass
 
-class InterfaceError(CodedError):
+class InterfaceError(Error):
     """Exception raised for errors that are related to the database interface 
     rather than the database itself.
     
@@ -92,19 +92,23 @@
     """
     pass
 
+class LibDrizzleError(InterfaceError, CodedError):
+    """Exception raised for coded errors raised by libdrizzle."""
+    pass
+
 # Drizzle Return Code Exceptions
-class AddressError(InterfaceError):
+class AddressError(LibDrizzleError):
     """Exception raised when a hostname or IP is invalid or cannot be resolved."""
     pass
 
-class AuthFailedError(InterfaceError):
+class AuthFailedError(LibDrizzleError):
     """Exception raised when authentication with the server failed."""
     pass
 
-class LostConnectionError(InterfaceError):
+class LostConnectionError(LibDrizzleError):
     """Exception raised when the connection to a database is lost."""
     pass
 
-class CouldNotConnectError(InterfaceError):
+class CouldNotConnectError(LibDrizzleError):
     """Exception raised when a connection could not be established."""
     pass

=== modified file 'python/tests/dbapi20.py'
--- python/tests/dbapi20.py	2010-01-21 04:19:33 +0000
+++ python/tests/dbapi20.py	2010-03-22 07:03:28 +0000
@@ -320,8 +320,8 @@
         try:
             cur = con.cursor()
             self.executeDDL1(cur)
-            self.assertEqual(cur.rowcount,-1,
-                'cursor.rowcount should be -1 after executing no-result '
+            self.failUnless(cur.rowcount in (0,-1),
+                'cursor.rowcount should be 0 or -1 after executing no-result '
                 'statements'
                 )
             cur.execute("insert into %sbooze values ('Victoria Bitter')" % (
@@ -337,8 +337,8 @@
                 'set to -1 after executing a select statement'
                 )
             self.executeDDL2(cur)
-            self.assertEqual(cur.rowcount,-1,
-                'cursor.rowcount not being reset to -1 after executing '
+            self.failUnless(cur.rowcount in (0,-1),
+                'cursor.rowcount not being reset to 0 or -1 after executing '
                 'no-result statements'
                 )
         finally: