Allow setting of the python module file (#2044)

bmello4688 · filmor · web-flow · commit 8e8c3f3c9217 · 2023-10-16T12:47:26.000+02:00
Allow the setting of the python module file in order to create a virtual package structure

---------

Co-authored-by: Benedikt Reinartz &lt;filmor@gmail.com&gt;
diff --git a/src/embed_tests/Modules.cs b/src/embed_tests/Modules.cs
@@ -51,7 +51,7 @@ public void TestEval()
                 ps.Set("a", 1);
                 var result = ps.Eval<int>("a + 2");
                 Assert.AreEqual(3, result);
-            }                
+            }
         }
 
         //github.com/ <summary>
@@ -169,6 +169,62 @@ public void TestScopeClass()
             }
         }
 
+        //github.com/ <summary>
+        //github.com/ Create a class in the scope, the class can read variables in the scope.
+        //github.com/ Its methods can write the variables with the help of 'global' keyword.
+        //github.com/ </summary>
+        [Test]
+        public void TestCreateVirtualPackageStructure()
+        {
+            using (Py.GIL())
+            {
+                using var _p1 = PyModule.FromString("test", "");
+                // Sub-module
+                using var _p2 = PyModule.FromString("test.scope",
+                    "class Class1():\n" +
+                    "    def __init__(self, value):\n" +
+                    "        self.value = value\n" +
+                    "    def call(self, arg):\n" +
+                    "        return self.value + bb + arg\n" + // use scope variables
+                    "    def update(self, arg):\n" +
+                    "        global bb\n" +
+                    "        bb = self.value + arg\n",  // update scope variable
+                    "test"
+                );
+
+                dynamic ps2 = Py.Import("test.scope");
+                ps2.bb = 100;
+
+                dynamic obj1 = ps2.Class1(20);
+                var result = obj1.call(10).As<int>();
+                Assert.AreEqual(130, result);
+
+                obj1.update(10);
+                result = ps2.Get<int>("bb");
+                Assert.AreEqual(30, result);
+            }
+        }
+
+        //github.com/ <summary>
+        //github.com/ Test setting the file attribute via a FromString parameter
+        //github.com/ </summary>
+        [Test]
+        public void TestCreateModuleWithFilename()
+        {
+            using var _gil = Py.GIL();
+
+            using var mod = PyModule.FromString("mod", "");
+            using var modWithoutName = PyModule.FromString("mod_without_name", "", " ");
+            using var modNullName = PyModule.FromString("mod_null_name", "", null);
+
+            using var modWithName = PyModule.FromString("mod_with_name", "", "some_filename");
+
+            Assert.AreEqual("none", mod.Get<string>("__file__"));
+            Assert.AreEqual("none", modWithoutName.Get<string>("__file__"));
+            Assert.AreEqual("none", modNullName.Get<string>("__file__"));
+            Assert.AreEqual("some_filename", modWithName.Get<string>("__file__"));
+        }
+
         //github.com/ <summary>
         //github.com/ Import a python module into the session.
         //github.com/ Equivalent to the Python "import" statement.
@@ -194,7 +250,7 @@ public void TestImportModule()
         }
 
         //github.com/ <summary>
-        //github.com/ Create a scope and import variables from a scope, 
+        //github.com/ Create a scope and import variables from a scope,
         //github.com/ exec Python statements in the scope then discard it.
         //github.com/ </summary>
         [Test]
@@ -218,7 +274,7 @@ public void TestImportScope()
         }
 
         //github.com/ <summary>
-        //github.com/ Create a scope and import variables from a scope, 
+        //github.com/ Create a scope and import variables from a scope,
         //github.com/ exec Python statements in the scope then discard it.
         //github.com/ </summary>
         [Test]
@@ -241,7 +297,7 @@ public void TestImportAllFromScope()
         }
 
         //github.com/ <summary>
-        //github.com/ Create a scope and import variables from a scope, 
+        //github.com/ Create a scope and import variables from a scope,
         //github.com/ call the function imported.
         //github.com/ </summary>
         [Test]
@@ -286,7 +342,7 @@ public void TestImportScopeFunction()
         public void TestVariables()
         {
             using (Py.GIL())
-            { 
+            {
                 (ps.Variables() as dynamic)["ee"] = new PyInt(200);
                 var a0 = ps.Get<int>("ee");
                 Assert.AreEqual(200, a0);
@@ -326,8 +382,8 @@ public void TestThread()
                     _ps.res = 0;
                     _ps.bb = 100;
                     _ps.th_cnt = 0;
-                    //add function to the scope 
-                    //can be call many times, more efficient than ast 
+                    //add function to the scope
+                    //can be call many times, more efficient than ast
                     ps.Exec(
                         "import threading\n"+
                         "lock = threading.Lock()\n"+
diff --git a/src/runtime/PythonTypes/PyModule.cs b/src/runtime/PythonTypes/PyModule.cs
@@ -82,7 +82,18 @@ public PyModule Reload()
 
         public static PyModule FromString(string name, string code)
         {
-            using NewReference c = Runtime.Py_CompileString(code, "none", (int)RunFlagType.File);
+            return FromString(name, code, "");
+        }
+
+        public static PyModule FromString(string name, string code, string file)
+        {
+            // Force valid value
+            if (string.IsNullOrWhiteSpace(file))
+            {
+                file = "none";
+            }
+
+            using NewReference c = Runtime.Py_CompileString(code, file, (int)RunFlagType.File);
             NewReference m = Runtime.PyImport_ExecCodeModule(name, c.BorrowOrThrow());
             return new PyModule(m.StealOrThrow());
         }
