Skip to main content

A library to create forms in aiogram3

Project description

aiogram3-form

A library to create forms in aiogram3

pip install aiogram3-form

Example

import asyncio

from aiogram import Bot, Dispatcher, F, Router, types
from aiogram3_form import Form, FormField
from aiogram.fsm.context import FSMContext

bot = Bot(token="YOUR_TOKEN")
dispatcher = Dispatcher()
router = Router()
dispatcher.include_router(router)


class NameForm(Form, router=router):
    first_name: str = FormField(enter_message_text="Enter your first name please")
    second_name: str = FormField(
        enter_message_text="Enter your second name please",
        filter=(F.text.len() > 10) & F.text,
    )
    age: int = FormField(
        enter_message_text="Enter age as integer",
        error_message_text="Age should be numeric!",
    )


@NameForm.submit()
async def name_form_submit_handler(form: NameForm, event_chat: types.Chat):
    # handle form data
    # also supports aiogram standart DI (e. g. middlewares, filters, etc)
    await form.answer(
        f"{form.first_name} {form.second_name} of age {form.age} in chat {event_chat.title}"
    )


@router.message(F.text == "/form")
async def form_handler(_, state: FSMContext):
    await NameForm.start(bot, state)  # start your form


async def main():
    await dispatcher.start_polling(bot)


asyncio.run(main())

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_form-1.0.0.tar.gz (5.2 kB view details)

Uploaded Source

Built Distribution

aiogram3_form-1.0.0-py3-none-any.whl (6.6 kB view details)

Uploaded Python 3

File details

Details for the file aiogram3_form-1.0.0.tar.gz.

File metadata

  • Download URL: aiogram3_form-1.0.0.tar.gz
  • Upload date:
  • Size: 5.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.12.1 Darwin/23.2.0

File hashes

Hashes for aiogram3_form-1.0.0.tar.gz
Algorithm Hash digest
SHA256 4222eb0e0f984edf2689057588cf056d5863145485a2aa007899e275218f4ebc
MD5 8c5616175ee488330edf0b8f376bf60d
BLAKE2b-256 a27e35bd20e99ed2496370bcdc358bb967263e8e3b80811d7e97530dacfd360b

See more details on using hashes here.

File details

Details for the file aiogram3_form-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: aiogram3_form-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 6.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.12.1 Darwin/23.2.0

File hashes

Hashes for aiogram3_form-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1a9966fb5d465b482dcbdda875ccd5b90c4c27ec525dc57c9cb0973dcc1b65da
MD5 9e394aea0adbad4d13342a10c1ec1983
BLAKE2b-256 34f5e7f0b6e33c31d8e294aea735c7193891abbe3040b9bc6fcf3ba996964c24

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