Skip to main content

Dependency Injection implementation for aiogram 3.

Project description

Example of usage

import logging
from os import getenv
from typing import Annotated

from aiogram import Router, Bot, Dispatcher
from aiogram.types import Message, User
from aiogram3_di import DIMiddleware, Depends

router = Router()


def get_user_full_name(event_from_user: User) -> str:
    return event_from_user.full_name


@router.message()
async def _(message: Message, full_name: Annotated[str, Depends(get_user_full_name)]) -> None:
    await message.answer(f'Hi {full_name}')


def main() -> None:
    logging.basicConfig(level=logging.INFO)

    bot = Bot(token=getenv('BOT_TOKEN'))

    dp = Dispatcher()
    dp.include_router(router)
    dp.message.middleware(DIMiddleware())  # register Dependency Injection middleware
    dp.run_polling(bot)


if __name__ == '__main__':
    main()

Handler Dependencies.

You can use Depends in the flags parameter of the handler, for example:

flags={'dependencies': [Depends(verify_user)]}

Global Dependencies.

You can use Depends in dispatcher, for example:

dp = Dispatcher()
dp.dependencies = [Depends(verify_user)]

Or in router, for example:

router = Router()
router.dependencies = [Depends(verify_user)]

Details

It is inspired by FastAPI.

If you define a normal def, your function will be called in a different thread.

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aiogram3_di-1.0.3.tar.gz (4.7 kB view details)

Uploaded Source

File details

Details for the file aiogram3_di-1.0.3.tar.gz.

File metadata

  • Download URL: aiogram3_di-1.0.3.tar.gz
  • Upload date:
  • Size: 4.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.7

File hashes

Hashes for aiogram3_di-1.0.3.tar.gz
Algorithm Hash digest
SHA256 5026398fa867133925f244b677a73226cc7f32c47437a995e3c631dc7f5e08b3
MD5 9ea4ddc99b1450528d9002865a801a07
BLAKE2b-256 b6140f8a65042a7f64dc9c1a80da5bf43478b87e3085deb0ffe15bd7d780763d

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page