cleaned up the Import methods

pythonnet · den-run-ai · Jun 9, 2017 · Mar 3, 2017 · Feb 15, 2017 · Feb 23, 2017
commit 497d7aabebd8719ca9bd226f878eb0640fa89cb3
diff --git a/src/embed_tests/TestPyScope.cs b/src/embed_tests/TestPyScope.cs
@@ -165,7 +165,7 @@ public void TestImportModule()
         {
             using (Py.GIL())
             {
-                dynamic sys = ps.ImportModule("sys");
+                dynamic sys = ps.Import("sys");
                 Assert.IsTrue(ps.ContainsVariable("sys"));
 
                 ps.Exec("sys.attr1 = 2");
@@ -175,7 +175,7 @@ public void TestImportModule()
                 Assert.AreEqual(2, value2);
 
                 //import as
-                ps.ImportModule("sys", "sys1");
+                ps.Import("sys", "sys1");
                 Assert.IsTrue(ps.ContainsVariable("sys1"));
             }
         }
@@ -193,7 +193,7 @@ public void TestImportScope()
                 ps.SetVariable("cc", 10);
 
                 PyScope scope = Py.CreateScope();
-                scope.ImportScope(ps, "ps");
+                scope.Import(ps, "ps");
 
                 scope.Exec("aa = ps.bb + ps.cc + 3");
                 var result = scope.GetVariable<int>("aa");
@@ -281,7 +281,7 @@ public void TestImportScopeByName()
                 ps.SetVariable("bb", 100);
 
                 var scope = Py.CreateScope();
-                scope.ImportAllFromScope("test");
+                scope.ImportAll("test");
                 //scope.ImportModule("test");
 
                 Assert.IsTrue(scope.ContainsVariable("bb"));

diff --git a/src/runtime/pyscope.cs b/src/runtime/pyscope.cs
@@ -35,26 +35,21 @@ public class PyScope : DynamicObject, IDisposable
 
         private bool isDisposed;
 
-        internal PyScopeManager Manager;
+        internal readonly PyScopeManager Manager;
 
         public event Action<PyScope> OnDispose;
 
-        internal static PyScope New(string name = null)
+        public PyScope(IntPtr ptr, PyScopeManager manager)
         {
-            if (name == null)
+            if (Runtime.PyObject_Type(ptr) != Runtime.PyModuleType)
             {
-                name = "";
+                throw new PyScopeException("object is not a module");
             }
-            var module = Runtime.PyModule_New(name);
-            if (module == IntPtr.Zero)
+            if(manager == null)
             {
-                throw new PythonException();
+                manager = PyScopeManager.Global;
             }
-            return new PyScope(module);
-        }
-
-        private PyScope(IntPtr ptr)
-        {
+            Manager = manager;
             obj = ptr;
             //Refcount of the variables not increase
             variables = Runtime.PyModule_GetDict(obj);
@@ -77,70 +72,92 @@ public PyDict Variables()
 
         public PyScope NewScope()
         {
-            var scope = PyScope.New();
-            scope.ImportAllFromScope(this);
+            var scope = Manager.Create();
+            scope.ImportAll(this);
             return scope;
         }
 
-        public void ImportAllFromScope(string name)
-        {
-            var scope = Manager.Get(name);
-            ImportAllFromScope(scope);
-        }
-
-        public void ImportAllFromScope(PyScope scope)
+        public dynamic Import(string name, string asname = null)
         {
-            int result = Runtime.PyDict_Update(variables, scope.variables);
-            if (result < 0)
+            Check();
+            if (asname == null)
             {
-                throw new PythonException();
+                asname = name;
             }
-        }
-
-        public void ImportScope(string name, string asname = null)
-        {
-            var scope = Manager.Get(name);
-            if(asname == null)
+            var scope = Manager.TryGet(name);
+            if(scope != null)
             {
-                asname = name;
+                Import(scope, asname);
+                return scope;
             }
-            ImportScope(scope, asname);
+            PyObject module = PythonEngine.ImportModule(name);
+            Import(module, asname);
+            return module;
         }
 
-        public void ImportScope(PyScope scope, string asname)
+        public void Import(PyScope scope, string asname)
         {
             this.SetVariable(asname, scope.obj);
         }
 
         /// <summary>
-        /// ImportModule Method
+        /// Import Method
         /// </summary>
         /// <remarks>
         /// The import .. as .. statement in Python.
-        /// Import a module ,add it to the variables dict and return the resulting module object as a PyObject.
+        /// Import a module,add it to the variables dict and return the resulting module object as a PyObject.
         /// </remarks>
-        public PyObject ImportModule(string name)
+        public void Import(PyObject module, string asname = null)
         {
-            return ImportModule(name, name);
+            if (asname == null)
+            {
+                asname = module.GetAttr("__name__").ToString();
+            }
+            SetVariable(asname, module);
         }
 
-        /// <summary>
-        /// ImportModule Method
-        /// </summary>
-        /// <remarks>
-        /// The import .. as .. statement in Python.
-        /// Import a module ,add it to the variables dict and return the resulting module object as a PyObject.
-        /// </remarks>
-        public PyObject ImportModule(string name, string asname)
+        public void ImportAll(string name)
         {
-            Check();
+            var scope = Manager.TryGet(name);
+            if(scope != null)
+            {
+                ImportAll(scope);
+                return;
+            }
             PyObject module = PythonEngine.ImportModule(name);
-            if (asname == null)
+            ImportAll(module);
+        }
+
+        public void ImportAll(PyScope scope)
+        {
+            int result = Runtime.PyDict_Update(variables, scope.variables);
+            if (result < 0)
             {
-                asname = name;
+                throw new PythonException();
+            }
+        }
+
+        public void ImportAll(PyObject module)
+        {
+            if (Runtime.PyObject_Type(module.obj) != Runtime.PyModuleType)
+            {
+                throw new PyScopeException("object is not a module");
+            }
+            var module_dict = Runtime.PyModule_GetDict(module.obj);
+            int result = Runtime.PyDict_Update(variables, module_dict);
+            if (result < 0)
+            {
+                throw new PythonException();
+            }
+        }
+
+        public void ImportAll(PyDict dict)
+        {
+            int result = Runtime.PyDict_Update(variables, dict.obj);
+            if (result < 0)
+            {
+                throw new PythonException();
             }
-            SetVariable(asname, module);
-            return module;
         }
 
         /// <summary>
@@ -263,15 +280,6 @@ private void SetVariable(string name, IntPtr value)
             }
         }
 
