state.getattr() can now take a StateVar argument

state.get_attr() now logs a deprecated warning.
updated docs & tests.

Author: craigbarratt

custom_components/pyscript/state.py

@@ -201,7 +201,8 @@ async def setattr(cls, var_attr_name, value):
         parts = var_attr_name.split(".")
         if len(parts) != 3:
             raise NameError(f"invalid name {var_attr_name} (should be 'domain.entity.attr')")
-
+        if not cls.exist(f"{parts[0]}.{parts[1]}"):
+            raise NameError(f"state {parts[0]}.{parts[1]} doesn't exist")
         await cls.set(f"{parts[0]}.{parts[1]}", **{parts[2]: value})
 
     @classmethod
@@ -309,13 +310,24 @@ async def service_call(*args, **kwargs):
     @classmethod
     async def getattr(cls, var_name):
         """Return a dict of attributes for a state variable."""
+        if isinstance(var_name, StateVal):
+            attrs = var_name.__dict__.copy()
+            for discard in STATE_VIRTUAL_ATTRS:
+                attrs.pop(discard, None)
+            return attrs
         if var_name.count(".") != 1:
             raise NameError(f"invalid name {var_name} (should be 'domain.entity')")
         value = cls.hass.states.get(var_name)
         if not value:
             return None
         return value.attributes.copy()
 
+    @classmethod
+    async def get_attr(cls, var_name):
+        """Return a dict of attributes for a state variable - deprecated."""
+        _LOGGER.warning("state.get_attr() is deprecated: use state.getattr() instead")
+        return cls.getattr(var_name)
+
     @classmethod
     def completions(cls, root):
         """Return possible completions of state variables."""
@@ -360,7 +372,7 @@ def register_functions(cls):
             "state.setattr": cls.setattr,
             "state.names": cls.names,
             "state.getattr": cls.getattr,
-            "state.get_attr": cls.getattr,  # deprecated form; to be removed
+            "state.get_attr": cls.get_attr,  # deprecated form; to be removed
             "state.persist": cls.persist,
             "pyscript.config": cls.pyscript_config,
         }

docs/new_features.rst

@@ -18,10 +18,15 @@ The new features since 0.32 in master include:
 
 - Pyscript state variables (entity_ids) can be persisted across pyscript reloads and HASS restarts,
   from @swazrgb and @dlashua (#48).
+- Entities ``domain.entity`` now support a virtual method ``service`` (eg, ``domain.entity.service()``)
+  that calls the service ``domain.service`` for any service that has an ``entity_id`` parameter, with
+  that ``entity_id`` set to ``domain.entity``. Proposed by @dlashua (#64).
 - ``@state_trigger`` now supports triggering on an attribute change with ``"domain.entity.attr"`` and
   any attribute change with ``"domain.entity.*"``, from @dlashua (#82)
 - State variables now support virtual attributes ``last_changed`` and ``last_updated`` for the UTC time when state
   values or any attribute was last changed.
+- State variable attributes can be set by direct assignment, eg: ``DOMAIN.name.attr = value``.
+  An equivalent new function ``state.setattr()`` allows a specific attribute to be set.
 - State variable values (eg, from ``domain.entity`` or ``state.get()``) now include attributes that can be accessed
   after they are assigned to another, normal, variable.
 - ``@state_trigger`` and ``task.wait_until`` now have an optional ``state_hold`` duration in seconds that requires
@@ -43,15 +48,10 @@ The new features since 0.32 in master include:
   directory, and each module's or app's directory. Those files are read and any missing packages are
   installed on HASS startup and pyscript reload. If a specific version of a package is needed, it must be
   pinned using the format 'package_name==version'. Contributed by @raman325 (#66, #68, #69, #70, #78).
-- State variable attributes can be set by direct assignment, eg: ``DOMAIN.name.attr = value``.
-  An equivalent new function ``state.setattr()`` allows a specific attribute to be set.
 - The reload service now takes an optional parameter ``global_ctx`` that specifies just that
   global context is reloaded, eg: ``global_ctx="file.my_scripts"``.  Proposed by @dlashua (#63).
 - The ``state.get_attr()`` function has been renamed ``state.getattr()``. The old function is
-  still available and will be removed in some future release.
-- Entities ``DOMAIN.ENTITY`` now support a virtual method ``SERVICE`` (eg, ``DOMAIN.ENTITY.SERVICE()``)
-  that calls the service ``DOMAIN.SERVICE`` for any service that has an ``entity_id`` parameter, with
-  that ``entity_id`` set to ``DOMAIN.ENTITY``. Proposed by @dlashua (#64).
+  still available and will be removed in some future release (it logs a warning when used).
 - VSCode connections to pyscript's Jupyter kernel now work.  Two changes were required: VSCode immediately
   closes the heartbeat port, which no longer causes pyscript to shut down the kernel.  Also, ``stdout``
   messages are flushed prior to sending the execute complete message. This is to ensure `log` and `print`

docs/reference.rst

@@ -693,9 +693,10 @@ which you can’t do if you are directly assigning to the variable:
   then the attribute ``attr`` of the state variable ``DOMAIN.entity`` is returned; an
   ``AttributeError`` exception is thrown if that attribute doesn't exist.
 ``state.getattr(name)``
-  Returns a ``dict`` of attribute values for the state variable, or ``None`` if it doesn’t exist.
-  In pyscript versions 0.32 and earlier, this function was ``state.get_attr()``. That deprecated
-  name is still supported, but will be removed in a future version.
+  Returns a ``dict`` of attribute values for the state variable ``name`` string, or ``None`` if it
+  doesn’t exist.  Alternatively, ``name`` can be a state variable.  In pyscript versions 0.32 and
+  earlier, this function was ``state.get_attr()``. That deprecated name is still supported, but
+  logs a warning message and will be removed in a future version.
 ``state.names(domain=None)``
   Returns a list of all state variable names (ie, ``entity_id``\ s) of a
   domain. If ``domain`` is not specified, it returns all HASS state variable (``entity_id``) names.

tests/test_unit_eval.py

@@ -150,12 +150,12 @@
 state.set("pyscript.var1", pyscript.var1, new_attributes={"attr2": 8.5, "attr3": "xyz"})
 chk.append(state.getattr("pyscript.var1"))
 pyscript.var1.attr2 = "abc"
-chk.append(state.getattr("pyscript.var1"))
+chk.append(state.getattr(pyscript.var1))
 state.set("pyscript.var1", attr1=123)
 state.set("pyscript.var1", attr3="def")
 chk.append(state.getattr("pyscript.var1"))
 pyscript.var1.attr4 = 987
-chk.append(state.getattr("pyscript.var1"))
+chk.append(state.getattr(pyscript.var1))
 state.set("pyscript.var1", new_attributes={"attr2": 9.5, "attr3": "xyz"})
 chk.append(state.getattr("pyscript.var1"))
 chk.append(pyscript.var1)
@@ -955,6 +955,7 @@ async def test_eval(hass):
     ],
     ["assert 1 == 0, 'this is an error'", "Exception in test line 1 column 15: this is an error"],
     ["assert 1 == 0", "Exception in test line 1 column 12: "],
+    ["pyscript.var1.attr1 = 10", "Exception in test line 1 column 0: state pyscript.var1 doesn't exist"],
     [
         "import math; math.sinXYZ",
         "Exception in test line 1 column 13: module 'math' has no attribute 'sinXYZ'",