dispose registered codecs and interop configuration during shutdown

lostmsu · lostmsu · commit 62e2fb45eeba · 2021-11-11T22:02:16.000-08:00
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))

Original file line number	Diff line number	Diff line change
`@@ -421,13 +421,18 @@ public PyObject TryEncode(object value)`
`421`	`421`	`}`
`422`	`422`	`}`
`423`	`423`
`424`		`- class InstancelessExceptionDecoder : IPyObjectDecoder`
	`424`	`+ class InstancelessExceptionDecoder : IPyObjectDecoder, IDisposable`
`425`	`425`	`{`
`426`	`426`	`readonly PyObject PyErr = Py.Import("clr.interop").GetAttr("PyErr");`
`427`	`427`
`428`	`428`	`public bool CanDecode(PyType objectType, Type targetType)`
`429`	`429`	`=> PythonReferenceComparer.Instance.Equals(PyErr, objectType);`
`430`	`430`
	`431`	`+ public void Dispose()`
	`432`	`+ {`
	`433`	`+ PyErr.Dispose();`
	`434`	`+ }`
	`435`	`+`
`431`	`436`	`public bool TryDecode<T>(PyObject pyObj, out T value)`
`432`	`437`	`{`
`433`	`438`	`if (pyObj.HasAttr("value"))`
Original file line number	Diff line number	Diff line change
`@@ -24,6 +24,7 @@ public void SetUp()`
`24`	`24`	`[OneTimeTearDown]`
`25`	`25`	`public void Dispose()`
`26`	`26`	`{`
	`27`	`+ ExtraBaseTypeProvider.ExtraBase.Dispose();`
`27`	`28`	`PythonEngine.Shutdown();`
`28`	`29`	`}`
`29`	`30`
Original file line number	Diff line number	Diff line change
`@@ -176,6 +176,7 @@ public static void TestRunExitFuncs()`
`176`	`176`	`{`
`177`	`177`	`Assert.Fail(msg);`
`178`	`178`	`}`
	`179`	`+ PythonEngine.InteropConfiguration = InteropConfiguration.MakeDefault();`
`179`	`180`	`return;`
`180`	`181`	`}`
`181`	`182`	`bool called = false;`
`@@ -187,6 +188,7 @@ public static void TestRunExitFuncs()`
`187`	`188`	`atexit.Dispose();`
`188`	`189`	`Runtime.Runtime.Shutdown();`
`189`	`190`	`Assert.True(called);`
	`191`	`+ PythonEngine.InteropConfiguration = InteropConfiguration.MakeDefault();`
`190`	`192`	`}`
`191`	`193`	`}`
`192`	`194`
Original file line number	Diff line number	Diff line change
`@@ -2,10 +2,11 @@ namespace Python.Runtime`
`2`	`2`	`{`
`3`	`3`	`using System;`
`4`	`4`	`using System.Collections.Generic;`
	`5`	`+ using System.Linq;`
`5`	`6`
`6`	`7`	`using Python.Runtime.Mixins;`
`7`	`8`
`8`		`- public sealed class InteropConfiguration`
	`9`	`+ public sealed class InteropConfiguration: IDisposable`
`9`	`10`	`{`
`10`	`11`	`internal readonly PythonBaseTypeProviderGroup pythonBaseTypeProviders`
`11`	`12`	`= new PythonBaseTypeProviderGroup();`
`@@ -24,5 +25,14 @@ public static InteropConfiguration MakeDefault()`
`24`	`25`	`},`
`25`	`26`	`};`
`26`	`27`	`}`
	`28`	`+`
	`29`	`+ public void Dispose()`
	`30`	`+ {`
	`31`	`+ foreach (var provider in PythonBaseTypeProviders.OfType<IDisposable>())`
	`32`	`+ {`
	`33`	`+ provider.Dispose();`
	`34`	`+ }`
	`35`	`+ PythonBaseTypeProviders.Clear();`
	`36`	`+ }`
`27`	`37`	`}`
`28`	`38`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`
`5`	`5`	`namespace Python.Runtime.Mixins`
`6`	`6`	`{`
`7`		`- class CollectionMixinsProvider : IPythonBaseTypeProvider`
	`7`	`+ class CollectionMixinsProvider : IPythonBaseTypeProvider, IDisposable`
`8`	`8`	`{`
`9`	`9`	`readonly Lazy<PyObject> mixinsModule;`
`10`	`10`	`public CollectionMixinsProvider(Lazy<PyObject> mixinsModule)`
`@@ -86,5 +86,13 @@ static Type[] NewInterfaces(Type type)`
`86`	`86`
`87`	`87`	`static Type GetDefinition(Type type)`
`88`	`88`	`=> type.IsGenericType ? type.GetGenericTypeDefinition() : type;`
	`89`	`+`
	`90`	`+ public void Dispose()`
	`91`	`+ {`
	`92`	`+ if (this.mixinsModule.IsValueCreated)`
	`93`	`+ {`
	`94`	`+ this.mixinsModule.Value.Dispose();`
	`95`	`+ }`
	`96`	`+ }`
`89`	`97`	`}`
`90`	`98`	`}`
Original file line number	Diff line number	Diff line change
`@@ -166,8 +166,8 @@ internal static void Reset()`
`166`	`166`	`{`
`167`	`167`	`clrToPython.Clear();`
`168`	`168`	`pythonToClr.Clear();`
`169`		`- encoders.Clear();`
`170`		`- decoders.Clear();`
	`169`	`+ encoders.Dispose();`
	`170`	`+ decoders.Dispose();`
`171`	`171`	`}`
`172`	`172`	`}`
`173`	`173`