varname 0.12.1__py3-none-any.whl → 0.13.0__py3-none-any.whl

varname/__init__.py

@@ -13,4 +13,4 @@ from .utils import (
 )
 from .core import varname, nameof, will, argname
 
-__version__ = "0.12.1"
+__version__ = "0.13.0"

varname/helpers.py

@@ -1,9 +1,13 @@
 """Some helper functions builtin based upon core features"""
+from __future__ import annotations
+
 import inspect
 from functools import partial, wraps
+from os import PathLike
 from typing import Any, Callable, Dict, Tuple, Type, Union
 
 from .utils import IgnoreType
+from .ignore import IgnoreList
 from .core import argname, varname
 
 
@@ -220,3 +224,74 @@ def debug(
     else:
         for name_and_value in name_and_values:
             print(f"{prefix}{name_and_value}")
+
+
+def exec_code(
+    code: str,
+    globals: Dict[str, Any] = None,
+    locals: Dict[str, Any] = None,
+    /,
+    sourcefile: PathLike | str = None,
+    frame: int = 1,
+    ignore: IgnoreType = None,
+    **kwargs: Any,
+) -> None:
+    """Execute code where source code is visible at runtime.
+
+    This function is useful when you want to execute some code, where you want to
+    retrieve the AST node of the code at runtime. This function will create a
+    temporary file and write the code into it, then execute the code in the
+    file.
+
+    Examples:
+        >>> from varname import varname
+        >>> def func(): return varname()
+        >>> exec('var = func()')  # VarnameRetrievingError:
+        >>>                       #  Unable to retrieve the ast node.
+        >>> from varname.helpers import code_exec
+        >>> code_exec('var = func()')  # var == 'var'
+
+    Args:
+        code: The code to execute.
+        globals: The globals to use.
+        locals: The locals to use.
+        sourcefile: The source file to write the code into.
+            if not given, a temporary file will be used.
+            This file will be deleted after the code is executed.
+        frame: The call stack index. You can understand this as the number of
+            wrappers around this function. This is used to fetch `globals` and
+            `locals` from where the destination function (include the wrappers
+            of this function)
+            is called.
+        ignore: The intermediate calls to be ignored. See `varname.ignore`
+            Note that if both `globals` and `locals` are given, `frame` and
+            `ignore` will be ignored.
+        **kwargs: The keyword arguments to pass to `exec`.
+    """
+    if sourcefile is None:
+        import tempfile
+
+        with tempfile.NamedTemporaryFile(
+            mode="w", suffix=".py", delete=False
+        ) as f:
+            f.write(code)
+            sourcefile = f.name
+    else:
+        sourcefile = str(sourcefile)
+        with open(sourcefile, "w") as f:
+            f.write(code)
+
+    if globals is None or locals is None:
+        ignore_list = IgnoreList.create(ignore)
+        frame_info = ignore_list.get_frame(frame)
+        if globals is None:
+            globals = frame_info.f_globals
+        if locals is None:
+            locals = frame_info.f_locals
+
+    try:
+        exec(compile(code, sourcefile, "exec"), globals, locals, **kwargs)
+    finally:
+        import os
+
+        os.remove(sourcefile)

varname/utils.py

@@ -185,7 +185,10 @@ def lookfor_parent_assign(node: ast.AST, strict: bool = True) -> AssignType:
     return None
 
 
-def node_name(node: ast.AST) -> Union[str, Tuple[Union[str, Tuple], ...]]:
+def node_name(
+    node: ast.AST,
+    subscript_slice: bool = False,
+) -> Union[str, Tuple[Union[str, Tuple], ...]]:
     """Get the node node name.
 
     Raises ImproperUseError when failed
@@ -193,15 +196,50 @@ def node_name(node: ast.AST) -> Union[str, Tuple[Union[str, Tuple], ...]]:
     if isinstance(node, ast.Name):
         return node.id
     if isinstance(node, ast.Attribute):
-        return node.attr
-    if isinstance(node, (ast.List, ast.Tuple)):
+        return f"{node_name(node.value)}.{node.attr}"
+    if isinstance(node, ast.Constant):
+        return repr(node.value)
+    if isinstance(node, (ast.List, ast.Tuple)) and not subscript_slice:
         return tuple(node_name(elem) for elem in node.elts)
+    if isinstance(node, ast.List):
+        return f"[{', '.join(node_name(elem) for elem in node.elts)}]"  # type: ignore
+    if isinstance(node, ast.Tuple):
+        if len(node.elts) == 1:
+            return f"({node_name(node.elts[0])},)"
+        return f"({', '.join(node_name(elem) for elem in node.elts)})"  # type: ignore
     if isinstance(node, ast.Starred):
         return f"*{node_name(node.value)}"
+    if isinstance(node, ast.Slice):
+        return (
+            f"{node_name(node.lower)}:{node_name(node.upper)}:{node_name(node.step)}"
+            if node.lower is not None
+            and node.upper is not None
+            and node.step is not None
+            else f"{node_name(node.lower)}:{node_name(node.upper)}"
+            if node.lower is not None and node.upper is not None
+            else f"{node_name(node.lower)}:"
+            if node.lower is not None
+            else f":{node_name(node.upper)}"
+            if node.upper is not None
+            else ":"
+        )
+
+    name = type(node).__name__
+    if isinstance(node, ast.Subscript):
+        try:
+            return f"{node_name(node.value)}[{node_name(node.slice, True)}]"
+        except ImproperUseError:
+            name = f"{node_name(node.value)}[{type(node.slice).__name__}]"
 
     raise ImproperUseError(
-        f"Can only get name of a variable or attribute, "
-        f"not {ast.dump(node)}"
+        f"Node {name!r} detected, but only following nodes are supported: \n"
+        "  - ast.Name (e.g. x)\n"
+        "  - ast.Attribute (e.g. x.y, x be other supported nodes)\n"
+        "  - ast.Constant (e.g. 1, 'a')\n"
+        "  - ast.List (e.g. [x, y, z])\n"
+        "  - ast.Tuple (e.g. (x, y, z))\n"
+        "  - ast.Starred (e.g. *x)\n"
+        "  - ast.Subscript with slice of the above nodes (e.g. x[y])"
     )
 
 

{varname-0.12.1.dist-info → varname-0.13.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: varname
-Version: 0.12.1
+Version: 0.13.0
 Summary: Dark magics about variable names in python.
 Home-page: https://github.com/pwwang/python-varname
 License: MIT
@@ -54,6 +54,7 @@ Note if you use `python < 3.8`, install `varname < 0.11`
   - A decorator to register `__varname__` to functions/classes, using `register`
   - A helper function to create dict without explicitly specifying the key-value pairs, using `jsobj`
   - A `debug` function to print variables with their names and values
+  - `exec_code` to replace `exec` where source code is available at runtime
 
 ## Credits
 
@@ -221,7 +222,7 @@ Special thanks to [@HanyuuLu][2] to give up the name `varname` in pypi for this
     func = function2()  # func == 'func'
 
     a = lambda: 0
-    a.b = function() # a.b == 'b'
+    a.b = function() # a.b == 'a.b'
     ```
 
 ### The decorator way to register `__varname__` to functions/classes
@@ -346,7 +347,7 @@ func4(y, x, c=z) # prints: ('x', 'z')
 # __getattr__/__getitem__/__setattr/__setitem__/__add__/__lt__, etc.
 class Foo:
     def __setattr__(self, name, value):
-        print(argname("name", "value"))
+        print(argname("name", "value", func=self.__setattr__))
 
 Foo().a = 1 # prints: ("'a'", '1')
 
@@ -406,6 +407,26 @@ debug(a+a)
 debug(a+a, vars_only=True) # ImproperUseError
 ```
 
+### Replacing `exec` with `exec_code`
+
+```python
+from varname import argname
+from varname.helpers import exec_code
+
+class Obj:
+    def __init__(self):
+        self.argnames = []
+
+    def receive(self, arg):
+        self.argnames.append(argname('arg', func=self.receive))
+
+obj = Obj()
+# exec('obj.receive(1)')  # Error
+exec_code('obj.receive(1)')
+exec_code('obj.receive(2)')
+obj.argnames # ['1', '2']
+```
+
 ## Reliability and limitations
 
 `varname` is all depending on `executing` package to look for the node.

varname-0.13.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+varname/__init__.py,sha256=UTuY7fG_AbLwpbhBnup66zRlEvl0WnG6exf5AvOyyp0,369
+varname/core.py,sha256=nntOVpiavXP0EXijTNF6xIe4mxvz_FRpBjrL9z_JHJ0,19311
+varname/helpers.py,sha256=ho5X2t3PiSYDexwpA4TO_l68VWh3HER7bsUKzcbiCNM,9242
+varname/ignore.py,sha256=-VC3oqag44y2UlAw0ErYKHotx616qJL3Sjb_5y7Tw1c,14400
+varname/utils.py,sha256=ByHbUjbdMlHHckW4y77Jr_DHhkSmk8TabTy3INDJWsY,20971
+varname-0.13.0.dist-info/LICENSE,sha256=3bS8O2tMbBPz8rWmZBAOzkHQjcK-b7KwFHyyghEZ-Ak,1063
+varname-0.13.0.dist-info/METADATA,sha256=6YjfqWLcmjJ9TXHN5yLlAn0DHrBg3escnFyzqLgKdWM,12580
+varname-0.13.0.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
+varname-0.13.0.dist-info/RECORD,,

varname-0.12.1.dist-info/RECORD

@@ -1,9 +0,0 @@
-varname/__init__.py,sha256=wCvOdwu0J6X2OQr3j_LgE5rTFYtVK7gPqDD382qOkVs,369
-varname/core.py,sha256=nntOVpiavXP0EXijTNF6xIe4mxvz_FRpBjrL9z_JHJ0,19311
-varname/helpers.py,sha256=TUeohi5yCSleXA2betkulAG2_23jsoM_vohHuCEVPQI,6679
-varname/ignore.py,sha256=-VC3oqag44y2UlAw0ErYKHotx616qJL3Sjb_5y7Tw1c,14400
-varname/utils.py,sha256=f0dDRYfOeebdDvEwVSQVXNpHC1sB3-1qNE8mICg1IcE,19296
-varname-0.12.1.dist-info/LICENSE,sha256=3bS8O2tMbBPz8rWmZBAOzkHQjcK-b7KwFHyyghEZ-Ak,1063
-varname-0.12.1.dist-info/METADATA,sha256=IrxRHVvT9g4Xtq0w_1tEV9o3_rCeeW1KqkU0dAsg3s4,12074
-varname-0.12.1.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
-varname-0.12.1.dist-info/RECORD,,