Aiogram. Python. Writing a multifunctional bot #1 Initial project setup.

Всех приветствую дорогие форумчане! Сегодня я начну серию уроков по созданию функционального Telegram бота на такой фреймворке как aiogram. По ходу серии уроков мы научимся с вами работать с командами, кнопками, сообщениями, FSM состояниями (о ней я говорил в прошлой статье), а также научимся работать с базой данных (PostgreSQL, Gino ORM) и многое другое. Давайте же начнем

В первом уроке мы сделаем:
- разработаем архитектуру проекта
- настроим стандартные команды бота
- настроим уведомление о запуске бота
- полностью настроим и запустим бота

Для начала я создал новый проект в PyCharm с такой архитектурой (статья на отдельную тему структуризации проекта также скоро выйдет):


Файл app.py будет у нас как точка входа. Из него будет запускаться весь бот. В loader.py мы будем хранить Dispatcher, а также MemoryStorage для работы с FSM.

В файле config.py устанавливаем токен бота, а также в массив admins_id передаём id администратора, чтобы в будущем уведомлять о запуске бота:

import os

from dotenv import load_dotenv

load_dotenv()

BOT_TOKEN = str(os.getenv("BOT_TOKEN"))

admins_id = [
1782886979,
]

Python

import os



from dotenv import load_dotenv



load_dotenv()



BOT_TOKEN = str(os.getenv("BOT_TOKEN"))



admins_id = [

    1782886979,

]

Конструкция os.getenv("BOT_TOKEN") позволяет загрузить переменную окружения BOT_TOKEN с файлика .env

Теперь настроим фал loader.py. Тут мы создаём Dispatcher для нашего бота, где BOT_TOKEN берём с ранее настроенного config.py

from aiogram import Bot, Dispatcher, types

from data import config

bot = Bot(config.BOT_TOKEN, parse_mode=types.ParseMode.HTML)

dp = Dispatcher(bot)

Python

from aiogram import Bot, Dispatcher, types



from data import config



bot = Bot(config.BOT_TOKEN, parse_mode=types.ParseMode.HTML)



dp = Dispatcher(bot)

В папке utils создаём два файла с названиями
notify_admins.py (для уведомления администраторов о запуске бота) и
set_bot_commands.py (для установки стандартных команд для бота).


Файл notify_admins.py. Здесь мы отправляем сообщение о запуске бота администратору(-ам) (в зависимости сколько id в массиве admins_id).

import logging

from aiogram import Dispatcher

from data.config import admins_id


async def on_startup_notify(dp: Dispatcher):
for admin in admins_id:
try:
text = 'Bot was started!'
await dp.bot.send_message(admin, text)
except Exception as err:
logging.exception(err)

Python

import logging



from aiogram import Dispatcher



from data.config import admins_id





async def on_startup_notify(dp: Dispatcher):

    for admin in admins_id:

        try:

            text = 'Bot was started!'

            await dp.bot.send_message(admin, text)

        except Exception as err:

            logging.exception(err)

Файл set_bot_commands.py. В этом файле мы устанавливаем стандартные команды для бота с которыми пользователь может легко взаимодействовать.

from aiogram import types


async def set_default_commands(dp):
await dp.bot.set_my_commands(
[
types.BotCommand('start', 'Запустить бота'), # пока добавляем только одну команду
]
)

Python

from aiogram import types





async def set_default_commands(dp):

    await dp.bot.set_my_commands(

        [

            types.BotCommand('start', 'Запустить бота'), # пока добавляем только одну команду

        ]

    )

Отлично! Теперь нам осталось настроить запуск бота. Это мы сделаем в файлике app.py

async def on_startup(dp):
from utils.notify_admins import on_startup_notify
await on_startup_notify(dp)

from utils.set_bot_commands import set_default_commands
await set_default_commands(dp)

print("Бот запущен!")


if __name__ == '__main__':
from aiogram import executor
from handlers import dp

