Bots: Amend default-commands parameter to dispatch regular commands.

Author: neiljp

zulip_bots/zulip_bots/bots/helloworld_defaults/helloworld_defaults.py

@@ -15,9 +15,14 @@ def usage(self):
         sophisticated, bots using default commands.
         '''
 
+    def do_hi(self):
+        return "Hi!"
+
     def handle_message(self, message, bot_handler):
         default_commands_to_handle = ["", "about", "commands", "help"]
-        other_commands = {"hello": "Says hello to the user."}
+        other_commands = {"hello": ("Says hello to the user.", None),
+                          "hi": ("Says hi to the user.", self.do_hi),
+        }
         default_response = bot_handler.dispatch_default_commands(message,
                                                                  default_commands_to_handle,
                                                                  self.META,
@@ -33,4 +38,5 @@ def handle_message(self, message, bot_handler):
         content = 'beep boop'
         bot_handler.send_reply(message, content)
 
+
 handler_class = HelloWorld_DefaultBot

zulip_bots/zulip_bots/bots/helloworld_defaults/test_helloworld_defaults.py

@@ -24,3 +24,6 @@ def test_bot(self):
 #        "about"
 #        "commands"
 #        "help"
+
+#        "hi" is handled in the library too, though is an external function
+#        so we can't test it?

zulip_bots/zulip_bots/lib.py

@@ -16,7 +16,7 @@
 
 if False:
     from mypy_extensions import NoReturn
-from typing import Any, Optional, List, Dict, IO, Text, Set, Sequence
+from typing import Any, Optional, List, Dict, IO, Text, Set, Sequence, Tuple, Callable
 from types import ModuleType
 
 from zulip import Client, ZulipError
@@ -187,14 +187,14 @@ def open(self, filepath):
                                   "files in their local directory.".format(abs_filepath))
 
     def dispatch_default_commands(self, message, command_list, meta, other_commands=None):
-        # type: (Dict[str, Any], Sequence[Text], Dict[Text, Text], Optional[Mapping[Text, Text]]) -> Optional[Text]
+        # type: (Dict[str, Any], Sequence[Text], Dict[Text, Text], Optional[Mapping[Text, Tuple[Text, Optional[Callable[[], Text]]]]]) -> Optional[Text]
         supported_commands = OrderedDict([
             ("", ""),  # No help text, as this shouldn't appear in commands/help
             ("about", "The brief type and use of this bot."),
             ("commands", "A short list of the supported commands."),
             ("help", "This help text."),
         ])
-        ["", "about", "commands", "help"]  # TODO: 'custom'
+        ["", "about", "commands", "help"]
 
         # Check command_list has supported commands
         for requested_command in command_list:
@@ -219,11 +219,14 @@ def dispatch_default_commands(self, message, command_list, meta, other_commands=
                 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(other_commands)
+                        cmd_list.update(OrderedDict([(c, h[0]) for c, h in other_commands.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]()
         return None
 
 def extract_query_without_mention(message, client):