shipany.bot.contrib.aiogram

shipany.bot.contrib.aiogram package

Subpackages

• shipany.bot.contrib.aiogram.factories package
  • Submodules
  • shipany.bot.contrib.aiogram.factories.send_message module
    • construct_from()
  • shipany.bot.contrib.aiogram.factories.telegram_objects module
    • bot_from_config()
    • bot()
    • dispatcher()
  • Module contents
• shipany.bot.contrib.aiogram.persistency package
  • Submodules
  • shipany.bot.contrib.aiogram.persistency.bindings module
    • default_bindings()
  • shipany.bot.contrib.aiogram.persistency.handles module
    • EventInspector
      • EventInspector.__init__()
      • EventInspector.user_id()
      • EventInspector.chat_id()
    • AiogramHandleGenerator
      • AiogramHandleGenerator.__init__()
      • AiogramHandleGenerator.generate()
    • HandleGeneratorFactory
      • HandleGeneratorFactory.create()
  • Module contents
• shipany.bot.contrib.aiogram.process package
  • Subpackages
    • shipany.bot.contrib.aiogram.process.broken_action package
      • Submodules
      • shipany.bot.contrib.aiogram.process.broken_action.v1 module
      • Module contents
    • shipany.bot.contrib.aiogram.process.http_request package
      • Submodules
      • shipany.bot.contrib.aiogram.process.http_request.bindings module
      • shipany.bot.contrib.aiogram.process.http_request.namespaces module
      • shipany.bot.contrib.aiogram.process.http_request.v1 module
      • Module contents
    • shipany.bot.contrib.aiogram.process.json_path_action package
      • Submodules
      • shipany.bot.contrib.aiogram.process.json_path_action.v1 module
      • Module contents
    • shipany.bot.contrib.aiogram.process.message_action package
      • Submodules
      • shipany.bot.contrib.aiogram.process.message_action.v1 module
      • Module contents
    • shipany.bot.contrib.aiogram.process.state_action package
      • Submodules
      • shipany.bot.contrib.aiogram.process.state_action.v1 module
      • Module contents
    • shipany.bot.contrib.aiogram.process.timeout_action package
      • Submodules
      • shipany.bot.contrib.aiogram.process.timeout_action.v1 module
      • Module contents
    • shipany.bot.contrib.aiogram.process.transition_action package
      • Submodules
      • shipany.bot.contrib.aiogram.process.transition_action.v1 module
      • Module contents
  • Submodules
  • shipany.bot.contrib.aiogram.process.bindings module
    • default_bindings()
  • Module contents
• shipany.bot.contrib.aiogram.renders package
  • Submodules
  • shipany.bot.contrib.aiogram.renders.bindings module
    • default_bindings()
  • shipany.bot.contrib.aiogram.renders.namespaces module
    • message_namespace()
    • user_namespace()
    • reaction_namespace()
  • Module contents
• shipany.bot.contrib.aiogram.webhook package
  • Submodules
  • shipany.bot.contrib.aiogram.webhook.bindings module
    • default_bindings()
  • shipany.bot.contrib.aiogram.webhook.events module
    • OnStartupDispatcher
    • OnUpdatesDispatcher
    • OnShutdownDispatcher
  • Module contents

Submodules

shipany.bot.contrib.aiogram.backend module

async shipany.bot.contrib.aiogram.backend.serve(flow, app_config)

Start the bot server.

If the webhook URL for Telegram is set, the bot will operate in webhook mode. Otherwise, it will poll for updates.

• Parameters:
  • flow (Flow) — The conversation flow.
  • app_config (ApplicationConfig) — The application configuration.
• Return type: None

shipany.bot.contrib.aiogram.bindings module

shipany.bot.contrib.aiogram.bindings.default_bindings(binder)

Bind the default dependencies.

• Parameters: binder (Binder) — The dependency injector binder.
• Return type: None

shipany.bot.contrib.aiogram.router module

async shipany.bot.contrib.aiogram.router.handler(activation, steps, event)

Handle the activation.

• Parameters:
  • activation (CommandActivation | EventActivation | WebhookActivation | TimeoutActivation) — The activation to handle.
  • steps (list[Step]) — The steps of the conversation.
  • event (TelegramObject) — The event that triggered the activation.
• Return type: None

shipany.bot.contrib.aiogram.router.activate_entry_points(conversation, router)

Activate the entry points of the conversation.

• Parameters:
  • conversation (Conversation) — The conversation to activate.
  • router (Router) — The router to register the handlers.
• Return type: None

shipany.bot.contrib.aiogram.router.create_handlers(router, conversation)

Create the handlers for the conversation.

• Parameters:
  • router (Router) — The router to register the handlers.
  • conversation (Conversation) — The conversation to create the handlers for.
• Return type: None

shipany.bot.contrib.aiogram.router.create(flow)

Create the aiogram router for the flow.

• Parameters: flow (Flow) — The flow to create the router for.
• Returns: The created aiogram router.
• Return type: Router

Module contents