Add Interrupt method in PythonEngine

gpetrou · gpetrou · commit 9b35013a490c · 2020-12-26T16:30:31.000Z
diff --git a/AUTHORS.md b/AUTHORS.md
@@ -65,10 +65,10 @@
 -   Ville M. Vainio ([@vivainio](https://github.com/vivainio))
 -   Virgil Dupras ([@hsoft](https://github.com/hsoft))
 -   Wenguang Yang ([@yagweb](https://github.com/yagweb))
--   William Sardar ([@williamsardar])(https://github.com/williamsardar)
+-   William Sardar ([@williamsardar](https://github.com/williamsardar))
 -   Xavier Dupré ([@sdpython](https://github.com/sdpython))
 -   Zane Purvis ([@zanedp](https://github.com/zanedp))
--   ([@amos402]https://github.com/amos402)
+-   ([@amos402](https://github.com/amos402))
 -   ([@bltribble](https://github.com/bltribble))
 -   ([@civilx64](https://github.com/civilx64))
 -   ([@GSPP](https://github.com/GSPP))
@@ -81,3 +81,4 @@
 -   ([@testrunner123](https://github.com/testrunner123))
 -   ([@DanBarzilian](https://github.com/DanBarzilian))
 -   ([@alxnull](https://github.com/alxnull))
+-   ([@gpetrou](https://github.com/gpetrou))
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,6 +10,7 @@ This document follows the conventions laid out in [Keep a CHANGELOG][].
 ### Added
 
 -   Ability to instantiate new .NET arrays using `Array[T](dim1, dim2, ...)` syntax
+-   Add Interrupt method in PythonEngine
 
 ### Changed
 -   Drop support for Python 2, 3.4, and 3.5
diff --git a/src/embed_tests/TestInterrupt.cs b/src/embed_tests/TestInterrupt.cs
@@ -0,0 +1,83 @@
+
+using System;
+using System.Runtime.InteropServices;
+using System.Threading;
+using System.Threading.Tasks;
+
+using NUnit.Framework;
+
+using Python.Runtime;
+
+namespace Python.EmbeddingTest
+{
+    public class TestInterrupt
+    {
+        private IntPtr _threadState;
+
+        [DllImport("Kernel32", EntryPoint = "GetCurrentThreadId", ExactSpelling = true)]
+        private static extern uint GetCurrentThreadId();
+
+        [DllImport("libc", EntryPoint = "pthread_self")]
+        private static extern IntPtr pthread_selfLinux();
+
+        [DllImport("pthread", EntryPoint = "pthread_self", CallingConvention = CallingConvention.Cdecl)]
+        private static extern ulong pthread_selfOSX();
+
+        [OneTimeSetUp]
+        public void SetUp()
+        {
+            PythonEngine.Initialize();
+            _threadState = PythonEngine.BeginAllowThreads();
+        }
+
+        [OneTimeTearDown]
+        public void Dispose()
+        {
+            PythonEngine.EndAllowThreads(_threadState);
+            PythonEngine.Shutdown();
+        }
+
+        [Test]
+        public void InterruptTest()
+        {
+            int runSimpleStringReturnValue = int.MinValue;
+            ulong nativeThreadId = 0;
+            Task.Factory.StartNew(() =>
+            {
+                if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
+                {
+                    nativeThreadId = GetCurrentThreadId();
+                }
+                else if (RuntimeInformation.IsOSPlatform(OSPlatform.Linux))
+                {
+                    nativeThreadId = (ulong)pthread_selfLinux();
+                }
+                else if (RuntimeInformation.IsOSPlatform(OSPlatform.OSX))
+                {
+                    nativeThreadId = pthread_selfOSX();
+                }
+
+                using (Py.GIL())
+                {
+                    runSimpleStringReturnValue = PythonEngine.RunSimpleString(@"
+import time
+
+while True:
+    time.sleep(0.2)");
+                }
+            });
+
+            Thread.Sleep(100);
+
+            using (Py.GIL())
+            {
+                int interruptReturnValue = PythonEngine.Interrupt(nativeThreadId);
+                Assert.AreEqual(1, interruptReturnValue);
+            }
+
+            Thread.Sleep(200);
+
+            Assert.AreEqual(-1, runSimpleStringReturnValue);
+        }
+    }
+}
diff --git a/src/runtime/pythonengine.cs b/src/runtime/pythonengine.cs
@@ -567,6 +567,15 @@ public static void Exec(string code, IntPtr? globals = null, IntPtr? locals = nu
             }
         }
 
+        /// <summary>
+        /// Interrupts the execution of a thread.
+        /// </summary>
+        /// <param name="nativeThreadId">The native thread id.</param>
+        /// <returns>The number of thread states modified; this is normally one, but will be zero if the thread id isn’t found.</returns>
+        public static int Interrupt(ulong nativeThreadId)
+        {
+            return Runtime.PyThreadState_SetAsyncExc(nativeThreadId, Exceptions.KeyboardInterrupt);
+        }
 
         /// <summary>
         /// RunString Method. Function has been deprecated and will be removed.
diff --git a/src/runtime/runtime.cs b/src/runtime/runtime.cs
@@ -2143,6 +2143,9 @@ internal static void Py_CLEAR(ref IntPtr ob)
         [DllImport(_PythonDll, CallingConvention = CallingConvention.Cdecl)]
         internal static extern int Py_AddPendingCall(IntPtr func, IntPtr arg);
 
+        [DllImport(_PythonDll, CallingConvention = CallingConvention.Cdecl)]
+        internal static extern int PyThreadState_SetAsyncExc(ulong id, IntPtr exc);
+
         [DllImport(_PythonDll, CallingConvention = CallingConvention.Cdecl)]
         internal static extern int Py_MakePendingCalls();
 

Original file line number	Diff line number	Diff line change
`@@ -567,6 +567,15 @@ public static void Exec(string code, IntPtr? globals = null, IntPtr? locals = nu`
`567`	`567`	`}`
`568`	`568`	`}`
`569`	`569`
	`570`	`+ /// <summary>`
	`571`	`+ /// Interrupts the execution of a thread.`
	`572`	`+ /// </summary>`
	`573`	`+ /// <param name="nativeThreadId">The native thread id.</param>`
	`574`	`+ /// <returns>The number of thread states modified; this is normally one, but will be zero if the thread id isn’t found.</returns>`
	`575`	`+ public static int Interrupt(ulong nativeThreadId)`
	`576`	`+ {`
	`577`	`+ return Runtime.PyThreadState_SetAsyncExc(nativeThreadId, Exceptions.KeyboardInterrupt);`
	`578`	`+ }`
`570`	`579`
`571`	`580`	`/// <summary>`
`572`	`581`	`/// RunString Method. Function has been deprecated and will be removed.`