add support for service blocking

Author: raman325

custom_components/pyscript/function.py

@@ -190,13 +190,18 @@ def service_has_service(cls, domain, name):
     async def service_call(cls, domain, name, **kwargs):
         """Implement service.call()."""
         curr_task = asyncio.current_task()
-        if "context" in kwargs and isinstance(kwargs["context"], Context):
-            context = kwargs["context"]
-            del kwargs["context"]
-        else:
-            context = cls.task2context.get(curr_task, None)
-
-        await cls.hass.services.async_call(domain, name, kwargs, context=context)
+        hass_args = {}
+        for keyword, typ, default in [
+            ("context", Context, cls.task2context.get(curr_task, None)),
+            ("blocking", bool, None),
+            ("limit", float, None),
+        ]:
+            if keyword in kwargs and isinstance(kwargs[keyword], typ):
+                hass_args[keyword] = kwargs.pop(keyword)
+            elif default:
+                hass_args[keyword] = default
+
+        await cls.hass.services.async_call(domain, name, kwargs, **hass_args)
 
     @classmethod
     async def service_completions(cls, root):
@@ -255,15 +260,20 @@ def get(cls, name):
         def service_call_factory(domain, service):
             async def service_call(*args, **kwargs):
                 curr_task = asyncio.current_task()
-                if "context" in kwargs and isinstance(kwargs["context"], Context):
-                    context = kwargs["context"]
-                    del kwargs["context"]
-                else:
-                    context = cls.task2context.get(curr_task, None)
+                hass_args = {}
+                for keyword, typ, default in [
+                    ("context", Context, cls.task2context.get(curr_task, None)),
+                    ("blocking", bool, None),
+                    ("limit", float, None),
+                ]:
+                    if keyword in kwargs and isinstance(kwargs[keyword], typ):
+                        hass_args[keyword] = kwargs.pop(keyword)
+                    elif default:
+                        hass_args[keyword] = default
 
                 if len(args) != 0:
                     raise (TypeError, f"service {domain}.{service} takes no positional arguments")
-                await cls.hass.services.async_call(domain, service, kwargs, context=context)
+                await cls.hass.services.async_call(domain, service, kwargs, **hass_args)
 
             return service_call
 

custom_components/pyscript/state.py

@@ -258,11 +258,16 @@ async def get(cls, var_name):
             def service_call_factory(domain, service, entity_id, params):
                 async def service_call(*args, **kwargs):
                     curr_task = asyncio.current_task()
-                    if "context" in kwargs and isinstance(kwargs["context"], Context):
-                        context = kwargs["context"]
-                        del kwargs["context"]
-                    else:
-                        context = Function.task2context.get(curr_task, None)
+                    hass_args = {}
+                    for keyword, typ, default in [
+                        ("context", Context, Function.task2context.get(curr_task, None)),
+                        ("blocking", bool, None),
+                        ("limit", float, None),
+                    ]:
+                        if keyword in kwargs and isinstance(kwargs[keyword], typ):
+                            hass_args[keyword] = kwargs.pop(keyword)
+                        elif default:
+                            hass_args[keyword] = default
 
                     kwargs["entity_id"] = entity_id
                     if len(args) == 1 and len(params) == 1:
@@ -273,7 +278,7 @@ async def service_call(*args, **kwargs):
                         kwargs[param_name] = args[0]
                     elif len(args) != 0:
                         raise TypeError(f"service {domain}.{service} takes no positional arguments")
-                    await cls.hass.services.async_call(domain, service, kwargs, context=context)
+                    await cls.hass.services.async_call(domain, service, kwargs, **hass_args)
 
                 return service_call
 

docs/reference.rst

@@ -210,6 +210,11 @@ called by:
 
        service.call("myservice", "flash_light", light_name="front", light_color="red")
 
+When making a service call, either using the ``service.call`` function or the service name as the
+function, you can optionally pass the keyword argument ``blocking=True`` if you would like to wait
+for the service to finish execution before continuing execution in your function. You can also
+specify a timeout for a blocking service call using the ``limit=<number_of_seconds>`` parameters.
+
 Firing events
 -------------
 
@@ -691,8 +696,11 @@ or ``float()``). Attributes keep their native type.
 Service Calls
 ^^^^^^^^^^^^^
 
-``service.call(domain, name, **kwargs)``
-  calls the service ``domain.name`` with the given keyword arguments as parameters.
+``service.call(domain, name, blocking=False, limit=10, **kwargs)``
+  calls the service ``domain.name`` with the given keyword arguments as parameters. If ``blocking``
+  is ``True``, pyscript will wait for the service to finish executing before continuing the current
+  routine, or will wait a maximum of the number of seconds specified in the `limit` keyword
+  argument.
 ``service.has_service(domain, name)``
   returns whether the service ``domain.name`` exists.