Add the bot.link_preview_in_help attribute

This new attribute allows you to disable the preview of links on
the /help command.

Author: paolobarbolini

botogram/bot.py

@@ -38,6 +38,8 @@ def __init__(self, api_connection):
         self.before_help = []
         self.after_help = []
 
+        self.link_preview_in_help = True
+
         self.process_backlog = False
 
         self._lang = ""
@@ -218,8 +220,9 @@ def freeze(self):
 
         return frozenbot.FrozenBot(self.api, self.about, self.owner,
                                    self._hide_commands, self.before_help,
-                                   self.after_help, self.process_backlog,
-                                   self.lang, self.itself, self._commands_re,
+                                   self.after_help, self.link_preview_in_help,
+                                   self.process_backlog, self.lang,
+                                   self.itself, self._commands_re,
                                    self._commands, chains, self._scheduler,
                                    self._main_component._component_id,
                                    self._bot_id, self._shared_memory,

botogram/defaults.py

@@ -60,7 +60,8 @@ def help_command(self, bot, chat, args):
         else:
             message = self._help_generic_message(bot, commands)
 
-        chat.send("\n".join(message), syntax="html")
+        chat.send("\n".join(message), syntax="html",
+                  preview=bot.link_preview_in_help)
 
     def _help_generic_message(self, bot, commands):
         """Generate an help message"""

botogram/frozenbot.py

@@ -21,9 +21,9 @@ class FrozenBot:
     """A frozen version of botogram.Bot"""
 
     def __init__(self, api, about, owner, hide_commands, before_help,
-                 after_help, process_backlog, lang, itself, commands_re,
-                 commands, chains, scheduler, main_component_id, bot_id,
-                 shared_memory, update_processors):
+                 after_help, link_preview_in_help, process_backlog, lang,
+                 itself, commands_re, commands, chains, scheduler,
+                 main_component_id, bot_id, shared_memory, update_processors):
         # This attribute should be added with the default setattr, because is
         # needed by the custom setattr
         object.__setattr__(self, "_frozen", False)
@@ -35,6 +35,7 @@ def __init__(self, api, about, owner, hide_commands, before_help,
         self._hide_commands = hide_commands
         self.before_help = before_help
         self.after_help = after_help
+        self.link_preview_in_help = link_preview_in_help
         self.process_backlog = process_backlog
         self.lang = lang
         self._commands_re = commands_re
@@ -63,10 +64,11 @@ def __init__(self, api, about, owner, hide_commands, before_help,
     def __reduce__(self):
         args = (
             self.api, self.about, self.owner, self._hide_commands,
-            self.before_help, self.after_help, self.process_backlog,
-            self.lang, self.itself, self._commands_re, self._commands,
-            self._chains, self._scheduler, self._main_component_id,
-            self._bot_id, self._shared_memory, self._update_processors,
+            self.before_help, self.after_help, self.link_preview_in_help,
+            self.process_backlog, self.lang, self.itself, self._commands_re,
+            self._commands, self._chains, self._scheduler,
+            self._main_component_id, self._bot_id, self._shared_memory,
+            self._update_processors,
         )
         return restore, args
 

docs/api/bot.rst

@@ -54,6 +54,12 @@ components.
       A list of strings to be inserted in the ``/help`` messages. These ones
       will be inserted after the commands list.
 
+   .. py:attribute:: link_preview_in_help
+
+      Disable link preview in the ``/help`` messages.
+
+      .. versionadded:: 0.4
+
    .. py:attribute:: process_backlog
 
       A boolean representing if the backlog should be processed. Backlog is

docs/changelog/0.4.rst

@@ -19,6 +19,10 @@ Release description not yet written.
 New features
 ------------
 
+* Added ability to disable the link preview in ``/help``.
+
+  * New parameter :py:attr:`botogram.Bot.link_preview_in_help`
+
 * Added ability to reorder commands in ``/help``.
 
   * New argument ``order`` in :py:meth:`botogram.Bot.command`