Merge pull request #60 from Distributive-Network/Xmader/feat/pm.require

Add a globally-available `pm.require` that gets the caller’s filename from the Python call stack

Author: Xmader

examples/use-python-module.py

@@ -5,5 +5,4 @@
 
 import pythonmonkey as pm
 
-require = pm.createRequire(__file__)
-require('./use-python-module');
+pm.require('./use-python-module');

examples/use-require.py

@@ -5,7 +5,6 @@
 
 import pythonmonkey as pm
 
-require = pm.createRequire(__file__)
-require('./use-require/test1');
+pm.require('./use-require/test1');
 print("Done")
 

js-test-runner

@@ -8,8 +8,7 @@ import sys, os
 import pythonmonkey as pm
 
 # Main
-require = pm.createRequire(__file__)
-require('console');
+pm.require('console');
 
 testName = os.path.realpath(sys.argv[1]);
 testDir = os.path.dirname(testName);

pmjs

@@ -8,7 +8,7 @@ import pythonmonkey as pm
 
 globalThis = pm.eval("globalThis;")
 globalThis.python.write = sys.stdout.write
-pm.createRequire(__file__)('./pmjs-require')
+pm.require('./pmjs-require')
 
 pm.eval("""'use strict';
 const cmds = {};

python/pythonmonkey/require.py

@@ -23,11 +23,12 @@
 # @date         May 2023
 #
 
-import sys, os, types
-from typing import Union, Dict, Callable
+import sys, os
+from typing import Union, Dict
 import importlib
 from importlib import machinery
-from importlib import util
+import inspect
+import functools
 
 from . import pythonmonkey as pm 
 
@@ -223,7 +224,9 @@ def load(filename: str) -> Dict:
   require = createRequire(__file__)
   require('./my-javascript-module')
 """
-def createRequire(filename):
+# We cache the return value of createRequire to always use the same require for the same filename
+@functools.lru_cache(maxsize=None) # unbounded function cache that won't remove any old values
+def createRequire(filename: str):
     createRequireInner = pm.eval("""'use strict';(
 function createRequire(filename, bootstrap_broken)
 {
@@ -245,3 +248,11 @@ def createRequire(filename):
   return module.require;
 })""")
     return createRequireInner(filename)
+
+def require(moduleIdentifier: str):
+    # Retrieve the caller’s filename from the call stack
+    filename = inspect.stack()[1].filename
+    # From the REPL, the filename is "<stdin>", which is not a valid path
+    if not os.path.exists(filename):
+      filename = os.path.join(os.getcwd(), "__main__") # use the CWD instead
+    return createRequire(filename)(moduleIdentifier)