Merge lp:~cjwatson/storm/fix-py3-cextensions into lp:storm

[Colin Watson]

Fix C version of Compile.__call__(join=) on Python 3.

On Python 3, an "S" argument only takes bytes, but this parameter should only accept text. (It still accepts either bytes or text on Python 2.)

The reason this wasn't caught in tests was a little subtle. tox installs the C extension in a virtualenv, as you might expect; but, when running the test program, the storm package is imported from the same directory as the test program, and so it never actually finds any C extensions. The simplest workaround is to move the test program to a subdirectory, where no storm package exists and so it will be properly imported from the virtualenv.

[lp:~cjwatson/storm/fix-py3-cextensions]

532. By Colin Watson on 2019-09-30

Fix C version of Compile.__call__(join=) on Python 3.

On Python 3, an "S" argument only takes bytes, but this parameter should
only accept text. (It still accepts either bytes or text on Python 2.)

The reason this wasn't caught in tests was a little subtle. tox installs
the C extension in a virtualenv, as you might expect; but, when running the
test program, the storm package is imported from the same directory as the
test program, and so it never actually finds any C extensions. The simplest
workaround is to move the test program to a subdirectory, where no storm
package exists and so it will be properly imported from the virtualenv.

[Kristian Glass (doismellburning)]

I'm not familiar with Python C extensions, but your change certainly makes sense in the context of having just read https://docs.python.org/3/c-api/arg.html#parsing-arguments

review: Approve

=== modified file 'NEWS'
--- NEWS	2019-09-27 19:22:54 +0000
+++ NEWS	2019-09-30 22:58:57 +0000
@@ -5,6 +5,8 @@
 ---------
 
 - Fix incorrect caching of wrapped DB-API exceptions (bug 1845702).
+- Fix incorrect expected type for the 'join' parameter to the C version of
+  Compile.__call__ on Python 3.
 
 0.21 (2019-09-20)
 =================

=== renamed file 'test' => 'dev/test'
=== modified file 'storm/cextensions.c'
--- storm/cextensions.c	2019-09-17 09:35:10 +0000
+++ storm/cextensions.c	2019-09-30 22:58:57 +0000
@@ -27,6 +27,7 @@
 #if PY_VERSION_HEX >= 0x03000000
 #define PyInt_FromLong PyLong_FromLong
 #define PyText_AsString _PyUnicode_AsString
+#define PyString_Check(o) 0
 #define PyString_CheckExact(o) 0
 #else
 /* 2.x */
@@ -1699,10 +1700,16 @@
 
     join = default_compile_join;
 
-    if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O|OSbb", kwlist,
+    if (!PyArg_ParseTupleAndKeywords(args, kwargs, "O|OObb", kwlist,
                                      &expr, &state, &join, &raw, &token)) {
         return NULL;
     }
+    if (join && (!PyString_Check(join) && !PyUnicode_Check(join))) {
+        PyErr_Format(PyExc_TypeError,
+                     "'join' argument must be a string, not %.80s",
+                     Py_TYPE(join)->tp_name);
+        return NULL;
+    }
 
     if (state == Py_None) {
         state = PyObject_CallFunctionObjArgs(State, NULL);

=== modified file 'tox.ini'
--- tox.ini	2019-09-17 09:45:08 +0000
+++ tox.ini	2019-09-30 22:58:57 +0000
@@ -13,4 +13,4 @@
     cextensions: STORM_CEXTENSIONS = 1
     nocextensions: STORM_CEXTENSIONS = 0
 commands =
-    python test {posargs}
+    python dev/test {posargs}