feat: support frame to allow wrapping for helpers.jsobj() (#111)

Author: pwwang

tests/test_helpers.py

@@ -98,6 +98,16 @@ def test_jsobj():
     assert obj3 == {"vars_only": 3, "x.b": 2}
 
 
+def test_jsobj_wrapping():
+    def myjsobj(*args, **kwargs):
+        return jsobj(*args, vars_only=False, frame=2, **kwargs)
+
+    x = lambda: None
+    x.b = 2
+    obj = myjsobj(x.b)
+    assert obj == {"x.b": 2}
+
+
 def test_register_to_function():
     @register
     def func():

varname/helpers.py

@@ -153,7 +153,12 @@ def __repr__(self) -> str:
         )
 
 
-def jsobj(*args: Any, vars_only: bool = True, **kwargs: Any) -> Dict[str, Any]:
+def jsobj(
+    *args: Any,
+    vars_only: bool = True,
+    frame: int = 1,
+    **kwargs: Any,
+) -> Dict[str, Any]:
     """A wrapper to create a JavaScript-like object
 
     When an argument is passed as positional argument, the name of the variable
@@ -171,13 +176,19 @@ def jsobj(*args: Any, vars_only: bool = True, **kwargs: Any) -> Dict[str, Any]:
 
     Args:
         *args: The positional arguments
-        **kwargs: The keyword arguments
         vars_only: Whether to only include variables in the output
+        frame: The call stack index. You can understand this as the number of
+            wrappers around this function - 1.
+        **kwargs: The keyword arguments
 
     Returns:
         A dict-like object
     """
-    argnames: Tuple[str, ...] = argname("args", vars_only=vars_only)  # type: ignore
+    argnames: Tuple[str, ...] = argname(
+        "args",
+        vars_only=vars_only,
+        frame=frame,
+    )  # type: ignore
     out = dict(zip(argnames, args))
     out.update(kwargs)
     return out