0.8.0 (#63)

* Prepare 0.8.0
- Remove NonVariableArgumentError, use ImproperUseError
- Default `strict` of `varname()` to True
- Use the very right variable for multiple-target assignment for `varname()`
- Replace `argname()` by `argname2()` and deprecate `argname2()`
- Add `UsingExecWarning` when `exec` is used to get function for `argname()`
- Limit context lines of `rich_exc_message()`

* Add make_readme to pre-commit so that we know if changes break README examples

* Fix playground for 0.8

* 0.8.0

Author: pwwang

.gitignore

@@ -112,3 +112,5 @@ docs/api/
 
 # vscode's local history extension
 .history/
+
+playground/playground.nbconvert.ipynb

.pre-commit-config.yaml

@@ -28,18 +28,29 @@ repos:
         args: [varname]
 -   repo: local
     hooks:
-    -   id: poetry2setuppy
-        name: Convert pyproject.toml to setup.py
-        entry: dephell deps convert --from=poetry --to=setup.py
+    -   id: compile-readme
+        name: Make README.md
+        entry: python make_readme.py README.raw.md > README.md
         language: system
-        files: pyproject.toml
+        files: README.raw.md
         pass_filenames: false
-    -   id: poetry2requirements
-        name: Convert pyproject.toml to requirements.txt
-        entry: dephell deps convert --from=poetry --to=requirements.txt
+        always_run: true
+    -   id: poetry2setuppy
+        # keep setup.py for github to trace dependencies/dependents
+        # and for "pip install -e ." to work
+        name: Convert pyproject.toml to setup.py
+        entry: |
+            bash -c "poetry build --format sdist;
+            tar --wildcards -xvf dist/*-`poetry version -s`.tar.gz -O '*/setup.py' > setup.py"
         language: system
         files: pyproject.toml
         pass_filenames: false
+    # -   id: poetry2requirements
+    #     name: Convert pyproject.toml to requirements.txt
+    #     entry: poetry export -f requirements.txt --without-hashes -o requirements.txt
+    #     language: system
+    #     files: pyproject.toml
+    #     pass_filenames: false
     -   id: mypycheck
         name: Type checking by mypy
         entry: mypy
@@ -55,3 +66,9 @@ repos:
         args: [tests/]
         pass_filenames: false
         files: ^tests/.+$|^varname/.+$
+    -   id: execute-playground
+        name: Run playground notebook
+        entry: jupyter nbconvert playground/playground.ipynb --execute --to notebook
+        language: system
+        files: playground/playground.ipynb
+        pass_filenames: false

README.md

@@ -20,8 +20,7 @@ pip install -U varname
   - Retrieving names of variables a function/class call is assigned to from inside it, using `varname`.
   - Retrieving variable names directly, using `nameof`
   - Detecting next immediate attribute name, using `will`
-  - Fetching argument names/sources passed to a function using `argname2`
-    (`argname` is superseded by `argname2`)
+  - Fetching argument names/sources passed to a function using `argname`
 
 - Other helper APIs (built based on core features):
 
@@ -144,7 +143,7 @@ Special thanks to [@HanyuuLu][2] to give up the name `varname` in pypi for this
     def func():
         return varname(multi_vars=True)
 
-    a = func() # a == ('a', )
+    a = func() # a == ('a',)
     a, b = func() # (a, b) == ('a', 'b')
     [a, b] = func() # (a, b) == ('a', 'b')
 
@@ -155,14 +154,15 @@ Special thanks to [@HanyuuLu][2] to give up the name `varname` in pypi for this
 - Some unusual use
 
     ```python
-    def function():
-        return varname()
+    def function(**kwargs):
+        return varname(strict=False)
 
-    func = func1 = function()  # func == func1 == 'func'
+    func = func1 = function()  # func == func1 == 'func1'
+    # if varname < 0.8: func == func1 == 'func'
     # a warning will be shown
-    # since you may not want func1 to be 'func'
+    # since you may not want func to be 'func1'
 
-    x = func(y = func())  # x == 'x'
+    x = function(y = function())  # x == 'x'
 
     # get part of the name
     func_abc = function()[-3:]  # func_abc == 'abc'
@@ -173,16 +173,6 @@ Special thanks to [@HanyuuLu][2] to give up the name `varname` in pypi for this
 
     a = lambda: 0
     a.b = function() # a.b == 'b'
-
-    # Since v0.1.3
-    # We can ask varname to raise exceptions
-    # if it fails to detect the variable name
-    def get_name(raise_exc):
-        return varname(raise_exc=raise_exc)
-
-    a = {}
-    a['b'] = get_name(True) # VarnameRetrievingError
-    a['b'] = get_name(False) # None
     ```
 
 ### The decorator way to register `__varname__` to functions/classes
@@ -272,29 +262,33 @@ awesome.permit() # AttributeError: Should do something with AwesomeClass object
 awesome.permit().do() == 'I am doing!'
 ```
 
-### Fetching argument names/sources using `argname2`
+### Fetching argument names/sources using `argname`
 ```python
-from varname import argname2
+from varname import argname
 
 def func(a, b=1):
-    print(argname2('a'))
+    print(argname('a'))
 
 x = y = z = 2
 func(x) # prints: x
 
+
 def func2(a, b=1):
-    print(argname2('a', 'b'))
+    print(argname('a', 'b'))
 func2(y, b=x) # prints: ('y', 'x')
 
+
 # allow expressions
 def func3(a, b=1):
-    print(argname2('a', 'b', vars_only=False))
+    print(argname('a', 'b', vars_only=False))
 func3(x+y, y+x) # prints: ('x+y', 'y+x')
 
+
 # positional and keyword arguments
 def func4(*args, **kwargs):
-    print(argname2('args[1]', 'kwargs["c"]'))
+    print(argname('args[1]', 'kwargs[c]'))
 func4(y, x, c=z) # prints: ('x', 'z')
+
 ```
 
 ### Value wrapper
@@ -321,19 +315,22 @@ mydict = values_to_dict(foo, bar)
 from varname.helpers import debug
 
 a = 'value'
-b = object()
-debug(a) # DEBUG: a='value'
-debug(b) # DEBUG: b=<object object at 0x2b70580e5f20>
+b = ['val']
+debug(a)
+# "DEBUG: a='value'\n"
+debug(b)
+# "DEBUG: b=['val']\n"
 debug(a, b)
-# DEBUG: a='value'
-# DEBUG: b=<object object at 0x2b70580e5f20>
+# "DEBUG: a='value'\nDEBUG: b=['val']\n"
 debug(a, b, merge=True)
-# DEBUG: a='value', b=<object object at 0x2b70580e5f20>
-debug(a, repr=False, prefix='') # a=value
+# "DEBUG: a='value', b=['val']\n"
+debug(a, repr=False, prefix='')
+# 'a=value\n'
 # also debug an expression
-debug(a+a) # DEBUG: a+a='valuevalue'
+debug(a+a)
+# "DEBUG: a+a='valuevalue'\n"
 # If you want to disable it:
-debug(a+a, vars_only=True) # error
+debug(a+a, vars_only=True) # ImproperUseError
 ```
 
 ## Reliability and limitations