Refactored the Bot._call internal method

Before this commit, a bug considered all the hooks as part of the main
component, for shared memory. This caused serious issues with shared
memory initializers, since they didn't work for external components.

Now the Bot._call method accepts the component ID of the hook, and
provides shared memory as an argument only if the ID is provided.

This is a regression introduced in 350a78a.

Author: Pietro Albini

botogram/frozenbot.py

@@ -217,18 +217,13 @@ def _get_commands(self):
         """Get all the commands this bot implements"""
         return self._commands
 
-    def _call(self, func, **available):
+    def _call(self, func, component=None, **available):
         """Wrapper for calling user-provided functions"""
-        # Get the function's component
-        if hasattr(func, "botogram") and func.botogram.component is not None:
-            component = func.botogram.component._component_id
-        else:
-            component = self._main_component_id
-        shared = self._shared_memory.of(self._bot_id, component)
-
         # Set some default available arguments
         available.setdefault("bot", self)
-        available.setdefault("shared", shared)
+        if component is not None:
+            shared = self._shared_memory.of(self._bot_id, component)
+            available.setdefault("shared", shared)
 
         # Get the correct function signature
         # botogram_original_signature is set while using @utils.wraps

botogram/hooks.py

@@ -23,6 +23,7 @@ def __init__(self, func, component, args=None):
         self.func = func
         self.name = prefix+func.__name__
         self.component = component
+        self.component_id = component._component_id
 
         self._args = args
         self._after_init(args)
@@ -46,7 +47,8 @@ def call(self, bot, update):
     def _call(self, bot, update):
         """*Actually* call the hook"""
         message = update.message
-        return bot._call(self.func, chat=message.chat, message=message)
+        return bot._call(self.func, self.component_id, chat=message.chat,
+                         message=message)
 
 
 def rebuild(cls, func, component, args):
@@ -98,7 +100,8 @@ def _call(self, bot, update):
 
         if text != self._string:
             return
-        return bot._call(self.func, chat=message.chat, message=message)
+        return bot._call(self.func, self.component_id, chat=message.chat,
+                         message=message)
 
 
 class MessageContainsHook(MessageEqualsHook):
@@ -115,7 +118,8 @@ def _call(self, bot, update):
             if one != self._string:
                 continue
 
-            result = bot._call(self.func, chat=message.chat, message=message)
+            result = bot._call(self.func, self.component_id, chat=message.chat,
+                               message=message)
             res.append(result)
             if not self._args["multiple"]:
                 break
@@ -139,8 +143,8 @@ def _call(self, bot, update):
         for result in results:
             found = True
 
-            bot._call(self.func, chat=message.chat, message=message,
-                      matches=result.groups())
+            bot._call(self.func, self.component_id, chat=message.chat,
+                      message=message, matches=result.groups())
             if not self._args["multiple"]:
                 break
 
@@ -172,12 +176,13 @@ def _call(self, bot, update):
             return
 
         args = message.text.split(" ")[1:]
-        bot._call(self.func, chat=message.chat, message=message, args=args)
+        bot._call(self.func, self.component_id, chat=message.chat,
+                  message=message, args=args)
         return True
 
 
 class TimerHook(Hook):
     """Underlying hook for a timer"""
 
     def call(self, bot):
-        return bot._call(self.func)
+        return bot._call(self.func, self.component_id)

botogram/tasks.py

@@ -19,7 +19,7 @@ def process(self, bot):
         """Process the task"""
         if hasattr(self.hook, "call"):
             return self.hook.call(bot)
-        return bot._call(self.hook)
+        return self.hook(bot)
 
 
 class TimerTask(BaseTask):

botogram/utils.py

@@ -89,15 +89,15 @@ def format_docstr(docstring):
     return "\n".join(result)
 
 
-def docstring_of(func, bot=None):
+def docstring_of(func, bot=None, component_id=None):
     """Get the docstring of a function"""
     # Get the correct function from the hook
     if hasattr(func, "_botogram_hook"):
         func = func.func
 
     if hasattr(func, "_botogram_help_message"):
         if bot is not None:
-            docstring = bot._call(func._botogram_help_message)
+            docstring = bot._call(func._botogram_help_message, component_id)
         else:
             docstring = func._botogram_help_message()
     elif func.__doc__:

tests/test_frozenbot.py

@@ -40,11 +40,11 @@ def more(bot, a, c):
         assert 2 + 2 == 5
 
     for func in subset, all:
-        frozenbot._call(func, a="foo", b=42)
+        frozenbot._call(func, "comptest", a="foo", b=42)
 
     # More should raise a TypeError for the "c" argument
     with pytest.raises(TypeError):
-        frozenbot._call(more, a="foo", b=42)
+        frozenbot._call(more, "comptest", a="foo", b=42)
 
     assert subset_called
     assert all_called