Using argname to reimplement nameof (#44)

* Use argname to implement nameof

* Allow variable positional arguments (*args) for argname

* Update changelog

* Parse the arguments only if needed

* Update readme

Author: pwwang

README.md

@@ -315,6 +315,10 @@ debug(a, b)
 debug(a, b, merge=True)
 # DEBUG: a='value', b=<object object at 0x2b70580e5f20>
 debug(a, repr=False, prefix='') # a=value
+# also debug an expression
+debug(a+a) # DEBUG: a+a='valuevalue'
+# If you want to disable it:
+debug(a+a, vars_only=True) # error
 ```
 
 ## Reliability and limitations
@@ -331,15 +335,13 @@ For example:
 - This will not work with `pytest`:
   ```python
   a = 1
-  assert nameof(a) == 'a'
+  assert nameof(a) == 'a' # pytest manipulated the ast here
 
   # do this instead
   name_a = nameof(a)
   assert name_a == 'a'
   ```
 
-- `R` with `reticulate`.
-
 [1]: https://github.com/pwwang/python-varname
 [2]: https://github.com/HanyuuLu
 [3]: https://img.shields.io/pypi/v/varname?style=flat-square

README.rst

@@ -388,6 +388,8 @@ Debugging with ``debug``
    debug(a, b, merge=True)
    # DEBUG: a='value', b=<object object at 0x2b70580e5f20>
    debug(a, repr=False, prefix='') # a=value
+   # also debug an expression
+   debug(a+a, vars_only=False) # DEBUG: a+a='valuevalue'
 
 Reliability and limitations
 ---------------------------

docs/CHANGELOG.md

@@ -1,3 +1,71 @@
+## v0.6.2
+- Remove argument `full` for `nameof`, use `vars_only` instead. When `vars_only=False`, source of the argument returned.
+  ```python
+  # before:
+  nameof(a.b, full=True) # 'a.b'
+  nameof(x[0], full=True) # unable to fetch
+  # after (requires asttoken):
+  nameof(a.b, vars_only=False) # 'a.b'
+  nameof(x[0], vars_only=False) # 'x[0]'
+  ```
+- Add argument `frame` to `argname`, so that it can be wrapped.
+  ```python
+  def argname2(arg, *more_args):
+      return argname(arg, *more_args, frame=2)
+  ```
+- Allow `argname` to fetch the source of variable keyword arguments (`**kwargs`), which will be an empty dict (`{}`) when no keyword arguments passed.
+  ```python
+  def func(a, **kwargs):
+      return argname(a, kwargs)
+  # before:
+  func(x) # raises error
+  # after:
+  func(x) # returns ('x', {})
+  ```
+- Add argument `pos_only` to `argname` to only match the positional arguments
+  ```python
+  # before
+  def func(a, b=1):
+    return argname(a)
+  func(x) # 'x'
+  func(x, b=2) # error since 2 is not ast.Name
+
+  # after
+  def func(a, b=1):
+    return argname(a, pos_only=True)
+  func(x) # 'x'
+  func(x, b=2) # 'x'
+  ```
+- Parse the arguments only if needed
+  ```python
+  # before
+  def func(a, b):
+    return argname(a)
+  func(x, 1) # NonVariableArgumentError
+
+  # after
+  func(x, 1) # 'x'
+  ```
+- Allow variable positional arguments for `argname` so that `argname(*args)` is allowed
+  ```python
+  # before
+  def func(arg, *args):
+    return argname(arg, args) # *args not allowed
+  x = y = 1
+  func(x, y) # ('x', ('y', 1))
+
+  # after
+  def func(arg, *args):
+    return argname(arg, *args)
+  x = y = 1
+  func(x, y) # ('x', 'y')
+  ```
+- Add `vars_only` (defaults to `False`) argument to `helpers.debug` so source of expression becomes available
+  ```python
+  a=1
+  debug(a+a) # DEBUG: a+a=2
+  ```
+
 ## v0.6.1
 - Add `argname` to retrieve argument names/sources passed to a function