Minor corrections and improvements.

James William Pye · James William Pye · commit bc7612ed76ef · 2009-06-06T17:42:55.000-07:00
Use a TypeError instead of a ValueError for inconsistent processors and tuple
items. Document it as a gotcha(rather ambiguous description in the error
message).

Add comments.
diff --git a/postgresql/protocol/optimized/element3.c b/postgresql/protocol/optimized/element3.c
@@ -52,7 +52,7 @@ _pack_tuple_data(PyObject *tup)
 			PyErr_Format(
 				PyExc_TypeError,
 				"cannot serialize attribute %d, expected bytes() or None, got %s",
-				(long) catt, PyObject_TypeName(ob)
+				(int) catt, PyObject_TypeName(ob)
 			);
 			return(NULL);
 		}
@@ -76,7 +76,7 @@ _pack_tuple_data(PyObject *tup)
 		ob = PyTuple_GET_ITEM(tup, catt);
 		if (ob == Py_None)
 		{
-			*((uint32_t *) bufpos) = 0xFFFFFFFF;
+			*((uint32_t *) bufpos) = (uint32_t) 0xFFFFFFFFL;
 			bufpos = bufpos + 4;
 		}
 		else
diff --git a/postgresql/protocol/optimized/module.c b/postgresql/protocol/optimized/module.c
@@ -23,7 +23,7 @@
 	(((PyTypeObject *) (ob->ob_type))->tp_name)
 
 /*
- * buffer.c needs the message_types object from protocol.message_types.
+ * buffer.c needs the message_types object from .protocol.message_types.
  * Initialized in PyInit_optimized.
  */
 static PyObject *message_types = NULL;
@@ -40,7 +40,7 @@ static short (*local_ntohs)(short) = NULL;
 #include "element3.c"
 
 
-/* cpp abuse */
+/* cpp abuse, read up on X-Macros if you don't understand  */
 #define mFUNC(name, typ, doc) \
 	{#name, (PyCFunction) name, typ, PyDoc_STR(doc)},
 static PyMethodDef optimized_methods[] = {
@@ -68,6 +68,7 @@ PyInit_optimized(void)
 	PyObject *fromlist, *fromstr;
 	long l;
 
+	/* make some constants */
 	if (serialize_strob == NULL)
 	{
 		serialize_strob = PyUnicode_FromString("serialize");
diff --git a/postgresql/protocol/optimized/typio.c b/postgresql/protocol/optimized/typio.c
@@ -465,7 +465,7 @@ _process_tuple(PyObject *procs, PyObject *tup, PyObject *fail)
 	if (len != PyTuple_GET_SIZE(procs))
 	{
 		PyErr_Format(
-			PyExc_ValueError,
+			PyExc_TypeError,
 			"inconsistent items, %d processors and %d items in row",
 			len,
 			PyTuple_GET_SIZE(procs)
@@ -520,7 +520,7 @@ _process_tuple(PyObject *procs, PyObject *tup, PyObject *fail)
 			 * in order to properly generalize the failure. There are numerous,
 			 * and (sometimes) inconsistent reasons why a tuple cannot be
 			 * processed and therefore a generalized exception raised in the
-			 * context of the original is very useful.
+			 * context of the original is *very* useful.
 			 */
 
 			Py_DECREF(rob);
@@ -699,10 +699,6 @@ process_chunk(PyObject *self, PyObject *args)
 
 	if (PyList_Check(tupc))
 	{
-		/*
-		 * If given a list, it's assumed that the user wants the contents
-		 * replaced. The list(tupc) will be returned.
-		 */
 		return(_process_chunk_from_list(procs, tupc, fail));
 	}
 	else
diff --git a/postgresql/protocol/typio.py b/postgresql/protocol/typio.py
@@ -466,8 +466,8 @@ def process_tuple(procs, tup, exception_handler):
 	"""
 	i = len(procs)
 	if len(tup) != i:
-		raise ValueError(
-			"inconsistent items, %d processors and %d objects" %(
+		raise TypeError(
+			"inconsistent items, %d processors and %d items in row" %(
 				i, len(tup)
 			)
 		)
diff --git a/postgresql/test/test_protocol.py b/postgresql/test/test_protocol.py
@@ -1000,7 +1000,7 @@ def funpass(procs, tup, col):
 			self.failUnlessRaises(TypeError, pt, "foo", "bar", funpass)
 			self.failUnlessRaises(TypeError, pt, (), "bar", funpass)
 			self.failUnlessRaises(TypeError, pt, "foo", (), funpass)
-			self.failUnlessRaises(ValueError, pt, (), ("foo",), funpass)
+			self.failUnlessRaises(TypeError, pt, (), ("foo",), funpass)
 
 		def test_pack_tuple_data(self):
 			pit = protocol_optimized.pack_tuple_data

Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,7 @@ _pack_tuple_data(PyObject *tup)`
`52`	`52`	`PyErr_Format(`
`53`	`53`	`PyExc_TypeError,`
`54`	`54`	`"cannot serialize attribute %d, expected bytes() or None, got %s",`
`55`		`- (long) catt, PyObject_TypeName(ob)`
	`55`	`+ (int) catt, PyObject_TypeName(ob)`
`56`	`56`	`);`
`57`	`57`	`return(NULL);`
`58`	`58`	`}`
`@@ -76,7 +76,7 @@ _pack_tuple_data(PyObject *tup)`
`76`	`76`	`ob = PyTuple_GET_ITEM(tup, catt);`
`77`	`77`	`if (ob == Py_None)`
`78`	`78`	`{`
`79`		`- ((uint32_t ) bufpos) = 0xFFFFFFFF;`
	`79`	`+ ((uint32_t ) bufpos) = (uint32_t) 0xFFFFFFFFL;`
`80`	`80`	`bufpos = bufpos + 4;`
`81`	`81`	`}`
`82`	`82`	`else`
Original file line number	Diff line number	Diff line change
`@@ -466,8 +466,8 @@ def process_tuple(procs, tup, exception_handler):`
`466`	`466`	`"""`
`467`	`467`	`i = len(procs)`
`468`	`468`	`if len(tup) != i:`
`469`		`- raise ValueError(`
`470`		`- "inconsistent items, %d processors and %d objects" %(`
	`469`	`+ raise TypeError(`
	`470`	`+ "inconsistent items, %d processors and %d items in row" %(`
`471`	`471`	`i, len(tup)`
`472`	`472`	`)`
`473`	`473`	`)`