Py.Import and PyModule.Import return PyObject instead of PyModule, as not everything that can be imported is PyModule

lostmsu · lostmsu · commit 0fdce5250a0f · 2021-08-25T11:03:57.000-07:00
fixes #1489
diff --git a/src/embed_tests/TestFinalizer.cs b/src/embed_tests/TestFinalizer.cs
@@ -183,7 +183,7 @@ public void SimpleTestMemory()
             bool oldState = Finalizer.Instance.Enable;
             try
             {
-                using (PyModule gcModule = PyModule.Import("gc"))
+                using (PyObject gcModule = PyModule.Import("gc"))
                 using (PyObject pyCollect = gcModule.GetAttr("collect"))
                 {
                     long span1 = CompareWithFinalizerOn(pyCollect, false);
diff --git a/src/embed_tests/TestPyModule.cs b/src/embed_tests/TestPyModule.cs
@@ -1,6 +1,3 @@
-
-using System;
-
 using NUnit.Framework;
 
 using Python.Runtime;
@@ -43,5 +40,11 @@ public void TestCreate()
             Assert.IsTrue(scope.TryGet("x", out dynamic x));
             Assert.AreEqual("True", x.ToString());
         }
+
+        [Test]
+        public void ImportClrNamespace()
+        {
+            Py.Import(typeof(TestPyModule).Namespace);
+        }
     }
 }
diff --git a/src/runtime/exceptions.cs b/src/runtime/exceptions.cs
@@ -87,8 +87,8 @@ internal static Exception ToException(BorrowedReference ob)
     /// </remarks>
     internal static class Exceptions
     {
-        internal static PyModule warnings_module;
-        internal static PyModule exceptions_module;
+        internal static PyObject warnings_module;
+        internal static PyObject exceptions_module;
 
         /// <summary>
         /// Initialization performed on startup of the Python runtime.
diff --git a/src/runtime/pymodule.cs b/src/runtime/pymodule.cs
@@ -1,7 +1,4 @@
 using System;
-using System.Text;
-
-using Python.Runtime.Native;
 
 namespace Python.Runtime
 {
@@ -12,15 +9,14 @@ public PyModule(PyObject o) : base(o.Reference, PyScopeManager.Global) { }
         public PyModule(string name, string filename = null) : this(Create(name, filename)) { }
 
         /// <summary>
-        /// Given a module or package name, import the
-        /// module and return the resulting module object as a <see cref="PyModule"/>.
+        /// Given a module or package name, import the module and return the resulting object.
         /// </summary>
         /// <param name="name">Fully-qualified module or package name</param>
-        public static PyModule Import(string name)
+        public static PyObject Import(string name)
         {
             NewReference op = Runtime.PyImport_ImportModule(name);
             PythonException.ThrowIfIsNull(op);
-            return new PyModule(ref op);
+            return IsModule(op) ? new PyModule(ref op) : op.MoveToPyObject();
         }
 
         /// <summary>
@@ -85,5 +81,12 @@ public static PyDict SysModules
                 return new PyDict(sysModulesRef);
             }
         }
+
+        internal static bool IsModule(BorrowedReference reference)
+        {
+            if (reference == null) return false;
+            BorrowedReference type = Runtime.PyObject_TYPE(reference);
+            return Runtime.PyType_IsSubtype(type, Runtime.PyModuleType);
+        }
     }
 }
diff --git a/src/runtime/pyscope.cs b/src/runtime/pyscope.cs
@@ -56,7 +56,7 @@ internal PyScope(BorrowedReference reference, PyScopeManager manager)
         /// <summary>Create a scope based on a Python Module.</summary>
         private PyScope(IntPtr ptr, PyScopeManager manager) : base(ptr)
         {
-            if (!Runtime.PyType_IsSubtype(Runtime.PyObject_TYPE(Reference), Runtime.PyModuleType))
+            if (!PyModule.IsModule(Reference))
             {
                 throw new PyScopeException("object is not a module");
             }
diff --git a/src/runtime/pythonengine.cs b/src/runtime/pythonengine.cs
@@ -750,11 +750,10 @@ public static KeywordArguments kw(params object[] kv)
         }
 
         /// <summary>
-        /// Given a module or package name, import the
-        /// module and return the resulting module object as a <see cref="PyModule"/>.
+        /// Given a module or package name, import the module and return the resulting object.
         /// </summary>
         /// <param name="name">Fully-qualified module or package name</param>
