dispose registered codecs and interop configuration during shutdown

pythonnet · filmor · Nov 23, 2021 · Mar 3, 2020 · Nov 12, 2021 · Nov 12, 2021
commit 62e2fb45eebac0a01bb4df4ed8f276c4e4d59a23
diff --git a/src/embed_tests/Codecs.cs b/src/embed_tests/Codecs.cs
@@ -421,13 +421,18 @@ public PyObject TryEncode(object value)
             }
         }
 
-        class InstancelessExceptionDecoder : IPyObjectDecoder
+        class InstancelessExceptionDecoder : IPyObjectDecoder, IDisposable
         {
             readonly PyObject PyErr = Py.Import("clr.interop").GetAttr("PyErr");
 
             public bool CanDecode(PyType objectType, Type targetType)
                 => PythonReferenceComparer.Instance.Equals(PyErr, objectType);
 
+            public void Dispose()
+            {
+                PyErr.Dispose();
+            }
+
             public bool TryDecode<T>(PyObject pyObj, out T value)
             {
                 if (pyObj.HasAttr("value"))

diff --git a/src/embed_tests/Inheritance.cs b/src/embed_tests/Inheritance.cs
@@ -24,6 +24,7 @@ public void SetUp()
         [OneTimeTearDown]
         public void Dispose()
         {
+            ExtraBaseTypeProvider.ExtraBase.Dispose();
             PythonEngine.Shutdown();
         }
 

diff --git a/src/embed_tests/pyinitialize.cs b/src/embed_tests/pyinitialize.cs
@@ -176,6 +176,7 @@ public static void TestRunExitFuncs()
                 {
                     Assert.Fail(msg);
                 }
+                PythonEngine.InteropConfiguration = InteropConfiguration.MakeDefault();
                 return;
             }
             bool called = false;
@@ -187,6 +188,7 @@ public static void TestRunExitFuncs()
             atexit.Dispose();
             Runtime.Runtime.Shutdown();
             Assert.True(called);
+            PythonEngine.InteropConfiguration = InteropConfiguration.MakeDefault();
         }
     }
 

diff --git a/src/runtime/Codecs/DecoderGroup.cs b/src/runtime/Codecs/DecoderGroup.cs
@@ -8,7 +8,7 @@ namespace Python.Runtime.Codecs
     /// <summary>
     /// Represents a group of <see cref="IPyObjectDecoder"/>s. Useful to group them by priority.
     /// </summary>
-    public sealed class DecoderGroup: IPyObjectDecoder, IEnumerable<IPyObjectDecoder>
+    public sealed class DecoderGroup: IPyObjectDecoder, IEnumerable<IPyObjectDecoder>, IDisposable
     {
         readonly List<IPyObjectDecoder> decoders = new List<IPyObjectDecoder>();
 
@@ -46,6 +46,15 @@ public bool TryDecode<T>(PyObject pyObj, out T value)
         /// <inheritdoc />
         public IEnumerator<IPyObjectDecoder> GetEnumerator() => this.decoders.GetEnumerator();
         IEnumerator IEnumerable.GetEnumerator() => this.decoders.GetEnumerator();
+
+        public void Dispose()
+        {
+            foreach (var decoder in this.decoders.OfType<IDisposable>())
+            {
+                decoder.Dispose();
+            }
+            this.decoders.Clear();
+        }
     }
 
     public static class DecoderGroupExtensions

diff --git a/src/runtime/Codecs/EncoderGroup.cs b/src/runtime/Codecs/EncoderGroup.cs
@@ -8,7 +8,7 @@ namespace Python.Runtime.Codecs
     /// <summary>
     /// Represents a group of <see cref="IPyObjectDecoder"/>s. Useful to group them by priority.
     /// </summary>