-        public void AddVariables(PyDict dict)
-        {
-            int result = Runtime.PyDict_Update(variables, dict.obj);
-            if (result < 0)
-            {
-                throw new PythonException();
-            }
-        }
-
         /// <summary>
         /// RemoveVariable Method
         /// </summary>
@@ -442,13 +450,28 @@ public void Dispose()
 
     public class PyScopeManager
     {
+        public readonly static PyScopeManager Global = new PyScopeManager();
+
         private Dictionary<string, PyScope> NamedScopes = new Dictionary<string, PyScope>();
 
+        internal PyScope NewScope(string name)
+        {
+            if (name == null)
+            {
+                name = "";
+            }
+            var module = Runtime.PyModule_New(name);
+            if (module == IntPtr.Zero)
+            {
+                throw new PythonException();
+            }
+            return new PyScope(module, this);
+        }
+
         [PyGIL]
         public PyScope Create()
         {
-            var scope = PyScope.New();
-            scope.Manager = this;
+            var scope = this.NewScope(null);
             return scope;
         }
 
@@ -457,14 +480,13 @@ public PyScope Create(string name)
         {
             if (String.IsNullOrEmpty(name))
             {
-                throw new PyScopeException("Name of ScopeStorage must not be empty");
+                throw new ArgumentNullException(nameof(name));
             }
             if (name != null && NamedScopes.ContainsKey(name))
             {
-                throw new PyScopeException(String.Format("ScopeStorage '{0}' has existed", name));
+                throw new PyScopeException($"PyScope '{name}' has existed");
             }
-            var scope = PyScope.New(name);
-            scope.Manager = this;
+            var scope = this.NewScope(name);
             scope.OnDispose += Remove;
             NamedScopes[name] = scope;
             return scope;
@@ -477,11 +499,22 @@ public bool Contains(string name)
 
         public PyScope Get(string name)
         {
-            if (name != null && NamedScopes.ContainsKey(name))
+            if (name == null)
+            {
+                throw new ArgumentNullException(nameof(name));
+            }
+            if (NamedScopes.ContainsKey(name))
             {
                 return NamedScopes[name];
             }
-            throw new PyScopeException(String.Format("ScopeStorage '{0}' not exist", name));
+            throw new PyScopeException($"PyScope '{name}' not exist");
+        }
+
+        public PyScope TryGet(string name)
+        {
+            PyScope value;
+            NamedScopes.TryGetValue(name, out value);
+            return value;
         }
 
         public void Remove(PyScope scope)

diff --git a/src/runtime/pythonengine.cs b/src/runtime/pythonengine.cs
@@ -294,7 +294,7 @@ public static void Shutdown()
         {
             if (initialized)
             {
-                Py.PyScopeManager.Clear();
+                PyScopeManager.Global.Clear();
                 Marshal.FreeHGlobal(_pythonHome);
                 _pythonHome = IntPtr.Zero;
                 Marshal.FreeHGlobal(_programName);
@@ -546,18 +546,16 @@ public static GILState GIL()
 
             return new GILState();
         }
-
-        internal static PyScopeManager PyScopeManager = new PyScopeManager();
 
         public static PyScope CreateScope()
         {
-            var scope = PyScopeManager.Create();
+            var scope = PyScopeManager.Global.Create();
             return scope;
         }
 
         public static PyScope CreateScope(string name)
         {
-            var scope = PyScopeManager.Create(name);
+            var scope = PyScopeManager.Global.Create(name);
             return scope;
         }