-        public static PyModule Import(string name) => PyModule.Import(name);
+        public static PyObject Import(string name) => PyModule.Import(name);
 
         public static void SetArgv()
         {

Original file line number	Diff line number	Diff line change
`@@ -183,7 +183,7 @@ public void SimpleTestMemory()`
`183`	`183`	`bool oldState = Finalizer.Instance.Enable;`
`184`	`184`	`try`
`185`	`185`	`{`
`186`		`- using (PyModule gcModule = PyModule.Import("gc"))`
	`186`	`+ using (PyObject gcModule = PyModule.Import("gc"))`
`187`	`187`	`using (PyObject pyCollect = gcModule.GetAttr("collect"))`
`188`	`188`	`{`
`189`	`189`	`long span1 = CompareWithFinalizerOn(pyCollect, false);`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,3 @@`
`1`		`-`
`2`		`-using System;`
`3`		`-`
`4`	`1`	`using NUnit.Framework;`
`5`	`2`
`6`	`3`	`using Python.Runtime;`
`@@ -43,5 +40,11 @@ public void TestCreate()`
`43`	`40`	`Assert.IsTrue(scope.TryGet("x", out dynamic x));`
`44`	`41`	`Assert.AreEqual("True", x.ToString());`
`45`	`42`	`}`
	`43`	`+`
	`44`	`+ [Test]`
	`45`	`+ public void ImportClrNamespace()`
	`46`	`+ {`
	`47`	`+ Py.Import(typeof(TestPyModule).Namespace);`
	`48`	`+ }`
`46`	`49`	`}`
`47`	`50`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,4 @@`
`1`	`1`	`using System;`
`2`		`-using System.Text;`
`3`		`-`
`4`		`-using Python.Runtime.Native;`
`5`	`2`
`6`	`3`	`namespace Python.Runtime`
`7`	`4`	`{`
`@@ -12,15 +9,14 @@ public PyModule(PyObject o) : base(o.Reference, PyScopeManager.Global) { }`
`12`	`9`	`public PyModule(string name, string filename = null) : this(Create(name, filename)) { }`
`13`	`10`
`14`	`11`	`/// <summary>`
`15`		`- /// Given a module or package name, import the`
`16`		`- /// module and return the resulting module object as a <see cref="PyModule"/>.`
	`12`	`+ /// Given a module or package name, import the module and return the resulting object.`
`17`	`13`	`/// </summary>`
`18`	`14`	`/// <param name="name">Fully-qualified module or package name</param>`
`19`		`- public static PyModule Import(string name)`
	`15`	`+ public static PyObject Import(string name)`
`20`	`16`	`{`
`21`	`17`	`NewReference op = Runtime.PyImport_ImportModule(name);`
`22`	`18`	`PythonException.ThrowIfIsNull(op);`
`23`		`- return new PyModule(ref op);`
	`19`	`+ return IsModule(op) ? new PyModule(ref op) : op.MoveToPyObject();`
`24`	`20`	`}`
`25`	`21`
`26`	`22`	`/// <summary>`
`@@ -85,5 +81,12 @@ public static PyDict SysModules`
`85`	`81`	`return new PyDict(sysModulesRef);`
`86`	`82`	`}`
`87`	`83`	`}`
	`84`	`+`
	`85`	`+ internal static bool IsModule(BorrowedReference reference)`
	`86`	`+ {`
	`87`	`+ if (reference == null) return false;`
	`88`	`+ BorrowedReference type = Runtime.PyObject_TYPE(reference);`
	`89`	`+ return Runtime.PyType_IsSubtype(type, Runtime.PyModuleType);`
	`90`	`+ }`
`88`	`91`	`}`
`89`	`92`	`}`
Original file line number	Diff line number	Diff line change
`@@ -56,7 +56,7 @@ internal PyScope(BorrowedReference reference, PyScopeManager manager)`
`56`	`56`	`/// <summary>Create a scope based on a Python Module.</summary>`
`57`	`57`	`private PyScope(IntPtr ptr, PyScopeManager manager) : base(ptr)`
`58`	`58`	`{`
`59`		`- if (!Runtime.PyType_IsSubtype(Runtime.PyObject_TYPE(Reference), Runtime.PyModuleType))`
	`59`	`+ if (!PyModule.IsModule(Reference))`
`60`	`60`	`{`
`61`	`61`	`throw new PyScopeException("object is not a module");`
`62`	`62`	`}`
Original file line number	Diff line number	Diff line change
`@@ -750,11 +750,10 @@ public static KeywordArguments kw(params object[] kv)`
`750`	`750`	`}`
`751`	`751`
`752`	`752`	`/// <summary>`
`753`		`- /// Given a module or package name, import the`
`754`		`- /// module and return the resulting module object as a <see cref="PyModule"/>.`
	`753`	`+ /// Given a module or package name, import the module and return the resulting object.`
`755`	`754`	`/// </summary>`
`756`	`755`	`/// <param name="name">Fully-qualified module or package name</param>`
`757`		`- public static PyModule Import(string name) => PyModule.Import(name);`
	`756`	`+ public static PyObject Import(string name) => PyModule.Import(name);`
`758`	`757`
`759`	`758`	`public static void SetArgv()`
`760`	`759`	`{`