Refactor: improve code formatting and logging consistency across multiple files

Author: AlexTkDev

handlers/planner.py

@@ -1,14 +1,13 @@
+import re
 from aiogram import Router, types, F
 from aiogram.filters import Command
 from aiogram.fsm.context import FSMContext
 from aiogram.fsm.state import State, StatesGroup
 from aiogram.types.message import Message
-
 from services.llm import generate_study_plan, translate_text
 from services.pdf import save_plan_to_pdf
 from services.txt import save_plan_to_txt
 from services.db import save_user_plan, get_user_plan, get_user_language
-import re
 
 router = Router()
 
@@ -38,7 +37,9 @@ async def handle_topic(message: types.Message, state: FSMContext):
     topic = message.text.strip()
 
     # Send waiting message
-    await send_translated(message, "⏳ Please wait a moment. Generating your study plan...")
+    await send_translated(
+        message, "⏳ Please wait a moment. Generating your study plan..."
+    )
 
     # Send "typing" action to show the bot is working
     if message.bot and message.chat and message.chat.id:
@@ -62,21 +63,26 @@ async def handle_topic(message: types.Message, state: FSMContext):
     await state.set_state(PlanFormat.waiting_for_format)
     user_id = message.from_user.id if message.from_user else 0
     user_lang = get_user_language(user_id) or "en"
-    prompt = await translate_text("In which format do you want to save the plan?", user_lang)
+    prompt = await translate_text(
+        "In which format do you want to save the plan?", user_lang
+    )
     await send_translated(message, prompt)
     keyboard = types.InlineKeyboardMarkup(
         inline_keyboard=[
             [
                 types.InlineKeyboardButton(
-                    text=await translate_text("📄 pdf", user_lang), callback_data="format_pdf"
+                    text=await translate_text("📄 pdf", user_lang),
+                    callback_data="format_pdf",
                 ),
                 types.InlineKeyboardButton(
-                    text=await translate_text("📄 txt", user_lang), callback_data="format_txt"
+                    text=await translate_text("📄 txt", user_lang),
+                    callback_data="format_txt",
                 ),
             ],
             [
                 types.InlineKeyboardButton(
-                    text=await translate_text("⏭ Skip", user_lang), callback_data="format_skip"
+                    text=await translate_text("⏭ Skip", user_lang),
+                    callback_data="format_skip",
                 )
             ],
         ]
@@ -135,27 +141,31 @@ async def show_next_actions(message: types.Message, state: FSMContext):
     await state.set_state(PlanFormat.waiting_for_next_action)
     user_id = message.from_user.id if message.from_user else 0
     user_lang = get_user_language(user_id) or "en"
-    await send_translated(message, await translate_text("What else would you like to do?", user_lang))
+    await send_translated(
+        message, await translate_text("What else would you like to do?", user_lang)
+    )
     keyboard = types.InlineKeyboardMarkup(
         inline_keyboard=[
             [
                 types.InlineKeyboardButton(
                     text=await translate_text("⏰ Schedule reminders", user_lang),
-                    callback_data="schedule_reminders"
+                    callback_data="schedule_reminders",
                 )
             ],
             [
                 types.InlineKeyboardButton(
                     text=await translate_text("🔄 Create a new plan", user_lang),
-                    callback_data="new_plan"
+                    callback_data="new_plan",
                 )
             ],
             [
                 types.InlineKeyboardButton(
-                    text=await translate_text("👋 Nothing, have a nice day!", user_lang),
-                    callback_data="goodbye"
+                    text=await translate_text(
+                        "👋 Nothing, have a nice day!", user_lang
+                    ),
+                    callback_data="goodbye",
                 )
-            ]
+            ],
         ]
     )
     await message.answer("Choose your next action:", reply_markup=keyboard)
@@ -254,13 +264,13 @@ async def send_translated(message, text):
     if user_lang != "en":
         text = await translate_text(text, user_lang)
     # Clean/escape unsupported HTML/Markdown links and tags
-    text = re.sub(r'<(https?://[^>]+)>', r'\1', text)
-    text = re.sub(r'<([^ >]+)>', r'\1', text)
+    text = re.sub(r"<(https?://[^>]+)>", r"\1", text)
+    text = re.sub(r"<([^ >]+)>", r"\1", text)
     # If text is empty or only whitespace, send an informative message
-    if not text or text.strip() == '':
+    if not text or text.strip() == "":
         await message.answer("[Error] Empty text for user message.")
         return
     # If text is longer than Telegram limit, split into parts
     max_len = 4096
     for i in range(0, len(text), max_len):
-        await message.answer(text[i:i+max_len])
+        await message.answer(text[i : i + max_len])

handlers/start.py

@@ -8,11 +8,12 @@
 
 router = Router()
 
+
 @router.message(Command("start"))
 async def start_handler(message: types.Message, state: FSMContext):
     await send_translated(
         message,
-        "👋 Hi! I am a bot for creating study plans.\nUse the /plan command to start creating a study plan."
+        "👋 Hi! I am a bot for creating study plans.\nUse the /plan command to start creating a study plan.",
     )
     # Immediately prompt for language selection
     user_id = message.from_user.id if message.from_user else 0

services/llm.py

@@ -85,7 +85,7 @@ async def generate_study_plan(topic: str) -> list:
     try:
         return await generate_groq_plan(topic)
     except Exception as e:
-        logger.error(f"Groq fallback error: {e}")
+        logger.error("Groq fallback error: %s", e)
     # Fallback: local
     return generate_local_plan(topic)
 
@@ -96,7 +96,7 @@ async def translate_text(text: str, target_lang: str) -> str:
         f"Translate the following text to {target_lang}. "
         f"Output only the translation, no explanations, no extra text.\n{text}"
     )
-    logger.info(f"Translating to {target_lang}: {text}")
+    logger.info("Translating to %s: %s", target_lang, text)
     # Try OpenAI
     if OPENAI_API_KEY and client is not None:
         try:
@@ -105,7 +105,7 @@ async def translate_text(text: str, target_lang: str) -> str:
                 messages=[{"role": "user", "content": prompt}],
             )
             translated = response.choices[0].message.content
-            logger.info(f"OpenAI translation result: {translated}")
+            logger.info("OpenAI translation result: %s", translated)
             if translated:
                 return translated.strip()
         except Exception:  # pylint: disable=broad-exception-caught
@@ -114,7 +114,7 @@ async def translate_text(text: str, target_lang: str) -> str:
     try:
         return await groq_translate_text(text, target_lang)
     except Exception as e:
-        logger.error(f"Groq translation fallback error: {e}")
+        logger.error("Groq translation fallback error: %s", e)
     return text
 
 async def generate_groq_plan(topic: str) -> list:

tests/test_start_handler.py

@@ -16,13 +16,22 @@ def __init__(self):
         self.chat = type("Chat", (), {"id": 1})()
         self.from_user = type("User", (), {"id": 1})()
         self.answer_text = None
-    async def answer(self, text):
+        self.all_answers = []
+    async def answer(self, text, *_args, **_kwargs):
         self.answer_text = text
+        self.all_answers.append(text)
         return text
 
+class DummyState:
+    """Dummy state for testing purposes."""
+    async def set_state(self, *_args, **_kwargs):
+        pass
+    async def clear(self):
+        pass
+
 @pytest.mark.asyncio
 async def test_start_handler():
     message = DummyMessage()
-    await start_handler(message)
-    assert message.answer_text is not None
-    assert "bot for creating study plans" in message.answer_text 
+    state = DummyState()
+    await start_handler(message, state)
+    assert any("bot for creating study plans" in msg for msg in message.all_answers)