Add ability to reorder commands in /help

This commit adds the optional `order` argument to the @Bot.command
decorator, allowing you to reorder commands in `/help`.

    @bot.command("test", order=5)
    def test_commad(chat, message, args):
        """I'm the fifth!"""
        chat.send("I'm the fifth!")

Author: paolobarbolini

botogram/bot.py

@@ -142,11 +142,11 @@ def message_edited(self, func):
         self._main_component.add_message_edited_hook(func)
         return func
 
-    def command(self, name, hidden=False):
+    def command(self, name, hidden=False, order=0):
         """Register a new command"""
         def __(func):
             self._main_component.add_command(name, func, hidden,
-                                             _from_main=True)
+                                             order=order, _from_main=True)
             return func
         return __
 

botogram/commands.py

@@ -14,6 +14,7 @@ def __init__(self, hook, _bot=None):
         # Get some parameters from the hook
         self.name = hook._name
         self.hidden = hook._hidden
+        self.order = hook._order
 
         self._hook = hook
         self._component_id = hook.component_id

botogram/components.py

@@ -97,7 +97,7 @@ def add_message_matches_hook(self, regex, func, flags=0, multiple=False):
         })
         self.__processors.append(hook)
 
-    def add_command(self, name, func, hidden=False, _from_main=False):
+    def add_command(self, name, func, hidden=False, order=0, _from_main=False):
         """Register a new command"""
         if name in self.__commands:
             raise NameError("The command /%s already exists" % name)
@@ -113,6 +113,7 @@ def add_command(self, name, func, hidden=False, _from_main=False):
         hook = hooks.CommandHook(func, self, {
             "name": name,
             "hidden": hidden,
+            "order": order,
         })
         command = commands.Command(hook)
         self.__commands[name] = command

botogram/defaults.py

@@ -45,12 +45,12 @@ def _start_command_help(bot):
     # /help command
 
     def help_command(self, bot, chat, args):
-        commands = {cmd.name: cmd for cmd in bot.available_commands()}
+        commands = list(bot.available_commands())
         if len(args) > 1:
             message = [bot._("<b>Error!</b> The <code>/help</code> command "
                              "allows up to one argument.")]
         elif len(args) == 1:
-            if args[0] in commands:
+            if any(cmd.name == args[0] for cmd in commands):
                 message = self._help_command_message(bot, commands, args[0])
             else:
                 message = [bot._("<b>Unknown command:</b> "
@@ -78,11 +78,12 @@ def _help_generic_message(self, bot, commands):
         # Show help on commands
         if len(commands) > 0:
             message.append(bot._("<b>This bot supports those commands:</b>"))
-            for name in sorted(commands.keys()):
-                summary = escape_html(commands[name].summary)
+            for command in commands:
+                summary = escape_html(command.summary)
                 if summary is None:
                     summary = "<i>%s</i>" % bot._("No description available.")
-                message.append("/%s <code>-</code> %s" % (name, summary))
+                message.append("/%s <code>-</code> %s" %
+                               (command.name, summary))
             message.append("")
             message.append(bot._("You can also use <code>/help &lt;command&gt;"
                                  "</code> to get help about a specific "
@@ -107,7 +108,8 @@ def _help_command_message(self, bot, commands, command):
         """Generate a command's help message"""
         message = []
 
-        docstring = escape_html(commands[command].docstring)
+        docstring = escape_html(next((cmd for cmd in commands if
+                                      cmd.name == command), None).docstring)
         if docstring is None:
             docstring = "<i>%s</i>" % bot._("No description available.")
         message.append("/%s <code>-</code> %s" % (command, docstring))

botogram/frozenbot.py

@@ -226,7 +226,10 @@ def _(self, message, **args):
 
     def available_commands(self, all=False):
         """Get a list of the commands this bot implements"""
-        for command in self._commands.values():
+        s = sorted(self._commands.values(), key=lambda command: command.name)
+        c = sorted(s, key=lambda command: command.order)
+
+        for command in c:
             # Remove `or command.name in self.hide_commands` in botogram 1.0
             is_hidden = command.hidden or command.name in self._hide_commands
             if all or not is_hidden:

botogram/hooks.py

@@ -174,6 +174,9 @@ def _after_init(self, args):
         self._hidden = False
         if "hidden" in args:
             self._hidden = args["hidden"]
+        self._order = 0
+        if "order" in args:
+            self._order = args["order"]
 
     def _call(self, bot, update):
         message = update.message

docs/api/bot.rst

@@ -188,7 +188,7 @@ components.
 
       .. versionadded:: 0.3
 
-   .. py:decoratormethod:: command(name, [hidden=False])
+   .. py:decoratormethod:: command(name, [hidden=False, order=0])
 
       This decorator register a new command, and calls the decorated function
       when someone issues the command in a chat. The command will also be added
@@ -208,6 +208,11 @@ components.
 
       :param str name: The name of the command.
       :param bool hidden: If the command should be hidden from ``/help``
+      :param int order: The order in which the commands are shown in ``/help``
+
+      .. versionchanged:: 0.4
+
+         Added the ``order`` argument.
 
       .. versionchanged:: 0.3
 

docs/api/components.rst

@@ -158,7 +158,7 @@ about how to create them in the ":ref:`custom-components`" chapter.
 
       .. versionadded:: 0.3
 
-   .. py:method:: add_command(name, func, [hidden=False])
+   .. py:method:: add_command(name, func, [hidden=False, order=0])
 
       This function registers a new command, and calls the provided function
       when someone issues the command in a chat. The command will also be added
@@ -185,6 +185,11 @@ about how to create them in the ":ref:`custom-components`" chapter.
       :param str name: The name of the command.
       :param callable func: The function you want to use.
       :param bool hidden: If the command should be hidden from ``/help``
+      :param int order: The order in which the commands are shown in ``/help``
+
+      .. versionchanged:: 0.4
+
+         Added the ``order`` argument.
 
       .. versionchanged:: 0.3
 

tests/test_frozenbot.py

@@ -52,7 +52,7 @@ def more(bot, a, c):
 
 def test_available_commands(bot):
     # Create a bunch of dummy commands
-    @bot.command("test1")
+    @bot.command("test1", order=10)
     def test1():
         pass
 
@@ -64,19 +64,19 @@ def test2():
     def test3():
         pass
 
-    assert {cmd.name for cmd in bot.available_commands()} == {
+    assert [cmd.name for cmd in bot.available_commands()] == [
         "help",
-        "test1",
         "test2",
-    }
+        "test1",
+    ]
 
-    assert {cmd.name for cmd in bot.available_commands(all=True)} == {
+    assert [cmd.name for cmd in bot.available_commands(all=True)] == [
         "help",
         "start",
-        "test1",
         "test2",
         "test3",
-    }
+        "test1",
+    ]
 
 
 def test_pickle_frozenbot(frozenbot):