Merge pull request #1 from TimNekk/develop

feat: add advanced logging, refactor and linter

.env.dist

@@ -23,5 +23,9 @@ REDIS_HOST=redis
 REDIS_PORT=6379
 REDIS_PASS=exampleRedisPassword
 
-# Misc settings
-LOG_FILE_NAME=log_file_name
+# Log settings
+LOG_FILE_NAME=log_file_name
+LOG_ROTATION=00:00 # HH:MM
+LOG_RETENTION=3 # in days
+
+# Misc settings

.github/workflows/lint.yml

@@ -0,0 +1,28 @@
+name: Lint
+
+on:
+  - push
+  - pull_request
+
+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 mypy flake8
+    - name: Analysing the code with mypy
+      run: |
+        mypy . --install-types --non-interactive
+    - name: Analysing the code with flake8
+      run: |
+        flake8

alembic/versions/73ffa12c03c8_initial.py

@@ -8,7 +8,6 @@
 from alembic import op
 import sqlalchemy as sa
 
-
 # revision identifiers, used by Alembic.
 revision = '73ffa12c03c8'
 down_revision = None
@@ -19,17 +18,17 @@
 def upgrade() -> None:
     # ### commands auto generated by Alembic - please adjust! ###
     op.create_table('users',
-    sa.Column('id', sa.BigInteger(), nullable=False),
-    sa.Column('username', sa.String(length=32), nullable=True),
-    sa.Column('first_name', sa.String(length=255), nullable=True),
-    sa.Column('last_name', sa.String(length=255), nullable=True),
-    sa.Column('is_banned', sa.Boolean(), nullable=False),
-    sa.Column('deep_link', sa.String(length=225), nullable=True),
-    sa.Column('created_at', sa.DateTime(timezone=True), server_default=sa.text('now()'), nullable=True),
-    sa.Column('updated_at', sa.DateTime(timezone=True), server_default=sa.text('now()'), nullable=True),
-    sa.PrimaryKeyConstraint('id'),
-    sa.UniqueConstraint('id')
-    )
+                    sa.Column('id', sa.BigInteger(), nullable=False),
+                    sa.Column('username', sa.String(length=32), nullable=True),
+                    sa.Column('first_name', sa.String(length=255), nullable=True),
+                    sa.Column('last_name', sa.String(length=255), nullable=True),
+                    sa.Column('is_banned', sa.Boolean(), nullable=False),
+                    sa.Column('deep_link', sa.String(length=225), nullable=True),
+                    sa.Column('created_at', sa.DateTime(timezone=True), server_default=sa.text('now()'), nullable=True),
+                    sa.Column('updated_at', sa.DateTime(timezone=True), server_default=sa.text('now()'), nullable=True),
+                    sa.PrimaryKeyConstraint('id'),
+                    sa.UniqueConstraint('id')
+                    )
     # ### end Alembic commands ###
 
 

bot.py

@@ -16,10 +16,10 @@
 from tgbot.services.setting_commands import set_bot_command
 
 
-async def main():
+async def main() -> None:
     config = load_config(".env")
 
-    logging.setup(config.misc.log_file_name)
+    logging.setup(config.log.file_name, config.log.rotation, config.log.retention)
     logger.info("Starting bot")
 
     if config.tg_bot.use_redis:

setup.cfg

@@ -0,0 +1,18 @@
+[flake8]
+max-line-length = 120
+exclude =.git,__pycache__,docs/source/conf.py,build,dist,tests,alembic
+ignore = I101,D100,D101,D102,D103,D104,D105,D107,D401,E203,I900,N802,N806,N812,W503,S311,S605,S607,ISC003,ISC001,T101,T000,F541,PL123,E712
+per-file-ignores = __init__.py:F401,F403
+
+[mypy]
+
+ignore_missing_imports = True
+disallow_untyped_defs = True
+check_untyped_defs = True
+warn_redundant_casts = True
+no_implicit_optional = True
+strict_optional = True
+show_error_codes = True
+strict_equality = true
+warn_unreachable = true
+warn_unused_configs = true

