lint and convert to modular server

Author: manavmehta

.github/workflows/pylint.yml

@@ -0,0 +1,23 @@
+name: Pylint
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10"]
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install pylint
+    - name: Analysing the code with pylint
+      run: |
+        pylint $(git ls-files '*.py')

README.md

@@ -17,6 +17,7 @@ pip install -r requirements.txt
 ```python
 python app.py
 ```
+
 # Instructions to add Mallya to your Telegram
 * Add Mallya to your Telegram by clicking [this link](https://t.me/MallyaBot)
 * Chat with the King of good times

app.py

@@ -1,54 +1,85 @@
 #!/usr/bin/env python3
+"""
+primary entry point to the bot backend
+"""
 
-import threading
+import os
 import time
+import signal
+import logging
 from collections import OrderedDict
-import os
-import telebot
+from concurrent.futures import ThreadPoolExecutor
 import dotenv
+import telebot
+from telebot.types import Update
 import utils
 
+# Load environment variables
 dotenv.load_dotenv()
 TOKEN = os.getenv("TOKEN")
 
+# Initialize the bot
 bot = telebot.TeleBot(TOKEN)
 
+# Initialize update ID dictionary and logger
 updateid_dict = OrderedDict()
+logging.basicConfig(
+    level=logging.INFO, format="%(asctime)s - %(levelname)s - %(message)s"
+)
+
+# Define maximum threads and updates to fetch
+MAX_THREADS = 10
+MAX_UPDATES = 100
+
+# Initialize the thread pool
+executor = ThreadPoolExecutor(max_workers=MAX_THREADS)
+
 
+def fetch_updates(offset):
+    """
+    Fetch updates from the Telegram server.
+    """
+    return (
+        bot.get_updates()
+        if offset is None
+        else bot.get_updates(offset, MAX_UPDATES, timeout=20)
+    )
 
-def index():
+
+def process_update(update: Update):
     """
-    Main function that is responsible to run the server.
+    Process an incoming update.
     """
+    if update.update_id not in updateid_dict:
+        updateid_dict[update.update_id] = time.time()
+        try:
+            executor.submit(utils.address_query, update)
+        except Exception as exception:
+            logging.error(
+                "Unable to process update {%s}: {%s}", update.update_id, exception
+            )
+
+        if len(updateid_dict) > 50:
+            updateid_dict.popitem(last=False)
 
+
+def run_bot():
+    """
+    Main function that runs the bot.
+    """
+    logging.info("Bot is starting...")
     last_update_id = None
 
-    # Keep Listening to incoming requests
     while True:
-        # The following conditional ensures fetching of latest 50 updates
-        updates_list = None
-        if last_update_id is None:
-            updates_list = bot.get_updates()
-        else:
-            updates_list = bot.get_updates(last_update_id, 100, 20)
-
-        for update in updates_list:
-            last_update_id = update.update_id
-
-            if update.update_id not in updateid_dict.keys():
-                updateid_dict[update.update_id] = time.time()
-                try:
-                    new_thread = threading.Thread(
-                        target=utils.address_query, args=(update,)
-                    )
-                    new_thread.start()
-                except Exception as exception:
-                    print("Unable to create a thread")
-                    raise exception
-
-                if len(updateid_dict.keys()) > 50:
-                    updateid_dict.pop(list(updateid_dict.keys())[0])
+        try:
+            updates_list = fetch_updates(last_update_id)
+            for update in updates_list:
+                last_update_id = update.update_id
+                process_update(update)
+        except Exception as e:
+            logging.error("Error while fetching or processing updates: {%s}", e)
+            time.sleep(5)  # Sleep for a bit before retrying
 
 
 if __name__ == "__main__":
-    index()
+    run_bot()

commands.py

@@ -1,10 +1,11 @@
 """
 default commands for the bot
 """
+
 commands = {
-    'start': 'Hello there {}! I am a bot sent by the heavens to be yours. Type /help and know what I can do for you.',
-    'hi':'Hello there {}!',
-    'hello':'Hello there {}!',
-    'hey':'Hello there {}!',
-    'help': 'Hey, {}. I see you sought my help.\n\nI know the following commands:\n/Hi, /Hey, /Hello - They\'re pretty much the same😬\n/Help - To know how I can help you.\n\n/q followed by your query - regarding IIT Mandi. \ne.g:\n/q What all facilities are available in campus?\n\nFor General questions you can just ask straight-away.\ne.g:\nWhat is your name\nTell me a joke\n\nYou can also use /u, /d and /n to upvote, downvote and get the next answer respectively. These three are only valid when you ask a query.'
+    "start": "Hello there {}! I am a bot sent by the heavens to be yours. Type /help and know what I can do for you.",
+    "hi": "Hello there {}!",
+    "hello": "Hello there {}!",
+    "hey": "Hello there {}!",
+    "help": "Hey, {}. I see you sought my help.\n\nI know the following commands:\n/Hi, /Hey, /Hello - They're pretty much the same😬\n/Help - To know how I can help you.\n\n/q followed by your query - regarding IIT Mandi. \ne.g:\n/q What all facilities are available in campus?\n\nFor General questions you can just ask straight-away.\ne.g:\nWhat is your name\nTell me a joke\n\nYou can also use /u, /d and /n to upvote, downvote and get the next answer respectively. These three are only valid when you ask a query.",
 }

db.py

@@ -1,3 +1,7 @@
+"""
+program to setup db
+"""
+
 import os
 import logging
 import dotenv
@@ -11,6 +15,7 @@
 
 logger = logging.getLogger(__name__)
 
+
 def init_db():
     """
     Initializes the database client and returns a reference to the database.
@@ -112,12 +117,17 @@ def update_vote_qna(vote_type: str, answer: str):
     """
     try:
         qna = get_collection(DB, "qna")
-        where_clause = {'answers.answer': answer}
-        update_clause = {"$inc": {"answers.$.upvotes": 1}} if vote_type == "u" else {"$inc": {"answers.$.downvotes": 1}}
+        where_clause = {"answers.answer": answer}
+        update_clause = (
+            {"$inc": {"answers.$.upvotes": 1}}
+            if vote_type == "u"
+            else {"$inc": {"answers.$.downvotes": 1}}
+        )
         qna.update_one(where_clause, update_clause)
     except Exception as exception:
         logger.exception("Error updating vote count for answer: %s", answer)
         raise exception
 
+
 global DB
 DB = init_db()

requirements.txt

@@ -3,4 +3,4 @@ pyTelegramBotAPI==4.11.0
 python-dotenv
 tensorflow_hub
 tensorflow
-urllib3==1.26.6
+urllib3==1.26.18

resources/populateDB.py

@@ -1,8 +1,10 @@
 import sys
-sys.path.append('..')
+
+sys.path.append("..")
 from db import *
 from pprint import pprint
 
+
 def restructureQnA():
     collection = get_collection(DB, "qna")
     all_documents = collection.find()
@@ -18,7 +20,11 @@ def restructureQnA():
 
         # if the question is not in the dictionary, add it
         if question not in question_answer_dict:
-            question_answer_dict[question] = {"_id": document["_id"], "question": question, "answers": [answer]}
+            question_answer_dict[question] = {
+                "_id": document["_id"],
+                "question": question,
+                "answers": [answer],
+            }
         else:
             # if the question is already in the dictionary, add the answer to the list of answers
             question_answer_dict[question]["answers"].append(answer)
@@ -29,10 +35,15 @@ def restructureQnA():
     # update the documents to add upvotes and downvotes to each answer
     for document in combined_documents:
         for answer_index, answer in enumerate(document["answers"]):
-            document["answers"][answer_index] = {"answer": answer, "upvotes": 0, "downvotes": 0}
+            document["answers"][answer_index] = {
+                "answer": answer,
+                "upvotes": 0,
+                "downvotes": 0,
+            }
     pprint(combined_documents)
     # insert the updated documents into the collection
     collection.delete_many({})
     collection.insert_many(combined_documents)
 
-restructureQnA()
+
+restructureQnA()