duplicate service funcdefs correctly register the service; fixes #121

Author: craigbarratt

custom_components/pyscript/eval.py

@@ -372,9 +372,7 @@ async def do_service_call(func, ast_ctx, data):
 
                     return pyscript_service_handler
 
-                Function.hass.services.async_register(
-                    DOMAIN, self.name, pyscript_service_factory(self.name, self),
-                )
+                Function.service_register(DOMAIN, self.name, pyscript_service_factory(self.name, self))
                 async_set_service_schema(Function.hass, DOMAIN, self.name, service_desc)
                 self.trigger_service = True
             else:
@@ -513,7 +511,7 @@ def trigger_stop(self):
             trigger.stop()
         if self.trigger_service:
             self.trigger_service = False
-            Function.hass.services.async_remove(DOMAIN, self.name)
+            Function.service_remove(DOMAIN, self.name)
 
     async def eval_decorators(self, ast_ctx):
         """Evaluate the function decorators arguments."""

custom_components/pyscript/function.py

@@ -59,6 +59,13 @@ class Function:
     task_waiter = None
     task_waiter_q = None
 
+    #
+    # reference counting for service registrations; the new @service trigger
+    # registers the service call before the old one is removed, so we only
+    # remove the service registration when the reference count goes to zero
+    #
+    service_cnt = {}
+
     def __init__(self):
         """Warn on Function instantiation."""
         _LOGGER.error("Function class is not meant to be instantiated")
@@ -376,3 +383,22 @@ async def run_coro(cls, coro):
     def create_task(cls, coro):
         """Create a new task that runs a coroutine."""
         return cls.hass.loop.create_task(cls.run_coro(coro))
+
+    @classmethod
+    def service_register(cls, domain, service, callback):
+        """Register a new service callback."""
+        key = f"{domain}.{service}"
+        if key not in cls.service_cnt:
+            cls.service_cnt[key] = 0
+        cls.service_cnt[key] += 1
+        cls.hass.services.async_register(domain, service, callback)
+
+    @classmethod
+    def service_remove(cls, domain, service):
+        """Remove a service callback."""
+        key = f"{domain}.{service}"
+        if cls.service_cnt.get(key, 0) > 1:
+            cls.service_cnt[key] -= 1
+            return
+        cls.service_cnt[key] = 0
+        cls.hass.services.async_remove(domain, service)

docs/new_features.rst

@@ -38,4 +38,6 @@ Breaking changes since 1.1.0 include:
 Bug fixes since 1.1.0 include:
 
 - Fixed shutdown trigger for case where it calls ``task.unique()`` (#117).
+- Duplicate ``@service`` function definitions (with the same name) now correctly register the service,
+  reported by @wsw70 (#121)
 - Added error message for invalid ``@time_active`` argument, by @dlashua (#118).

tests/test_init.py

@@ -89,6 +89,11 @@ async def test_service_exists(hass, caplog):
 def func1():
     pass
 
+# make sure a double definition still keeps the service registered
+@service
+def func1():
+    pass
+
 def func2():
     pass