aiogram / tg-codegen

Code generator for aiogram 3.x with parser of Telegram Bot API docs

aiogram

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

Features

• Asynchronous (asyncio docs, 492)
• Has type hints (484) and can be used with mypy
• Supports PyPy
• Supports Telegram Bot API 7.3 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
• 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

tg-codegen's Issues

Emojis are not inserted into docstring

They are in fact pictures (<img /> tags), but they have alt= attr, which can be inserted into docstring

tg-codegen/aiogram/api/types/dice.py

Line 16 in 623c290

"""Value of the dice, 1-6 for '' and '' base emoji, 1-5 for '' base emoji"""

Parse enums from documentation

Example

We have type attribute in Chat class

So we should create an enum like this:

from aiogram.utils.enum import AutoName

from enum import auto


class ChatType(AutoName):
    PRIVATE = auto()
    GROUP = auto()
    SUPERGROUP = auto()
    CHANNEL = auto()

Enum class name should be generated from base class name and target field name capitalized: Chat + Type.
For MessageEntity.type field it should be MessageEntityType, so following the same rules.

More complex example

We have ChatMember and its subclasses that differ in status attribute

So we should create an enum like this:

from aiogram.utils.enum import AutoName

from enum import auto


class ChatMemberStatus(AutoName):
    CREATOR = auto()
    ADMINISTRATOR = auto()
    MEMBER = auto()
    RESTRICTED = auto()
    LEFT = auto()
    KICKED = auto()

Enum class name should be generated in the same way: ChatMember + Status.