tgbot/config.py

@@ -1,5 +1,6 @@
 from dataclasses import dataclass, fields
-from typing import List, Optional
+from datetime import time, timedelta, datetime
+from typing import List, Optional, Generator
 
 from aiogram.types import BotCommand
 from environs import Env
@@ -13,15 +14,15 @@ class CommandInfo:
     is_admin: bool = False
     bot_command: Optional[BotCommand] = None
 
-    def __post_init__(self):
+    def __post_init__(self) -> None:
         self.bot_command = BotCommand(self.command, self.description)
 
 
 @dataclass
 class Commands:
     send_all: CommandInfo
 
-    def __iter__(self):
+    def __iter__(self) -> Generator[CommandInfo, None, None]:
         return (getattr(self, field.name) for field in fields(self))
 
 
@@ -34,7 +35,7 @@ class DbConfig:
     port: int
     uri: str = ""
 
-    def __post_init__(self):
+    def __post_init__(self) -> None:
         self.uri = f"postgresql://{self.user}:{self.password}@{self.host}:{self.port}/{self.database}"
 
 
@@ -53,22 +54,31 @@ class TgBot:
     commands: Commands
 
 
+@dataclass
+class LogConfig:
+    file_name: str
+    rotation: time
+    retention: timedelta
+
+
 @dataclass
 class Miscellaneous:
-    log_file_name: str
+    pass
 
 
 @dataclass
 class Config:
     tg_bot: TgBot
     db: DbConfig
     redis: RedisConfig
+    log: LogConfig
     misc: Miscellaneous
 
 
-def load_config(path: str = None):
+def load_config(path: str | None = None) -> Config:
     env = Env()
     env.read_env(path)
+
     return Config(
         tg_bot=TgBot(
             token=env.str("BOT_TOKEN"),
@@ -90,7 +100,10 @@ def load_config(path: str = None):
             password=env.str('REDIS_PASS'),
             port=env.int('REDIS_PORT'),
         ),
-        misc=Miscellaneous(
-            log_file_name=env.str("LOG_FILE_NAME")
-        )
+        log=LogConfig(
+            file_name=env.str('LOG_FILE_NAME'),
+            rotation=datetime.strptime(env.str('LOG_ROTATION'), '%H:%M').time(),
+            retention=timedelta(days=env.int('LOG_RETENTION')),
+        ),
+        misc=Miscellaneous()
     )

tgbot/filters/__init__.py

@@ -4,6 +4,6 @@
 from .command import CommandFilter
 
 
-def register_filters(dp: Dispatcher):
+def register_filters(dp: Dispatcher) -> None:
     dp.filters_factory.bind(AdminFilter)
     dp.filters_factory.bind(CommandFilter)

tgbot/filters/admin.py

@@ -1,5 +1,6 @@
 from dataclasses import dataclass
 
+from aiogram import types
 from aiogram.dispatcher.filters import BoundFilter
 
 from tgbot.config import Config
@@ -10,6 +11,6 @@ class AdminFilter(BoundFilter):
     key = 'is_admin'
     is_admin: bool
 
-    async def check(self, obj):
+    async def check(self, obj: types.base.TelegramObject) -> bool:
         config: Config = obj.bot.get('config')
         return (obj.from_user.id in config.tg_bot.admin_ids) == self.is_admin

tgbot/filters/command.py

@@ -11,7 +11,7 @@ class CommandFilter(BoundFilter):
     key = 'command'
     command: CommandInfo
 
-    async def check(self, obj):
+    async def check(self, obj: types.base.TelegramObject) -> bool:
         if not isinstance(obj, types.Message):
             raise NotImplementedError("CommandFilter can only be used with Message")
         message: types.Message = obj

tgbot/handlers/__init__.py

@@ -4,6 +4,6 @@
 from .start import register_start_handlers
 
 
