Pump to 0.5.6 (#38)

* Deprecate inject_varname, use register instead.

* 0.5.6

* Update CHANGELOG and README

Author: pwwang

README.md

@@ -62,8 +62,12 @@ Special thanks to [@HanyuuLu][2] to give up the name `varname` in pypi for this
 
     ```python
     def function():
-        # I know that at which stack this will be called
-        return varname(caller=3)
+        # I know that at which frame this will be called
+        return varname(3)
+        # with v0.5.6+ now you can also specify a list of intermediate
+        # calls to be ignored in counting:
+        # module = sys.modules[__name__]
+        # return varname(ignore=[(module, 'function1'), (module, 'function2)])
 
     def function1():
         return function()
@@ -74,6 +78,24 @@ Special thanks to [@HanyuuLu][2] to give up the name `varname` in pypi for this
     func = function2()  # func == 'func'
     ```
 
+- `varname` in type annotation or async context
+    ```python
+    import typing
+    class Foo:
+        def __init__(self):
+            self.id = varname(ignore=[typing])
+
+    foo: Foo = Foo() # foo.id == 'foo'
+    ```
+
+    ```python
+    import asyncio
+    async def func():
+        return varname(ignore=[asyncio])
+
+    x = asyncio.run(func()) # x == 'x'
+    ```
+
 - Retrieving instance name of a class
 
     ```python
@@ -88,6 +110,7 @@ Special thanks to [@HanyuuLu][2] to give up the name `varname` in pypi for this
             return copied
 
     k = Foo()   # k.id == 'k'
+    # see also register __varname__ to classes
 
     k2 = k.copy() # k2.id == 'k2'
     ```
@@ -213,12 +236,12 @@ awesome.permit() # AttributeError: Should do something with AwesomeClass object
 awesome.permit().do() == 'I am doing!'
 ```
 
-### Injecting `__varname__` to classes
+### Register `__varname__` to classes
 
 ```python
-from varname import inject_varname
+from varname import register
 
-@inject_varname
+@register
 class Dict(dict):
     pass
 

docs/CHANGELOG.md

@@ -1,3 +1,7 @@
+## v0.5.6
+- Add `ignore` argument to `varname` to ignore frames that are not counted by caller
+- Deprecate `inject_varname`, use `register` instead
+
 ## v0.5.5
 - Deprecate inject and use inject_varname decorator instead
 

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.masonry.api"
 
 [tool.poetry]
 name = "varname"
-version = "0.5.5"
+version = "0.5.6"
 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.5.5',
+    version='0.5.6',
     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"},

tests/test_bytecode_nameof.py

@@ -5,8 +5,6 @@
 
 def nameof_both(*args):
     """Test both implementations at the same time"""
-    # No need caller=2 anymore, since internal calls from varname are ignored
-    # now by default
     result = nameof(*args, caller=2)
     if len(args) == 1:
         assert result == _bytecode_nameof(caller=2)

varname.py

@@ -11,10 +11,10 @@
 
 import executing
 
-__version__ = "0.5.5"
+__version__ = "0.5.6"
 __all__ = [
     "VarnameRetrievingError", "varname", "will", "inject_varname",
-    "inject", "nameof", "namedtuple", "Wrapper", "debug"
+    "register", "inject", "nameof", "namedtuple", "Wrapper", "debug"
 ]
 
 # To show how the desired frame is selected and other frames are skipped
@@ -181,7 +181,7 @@ def will(caller: int = 1, raise_exc: bool = True) -> Optional[str]:
     # ast.Attribute
     return node.attr
 
-def inject_varname(
+def register(
         cls: type = None, *,
         caller: int = 1,
         multi_vars: bool = False,
@@ -201,23 +201,24 @@ def inject_varname(
             to retrieve the name.
 
     Examples:
-        >>> @inject_varname
+        >>> @varname.register
         >>> class Foo: pass
         >>> foo = Foo()
         >>> # foo.__varname__ == 'foo'
 
     Returns:
         The wrapper function or the class itself if it is specified explictly.
     """
+
     if cls is not None:
-        # Used as @inject_varname directly
-        return inject_varname(
+        # Used as @register directly
+        return register(
             caller=caller,
             multi_vars=multi_vars,
             raise_exc=raise_exc
         )(cls)
 
-    # Used as @inject_varname(multi_vars=..., raise_exc=...)
+    # Used as @register(multi_vars=..., raise_exc=...)
     def wrapper(cls):
         """The wrapper function to wrap a class and inject `__varname__`"""
         orig_init = cls.__init__
@@ -237,6 +238,23 @@ def wrapped_init(self, *args, **kwargs):
 
     return wrapper
 
+def inject_varname(
+        cls: type = None, *,
+        caller: int = 1,
+        multi_vars: bool = False,
+        raise_exc: bool = True
+) -> Union[type, Callable[[type], type]]:
+    """Alias of register. Will be deprecated"""
+    warnings.warn("Decorator inject_varname will be removed in 0.6.0. "
+                  "Use varname.register to decorate your class.",
+                  DeprecationWarning)
+    return register(
+        cls,
+        caller=caller,
+        multi_vars=multi_vars,
+        raise_exc=raise_exc
+    )
+
 def inject(obj: object) -> object:
     """Inject attribute `__varname__` to an object
 
@@ -268,7 +286,7 @@ def inject(obj: object) -> object:
         The object with __varname__ injected
     """
     warnings.warn("Function inject will be removed in 0.6.0. Use "
-                  "varname.inject_varname to decorate your class.",
+                  "varname.register to decorate your class.",
                   DeprecationWarning)
     vname = varname(caller=0)
     try: