Refactoring

Author: BushlanovDev

README.md

@@ -1,6 +1,9 @@
 # 🤖 Aiogram Fastapi Bot Template
 
-[![Actions status](https://github.com/BushlanovDev/aiogram-fastapi-bot-template/actions/workflows/check.yml/badge.svg)](https://github.com/BushlanovDev/aiogram-fastapi-bot-template/actions) [![Python](https://img.shields.io/badge/Python-3.12%2B-brightgreen)](https://www.python.org/downloads/) [![Aiogram](https://img.shields.io/badge/aiogram-3.17-brightgreen)](https://pypi.org/project/aiogram/)
+[![Actions status](https://github.com/BushlanovDev/aiogram-fastapi-bot-template/actions/workflows/check.yml/badge.svg)](https://github.com/BushlanovDev/aiogram-fastapi-bot-template/actions) 
+[![Python](https://img.shields.io/badge/Python-3.12%2B-brightgreen)](https://www.python.org/downloads/) 
+[![Aiogram](https://img.shields.io/badge/aiogram-3.17-brightgreen)](https://pypi.org/project/aiogram/)
+[![MIT license](http://img.shields.io/badge/license-MIT-brightgreen.svg)](LICENSE)
 
 A simple template for creating a telegram bot on webhooks using the **aiogram** and **fastapi**
 
@@ -39,3 +42,7 @@ Run bot `python main.py` or `docker compose up -d`
 | middlewares | Middlewares for localization, throttling |
 | services    | Custom libraries                         |
 | states      | State objects                            |
+
+## 📄 License
+
+This repository's source code is available under the [MIT License](LICENSE).

bot/handlers/handlers.py

@@ -4,26 +4,22 @@
 from aiogram.types import CallbackQuery, Message
 
 from bot.callbacks.callback import SaveCallbackFactory
-from bot.i18n.lexicon import Lexicon
-from bot.keyboards.keyboards import Keyboards
-from bot.services.bot_service import BotService
+from bot.services.context import HandlerContext
 from bot.states.bot_state import BotState
 
 
 class Handlers:
-    def __init__(self, bot: Bot, kb: Keyboards, bot_service: BotService):
+    def __init__(self, bot: Bot):
         self.bot = bot
-        self.kb = kb
-        self.bot_service = bot_service
 
-    async def start_command(self, message: Message, lexicon: Lexicon, user_lang: str | None):
+    async def start_command(self, message: Message, ctx: HandlerContext, user_lang: str | None):
         await message.answer(
-            text=lexicon.get_text('Hi user! This start message.', user_lang),
-            reply_markup=self.kb.get_start_button(),
+            text=ctx.lexicon.get_text('Hi user! This start message.', user_lang),
+            reply_markup=ctx.keyboards.get_start_button(ctx.lexicon, user_lang),
         )
 
-    async def help_command(self, message: Message, lexicon: Lexicon, user_lang: str | None):
-        await message.answer(text=lexicon.get_text('This help message.', user_lang))
+    async def help_command(self, message: Message, ctx: HandlerContext, user_lang: str | None):
+        await message.answer(text=ctx.lexicon.get_text('This help message.', user_lang))
 
     async def answer(self, message: Message, answer: str):
         await self.__send_message(message.chat.id, answer, message.message_id)
@@ -40,18 +36,18 @@ async def answer_fsm_state_1(self, message: Message, state: FSMContext):
     async def answer_fsm_state_2(self, message: Message, state: FSMContext):
         await state.update_data(step_2=message.text)
         data = await state.get_data()
-        await message.answer(f"Step 1: {data['step_1']}\nStep 2: {data['step_2']}")
+        await message.answer(f'Step 1: {data["step_1"]}\nStep 2: {data["step_2"]}')
         await state.clear()
 
-    async def answer_inline_button(self, message: Message, lexicon: Lexicon):
+    async def answer_inline_button(self, message: Message, ctx: HandlerContext, user_lang: str | None):
         callback = SaveCallbackFactory(message_id=message.message_id).pack()
         await message.answer(
-            text=lexicon.get_text('Inline button message'),
-            reply_markup=self.kb.get_inline_button(callback_data=callback),
+            text=ctx.lexicon.get_text('Inline button message'),
+            reply_markup=ctx.keyboards.get_inline_button(ctx.lexicon, user_lang, callback),
         )
 
-    async def reply(self, message: Message):
-        await message.reply(text=self.bot_service.upper(message.text))
+    async def reply(self, message: Message, ctx: HandlerContext):
+        await message.reply(text=ctx.bot_service.upper(message.text))
 
     async def process_any_inline_button_press(self, callback: CallbackQuery, callback_data: SaveCallbackFactory):
         await callback.message.answer(text=callback_data.pack())

bot/i18n/ru.py

@@ -1,4 +1,6 @@
 LEXICON_RU: dict[str, str] = {
+    'hi': 'привет',
+    'Save': 'Сохранить',
     'Hi user! This start message.': 'Привет, пользователь! Это стартовое сообщение.',
     'This help message.': 'Это справочное сообщение.',
 }

bot/keyboards/keyboards.py

@@ -1,22 +1,26 @@
 from aiogram.types import InlineKeyboardButton, InlineKeyboardMarkup, KeyboardButton, ReplyKeyboardMarkup
 
+from bot.i18n.lexicon import Lexicon
+
 
 class Keyboards:
     def __init__(self):
         pass
 
-    def get_start_button(self) -> ReplyKeyboardMarkup:
+    def get_start_button(self, lexicon: Lexicon, user_lang: str | None) -> ReplyKeyboardMarkup:
         kb_list = [
-            [KeyboardButton(text='hi'), KeyboardButton(text='test')],
+            [KeyboardButton(text=lexicon.get_text('hi', user_lang)), KeyboardButton(text='test')],
             [KeyboardButton(text='inline button'), KeyboardButton(text='fsm')],
         ]
 
         return ReplyKeyboardMarkup(keyboard=kb_list, resize_keyboard=True, one_time_keyboard=True)
 
-    def get_inline_button(self, callback_data: str | None = None) -> InlineKeyboardMarkup:
+    def get_inline_button(
+        self, lexicon: Lexicon, user_lang: str | None, callback_data: str | None = None
+    ) -> InlineKeyboardMarkup:
         inline_kb_list = [
             [
-                InlineKeyboardButton(text='Save', callback_data=callback_data),
+                InlineKeyboardButton(text=lexicon.get_text('Save', user_lang), callback_data=callback_data),
             ],
         ]
 

bot/middlewares/context.py

@@ -0,0 +1,14 @@
+from aiogram import BaseMiddleware
+
+from bot.services.context import HandlerContext
+
+
+class ContextMiddleware(BaseMiddleware):
+    async def __call__(self, handler, event, data):
+        data['ctx'] = HandlerContext(
+            lexicon=data['lexicon'],
+            keyboards=data['keyboards'],
+            bot_service=data['bot_service'],
+        )
+
+        return await handler(event, data)

bot/services/context.py

@@ -0,0 +1,12 @@
+from dataclasses import dataclass
+
+from bot.i18n.lexicon import Lexicon
+from bot.keyboards.keyboards import Keyboards
+from bot.services.bot_service import BotService
+
+
+@dataclass
+class HandlerContext:
+    lexicon: Lexicon
+    keyboards: Keyboards
+    bot_service: BotService

main.py

@@ -17,6 +17,7 @@
 from bot.handlers.handlers import Handlers
 from bot.i18n.lexicon import Lexicon
 from bot.keyboards.keyboards import Keyboards
+from bot.middlewares.context import ContextMiddleware
 from bot.middlewares.i18n import I18nMiddleware
 from bot.middlewares.throttling import ThrottlingMiddleware
 from bot.services.bot_service import BotService
@@ -92,10 +93,19 @@ def register_handlers(dp: Dispatcher, hd: Handlers) -> None:
 def register_middlewares(dp: Dispatcher) -> None:
     dp.update.outer_middleware(I18nMiddleware())
     dp.update.outer_middleware(ThrottlingMiddleware())
+    dp.update.outer_middleware(ContextMiddleware())
 
 
 def register_workflow_data(dp: Dispatcher, settings: Settings) -> None:
     dp.workflow_data.update({'answer': 'Hello', 'lexicon': Lexicon(settings.app.default_language)})
+    dp.workflow_data.update(
+        {
+            'answer': 'Hello',
+            'lexicon': Lexicon(settings.app.default_language),
+            'keyboards': Keyboards(),
+            'bot_service': BotService(),
+        }
+    )
 
 
 def create_app(bot: Bot, dp: Dispatcher, settings: App) -> FastAPI:
@@ -115,9 +125,9 @@ def main() -> None:
     bot = create_bot(settings.tg_bot)
     dp = create_dispatcher(MemoryStorage())
     app = create_app(bot, dp, settings.app)
-    register_handlers(dp, Handlers(bot, Keyboards(), BotService()))
-    register_middlewares(dp)
+    register_handlers(dp, Handlers(bot))
     register_workflow_data(dp, settings)
+    register_middlewares(dp)
 
     logger.debug('Application is running')