-def register_handlers(dp: Dispatcher):
+def register_handlers(dp: Dispatcher) -> None:
     register_admin_handlers(dp)
     register_start_handlers(dp)

tgbot/handlers/admin/__init__.py

@@ -3,5 +3,5 @@
 from .send_all import register_send_all_handlers
 
 
-def register_admin_handlers(dp: Dispatcher):
+def register_admin_handlers(dp: Dispatcher) -> None:
     register_send_all_handlers(dp)

tgbot/handlers/admin/send_all.py

@@ -5,21 +5,22 @@
 import validators
 
 from tgbot.config import Config
-from tgbot.keyboards.inline.admin import send_all_callback_data, send_all_keyboard, SendAllAction, broadcast_message_keyboard
+from tgbot.keyboards.inline.admin import send_all_callback_data, send_all_keyboard, SendAllAction, \
+    broadcast_message_keyboard
 from tgbot.models.user import User
 from tgbot.models.user_tg import UserTG
 from tgbot.states import SendAllState
 
 
-async def send_all(message: types.Message, user: UserTG, state: FSMContext):
+async def send_all(message: types.Message, user: UserTG, state: FSMContext) -> None:
     text = "<b>Отправьте сообщение для рассылки</b>"
     initial_message = await user.send_message(text)
 
     await SendAllState.waiting_for_message.set()
     await state.update_data(initial_message_id=initial_message.message_id)
 
 
-async def confirm_send(message: types.Message, user: UserTG, state: FSMContext):
+async def confirm_send(message: types.Message, user: UserTG, state: FSMContext) -> None:
     data = await state.get_data()
     initial_message_id: int = data.get("initial_message_id")
 
@@ -34,7 +35,7 @@ async def confirm_send(message: types.Message, user: UserTG, state: FSMContext):
     await state.update_data(broadcast_message_id=broadcast_message.message_id)
 
 
