Adapted to changes in main branch

Author: euribates

.gitignore

@@ -7,3 +7,4 @@ virtualenv
 .DS_Store
 .env
 .pytest_cache
+.python-version

Pipfile

@@ -9,10 +9,19 @@ Telegram Bot made in Python to automate different tasks of [Python Canarias](htt
 
 ## Installation
 
-Create the virtualenv for Python3 and install dependencies with:
+Create a virtualenv for Python3 and install dependencies. In this
+example we are using pyenv:
 
 ~~~console
-$ pipenv install
+$ pyenv virtualenv 3.12.4 pydeckard
+$ pyenv activate pydeckard
+$ pip install -r requirements.txt
+~~~
+
+A developer needs to install a few more packages:
+
+~~~console
+$ pip install -r dev-requirements.txt
 ~~~
 
 Next step is to set your bot token for development:
@@ -27,9 +36,17 @@ Now you can launch the bot with:
 $ python bot.py
 ~~~
 
+You can use the flag `--verbose` (or `-v') to get more information in rhe console:
+
+~~~console
+$ python bot.py --verbose
+~~~
+
+
 ## Tests
 
+Use pytest:
+
 ~~~console
-$ pipenv install --dev
-$ pytest
+$ python -m pytest
 ~~~

Pipfile.lock

@@ -1,111 +1,165 @@
+#!/usr/bin/enb python3
+
+from datetime import datetime as DateTime
+import argparse
 import logging
-from time import sleep
+import sys
+import time
 
 import telegram
-from telegram.ext import Updater, Filters, MessageHandler, CommandHandler
 from telegram import Update
+from telegram.ext import ApplicationBuilder, filters, MessageHandler, CommandHandler, ContextTypes
+from telegram.constants import ParseMode
 
 import config
 import utils
 
 
-logger = logging.getLogger('bot')
-
-
-def command_start(update, context):
-    logger.info('Received command /start')
-    context.bot.send_message(chat_id=update.message.chat_id, text=config.BOT_GREETING)
-
-
-def command_help(update, context):
-    logger.info('Received command /help')
-    context.bot.send_message(
-        chat_id=update.message.chat_id,
-        text="Available commands:\n"
-        " - /start - start intereaction with the bot\n"
-        " - /help - Show commands\n"
-        " - /status - Show status and alive time\n"
-        )
-
-
-def command_status(update, context):
-    logger.info('bot asked to execute /status commamd')
-    context.bot.send_message(
-        chat_id=update.message.chat_id,
-        text=f'Status is OK, running since {utils.since()}',
-    )
-
-
-def welcome(update: Update, context):
-    logger.info('Received new user event')
-    new_member = update.message.new_chat_members[0]
-
-    logger.info(f'Waiting {config.WELCOME_DELAY} seconds until user completes captcha...')
-    sleep(config.WELCOME_DELAY)
-    membership_info = context.bot.get_chat_member(update.message.chat_id, new_member.id)
-    if membership_info['status'] == 'left':
-        logger.info(f'Skipping welcome message, user {new_member.name} is no longer in the chat')
-        return
-
-    logger.info(f'send welcome message for {new_member.name}')
-    msg = None
-
-    if new_member.is_bot:
-        msg = f"{new_member.name} is a *bot*!! " \
-              "-> It could be kindly removed 🗑"
-    else:
-        if utils.is_bot(new_member):
-            context.bot.delete_message(update.message.chat_id,
-                                       update.message.message_id)
-            if context.bot.kick_chat_member(update.message.chat_id, new_member.id):
-                msg = (f"*{new_member.username}* has been banned because I "
-                       "considered it was a bot. ")
+class DeckardBot():
+
+    def __init__(self):
+        self.get_options()
+        self.set_logger()
+        self.started_at = DateTime.now()
+    
+    def get_options(self):
+        parser = argparse.ArgumentParser(
+            prog='bot',
+            description='PyDeckard Bot',
+            epilog='Text at the bottom of help',
+            )
+        parser.add_argument('-v', '--verbose', action='store_true')
+        args = parser.parse_args()
+        self.verbose = args.verbose
+
+    def set_logger(self):
+        self.logger = logging.getLogger('bot')
+        logging.basicConfig(
+            level=config.LOG_LEVEL,
+            format='%(asctime)s [%(name)s] %(levelname)s: %(message)s',
+            )
+        config.log(self.logger.info)
+
+    def trace(self, msg):
+        self.logger.info('bot asked to execute /status commamd')
+        if self.verbose:
+            print(msg)
+
+    async def command_status(self, update: Update, context: ContextTypes.DEFAULT_TYPE):
+        self.trace('bot asked to execute /status commamd')
+        python_version = sys.version.split(maxsplit=1)[0]
+        text = '\n'.join([
+            config.BOT_GREETING,
+            f'Status is <b>OK</b>, running since {utils.since(self.started_at)}',
+            f'Python version is {python_version}',
+            ])
+        await context.bot.send_message(
+            chat_id=update.effective_chat.id,
+            text=text,
+            parse_mode=ParseMode.HTML,
+            )
+        self.trace(text)
+
+    async def command_start(self, update: Update, context: ContextTypes.DEFAULT_TYPE):
+        self.trace('Received command /start')
+        await context.bot.send_message(
+            chat_id=update.effective_chat.id,
+            text=config.BOT_GREETING,
+            parse_mode=ParseMode.HTML,
+            )
+
+    async def command_help(self, update: Update, context: ContextTypes.DEFAULT_TYPE):
+        self.trace('Received command /help')
+        await context.bot.send_message(
+            chat_id=update.effective_chat.id,
+            text=(
+                "Available commands:\n\n"
+                "<code>/start</code> : start intereaction with the bot\n"
+                "<code>/help</code> : Show commands\n"
+                "<code>/status</code> : Show status and alive time\n"
+                "<code>/zen</code> : Show the Zen of Python\n"
+                ),
+            parse_mode=ParseMode.HTML,
+            )
+
+    async def command_zen(self, update: Update, context: ContextTypes.DEFAULT_TYPE):
+        self.trace('Received command /zen')
+        text = '\n'.join(config.THE_ZEN_OF_PYTHON)
+        await context.bot.send_message(
+            chat_id=update.effective_chat.id,
+            text=text,
+            parse_mode=ParseMode.HTML,
+            )
+
+    async def welcome(self, update: Update, context):
+        logger.info('Received new user event')
+        new_member = update.message.new_chat_members[0]
+
+        self.trace(f'Waiting {config.WELCOME_DELAY} seconds until user completes captcha...')
+        time.sleep(config.WELCOME_DELAY)
+        membership_info = await context.bot.get_chat_member(update.message.chat_id, new_member.id)
+        if membership_info['status'] == 'left':
+            self.trace(f'Skipping welcome message, user {new_member.name} is no longer in the chat')
+            return
+
+        self.trace(f'send welcome message for {new_member.name}')
+        msg = None
+
+        if new_member.is_bot:
+            msg = f"{new_member.name} is a *bot*\\!\\! " \
+                  "-> It could be kindly removed 🗑"
         else:
-            msg = f"Welcome {new_member.name}!! " \
-                   "I am a friendly and polite *bot* 🤖"
-    if msg:
-        context.bot.send_message(
-            chat_id=update.message.chat_id,
-            text=msg,
-            parse_mode=telegram.ParseMode.MARKDOWN
-        )
-
-
-def reply(update, context):
-    if not config.bot_replies_enabled():
-        return
-
-    msg = update.message.text
-    reply_spec = utils.triggers_reply(msg) if msg else None
-    if reply_spec is not None:
-        logger.info(f'bot sends reply {reply_spec.reply}')
-        context.bot.send_message(
-            chat_id=update.message.chat_id,
-            text=reply_spec.reply
-        )
-
-
-def main():
-    logging.basicConfig(
-        level=config.LOG_LEVEL,
-        format='%(asctime)s [%(name)s] %(levelname)s: %(message)s',
-        )
-    logger.info('Starting bot...')
-    config.log(logger.info)
-    updater = Updater(config.TELEGRAM_BOT_TOKEN)
-    dp = updater.dispatcher
-
-    dp.add_handler(CommandHandler('start', command_start))
-    dp.add_handler(CommandHandler('help', command_help))
-    dp.add_handler(CommandHandler('status', command_status))
-    dp.add_handler(MessageHandler(Filters.status_update.new_chat_members,
-                                  welcome, run_async=True))
-    dp.add_handler(MessageHandler(Filters.chat_type.groups, reply))
-
-    logger.info('Bot is ready')
-    updater.start_polling(poll_interval=config.POLL_INTERVAL)
-    updater.idle()
+            if utils.is_bot(new_member):
+                await context.bot.delete_message(update.message.chat_id,
+                                           update.message.message_id)
+                if await context.bot.kick_chat_member(update.message.chat_id, new_member.id):
+                    msg = (f"*{new_member.username}* has been banned because I "
+                           "considered it was a bot. ")
+            else:
+                msg = f"Welcome {new_member.name}\\!\\! " \
+                       "I am a friendly and polite *bot* 🤖"
+        if msg:
+            await update.message.reply_text(msg, parse_mode=telegram.constants.ParseMode('MarkdownV2'))
+
+    async def reply(self, update: Update, context: ContextTypes.DEFAULT_TYPE):
+        if config.bot_replies_enabled():
+            msg = update.message.text
+            reply_spec = utils.triggers_reply(msg) if msg else None
+            if reply_spec is not None:
+                logger.info(f'bot sends reply {reply_spec.reply}')
+                await update.message.reply_text(reply_spec.reply)
+                context.bot.send_message(
+                    chat_id=update.message.chat_id,
+                    text=reply_spec.reply
+                )
+
+    def run(self):
+        self.trace('Starting bot...')
+        application = ApplicationBuilder().token(config.TELEGRAM_BOT_TOKEN).build()
+        start_handler = CommandHandler('start', self.command_start)
+        application.add_handler(start_handler)
+        help_handler = CommandHandler('help', self.command_help)
+        application.add_handler(help_handler)
+        status_handler = CommandHandler('status', self.command_status)
+        application.add_handler(status_handler)
+
+        # Zen Command
+        application.add_handler(CommandHandler('zen', self.command_zen))
+
+        welcome_handler = MessageHandler(
+            filters.StatusUpdate.NEW_CHAT_MEMBERS,
+            self.welcome,
+            )
+        application.add_handler(welcome_handler)
+        reply_handler = MessageHandler(
+            filters.TEXT & (~filters.COMMAND),
+            self.reply,
+            )
+        application.add_handler(reply_handler)
+        self.trace('Bot is ready')
+        application.run_polling(poll_interval=config.POLL_INTERVAL)
 
 
 if __name__ == "__main__":
-    main()
+    bot = DeckardBot()
+    bot.run()