Migration FAQ (2.x -> 3.0)#
This guide is still in progress.
This version introduces numerous breaking changes and architectural improvements. It helps reduce the count of global variables in your code, provides useful mechanisms to modularize your code, and enables the creation of shareable modules via packages on PyPI. It also makes middlewares and filters more controllable, among other improvements.
On this page, you can read about the changes made in relation to the last stable 2.x version.
This page more closely resembles a detailed changelog than a migration guide, but it will be updated in the future.
Feel free to contribute to this page, if you find something that is not mentioned here.
Dispatcherclass no longer accepts a Bot instance in its initializer. Instead, the Bot instance should be passed to the dispatcher only for starting polling or handling events from webhooks. This approach also allows for the use of multiple bot instances simultaneously (“multibot”).
Dispatchernow can be extended with another Dispatcher-like thing named
Router(Read more »).
With routes, you can easily modularize your code and potentially share these modules between projects.
Removed the _handler suffix from all event handler decorators and registering methods. (Read more »)
The Executor has been entirely removed; you can now use the Dispatcher directly to start poll the API or handle webhooks from it.
The throttling method has been completely removed; you can now use middlewares to control the execution context and implement any throttling mechanism you desire.
Removed global context variables from the API types, Bot and Dispatcher object, From now on, if you want to access the current bot instance within handlers or filters, you should accept the argument
bot: Botand use it instead of
Bot.get_current(). In middlewares, it can be accessed via
To skip pending updates, you should now call the
aiogram.methods.delete_webhook.DeleteWebhookmethod directly, rather than passing
skip_updates=Trueto the start polling method.
Keyword filters can no longer be used; use filters explicitly. (Read more »)
Due to the removal of keyword filters, all previously enabled-by-default filters (such as state and content_type) are now disabled. You must specify them explicitly if you wish to use them. For example instead of using
@dp.message_handler(content_types=ContentType.PHOTO)you should use
Most common filters have been replaced with the “magic filter.” (Read more »)
By default, the message handler now receives any content type. If you want a specific one, simply add the appropriate filters (Magic or any other).
The state filter is no longer enabled by default. This means that if you used
state="*"in v2, you should not pass any state filter in v3. Conversely, if the state was not specified in v2, you will now need to specify it in v3.
Added the possibility to register global filters for each router, which helps to reduce code repetition and provides an easier way to control the purpose of each router.
All API methods are now classes with validation, implemented via pydantic <https://docs.pydantic.dev/>. These API calls are also available as methods in the Bot class.
More pre-defined Enums have been added and moved to the aiogram.enums sub-package. For example, the chat type enum is now
The HTTP client session has been separated into a container that can be reused across different Bot instances within the application.
API Exceptions are no longer classified by specific messages, as Telegram has no documented error codes. However, all errors are classified by HTTP status codes, and for each method, only one type of error can be associated with a given code. Therefore, in most cases, you should check only the error type (by status code) without inspecting the error message.
Middlewares can now control an execution context, e.g., using context managers. (Read more »)
All contextual data is now shared end-to-end between middlewares, filters, and handlers. For example now you can easily pass some data into context inside middleware and get it in the filters layer as the same way as in the handlers via keyword arguments.
Added a mechanism named flags that helps customize handler behavior in conjunction with middlewares. (Read more »)
aiogram.types.reply_keyboard_markup.ReplyKeyboardMarkupno longer have methods for extension, instead you have to use markup builders
aiogram.utils.keyboard.KeyboardBuilderrespectively (Read more »)
Finite State machine#
State filters will no longer be automatically added to all handlers; you will need to specify the state if you want to use it.
Added the possibility to change the FSM strategy. For example, if you want to control the state for each user based on chat topics rather than the user in a chat, you can specify this in the Dispatcher.
aiogram.fsm.state.StateGroupdon’t have helper methods like
Instead, you should set states by passing them directly to
aiogram.fsm.context.FSMContext(Read more »)
The state proxy is deprecated; you should update the state data by calling
From now on, you should wrap files in an InputFile object before sending them, instead of passing the IO object directly to the API method. (Read more »)
The aiohttp web app configuration has been simplified.
By default, the ability to upload files has been added when you make requests in response to updates (available for webhook only).
Telegram API Server#
The server parameter has been moved from the Bot instance to api in BaseSession.
The constant aiogram.bot.api.TELEGRAM_PRODUCTION has been moved to aiogram.client.telegram.PRODUCTION.