UNI-62864: shutdown on domain reload.

Benoit Hudson · Benoit Hudson · commit c07fff02f4fe · 2018-09-14T18:08:50.000-04:00
Shut down python when the domain that loaded python reloads.
diff --git a/src/embed_tests/TestDomainReload.cs b/src/embed_tests/TestDomainReload.cs
@@ -2,6 +2,7 @@
 using System.CodeDom.Compiler;
 using System.Reflection;
 using NUnit.Framework;
+using Python.Runtime;
 
 namespace Python.EmbeddingTest
 {
@@ -48,6 +49,9 @@ public static void DomainReloadAndGC()
             Assembly pythonRunner1 = BuildAssembly("test1");
             RunAssemblyAndUnload(pythonRunner1, "test1");
 
+            // Verify that python is not initialized even though we ran it.
+            Assert.That(Runtime.Runtime.Py_IsInitialized(), Is.Zero);
+
             // This caused a crash because objects allocated in pythonRunner1
             // still existed in memory, but the code to do python GC on those
             // objects is gone.
diff --git a/src/runtime/pythonengine.cs b/src/runtime/pythonengine.cs
@@ -220,9 +220,17 @@ public static void Initialize(IEnumerable<string> args, bool setSysArgv = true)
                 {
                     locals.Dispose();
                 }
+
+                // Make sure we clean up properly on app domain unload.
+                AppDomain.CurrentDomain.DomainUnload += OnDomainUnload;
             }
         }
 
+        static void OnDomainUnload(object _, EventArgs __)
+        {
+            Shutdown();
+        }
+
         /// <summary>
         /// A helper to perform initialization from the context of an active
         /// CPython interpreter process - this bootstraps the managed runtime
@@ -303,6 +311,8 @@ public static void Shutdown()
                 _pythonPath = IntPtr.Zero;
 
                 Runtime.Shutdown();
+
+                AppDomain.CurrentDomain.DomainUnload -= OnDomainUnload;
                 initialized = false;
             }
         }

Original file line number	Diff line number	Diff line change
`@@ -220,9 +220,17 @@ public static void Initialize(IEnumerable<string> args, bool setSysArgv = true)`
`220`	`220`	`{`
`221`	`221`	`locals.Dispose();`
`222`	`222`	`}`
	`223`	`+`
	`224`	`+ // Make sure we clean up properly on app domain unload.`
	`225`	`+ AppDomain.CurrentDomain.DomainUnload += OnDomainUnload;`
`223`	`226`	`}`
`224`	`227`	`}`
`225`	`228`
	`229`	`+ static void OnDomainUnload(object _, EventArgs __)`
	`230`	`+ {`
	`231`	`+ Shutdown();`
	`232`	`+ }`
	`233`	`+`
`226`	`234`	`/// <summary>`
`227`	`235`	`/// A helper to perform initialization from the context of an active`
`228`	`236`	`/// CPython interpreter process - this bootstraps the managed runtime`
`@@ -303,6 +311,8 @@ public static void Shutdown()`
`303`	`311`	`_pythonPath = IntPtr.Zero;`
`304`	`312`
`305`	`313`	`Runtime.Shutdown();`
	`314`	`+`
	`315`	`+ AppDomain.CurrentDomain.DomainUnload -= OnDomainUnload;`
`306`	`316`	`initialized = false;`
`307`	`317`	`}`
`308`	`318`	`}`