appdaemon 4.5.2__tar.gz → 4.5.4__tar.gz

{appdaemon-4.5.2/appdaemon.egg-info → appdaemon-4.5.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: appdaemon
-Version: 4.5.2
+Version: 4.5.4
 Summary: Apps for the Home Assistant home automation package.
 Author-email: Andrew I Cockburn <appdaemon@acockburn.com>
 Project-URL: documentation, https://appdaemon.readthedocs.io

{appdaemon-4.5.2 → appdaemon-4.5.4}/appdaemon/adapi.py

@@ -489,7 +489,8 @@ class ADAPI:
     # Threading
     #
 
-    def set_app_pin(self, pin: bool) -> None:
+    @utils.sync_decorator
+    async def set_app_pin(self, pin: bool) -> None:
         """Sets an App to be pinned or unpinned.
 
         Args:
@@ -506,7 +507,8 @@ class ADAPI:
         """
         self.AD.app_management.set_app_pin(self.name, pin)
 
-    def get_app_pin(self) -> bool:
+    @utils.sync_decorator
+    async def get_app_pin(self) -> bool:
         """Finds out if the current App is currently pinned or not.
 
         Returns:
@@ -519,7 +521,8 @@ class ADAPI:
         """
         return self.AD.app_management.get_app_pin(self.name)
 
-    def set_pin_thread(self, thread: int) -> None:
+    @utils.sync_decorator
+    async def set_pin_thread(self, thread: int) -> None:
         """Sets the thread that the App will be pinned to.
 
         Args:
@@ -537,7 +540,8 @@ class ADAPI:
         """
         self.AD.app_management.set_pin_thread(self.name, thread)
 
-    def get_pin_thread(self) -> int:
+    @utils.sync_decorator
+    async def get_pin_thread(self) -> int:
         """Finds out which thread the App is pinned to.
 
         Returns:
@@ -590,7 +594,8 @@ class ADAPI:
         # Keeping namespace get/set functions for legacy compatibility
         return self.namespace
 
-    def namespace_exists(self, namespace: str) -> bool:
+    @utils.sync_decorator
+    async def namespace_exists(self, namespace: str) -> bool:
         """Check the existence of a namespace in AppDaemon.
 
         See the `namespace documentation <APPGUIDE.html#namespaces>`__ for more information.
@@ -668,7 +673,8 @@ class ADAPI:
 
         return await self.AD.state.remove_namespace(namespace)
 
-    def list_namespaces(self) -> list[str]:
+    @utils.sync_decorator
+    async def list_namespaces(self) -> list[str]:
         """Get a list of all the namespaces in AppDaemon.
 
         Examples:
@@ -909,7 +915,8 @@ class ADAPI:
         """
         return devices.split(",")
 
-    def get_plugin_config(self, namespace: str | None = None) -> Any:
+    @utils.sync_decorator
+    async def get_plugin_config(self, namespace: str | None = None) -> Any:
         """Gets any useful metadata that the plugin may have available.
 
         For instance, for the HASS plugin, this will return Home Assistant configuration
@@ -931,7 +938,8 @@ class ADAPI:
         namespace = namespace or self.namespace
         return self.AD.plugins.get_plugin_meta(namespace)
 
-    def friendly_name(self, entity_id: str, namespace: str | None = None) -> str:
+    @utils.sync_decorator
+    async def friendly_name(self, entity_id: str, namespace: str | None = None) -> str:
         """Gets the Friendly Name of an entity.
 
         Args:
@@ -1380,7 +1388,7 @@ class ADAPI:
     # State
     #
 
-    @overload
+    @overload # single entity
     @utils.sync_decorator
     async def listen_state(
         self,
@@ -1399,7 +1407,7 @@ class ADAPI:
         **kwargs: Any
     ) -> str: ...
 
-    @overload
+    @overload # multiple entities
     @utils.sync_decorator
     async def listen_state(
         self,

{appdaemon-4.5.2 → appdaemon-4.5.4}/appdaemon/app_management.py

@@ -191,10 +191,11 @@ class AppManagement:
     def app_rel_path(self, app_name: str) -> Path:
         return self.app_config.root[app_name].config_path.relative_to(self.AD.app_dir.parent)
 
-    def mod_rel_path(self, app_obj: object) -> Path:
+    def err_app_path(self, app_obj: object) -> Path:
         module_path = Path(sys.modules[app_obj.__module__].__file__)
-        rel_path = module_path.relative_to(self.AD.app_dir.parent)
-        return rel_path
+        if module_path.is_relative_to(self.AD.app_dir.parent):
+            return module_path.relative_to(self.AD.app_dir.parent)
+        return module_path
 
     async def init_admin_stats(self):
         # create sensors
@@ -266,16 +267,18 @@ class AppManagement:
     async def initialize_app(self, app_name: str):
         assert app_name in self.objects, 'Something is very wrong'
         app_obj = self.objects[app_name].object
-        rel_path = self.mod_rel_path(app_obj)
+
+        # Get the path that will be used for the exception
+        err_path = self.err_app_path(app_obj)
 
         try:
             init_func = app_obj.initialize
         except AttributeError:
-            raise ade.NoInitializeMethod(app_obj.__class__, rel_path)
+            raise ade.NoInitializeMethod(app_obj.__class__, err_path)
 
         signature = inspect.signature(init_func)
         if len(signature.parameters) != 0:
-            raise ade.BadInitializeMethod(app_obj.__class__, rel_path, signature)
+            raise ade.BadInitializeMethod(app_obj.__class__, err_path, signature)
 
         # Call its initialize function
         await self.set_state(app_name, state="initializing")

{appdaemon-4.5.2 → appdaemon-4.5.4}/appdaemon/entity.py

@@ -355,8 +355,6 @@ class Entity:
 
         Args:
             service (str): The service name, without the domain (e.g "toggle")
-            return_result(bool, option): If `return_result` is provided and set to `True` AD will attempt
-                to wait for the result, and return it after execution
             callback: The non-async callback to be executed when complete.
             **kwargs: Each service has different parameter requirements. This argument
                 allows you to specify a comma-separated list of keyword value pairs, e.g.,
@@ -437,7 +435,7 @@ class Entity:
             self.logger.warning(f"State Wait for {self.entity_id} Timed Out")
             raise TimeOutException("The entity timed out") from e
         finally:
-            self._async_events.pop(wait_id)
+            self._async_events.pop(wait_id, None)  # Ignore if already removed
 
     async def entity_state_changed(self, *args, wait_id: str, **kwargs) -> None:
         """The entity state changed"""

{appdaemon-4.5.2 → appdaemon-4.5.4}/appdaemon/models/config/plugin.py

@@ -100,7 +100,6 @@ class HASSConfig(PluginConfig):
         BeforeValidator(utils.parse_timedelta)
     ] = Field(default_factory=lambda: timedelta(seconds=10))
     """Default timeout for waiting for responses from the websocket connection"""
-    # return_result: bool | None = None
     suppress_log_messages: bool = False
     retry_secs: int = 5
     services_sleep_time: int = 60

{appdaemon-4.5.2 → appdaemon-4.5.4}/appdaemon/plugin_management.py

@@ -126,8 +126,14 @@ class PluginBase(abc.ABC):
         pass
 
     # @abc.abstractmethod
-    async def set_plugin_state(self):
-        raise NotImplementedError
+    # async def set_plugin_state(
+    #     self,
+    #     namespace: str,
+    #     entity_id: str,
+    #     state: Any | None = None,
+    #     attributes: Any | None = None,
+    # ) -> dict[str, Any] | None:
+    #     pass
 
     # @abc.abstractmethod
     async def fire_plugin_event(self):

{appdaemon-4.5.2 → appdaemon-4.5.4}/appdaemon/plugins/hass/hassapi.py

@@ -260,7 +260,8 @@ class Hass(ADBase, ADAPI):
         """
         return self.get_state(*args, **kwargs)
 
-    def anyone_home(self, person: bool = True, namespace: str | None = None) -> bool:
+    @utils.sync_decorator
+    async def anyone_home(self, person: bool = True, namespace: str | None = None) -> bool:
         """Determines if the house/apartment is occupied.
 
         A convenience function to determine if one or more person is home. Use
@@ -285,10 +286,11 @@ class Hass(ADBase, ADAPI):
             >>>     do something
 
         """
-        details = self.get_tracker_details(person, namespace, copy=False)
+        details = await self.get_tracker_details(person, namespace, copy=False)
         return any(state['state'] == 'home' for state in details.values())
 
-    def everyone_home(self, person: bool = True, namespace: str | None = None) -> bool:
+    @utils.sync_decorator
+    async def everyone_home(self, person: bool = True, namespace: str | None = None) -> bool:
         """Determine if all family's members at home.
 
         A convenience function to determine if everyone is home. Use this in
@@ -312,10 +314,11 @@ class Hass(ADBase, ADAPI):
             >>>    do something
 
         """
-        details = self.get_tracker_details(person, namespace, copy=False)
+        details = await self.get_tracker_details(person, namespace, copy=False)
         return all(state['state'] == 'home' for state in details.values())
 
-    def noone_home(self, person: bool = True, namespace: str | None = None) -> bool:
+    @utils.sync_decorator
+    async def noone_home(self, person: bool = True, namespace: str | None = None) -> bool:
         """Determines if the house/apartment is empty.
 
         A convenience function to determine if no people are at home. Use this
@@ -340,7 +343,7 @@ class Hass(ADBase, ADAPI):
             >>>     do something
 
         """
-        return not self.anyone_home(person, namespace)
+        return not await self.anyone_home(person, namespace)
 
     #
     # Built-in constraints
@@ -408,7 +411,7 @@ class Hass(ADBase, ADAPI):
             case str():
                 constraints = [value]
 
-        assert isinstance(value, list) and all(isinstance(v, str) for v in value)
+        assert isinstance(constraints, list) and all(isinstance(v, str) for v in constraints)
 
         for constraint in constraints:
             # using re.split allows for an arbitrary amount of whitespace after the comma
@@ -1340,7 +1343,7 @@ class Hass(ADBase, ADAPI):
     # Functions that use self.render_template
 
     @utils.sync_decorator
-    async def render_template(self, template: str, namespace: str | None = None) -> Any:
+    async def render_template(self, template: str, namespace: str | None = None, **kwargs) -> Any:
         """Renders a Home Assistant Template.
 
         See the documentation for the `Template Integration <https://www.home-assistant.io/integrations/template>`__ and
@@ -1348,9 +1351,9 @@ class Hass(ADBase, ADAPI):
 
         Args:
             template (str): The Home Assistant template to be rendered.
-            namespace (str, optional): Namespace to use for the call. See the section on
-                `namespaces <APPGUIDE.html#namespaces>`__ for a detailed description.
-                In most cases it is safe to ignore this parameter.
+            namespace (str, optional): Optional namespace to use. Defaults to using the app's current namespace. See the
+                `namespace documentation <APPGUIDE.html#namespaces>`__ for more information.
+            **kwargs (optional): Zero or more keyword arguments that get passed to the template rendering.
 
         Returns:
             The rendered template in a native Python type.
@@ -1365,17 +1368,20 @@ class Hass(ADBase, ADAPI):
             >>> self.render_template("{{ states('sensor.outside_temp') }}")
             97.2
 
+            >>> self.render_template("hello {{ name }}", variables={"name": "bob"})
+            hello bob
+
         """
         plugin: "HassPlugin" = self.AD.plugins.get_plugin_object(
             namespace or self.namespace
         )
-        result = await plugin.render_template(self.namespace, template)
+        result = await plugin.render_template(self.namespace, template, **kwargs)
         try:
             return literal_eval(result)
         except (SyntaxError, ValueError):
             return result
 
-    def _template_command(self, command: str, *args: tuple[str, ...]) -> str | list[str]:
+    def _template_command(self, command: str, *args: str) -> str | list[str]:
         """Internal AppDaemon function to format calling a single template command correctly."""
         if len(args) == 0:
             return self.render_template(f'{{{{ {command}() }}}}')
@@ -1478,6 +1484,10 @@ class Hass(ADBase, ADAPI):
         <https://www.home-assistant.io/docs/configuration/templating/#entities-for-an-integration>`_ for more
         information.
         """
+        entities = self._template_command('integration_entities', integration)
+        assert isinstance(entities, list) and all(isinstance(e, str) for e in entities), \
+            'Invalid return type from integration_entities'
+        return entities
 
     # Labels
     # https://www.home-assistant.io/docs/configuration/templating/#labels

{appdaemon-4.5.2 → appdaemon-4.5.4}/appdaemon/plugins/hass/hassplugin.py

@@ -888,7 +888,7 @@ class HassPlugin(PluginBase):
         return result
 
     @utils.warning_decorator(error_text='Unexpected error rendering template')
-    async def render_template(self, namespace: str, template: str):
+    async def render_template(self, namespace: str, template: str, **kwargs):
         self.logger.debug(
             "render_template() namespace=%s data=%s",
             namespace,
@@ -897,4 +897,4 @@ class HassPlugin(PluginBase):
 
         # if we get a request for not our namespace something has gone very wrong
         assert namespace == self.namespace
-        return await self.http_method("post", "/api/template", template=template)
+        return await self.http_method("post", "/api/template", template=template, **kwargs)

{appdaemon-4.5.2 → appdaemon-4.5.4}/appdaemon/stream/adstream.py

@@ -1,15 +1,16 @@
+import asyncio
+import threading
 import traceback
-import bcrypt
 import uuid
-import threading
-import asyncio
 
-from appdaemon.appdaemon import AppDaemon
+import bcrypt
+
 import appdaemon.utils as utils
+from appdaemon.appdaemon import AppDaemon
+from appdaemon.exceptions import RequestHandlerException
 from appdaemon.stream.socketio_handler import SocketIOHandler
-from appdaemon.stream.ws_handler import WSHandler
 from appdaemon.stream.sockjs_handler import SockJSHandler
-from appdaemon.exceptions import RequestHandlerException
+from appdaemon.stream.ws_handler import WSHandler
 
 
 class ADStream:
@@ -51,7 +52,7 @@ class ADStream:
         rh = RequestHandler(self.AD, self, handle, request)
         with self.handlers_lock:
             self.handlers[handle] = rh
-        await rh.stream.run()
+        return await rh.stream.run()
 
     async def on_disconnect(self, handle):
         with self.handlers_lock:
@@ -98,9 +99,7 @@ class RequestHandler:
 
         # Create a stream
         #
-        self.stream = self.adstream.stream_handler.makeStream(
-            self.AD, request, on_message=self._on_message, on_disconnect=self._on_disconnect
-        )
+        self.stream = self.adstream.stream_handler.makeStream(self.AD, request, on_message=self._on_message, on_disconnect=self._on_disconnect)
         #
 
     async def _on_message(self, data):
@@ -331,6 +330,9 @@ class RequestHandler:
 
             service_data = data["data"]
 
+            if "__name" in service_data:
+                del service_data["__name"]
+
         return await self.AD.services.call_service(
             namespace=data["namespace"],
             domain=domain,

{appdaemon-4.5.2 → appdaemon-4.5.4}/appdaemon/stream/ws_handler.py

@@ -1,9 +1,9 @@
-import traceback
+import asyncio
 import json
+import traceback
 
 import aiohttp
 from aiohttp import web
-import asyncio
 
 from appdaemon import utils as utils
 
@@ -24,7 +24,7 @@ class WSHandler:
         # We have a connection
         #
         # Add handler
-        await self.ADStream.on_connect(request)
+        return await self.ADStream.on_connect(request)
 
     def makeStream(self, ad, request, **kwargs):
         return WSStream(ad, request, **kwargs)
@@ -76,6 +76,7 @@ class WSStream:
             self.logger.debug("Closing websocket ...")
             await self.ws.close()
             self.logger.debug("Done")
+        return self.ws
 
     async def sendclient(self, data):
         try:

{appdaemon-4.5.2 → appdaemon-4.5.4}/appdaemon/threads.py

@@ -78,10 +78,15 @@ class Threading:
         self.callback_list = []
 
     @property
-    def pin_apps(self):
+    def pin_apps(self) -> bool:
         "Whether each app should be pinned to a thread"
         return self.AD.config.pin_apps
 
+    @pin_apps.setter
+    def pin_apps(self, new: bool) -> None:
+        """Set whether each app should be pinned to a thread"""
+        self.AD.config.pin_apps = new
+
     @property
     def total_threads(self) -> int:
         """Number of threads created for apps.

appdaemon-4.5.4/appdaemon/version.py

@@ -0,0 +1,2 @@
+__version__ = "4.5.4"
+__version_comments__ = ""

{appdaemon-4.5.2 → appdaemon-4.5.4/appdaemon.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: appdaemon
-Version: 4.5.2
+Version: 4.5.4
 Summary: Apps for the Home Assistant home automation package.
 Author-email: Andrew I Cockburn <appdaemon@acockburn.com>
 Project-URL: documentation, https://appdaemon.readthedocs.io

appdaemon-4.5.2/appdaemon/version.py

@@ -1,2 +0,0 @@
-__version__ = "4.5.2"
-__version_comments__ = "dev"