0.7.0 (#54)

* Support single-dispatched function for argname()

* Fix CI pylint to 2.8.*

* 0.7.0

* Raise error when possible wrong frame specified for argname2

Author: pwwang

.github/workflows/build.yml

@@ -1,6 +1,9 @@
 name: Build and Deploy
 
-on: [push, pull_request]
+on:
+  push:
+  release:
+    types: [published]
 
 jobs:
 
@@ -19,34 +22,34 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          python -m pip install pylint
+          python -m pip install pylint=='2.8.*'
           python -m pip install poetry
+          poetry config virtualenvs.create false
           poetry install -v
       - name: Run pylint
         run: pylint varname
       - name: Test with pytest
-        run: poetry run pytest tests/ --junitxml=junit/test-results-${{ matrix.python-version }}.xml
+        run: pytest tests/ --junitxml=junit/test-results-${{ matrix.python-version }}.xml
       - name: Upload pytest test results
         uses: actions/upload-artifact@v2
         with:
           name: pytest-results-${{ matrix.python-version }}
           path: junit/test-results-${{ matrix.python-version }}.xml
         # Use always() to always run this step to publish test results when there are test failures
         if: ${{ always() }}
-      - name: Run codacy-coverage-reporter
-        uses: codacy/codacy-coverage-reporter-action@master
-        if: matrix.python-version == 3.8
-        with:
-          project-token: ${{ secrets.CODACY_PROJECT_TOKEN }}
-          coverage-reports: .coverage.xml
+      - name: Upload Coverage
+        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
 
   deploy:
     needs: build
     runs-on: ubuntu-latest
-    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
+    if: github.event_name == 'release'
     strategy:
       matrix:
-        python-version: [3.8]
+        python-version: [3.9]
     steps:
       - uses: actions/checkout@v2
       - name: Setup Python # Set Python version

.pylintrc

@@ -158,7 +158,9 @@ disable=print-statement,
         not-callable,
         unsubscriptable-object,
         unused-arguments,
-        fixme
+        fixme,
+        consider-using-dict-items,
+        C0330
 
 # Enable the message, report, category or checker with the given id(s). You can
 # either give multiple identifier separated by comma (,) or put this option

README.md

@@ -20,7 +20,8 @@ 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 `argname`
+  - Fetching argument names/sources passed to a function using `argname2`
+    (`argname` is superseded by `argname2`)
 
 - Other helper APIs (built based on core features):
 
@@ -257,28 +258,28 @@ awesome.permit() # AttributeError: Should do something with AwesomeClass object
 awesome.permit().do() == 'I am doing!'
 ```
 
-### Fetching argument names/sources using `argname`
+### Fetching argument names/sources using `argname2`
 ```python
-from varname import argname
+from varname import argname2
 
 def func(a, b=1):
-    print(argname(a))
+    print(argname2('a'))
 
 x = y = z = 2
 func(x) # prints: x
 
 def func2(a, b=1):
-    print(argname(a, b))
+    print(argname2('a', 'b'))
 func2(y, b=x) # prints: ('y', 'x')
 
 # allow expressions
 def func3(a, b=1):
-    print(argname(a, b, vars_only=False))
+    print(argname2('a', 'b', vars_only=False))
 func3(x+y, y+x) # prints: ('x+y', 'y+x')
 
 # positional and keyword arguments
 def func4(*args, **kwargs):
-    print(argname(args[1], kwargs['c']))
+    print(argname2('args[1]', 'kwargs["c"]'))
 func4(y, x, c=z) # prints: ('x', 'z')
 ```
 
@@ -353,9 +354,9 @@ For example:
 [9]: https://img.shields.io/github/workflow/status/pwwang/python-varname/Build%20Docs?label=docs&style=flat-square
 [10]: https://img.shields.io/github/workflow/status/pwwang/python-varname/Build%20and%20Deploy?style=flat-square
 [11]: https://mybinder.org/v2/gh/pwwang/python-varname/dev?filepath=playground%2Fplayground.ipynb
-[12]: https://img.shields.io/codacy/grade/ed851ff47b194e3e9389b2a44d6f21da?style=flat-square
-[13]: https://app.codacy.com/manual/pwwang/python-varname/dashboard
-[14]: https://img.shields.io/codacy/coverage/ed851ff47b194e3e9389b2a44d6f21da?style=flat-square
+[12]: https://img.shields.io/codacy/grade/6fdb19c845f74c5c92056e88d44154f7?style=flat-square
+[13]: https://app.codacy.com/gh/pwwang/python-varname/dashboard
+[14]: https://img.shields.io/codacy/coverage/6fdb19c845f74c5c92056e88d44154f7?style=flat-square
 [15]: https://pwwang.github.io/python-varname/api/varname
 [16]: https://pwwang.github.io/python-varname/CHANGELOG/
 [17]: https://img.shields.io/gitter/room/pwwang/python-varname?style=flat-square

README.rst

@@ -27,14 +27,14 @@
    :target: https://img.shields.io/github/workflow/status/pwwang/python-varname/Build%20Docs?label=docs&style=flat-square
    :alt: Docs and API
  <https://pwwang.github.io/python-varname/api/varname>`_ `
-.. image:: https://img.shields.io/codacy/grade/ed851ff47b194e3e9389b2a44d6f21da?style=flat-square
-   :target: https://img.shields.io/codacy/grade/ed851ff47b194e3e9389b2a44d6f21da?style=flat-square
+.. image:: https://img.shields.io/codacy/grade/6fdb19c845f74c5c92056e88d44154f7?style=flat-square
+   :target: https://img.shields.io/codacy/grade/6fdb19c845f74c5c92056e88d44154f7?style=flat-square
    :alt: Codacy
- <https://app.codacy.com/manual/pwwang/python-varname/dashboard>`_ `
-.. image:: https://img.shields.io/codacy/coverage/ed851ff47b194e3e9389b2a44d6f21da?style=flat-square
-   :target: https://img.shields.io/codacy/coverage/ed851ff47b194e3e9389b2a44d6f21da?style=flat-square
+ <https://app.codacy.com/gh/pwwang/python-varname/dashboard>`_ `
+.. image:: https://img.shields.io/codacy/coverage/6fdb19c845f74c5c92056e88d44154f7?style=flat-square
+   :target: https://img.shields.io/codacy/coverage/6fdb19c845f74c5c92056e88d44154f7?style=flat-square
    :alt: Codacy coverage
- <https://app.codacy.com/manual/pwwang/python-varname/dashboard>`_
+ <https://app.codacy.com/gh/pwwang/python-varname/dashboard>`_
 `
 .. image:: https://img.shields.io/gitter/room/pwwang/python-varname?style=flat-square
    :target: https://img.shields.io/gitter/room/pwwang/python-varname?style=flat-square
@@ -63,7 +63,8 @@ Features
   * 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 ``argname``
+  * Fetching argument names/sources passed to a function using ``argname2``
+    (\ ``argname`` is superseded by ``argname2``\ )
 
 * 
   Other helper APIs (built based on core features):
@@ -324,31 +325,31 @@ Detecting next immediate attribute name
    awesome.permit() # AttributeError: Should do something with AwesomeClass object
    awesome.permit().do() == 'I am doing!'
 
-Fetching argument names/sources using ``argname``
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Fetching argument names/sources using ``argname2``
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 .. code-block:: python
 
-   from varname import argname
+   from varname import argname2
 
    def func(a, b=1):
-       print(argname(a))
+       print(argname2('a'))
 
    x = y = z = 2
    func(x) # prints: x
 
    def func2(a, b=1):
-       print(argname(a, b))
+       print(argname2('a', 'b'))
    func2(y, b=x) # prints: ('y', 'x')
 
    # allow expressions
    def func3(a, b=1):
-       print(argname(a, b, vars_only=False))
+       print(argname2('a', 'b', vars_only=False))
    func3(x+y, y+x) # prints: ('x+y', 'y+x')
 
    # positional and keyword arguments
    def func4(*args, **kwargs):
-       print(argname(args[1], kwargs['c']))
+       print(argname2('args[1]', 'kwargs["c"]'))
    func4(y, x, c=z) # prints: ('x', 'z')
 
 Value wrapper

docs/CHANGELOG.md

@@ -1,3 +1,12 @@
+## v0.7.0
+- `ImproperUseError` is now independent of `VarnameRetrievingError`
+- Deprecate `argname`, superseded by `argname2`
+  ```python
+    >>> argname(a, b, ...) # before
+    >>> argname2('a', 'b', ...) # after
+  ```
+- Add `dispatch` argument to `argname`/`argment2` to be used for single-dispatched functions.
+
 ## v0.6.5
 - Add `sep` argument to `helpers.debug()`