Add a parameter to specify the shutdown mode.

BadSingleton · BadSingleton · commit 4c4bcb083ba4 · 2020-08-26T13:05:58.000-04:00
Addresses comment: pythonnet#958
diff --git a/src/runtime/pythonengine.cs b/src/runtime/pythonengine.cs
@@ -189,9 +189,6 @@ public static void Initialize(IEnumerable<string> args, bool setSysArgv = true,
             // Make sure we clean up properly on app domain unload.
             AppDomain.CurrentDomain.DomainUnload += OnDomainUnload;
 
-            // Remember to shut down the runtime.
-            AddShutdownHandler(Runtime.Shutdown);
-
             // The global scope gets used implicitly quite early on, remember
             // to clear it out when we shut down.
             AddShutdownHandler(PyScopeManager.Global.Clear);
@@ -318,7 +315,8 @@ public static IntPtr InitExt()
         /// Python runtime can no longer be used in the current process
         /// after calling the Shutdown method.
         /// </remarks>
-        public static void Shutdown()
+        /// <param name="mode">The ShutdownMode to use when shutting down the Runtime</param>
+        public static void Shutdown(ShutdownMode mode)
         {
             if (!initialized)
             {
@@ -330,11 +328,26 @@ public static void Shutdown()
 
             PyScopeManager.Global.Clear();
             ExecuteShutdownHandlers();
+            // Remember to shut down the runtime.
+            Runtime.Shutdown(mode);
             PyObjectConversions.Reset();
 
             initialized = false;
         }
 
+        /// <summary>
+        /// Shutdown Method
+        /// </summary>
+        /// <remarks>
+        /// Shutdown and release resources held by the Python runtime. The
+        /// Python runtime can no longer be used in the current process
+        /// after calling the Shutdown method.
+        /// </remarks>
+        public static void Shutdown()
+        {
+            Shutdown(Runtime.ShutdownMode);
+        }
+
         /// <summary>
         /// Called when the engine is shut down.
         ///
diff --git a/src/runtime/runtime.cs b/src/runtime/runtime.cs
@@ -312,7 +312,7 @@ private static IntPtr Get_PyObject_NextNotImplemented()
             return iternext;
         }
 
-        internal static void Shutdown()
+        internal static void Shutdown(ShutdownMode mode)
         {
             if (Py_IsInitialized() == 0 || !_isInitialized)
             {
@@ -322,7 +322,6 @@ internal static void Shutdown()
 
             var state = PyGILState_Ensure();
 
-            var mode = ShutdownMode;
             if (mode == ShutdownMode.Soft)
             {
                 RunExitFuncs();
@@ -375,6 +374,12 @@ internal static void Shutdown()
             }
         }
 
+        internal static void Shutdown()
+        {
+            var mode = ShutdownMode;
+            Shutdown(mode);
+        }
+
         internal static ShutdownMode GetDefaultShutdownMode()
         {
             string modeEvn = Environment.GetEnvironmentVariable("PYTHONNET_SHUTDOWN_MODE");

Original file line number	Diff line number	Diff line change
`@@ -312,7 +312,7 @@ private static IntPtr Get_PyObject_NextNotImplemented()`
`312`	`312`	`return iternext;`
`313`	`313`	`}`
`314`	`314`
`315`		`- internal static void Shutdown()`
	`315`	`+ internal static void Shutdown(ShutdownMode mode)`
`316`	`316`	`{`
`317`	`317`	`if (Py_IsInitialized() == 0 \|\| !_isInitialized)`
`318`	`318`	`{`
`@@ -322,7 +322,6 @@ internal static void Shutdown()`
`322`	`322`
`323`	`323`	`var state = PyGILState_Ensure();`
`324`	`324`
`325`		`- var mode = ShutdownMode;`
`326`	`325`	`if (mode == ShutdownMode.Soft)`
`327`	`326`	`{`
`328`	`327`	`RunExitFuncs();`
`@@ -375,6 +374,12 @@ internal static void Shutdown()`
`375`	`374`	`}`
`376`	`375`	`}`
`377`	`376`
	`377`	`+ internal static void Shutdown()`
	`378`	`+ {`
	`379`	`+ var mode = ShutdownMode;`
	`380`	`+ Shutdown(mode);`
	`381`	`+ }`
	`382`	`+`
`378`	`383`	`internal static ShutdownMode GetDefaultShutdownMode()`
`379`	`384`	`{`
`380`	`385`	`string modeEvn = Environment.GetEnvironmentVariable("PYTHONNET_SHUTDOWN_MODE");`