Add Runtime.CheckExceptionOccurred(...)

vmuriart · vmuriart · commit 46660fafb62c · 2017-02-28T08:26:12.000-07:00
Helps refactor exceptions checks
diff --git a/src/runtime/pytuple.cs b/src/runtime/pytuple.cs
@@ -51,10 +51,7 @@ public PyTuple(PyObject o)
         public PyTuple()
         {
             obj = Runtime.PyTuple_New(0);
-            if (obj == IntPtr.Zero)
-            {
-                throw new PythonException();
-            }
+            Runtime.CheckExceptionOccurred();
         }
 
 
@@ -63,6 +60,9 @@ public PyTuple()
         /// </summary>
         /// <remarks>
         /// Creates a new PyTuple from an array of PyObject instances.
+        /// <para />
+        /// See caveats about PyTuple_SetItem:
+        /// https://www.coursehero.com/file/p4j2ogg/important-exceptions-to-this-rule-PyTupleSetItem-and-PyListSetItem-These/
         /// </remarks>
         public PyTuple(PyObject[] items)
         {
@@ -72,11 +72,8 @@ public PyTuple(PyObject[] items)
             {
                 IntPtr ptr = items[i].obj;
                 Runtime.XIncref(ptr);
-                int r = Runtime.PyTuple_SetItem(obj, i, ptr);
-                if (r < 0)
-                {
-                    throw new PythonException();
-                }
+                Runtime.PyTuple_SetItem(obj, i, ptr);
+                Runtime.CheckExceptionOccurred();
             }
         }
 
@@ -104,10 +101,7 @@ public static bool IsTupleType(PyObject value)
         public static PyTuple AsTuple(PyObject value)
         {
             IntPtr op = Runtime.PySequence_Tuple(value.obj);
-            if (op == IntPtr.Zero)
-            {
-                throw new PythonException();
-            }
+            Runtime.CheckExceptionOccurred();
             return new PyTuple(op);
         }
     }
diff --git a/src/runtime/runtime.cs b/src/runtime/runtime.cs
@@ -384,6 +384,21 @@ internal static int AtExit()
         internal static IntPtr PyNone;
         internal static IntPtr Error;
 
+        /// <summary>
+        /// Check if any Python Exceptions occurred.
+        /// If any exist throw new PythonException.
+        /// </summary>
+        /// <remarks>
+        /// Can be used instead of `obj == IntPtr.Zero` for example.
+        /// </remarks>
+        internal static void CheckExceptionOccurred()
+        {
+            if (PyErr_Occurred() != 0)
+            {
+                throw new PythonException();
+            }
+        }
+
         internal static IntPtr GetBoundArgTuple(IntPtr obj, IntPtr args)
         {
             if (Runtime.PyObject_TYPE(args) != Runtime.PyTupleType)

Original file line number	Diff line number	Diff line change
`@@ -51,10 +51,7 @@ public PyTuple(PyObject o)`
`51`	`51`	`public PyTuple()`
`52`	`52`	`{`
`53`	`53`	`obj = Runtime.PyTuple_New(0);`
`54`		`- if (obj == IntPtr.Zero)`
`55`		`- {`
`56`		`- throw new PythonException();`
`57`		`- }`
	`54`	`+ Runtime.CheckExceptionOccurred();`
`58`	`55`	`}`
`59`	`56`
`60`	`57`
`@@ -63,6 +60,9 @@ public PyTuple()`
`63`	`60`	`/// </summary>`
`64`	`61`	`/// <remarks>`
`65`	`62`	`/// Creates a new PyTuple from an array of PyObject instances.`
	`63`	`+ /// <para />`
	`64`	`+ /// See caveats about PyTuple_SetItem:`
	`65`	`+ /// https://www.coursehero.com/file/p4j2ogg/important-exceptions-to-this-rule-PyTupleSetItem-and-PyListSetItem-These/`
`66`	`66`	`/// </remarks>`
`67`	`67`	`public PyTuple(PyObject[] items)`
`68`	`68`	`{`
`@@ -72,11 +72,8 @@ public PyTuple(PyObject[] items)`
`72`	`72`	`{`
`73`	`73`	`IntPtr ptr = items[i].obj;`
`74`	`74`	`Runtime.XIncref(ptr);`
`75`		`- int r = Runtime.PyTuple_SetItem(obj, i, ptr);`
`76`		`- if (r < 0)`
`77`		`- {`
`78`		`- throw new PythonException();`
`79`		`- }`
	`75`	`+ Runtime.PyTuple_SetItem(obj, i, ptr);`
	`76`	`+ Runtime.CheckExceptionOccurred();`
`80`	`77`	`}`
`81`	`78`	`}`
`82`	`79`
`@@ -104,10 +101,7 @@ public static bool IsTupleType(PyObject value)`
`104`	`101`	`public static PyTuple AsTuple(PyObject value)`
`105`	`102`	`{`
`106`	`103`	`IntPtr op = Runtime.PySequence_Tuple(value.obj);`
`107`		`- if (op == IntPtr.Zero)`
`108`		`- {`
`109`		`- throw new PythonException();`
`110`		`- }`
	`104`	`+ Runtime.CheckExceptionOccurred();`
`111`	`105`	`return new PyTuple(op);`
`112`	`106`	`}`
`113`	`107`	`}`