0.7.2 (#59)

* Add strict mode to varname (#57)

* Update CI configuration so that it can be triggered in PR by assign and label.

* Support the walrus operator (:=) (#58)

* Prepare 0.7.2
- Update README to add breuleux as contributor
- Don't upload coverage in CI with PRs
- Update some docs for varname()

* 0.7.2

Co-authored-by: Olivier Breuleux <breuleux AT gmail.com>

Author: pwwang

.github/workflows/build.yml

@@ -2,6 +2,8 @@ name: Build and Deploy
 
 on:
   push:
+  pull_request:
+    types: [assigned, labeled]
   release:
     types: [published]
 
@@ -41,7 +43,7 @@ jobs:
         run: |
           export CODACY_PROJECT_TOKEN=${{ secrets.CODACY_PROJECT_TOKEN }}
           bash <(curl -Ls https://coverage.codacy.com/get.sh) report -r .coverage.xml
-        if: matrix.python-version == 3.7
+        if: matrix.python-version == 3.9 && github.event_name != 'pull_request'
 
   deploy:
     needs: build

.pylintrc

@@ -160,6 +160,7 @@ disable=print-statement,
         unused-arguments,
         fixme,
         consider-using-dict-items,
+        unexpected-keyword-arg,
         C0330
 
 # Enable the message, report, category or checker with the given id(s). You can

README.md

@@ -41,9 +41,15 @@ Thanks goes to these awesome people/projects:
         <br /><sub><b>@alexmojaki</b></sub>
       </a>
     </td>
+    <td align="center" style="min-width: 75px">
+      <a href="https://github.com/breuleux">
+        <img src="https://avatars.githubusercontent.com/u/599820?s=400&v=4" width="50px;" alt=""/>
+        <br /><sub><b>@breuleux</b></sub>
+      </a>
+    </td>
     <td align="center" style="min-width: 75px">
       <a href="https://github.com/alexmojaki/executing">
-        <img src="https://via.placeholder.com/50?text=executing" width="50px;" alt=""/>
+        <img src="https://ui-avatars.com/api/?color=3333ff&background=ffffff&bold=true&name=e&size=400" width="50px;" alt=""/>
         <br /><sub><b>executing</b></sub>
       </a>
     </td>
@@ -99,6 +105,20 @@ Special thanks to [@HanyuuLu][2] to give up the name `varname` in pypi for this
     func = asyncio.run(function()) # func == 'func'
     ```
 
+    Use `strict` to control whether the call should be assigned to
+    the variable directly:
+    ```python
+    def function(strict):
+        return varname(strict=strict)
+
+    func = function(True)     # OK, direct assignment, func == 'func'
+
+    func = [function(True)]   # Not a direct assignment, raises ImproperUseError
+    func = [function(False)]  # OK, func == ['func']
+
+    func = function(False), function(False)   # OK, func = ('func', 'func')
+    ```
+
 - Retrieving name of a class instance
 
     ```python
@@ -138,12 +158,6 @@ Special thanks to [@HanyuuLu][2] to give up the name `varname` in pypi for this
     def function():
         return varname()
 
-    func = [function()]    # func == ['func']
-
-    func = [function(), function()] # func == ['func', 'func']
-
-    func = function(), function()   # func = ('func', 'func')
-
     func = func1 = function()  # func == func1 == 'func'
     # a warning will be shown
     # since you may not want func1 to be 'func'

README.rst

@@ -90,9 +90,15 @@ Thanks goes to these awesome people/projects:
            <br /><sub><b>@alexmojaki</b></sub>
          </a>
        </td>
+       <td align="center" style="min-width: 75px">
+         <a href="https://github.com/breuleux">
+           <img src="https://avatars.githubusercontent.com/u/599820?s=400&v=4" width="50px;" alt=""/>
+           <br /><sub><b>@breuleux</b></sub>
+         </a>
+       </td>
        <td align="center" style="min-width: 75px">
          <a href="https://github.com/alexmojaki/executing">
-           <img src="https://via.placeholder.com/50?text=executing" width="50px;" alt=""/>
+           <img src="https://ui-avatars.com/api/?color=3333ff&background=ffffff&bold=true&name=e&size=400" width="50px;" alt=""/>
            <br /><sub><b>executing</b></sub>
          </a>
        </td>
@@ -156,6 +162,21 @@ Retrieving the variable names using ``varname(...)``
 
        func = asyncio.run(function()) # func == 'func'
 
+    Use ``strict`` to control whether the call should be assigned to
+    the variable directly:
+
+  .. code-block:: python
+
+       def function(strict):
+           return varname(strict=strict)
+
+       func = function(True)     # OK, direct assignment, func == 'func'
+
+       func = [function(True)]   # Not a direct assignment, raises ImproperUseError
+       func = [function(False)]  # OK, func == ['func']
+
+       func = function(False), function(False)   # OK, func = ('func', 'func')
+
 * 
   Retrieving name of a class instance
 
@@ -199,12 +220,6 @@ Retrieving the variable names using ``varname(...)``
        def function():
            return varname()
 
-       func = [function()]    # func == ['func']
-
-       func = [function(), function()] # func == ['func', 'func']
-
-       func = function(), function()   # func = ('func', 'func')
-
        func = func1 = function()  # func == func1 == 'func'
        # a warning will be shown
        # since you may not want func1 to be 'func'

docs/CHANGELOG.md

@@ -1,3 +1,7 @@
+## v0.7.2
+- Add `strict` mode to `varname()` (#57)
+- Support the walrus operator (`:=`) (#58)
+
 ## v0.7.1
 - Add `ignore` argument to `argname2()`
 - Fix Fix utils.get_argument_sources() when kwargs is given as `**kwargs`.

pyproject.toml

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

setup.py

@@ -24,11 +24,10 @@
 setup(
     long_description=readme,
     name='varname',
-    version='0.7.1',
+    version='0.7.2',
     description='Dark magics about variable names in python.',
     python_requires='==3.*,>=3.6.0',
-    project_urls={"homepage": "https://github.com/pwwang/python-varname",
-                  "repository": "https://github.com/pwwang/python-varname"},
+    project_urls={"homepage": "https://github.com/pwwang/python-varname", "repository": "https://github.com/pwwang/python-varname"},
     author='pwwang',
     author_email='[email protected]',
     license='MIT',

tests/named_expr.py

@@ -0,0 +1,8 @@
+"""Contains code that is only importable with Python >= 3.8."""
+
+from varname import varname
+
+def function():
+    return varname()
+
+a = [b := function(), c := function()]

tests/test_argname.py

@@ -376,12 +376,12 @@ def test_argname2_frame_error():
     def func(x):
         return argname2('x', frame=2)
 
-    with pytest.raises(ValueError):
+    with pytest.raises(ValueError, match="is not a valid argument"):
         func(1)
 
 def test_argname2_ignore():
     def target(*args):
-        return argname2('*args', ignore=wrapper)
+        return argname2('*args', ignore=(wrapper, 0))
 
     def wrapper(*args):
         return target(*args)

tests/test_varname.py

@@ -22,18 +22,6 @@ def function():
     func = function()
     assert func == 'func'
 
-    func = [function()]
-    assert func == ['func']
-
-    func = [function(), function()]
-    assert func == ['func', 'func']
-
-    func = (function(), )
-    assert func == ('func', )
-
-    func = (function(), function())
-    assert func == ('func', 'func')
-
 def test_function_with_frame_arg():
 
     def function():
@@ -132,14 +120,62 @@ def test_raise_exc():
     def get_name(raise_exc):
         return varname(raise_exc=raise_exc)
 
-    with pytest.raises(VarnameRetrievingError):
+    with pytest.raises(ImproperUseError):
         get_name(True)
 
     name = "0"
     # we can't get it in such way.
     name += str(get_name(False))
     assert name == '0None'
 
+def test_strict():
+
+    def foo(x):
+        return x
+
+    def function():
+        return varname(strict=True)
+
+    func = function()
+    assert func == 'func'
+
+    with pytest.raises(ImproperUseError):
+        func = function() + "_"
+
+    with pytest.raises(ImproperUseError):
+        func = foo(function())
+
+    with pytest.raises(ImproperUseError):
+        func = [function()]
+
+def test_not_strict():
+
+    def function():
+        return varname(strict=False)
+
+    func = function()
+    assert func == 'func'
+
+    func = [function()]
+    assert func == ['func']
+
+    func = [function(), function()]
+    assert func == ['func', 'func']
+
+    func = (function(), )
+    assert func == ('func', )
+
+    func = (function(), function())
+    assert func == ('func', 'func')
+
+@pytest.mark.skipif(
+    sys.version_info < (3, 8),
+    reason="named expressions require Python >= 3.8"
+)
+def test_named_expr():
+    from .named_expr import a
+    assert a == ["b", "c"]
+
 def test_multiple_targets():
 
     def function():
@@ -160,7 +196,7 @@ def function():
     assert xyz == 'z'
 
     x = 'a'
-    with pytest.raises(VarnameRetrievingError):
+    with pytest.raises(ImproperUseError):
         x += function()
     assert x == 'a'
 
@@ -366,7 +402,7 @@ def foo6():
     def foo7():
         return varname(ignore=(foo4, 100))
 
-    with pytest.raises(VarnameRetrievingError):
+    with pytest.raises(ImproperUseError):
         f6 = foo6()
 
 def test_ignore_dirname(tmp_path):

varname/__init__.py

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