executor.start_polling(dp, on_startup=on_startup, skip_updates=True)

Python

async def on_startup(dp):

    from utils.notify_admins import on_startup_notify

    await on_startup_notify(dp)



    from utils.set_bot_commands import set_default_commands

    await set_default_commands(dp)



    print("Бот запущен!")





if __name__ == '__main__':

    from aiogram import executor

    from handlers import dp



    executor.start_polling(dp, on_startup=on_startup, skip_updates=True)

Итак, давайте разбираться что тут написано.

from utils.notify_admins import on_startup_notify
await on_startup_notify(dp)

Python

from utils.notify_admins import on_startup_notify

    await on_startup_notify(dp)

Эта функция уведомляет администратора о запуске бота, её мы прописывали выше.

Следующей функцией мы устанавливаем стандартные команды для бота, я думаю тут всё понятно, всё аналогично как и с

await on_startup_notify(dp)

На передаваемый аргумент dp пока не обращаем внимание, к нему мы ещё вернемся.

Далее мы выводим в консоль уведомление о том, что бот запущен.

После чего запускаем конструкцию if __name__ == "__main__" где импортируем executor, dp from handler, а также запускаем бота с помощью


executor.start_polling(dp, on_startup=on_startup, skip_updates=True)


Теперь давайте разберёмся с тем самым dp (Dispatcher).
В файлах handlers/__init__.py и handlers/users/__init.py__ прописываем данную конструкцию


__all__ = ['dp']


Что делает __all__? Он объявляет семантически "общедоступные" имена из модуля. В нашем случае, общедоступным станет dp.
Однако сейчас у нас горит ошибка, это потому что мы не указали из которого нужно импортировать dp.

В папке handlers/users создадим файл start.py, где опишем команду /start. С loader импортируем dp (Dispather)


Файл handlers/users/start.py

from aiogram import types

from loader import dp


@dp.message_handler(commands=['start'])
async def command_start(message: types.Message):
await message.answer(f"Привет {message.from_user.first_name}")

Python

from aiogram import types



from loader import dp





@dp.message_handler(commands=['start'])

async def command_start(message: types.Message):

    await message.answer(f"Привет {message.from_user.first_name}")

  

Теперь нам нужно инициализировать этот файл. Для начала заходим в handlers/__init__.py. В самое начало прописываем


from .users import dp


Далее заходим в handlers/users/__init__.py и также в самое начало добавляем


from .start import dp


ИТОГ​

Отлично! Теперь наш бот полностью готов к запуску. Обязательно запускаем его в файла app.py! Если при первом запуске у вас вылезла такая ошибка, то это нормально. При запуске бота у нас запускается функция
on_startup_notify() где сообщение отправляется в чат администратору, а так как администратор ещё ни разу не писал боту, а бот первым написать не может, то у нас выскакивает ChatNotFound (чат не найден), однако когда администратор запустит бота, всё будет хорошо.


Давайте напишем нашему боту.

Теперь перезапустим бота.

Как видите ошибок уже нет, а сообщение Updates were skipped successfully говорит нам о том, что все ранее отправленные сообщения боту, когда он был выключен, пропущены. Этого мы добились с помощью skip_updates = True


executor.start_polling(dp, on_startup=on_startup, skip_updates=True)


После чего в консоли нам пишется о том, что бот запущен, а также в личные сообщения администратору (мне) бот прислал оповещение:


Также внизу появляется кнопка Меню, при нажатии которой, выпадает наша с вами раннее добавленная команда /start в
set_default_commands()



На этом первый урок я предлагаю закончить, если кому-то что-то не понятно, то перечитайте статью либо же напишите мне. Всегда рад помочь!
Если понравился урок - дайте об этом знать и я пойму, делать продолжение или нет. Всем спасибо!

Полезные ссылки:​

GitHub - https://github.com/Kolini77/aiogram-lessons

Наш Telegram чат Python программистов - https://t.me/+q9HNGuHpkpA1Y2Y6​