-    public sealed class EncoderGroup: IPyObjectEncoder, IEnumerable<IPyObjectEncoder>
+    public sealed class EncoderGroup: IPyObjectEncoder, IEnumerable<IPyObjectEncoder>, IDisposable
     {
         readonly List<IPyObjectEncoder> encoders = new List<IPyObjectEncoder>();
 
@@ -47,6 +47,15 @@ public PyObject TryEncode(object value)
         /// <inheritdoc />
         public IEnumerator<IPyObjectEncoder> GetEnumerator() => this.encoders.GetEnumerator();
         IEnumerator IEnumerable.GetEnumerator() => this.encoders.GetEnumerator();
+
+        public void Dispose()
+        {
+            foreach (var encoder in this.encoders.OfType<IDisposable>())
+            {
+                encoder.Dispose();
+            }
+            this.encoders.Clear();
+        }
     }
 
     public static class EncoderGroupExtensions

diff --git a/src/runtime/InteropConfiguration.cs b/src/runtime/InteropConfiguration.cs
@@ -2,10 +2,11 @@ namespace Python.Runtime
 {
     using System;
     using System.Collections.Generic;
+    using System.Linq;
 
     using Python.Runtime.Mixins;
 
-    public sealed class InteropConfiguration
+    public sealed class InteropConfiguration: IDisposable
     {
         internal readonly PythonBaseTypeProviderGroup pythonBaseTypeProviders
             = new PythonBaseTypeProviderGroup();
@@ -24,5 +25,14 @@ public static InteropConfiguration MakeDefault()
                 },
             };
         }
+
+        public void Dispose()
+        {
+            foreach (var provider in PythonBaseTypeProviders.OfType<IDisposable>())
+            {
+                provider.Dispose();
+            }
+            PythonBaseTypeProviders.Clear();
+        }
     }
 }
diff --git a/src/runtime/Mixins/CollectionMixinsProvider.cs b/src/runtime/Mixins/CollectionMixinsProvider.cs
@@ -4,7 +4,7 @@
 
 namespace Python.Runtime.Mixins
 {
-    class CollectionMixinsProvider : IPythonBaseTypeProvider
+    class CollectionMixinsProvider : IPythonBaseTypeProvider, IDisposable
     {
         readonly Lazy<PyObject> mixinsModule;
         public CollectionMixinsProvider(Lazy<PyObject> mixinsModule)
@@ -86,5 +86,13 @@ static Type[] NewInterfaces(Type type)
 
         static Type GetDefinition(Type type)
             => type.IsGenericType ? type.GetGenericTypeDefinition() : type;
+
+        public void Dispose()
+        {
+            if (this.mixinsModule.IsValueCreated)
+            {
+                this.mixinsModule.Value.Dispose();
+            }
+        }
     }
 }
diff --git a/src/runtime/converterextensions.cs b/src/runtime/converterextensions.cs
@@ -166,8 +166,8 @@ internal static void Reset()
                 {
                     clrToPython.Clear();
                     pythonToClr.Clear();
-                    encoders.Clear();
-                    decoders.Clear();
+                    encoders.Dispose();
+                    decoders.Dispose();
                 }
         }
 

diff --git a/src/runtime/pythonengine.cs b/src/runtime/pythonengine.cs
@@ -381,7 +381,6 @@ public static void Shutdown(ShutdownMode mode)
             ExecuteShutdownHandlers();
             // Remember to shut down the runtime.
             Runtime.Shutdown(mode);
-            PyObjectConversions.Reset();
 
             initialized = false;
 

diff --git a/src/runtime/runtime.cs b/src/runtime/runtime.cs
@@ -373,6 +373,11 @@ internal static void Shutdown(ShutdownMode mode)
             PyCLRMetaType = IntPtr.Zero;
 
             Exceptions.Shutdown();
+            PythonEngine.InteropConfiguration.Dispose();
+            DisposeLazyModule(clrInterop);
+            DisposeLazyModule(inspect);
+            PyObjectConversions.Reset();
+
             Finalizer.Shutdown();
             InternString.Shutdown();
 
@@ -424,6 +429,14 @@ internal static void Shutdown()
             Shutdown(mode);
         }
 
+        static void DisposeLazyModule(Lazy<PyObject> module)
+        {
+            if (module.IsValueCreated)
+            {
+                module.Value.Dispose();
+            }
+        }
+
         private static Lazy<PyObject> GetModuleLazy(string moduleName)
             => moduleName is null
                 ? throw new ArgumentNullException(nameof(moduleName))