-async def ask_to_change_buttons(call: types.CallbackQuery, user: UserTG, state: FSMContext):
+async def ask_to_change_buttons(call: types.CallbackQuery, user: UserTG, state: FSMContext) -> None:
     text = """
 Введите <b>ВСЕ</b> кнопки в формате:
 
@@ -51,7 +52,7 @@ async def ask_to_change_buttons(call: types.CallbackQuery, user: UserTG, state:
     await state.update_data(buttons_message_id=buttons_message.message_id)
 
 
-async def change_buttons(message: types.Message, user: UserTG, state: FSMContext):
+async def change_buttons(message: types.Message, user: UserTG, state: FSMContext) -> None:
     data = await state.get_data()
     buttons_message_id: int = data.get("buttons_message_id")
     broadcast_message_id: int = data.get("broadcast_message_id")
@@ -60,7 +61,8 @@ async def change_buttons(message: types.Message, user: UserTG, state: FSMContext
     await message.delete()
 
     buttons = list(filter(lambda button: len(button) == 2 and validators.url(button[1]),
-                          [[button_args.strip() for button_args in button.split("|")] for button in message.text.split("\n")]))
+                          [[button_args.strip() for button_args in button.split("|")]
+                           for button in message.text.split("\n")]))
 
     if buttons:
         keyboard = broadcast_message_keyboard(buttons)
@@ -70,7 +72,7 @@ async def change_buttons(message: types.Message, user: UserTG, state: FSMContext
     await SendAllState.waiting_for_confirm.set()
 
 
-async def cancel(call: types.CallbackQuery, state: FSMContext):
+async def cancel(call: types.CallbackQuery, state: FSMContext) -> None:
     data = await state.get_data()
     broadcast_message_id: int = data.get("broadcast_message_id")
     await state.finish()
@@ -79,7 +81,7 @@ async def cancel(call: types.CallbackQuery, state: FSMContext):
     await call.bot.delete_message(call.message.chat.id, broadcast_message_id)
 
 
-async def start_broadcast(call: types.CallbackQuery, user: UserTG, state: FSMContext):
+async def start_broadcast(call: types.CallbackQuery, user: UserTG, state: FSMContext) -> None:
     data = await state.get_data()
     broadcast_message_id: int = data.get("broadcast_message_id")
     keyboard: types.InlineKeyboardMarkup = data.get("keyboard")
@@ -95,10 +97,15 @@ async def start_broadcast(call: types.CallbackQuery, user: UserTG, state: FSMCon
     await user.send_message("<b>Рассылка закончилась!</b>")
 
 
-def register_send_all_handlers(dp: Dispatcher):
+def register_send_all_handlers(dp: Dispatcher) -> None:
     config: Config = dp.bot.get("config")
-    dp.register_message_handler(send_all, command=config.tg_bot.commands.send_all, is_admin=True)
-    dp.register_message_handler(confirm_send, content_types=ContentType.ANY, is_admin=True, state=SendAllState.waiting_for_message)
+    dp.register_message_handler(send_all,
+                                command=config.tg_bot.commands.send_all,
+                                is_admin=True)
+    dp.register_message_handler(confirm_send,
+                                content_types=ContentType.ANY,
+                                is_admin=True,
+                                state=SendAllState.waiting_for_message)
     dp.register_callback_query_handler(ask_to_change_buttons,
                                        send_all_callback_data.filter(action=SendAllAction.BUTTONS()),
                                        is_admin=True,

tgbot/handlers/start.py

@@ -4,13 +4,13 @@
 from tgbot.models.user_tg import UserTG
 
 
-async def start(message: types.Message, user: UserTG):
+async def start(message: types.Message, user: UserTG) -> None:
     text = f"""
 <b>Привет{f', {user.info}' if user.info else ''}!</b>
 """
 
     await user.send_message(text)
 
 
-def register_start_handlers(dp: Dispatcher):
+def register_start_handlers(dp: Dispatcher) -> None:
     dp.register_message_handler(start, CommandStart())

tgbot/keyboards/inline/admin/send_all.py

@@ -15,11 +15,11 @@ class SendAllAction(StringEnum):
     CANCEL = auto()
 
 
-def make_send_all_callback_data(action: SendAllAction):
+def make_send_all_callback_data(action: SendAllAction) -> str:
     return send_all_callback_data.new(action=action)
 
 
-def send_all_keyboard():
+def send_all_keyboard() -> InlineKeyboardMarkup:
     keyboard = InlineKeyboardMarkup()
 
     keyboard.add(InlineKeyboardButton(text="Изменить кнопки ⚙️",

tgbot/middlewares/__init__.py

@@ -8,7 +8,7 @@
 from .throttling import ThrottlingMiddleware
 
 
-def register_middlewares(dp: Dispatcher, config: Config):
+def register_middlewares(dp: Dispatcher, config: Config) -> None:
     dp.setup_middleware(EnvironmentMiddleware(config=config))
     dp.setup_middleware(ACLMiddleware())
     dp.setup_middleware(LoggingMiddleware())

tgbot/middlewares/acl.py

@@ -6,7 +6,7 @@
 
 class ACLMiddleware(BaseMiddleware):
     @staticmethod
-    async def set_data(telegram_user: types.User, data: dict, deep_link: str | None = None):
+    async def set_data(telegram_user: types.User, data: dict, deep_link: str | None = None) -> None:
         user = await UserTG.get(telegram_user.id)
 
         if user is None:
@@ -24,8 +24,8 @@ async def set_data(telegram_user: types.User, data: dict, deep_link: str | None
         data["user"] = user
         data["deep_link"] = deep_link
 
-    async def on_pre_process_message(self, message: types.Message, data: dict):
+    async def on_pre_process_message(self, message: types.Message, data: dict) -> None:
         await self.set_data(message.from_user, data, deep_link=message.get_args())
 
-    async def on_pre_process_callback_query(self, callback_query: types.CallbackQuery, data: dict):
+    async def on_pre_process_callback_query(self, callback_query: types.CallbackQuery, data: dict) -> None:
         await self.set_data(callback_query.from_user, data)