0.4.0

Author: pwwang

README.rst

@@ -177,18 +177,12 @@ Retrieving the variable names from inside a function call/class instantiation
        # Since v0.1.3
        # We can ask varname to raise exceptions
        # if it fails to detect the variable name
-
-       from varname import VarnameRetrievingError
-       def get_name():
-           try:
-               # if raise_exc is False
-               # "var_<index>" will be returned
-               return varname(raise_exc=True)
-           except VarnameRetrieveingError:
-               return None
+       def get_name(raise_exc):
+           return varname(raise_exc=raise_exc)
 
        a = {}
-       a['b'] = get_name() # None
+       a['b'] = get_name(True) # VarnameRetrievingError
+       a['b'] = get_name(False) # None
 
 Value wrapper
 ^^^^^^^^^^^^^
@@ -244,7 +238,7 @@ Detecting next immediate attribute name
            self.will = None
 
        def permit(self):
-           self.will = will()
+           self.will = will(raise_exc=False)
            if self.will == 'do':
                # let self handle do
                return self
@@ -296,16 +290,21 @@ Injecting ``__varname__``
    b.append(1)
    a == b
 
-Limitations
------------
+Reliability and limitations
+---------------------------
 
 ``python-varname`` is all depending on ``executing`` package to look for the node.
-It does not work with any environment where ``executing`` is not able to detect the node.
+The node ``executing`` detects is ensured to be the correct one (see `this <https://github.com/alexmojaki/executing#is-it-reliable>`_\ ).
+
+It partially works with environments where other AST magics apply, including
+``pytest``\ , ``ipython``\ , ``macropy``\ , ``birdseye``\ , ``reticulate`` with ``R``\ , etc. Neither
+``executing`` nor ``python-varname`` is 100% working with those environments. Use
+it at your own risk.
+
 For example:
 
 
 * 
-  Environments where other AST magics apply. For example: ``pytest``\ , ``ipython``\ , ``macropy``\ , or ``birdseye``.
   This will not work with ``pytest``\ :
 
   .. code-block:: python
@@ -317,4 +316,13 @@ For example:
      name_a = nameof(a)
      assert name_a == 'a'
 
+* 
+  This will also typically fail with ``ipython``\ :
+
+  .. code-block:: python
+
+     a = 1
+     for _ in [0]:
+         print(nameof(a))
+
 * ``R`` with ``reticulate``.

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.masonry.api"
 
 [tool.poetry]
 name = "python-varname"
-version = "0.3.0"
+version = "0.4.0"
 description = "Retrieving variable names of function or class calls."
 authors = [ "pwwang <pwwang@pwwang.com>",]
 license = "MIT"

setup.py

@@ -21,7 +21,7 @@
 setup(
     long_description=readme,
     name='python-varname',
-    version='0.3.0',
+    version='0.4.0',
     description='Retrieving variable names of function or class calls.',
     python_requires='==3.*,>=3.6.0',
     project_urls={

varname.py

@@ -9,7 +9,7 @@
 
 import executing
 
-__version__ = "0.3.0"
+__version__ = "0.4.0"
 
 class VarnameRetrievingError(Exception):
     """When failed to retrieve the varname"""