Add ignore argument to argname2() (#55)

* Add `ignore` argument to `argname2()`

* 0.7.1

* Fix utils.get_argument_sources() when kwargs is given as **kwargs.

Author: pwwang

docs/CHANGELOG.md

@@ -1,3 +1,7 @@
+## v0.7.1
+- Add `ignore` argument to `argname2()`
+- Fix Fix utils.get_argument_sources() when kwargs is given as `**kwargs`.
+
 ## v0.7.0
 - `ImproperUseError` is now independent of `VarnameRetrievingError`
 - Deprecate `argname`, superseded by `argname2`

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.masonry.api"
 
 [tool.poetry]
 name = "varname"
-version = "0.7.0"
+version = "0.7.1"
 description = "Dark magics about variable names in python."
 authors = [ "pwwang <pwwang@pwwang.com>",]
 license = "MIT"

setup.py

@@ -24,7 +24,7 @@
 setup(
     long_description=readme,
     name='varname',
-    version='0.7.0',
+    version='0.7.1',
     description='Dark magics about variable names in python.',
     python_requires='==3.*,>=3.6.0',
     project_urls={"homepage": "https://github.com/pwwang/python-varname",

tests/test_argname.py

@@ -373,10 +373,19 @@ def func(x):
         func(1)
 
 def test_argname2_frame_error():
-
     def func(x):
         return argname2('x', frame=2)
 
-    with pytest.raises(VarnameRetrievingError):
+    with pytest.raises(ValueError):
         func(1)
 
+def test_argname2_ignore():
+    def target(*args):
+        return argname2('*args', ignore=wrapper)
+
+    def wrapper(*args):
+        return target(*args)
+
+    x = y = 1
+    out = wrapper(x, y)
+    assert out == ('x', 'y')

tests/test_varname.py

@@ -511,11 +511,12 @@ def foo3():
     x = foo1()
     assert x == 'x'
     msgs = capsys.readouterr().err.splitlines()
-    assert "Ignored by IgnoreModule('varname')" in msgs[0]
-    assert "Skipping (2 more to skip) [In 'foo3'" in msgs[1]
-    assert "Ignored by IgnoreModuleQualname('tests.test_varname', '*.wrapper')" in msgs[2]
-    assert "Skipping (1 more to skip) [In 'foo2'" in msgs[3]
-    assert "Ignored by IgnoreModuleQualname('tests.test_varname', '*.wrapper')" in msgs[4]
-    assert "Skipping (0 more to skip) [In 'foo1'" in msgs[5]
-    assert "Ignored by IgnoreModuleQualname('tests.test_varname', '*.wrapper')" in msgs[6]
-    assert "Gotcha! [In 'test_internal_debug'" in msgs[7]
+    assert ">>> IgnoreList initiated <<<" in msgs[0]
+    assert "Ignored by IgnoreModule('varname')" in msgs[1]
+    assert "Skipping (2 more to skip) [In 'foo3'" in msgs[2]
+    assert "Ignored by IgnoreModuleQualname('tests.test_varname', '*.wrapper')" in msgs[3]
+    assert "Skipping (1 more to skip) [In 'foo2'" in msgs[4]
+    assert "Ignored by IgnoreModuleQualname('tests.test_varname', '*.wrapper')" in msgs[5]
+    assert "Skipping (0 more to skip) [In 'foo1'" in msgs[6]
+    assert "Ignored by IgnoreModuleQualname('tests.test_varname', '*.wrapper')" in msgs[7]
+    assert "Gotcha! [In 'test_internal_debug'" in msgs[8]

varname/__init__.py

@@ -11,4 +11,4 @@
 )
 from .core import varname, nameof, will, argname, argname2
 
-__version__ = "0.7.0"
+__version__ = "0.7.1"

varname/core.py

@@ -202,7 +202,7 @@ def will(frame: int = 1, raise_exc: bool = True) -> str:
 
 
 def nameof(
-    var, # pylint: disable=unused-argument
+    var,  # pylint: disable=unused-argument
     *more_vars,
     # *, keyword only argument, supported with python3.8+
     frame: int = 1,
@@ -294,10 +294,10 @@ def nameof(
     out = argname2(
         "var", "*more_vars", func=nameof, frame=frame, vars_only=vars_only
     )
-    return out if more_vars else out[0] # type: ignore
+    return out if more_vars else out[0]  # type: ignore
 
 
-def argname( # pylint: disable=unused-argument,too-many-branches
+def argname(  # pylint: disable=unused-argument,too-many-branches
     arg: Any,
     *more_args: Any,
     # *, keyword-only argument, only available with python3.8+
@@ -393,7 +393,7 @@ def argname( # pylint: disable=unused-argument,too-many-branches
         pos_only=pos_only,
     )
 
-    ret = [] # type: List[ArgSourceType]
+    ret = []  # type: List[ArgSourceType]
     for argnode in argname_node.args:
         if not isinstance(argnode, (ast.Name, ast.Subscript, ast.Starred)):
             raise ValueError(
@@ -412,7 +412,7 @@ def argname( # pylint: disable=unused-argument,too-many-branches
                 raise ValueError(
                     f"No such variable positional argument {posvar!r}"
                 )
-            ret.extend(argument_sources[argnode.value.id]) # type: ignore
+            ret.extend(argument_sources[argnode.value.id])  # type: ignore
 
         elif isinstance(argnode, ast.Name):
             if argnode.id not in argument_sources:
@@ -441,7 +441,7 @@ def argname( # pylint: disable=unused-argument,too-many-branches
                     f"{name!r} is not a keyword argument "
                     "(**kwargs, for example)."
                 )
-            ret.append(argument_sources[name][subscript]) # type: ignore
+            ret.append(argument_sources[name][subscript])  # type: ignore
 
     if vars_only:
         for source in ret:
@@ -451,7 +451,7 @@ def argname( # pylint: disable=unused-argument,too-many-branches
                     "or an attribute."
                 )
 
-    return ret[0] if not more_args else tuple(ret) # type: ignore
+    return ret[0] if not more_args else tuple(ret)  # type: ignore
 
 
 def argname2(
@@ -461,6 +461,7 @@ def argname2(
     func: Callable = None,
     dispatch: Type = None,
     frame: int = 1,
+    ignore: IgnoreType = None,
     vars_only: bool = True,
 ) -> ArgSourceType:
     """Get the names/sources of arguments passed to a function.
@@ -505,14 +506,19 @@ def argname2(
             specified, expect `func` to be the generic function if provided.
         frame: The frame where target function is called from this call.
             Calls from python standard libraries are ignored.
+        ignore: The intermediate calls to be ignored. See `varname.ignore`
         vars_only: Require the arguments to be variables only.
             If False, `asttokens` is required to retrieve the source.
 
     Returns:
         Scalar string if
 
     """
-    ignore_list = IgnoreList.create(ignore_lambda=False, ignore_varname=False)
+    ignore_list = IgnoreList.create(
+        ignore,
+        ignore_lambda=False,
+        ignore_varname=False,
+    )
     # where func(...) is called, skip the argname2() call
     func_frame = ignore_list.get_frame(frame + 1)
     func_node = get_node_by_frame(func_frame)
@@ -545,17 +551,17 @@ def argname2(
             vars_only=vars_only,
             pos_only=False,
         )
-    except TypeError as terr:
+    except Exception as err:
         raise VarnameRetrievingError(
             "Have you specified the right `frame`?"
-        ) from terr
+        ) from err
 
-    out = [] # type: List[ArgSourceType]
+    out = []  # type: List[ArgSourceType]
     farg_star = False
     for farg in (arg, *more_args):
 
         farg_name = farg
-        farg_subscript = None # type: str | int
+        farg_subscript = None  # type: str | int
         match = re.match(r"^([\w_]+)\[(.+)\]$", farg)
         if match:
             farg_name = match.group(1)
@@ -582,7 +588,7 @@ def argname2(
             )
 
         if farg_subscript is not None:
-            out.append(source[farg_subscript]) # type: ignore
+            out.append(source[farg_subscript])  # type: ignore
         elif farg_star:
             out.extend(source)
         else:
@@ -591,5 +597,5 @@ def argname2(
     return (
         out[0]
         if not more_args and not farg_star
-        else tuple(out) # type: ignore
+        else tuple(out)  # type: ignore
     )

varname/ignore.py

@@ -331,6 +331,9 @@ def create(
 
     def __init__(self, ignore_list: List[IgnoreElemType]) -> None:
         self.ignore_list = ignore_list
+        debug_ignore_frame(
+            '>>> IgnoreList initiated <<<'
+        )
 
     def nextframe_to_check(
         self, frame_no: int, frameinfos: List[inspect.FrameInfo]

varname/utils.py

@@ -324,6 +324,7 @@ def get_argument_sources(
         {
             argnode.arg: argnode_source(source, argnode.value, vars_only)
             for argnode in node.keywords
+            if argnode.arg is not None
         }
         if not pos_only
         else {}