Bots: Add dispatch decorator for bot commands.

Author: neiljp

zulip_bots/zulip_bots/bots/helloworld_defaults/helloworld_defaults.py

@@ -1,5 +1,7 @@
 # See readme.md for instructions on running this code.
 
+from zulip_bots.lib import dispatch
+
 class HelloWorld_DefaultBot(object):
     META = {
         'name': 'HelloWorld-defaults',
@@ -38,5 +40,9 @@ def handle_message(self, message, bot_handler):
         content = 'beep boop'
         bot_handler.send_reply(message, content)
 
+@dispatch("bye", "Says bye to the user.")
+def do_byebye():
+    return "I'm not going anywhere!"
+
 
 handler_class = HelloWorld_DefaultBot

zulip_bots/zulip_bots/bots/helloworld_defaults/test_helloworld_defaults.py

@@ -25,5 +25,5 @@ def test_bot(self):
 #        "commands"
 #        "help"
 
-#        "hi" is handled in the library too, though is an external function
+#        "hi" and "bye" are handled in the library too, though is an external function
 #        so we can't test it?

zulip_bots/zulip_bots/lib.py

@@ -92,6 +92,15 @@ def __init__(self, command, supported):
     def __str__(self):
         return self.msg
 
+to_dispatch = {}
+def dispatch(command, help_text):
+    def wrap(func):
+        to_dispatch[command] = (help_text, func)
+        def wrapped_f(*args, **kwargs):
+            return func(*args, **kwargs)
+        return wrapped_f
+    return wrap
+
 class ExternalBotHandler(object):
     def __init__(self, client, root_dir, bot_details={}):
         # type: (Client, str, Dict[str, Any]) -> None
@@ -215,18 +224,22 @@ def dispatch_default_commands(self, message, command_list, meta, other_commands=
                     cmd_list = [cmd for cmd in command_list if cmd != ""]
                     if other_commands is not None:
                         cmd_list.extend(other_commands)
+                    cmd_list.extend(to_dispatch)
                     return "**Commands**: " + ", ".join(cmd_list)
                 elif command == "help":
                     cmd_list = OrderedDict([(cmd, supported_commands[cmd]) for cmd in command_list if cmd != ""])
                     if other_commands is not None:
                         cmd_list.update(OrderedDict([(c, h[0]) for c, h in other_commands.items()]))
+                    cmd_list.update(OrderedDict([(c, h[0]) for c, h in to_dispatch.items()]))
                     help_text = ("**{name}**: {description}".format(**meta)+
                                  "\nThis bot supports the following commands:\n"+
                                  "\n".join(["**{}** - {}".format(c, h) for c, h in cmd_list.items()]))
                     return help_text
             if other_commands is not None and command in other_commands:
                 if other_commands[command][1] is not None:
                     return other_commands[command][1]()
+            if command in to_dispatch:
+                return to_dispatch[command][1]()
         return None
 
 def extract_query_without_mention(message, client):