aiogram #

Danger

This version is still in development!

aiogram is a modern and fully asynchronous framework for Telegram Bot API written in Python 3.8 using asyncio and aiohttp.

Make your bots faster and more powerful!

Documentation:

🇺🇸 English
🇺🇦 Ukrainian

Danger

Breaking News:

aiogram 3.0 has breaking changes.

It breaks backward compatibility by introducing new breaking changes!

Features#

Asynchronous (asyncio docs, PEP 492)
Has type hints (PEP 484) and can be used with mypy
Supports PyPy
Supports Telegram Bot API 6.6 and gets fast updates to the latest versions of the Bot API
Telegram Bot API integration code was autogenerated and can be easily re-generated when API gets updated
Updates router (Blueprints)
Has Finite State Machine
Uses powerful magic filters <https://docs.aiogram.dev/en/dev-3.x/dispatcher/filters/magic_filters.html#magic-filters>
Middlewares (incoming updates and API calls)
Provides Replies into Webhook
Integrated I18n/L10n support with GNU Gettext (or Fluent)

Warning

It is strongly advised that you have prior experience working with asyncio before beginning to use aiogram.

If you have any questions, you can visit our community chats on Telegram:

🇺🇸 @aiogram
🇺🇦 @aiogramua
🇺🇿 @aiogram_uz
🇰🇿 @aiogram_kz
🇷🇺 @aiogram_ru
🇮🇷 @aiogram_fa
🇮🇹 @aiogram_it
🇧🇷 @aiogram_br

Simple usage#

import asyncio
import logging

from aiogram import Bot, Dispatcher, Router, types
from aiogram.filters import Command
from aiogram.types import Message

# Bot token can be obtained via https://t.me/BotFather
TOKEN = "42:TOKEN"

# All handlers should be attached to the Router (or Dispatcher)
router = Router()


@router.message(Command(commands=["start"]))
async def command_start_handler(message: Message) -> None:
    """
    This handler receive messages with `/start` command
    """
    # Most event objects have aliases for API methods that can be called in events' context
    # For example if you want to answer to incoming message you can use `message.answer(...)` alias
    # and the target chat will be passed to :ref:`aiogram.methods.send_message.SendMessage`
    # method automatically or call API method directly via
    # Bot instance: `bot.send_message(chat_id=message.chat.id, ...)`
    await message.answer(f"Hello, <b>{message.from_user.full_name}!</b>")


@router.message()
async def echo_handler(message: types.Message) -> None:
    """
    Handler will forward received message back to the sender

    By default, message handler will handle all message types (like text, photo, sticker and etc.)
    """
    try:
        # Send copy of the received message
        await message.send_copy(chat_id=message.chat.id)
    except TypeError:
        # But not all the types is supported to be copied so need to handle it
        await message.answer("Nice try!")


async def main() -> None:
    # Dispatcher is a root router
    dp = Dispatcher()
    # ... and all other routers should be attached to Dispatcher
    dp.include_router(router)

    # Initialize Bot instance with a default parse mode which will be passed to all API calls
    bot = Bot(TOKEN, parse_mode="HTML")
    # And the run events dispatching
    await dp.start_polling(bot)


if __name__ == "__main__":
    logging.basicConfig(level=logging.INFO)
    asyncio.run(main())

aiogram #

Features#

Simple usage#

Contents#