Add localization

Author: BushlanovDev

.env.example

@@ -2,5 +2,6 @@ APP__DEBUG=true
 APP__PORT=8080
 APP__URL=https://my.domain
 APP__WEBHOOK_PATH=/webhook/tg
+APP__DEFAULT_LANGUAGE=en
 
 TG_BOT__TOKEN=

bot/configs/config.py

@@ -9,6 +9,7 @@ class App(BaseSettings):
     port: int = 8080
     url: str = 'https://my.domain'
     webhook_path: str = '/webhook/tg'
+    default_language: str = 'en'
 
 
 class TgBot(BaseSettings):

bot/handlers/handlers.py

@@ -4,6 +4,7 @@
 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.states.bot_state import BotState
@@ -15,11 +16,14 @@ def __init__(self, bot: Bot, kb: Keyboards, bot_service: BotService):
         self.kb = kb
         self.bot_service = bot_service
 
-    async def start_command(self, message: Message):
-        await message.answer(text='Hi user! This start message.', reply_markup=self.kb.get_start_button())
+    async def start_command(self, message: Message, lexicon: Lexicon, 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(),
+        )
 
-    async def help_command(self, message: Message):
-        await message.answer(text='This help message.')
+    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 answer(self, message: Message, answer: str):
         await self.__send_message(message.chat.id, answer, message.message_id)
@@ -39,9 +43,12 @@ async def answer_fsm_state_2(self, message: Message, state: FSMContext):
         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):
+    async def answer_inline_button(self, message: Message, lexicon: Lexicon):
         callback = SaveCallbackFactory(message_id=message.message_id).pack()
-        await message.answer(text='This help message', reply_markup=self.kb.get_inline_button(callback_data=callback))
+        await message.answer(
+            text=lexicon.get_text('Inline button message'),
+            reply_markup=self.kb.get_inline_button(callback_data=callback),
+        )
 
     async def reply(self, message: Message):
         await message.reply(text=self.bot_service.upper(message.text))

bot/i18n/en.py

@@ -0,0 +1 @@
+LEXICON_EN: dict[str, str] = {}

bot/i18n/lexicon.py

@@ -0,0 +1,21 @@
+from bot.i18n.en import LEXICON_EN
+from bot.i18n.ru import LEXICON_RU
+
+
+class Lexicon:
+    def __init__(self, default_language: str):
+        self.default_language = default_language
+
+    def get_text(self, param: str, lang: str | None = None) -> str:
+        if lang is None:
+            lang = self.default_language
+
+        match lang:
+            case 'ru':
+                ret = LEXICON_RU.get(param, param)
+            case 'en':
+                ret = LEXICON_EN.get(param, param)
+            case _:
+                ret = LEXICON_EN.get(param, param)
+
+        return ret

bot/i18n/ru.py

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

bot/middlewares/i18n.py

@@ -0,0 +1,22 @@
+from collections.abc import Awaitable, Callable
+from typing import Any
+
+from aiogram import BaseMiddleware
+from aiogram.types import TelegramObject, User
+
+
+class I18nMiddleware(BaseMiddleware):
+    async def __call__(
+            self,
+            handler: Callable[[TelegramObject, dict[str, Any]], Awaitable[Any]],
+            event: TelegramObject,
+            data: dict[str, Any],
+    ) -> Any:
+        user: User = data.get('event_from_user')
+
+        if user is None:
+            return await handler(event, data)
+
+        data['user_lang'] = user.language_code
+
+        return await handler(event, data)

bot/middlewares/throttling.py

@@ -8,7 +8,7 @@
 
 logger = logging.getLogger(__name__)
 
-CACHE = TTLCache(maxsize=10_000, ttl=2)  # Максимальный размер кэша - 10000 ключей, время жизни ключа - 5 секунд
+CACHE = TTLCache(maxsize=10_000, ttl=2)  # Максимальный размер кэша - 10000 ключей, время жизни ключа - 2 секунды
 
 
 class ThrottlingMiddleware(BaseMiddleware):
@@ -20,10 +20,11 @@ async def __call__(
     ) -> Any:
         user: User = data.get('event_from_user')
 
-        if user.id in CACHE:
-            logger.debug(f'Throttling for user {user.id}')
-            return
+        if user is not None:
+            if user.id in CACHE:
+                logger.debug(f'Throttling for user {user.id}')
+                return
 
-        CACHE[user.id] = True
+            CACHE[user.id] = True
 
         return await handler(event, data)

main.py

@@ -15,7 +15,9 @@
 from bot.callbacks.callback import SaveCallbackFactory
 from bot.configs.config import App, Settings, TgBot
 from bot.handlers.handlers import Handlers
+from bot.i18n.lexicon import Lexicon
 from bot.keyboards.keyboards import Keyboards
+from bot.middlewares.i18n import I18nMiddleware
 from bot.middlewares.throttling import ThrottlingMiddleware
 from bot.services.bot_service import BotService
 from bot.states.bot_state import BotState
@@ -88,11 +90,12 @@ def register_handlers(dp: Dispatcher, hd: Handlers) -> None:
 
 
 def register_middlewares(dp: Dispatcher) -> None:
-    dp.update.middleware(ThrottlingMiddleware())
+    dp.update.outer_middleware(I18nMiddleware())
+    dp.update.outer_middleware(ThrottlingMiddleware())
 
 
-def register_workflow_data(dp: Dispatcher) -> None:
-    dp.workflow_data.update({'answer': 'Hello'})
+def register_workflow_data(dp: Dispatcher, settings: Settings) -> None:
+    dp.workflow_data.update({'answer': 'Hello', 'lexicon': Lexicon(settings.app.default_language)})
 
 
 def create_app(bot: Bot, dp: Dispatcher, settings: App) -> FastAPI:
@@ -114,7 +117,7 @@ def main() -> None:
     app = create_app(bot, dp, settings.app)
     register_handlers(dp, Handlers(bot, Keyboards(), BotService()))
     register_middlewares(dp)
-    register_workflow_data(dp)
+    register_workflow_data(dp, settings)
 
     logger.debug('Application is running')