eternnoir/pyTelegramBotAPI
PyTelegramBotAPI
pyTelegramBotAPI is a Python framework and API wrapper designed for building bots that interact with the Telegram Bot API. It provides a toolkit for managing bot lifecycles through both synchronous and asynchronous request patterns.
The framework is distinguished by a routing system that uses custom filters and middleware pipelines to direct incoming updates to specific handlers. It includes a finite state machine manager to track user progress through multi-step conversations and a retry-based system to handle server-side rate limiting.
The library covers a broad range of capabilities, including the transmission of rich media and formatted text, the management of interactive interface elements, and the configuration of network infrastructure via webhooks or long polling. It also provides utilities for user state persistence and API response simulation for testing.
Features
- Telegram Bot Frameworks - Provides a comprehensive framework for building interactive agents on the Telegram platform.
- Conversation State Managers - Implements a finite state machine to track user progress through complex, multi-step conversational dialogues.
- Dialogue Flow Management - Enables the creation of complex user dialogues and tracking of interaction progress for structured data collection.
- State Persistence - Provides mechanisms to store and retrieve arbitrary data associated with users or chats to maintain context.
- API Clients - Implements a client for sending rich media, managing stickers, and polling updates from Telegram servers.
- Direct Message Replies - Implements the ability to send text replies back to a user in direct response to a received message.
- Rich Media Transmission - Implements transmission of text, photos, audio, video, documents, stickers, and voice notes to specific chats.
- Long-Polling Queries - Continuously polls the API to retrieve and process new messages and events in real time.
- Finite State Machine Engines - Tracks user progress through multi-step dialogues using a persistent state identifier.
- Update Routing Systems - Processes incoming chat updates and routes them to specific handlers using custom filters and middleware pipelines.
- Interactive Message Components - Provides capabilities to edit messages, forward content, and attach interactive reply keyboards or buttons.
- Messaging Bot Wrappers - Provides a Python library that wraps the Telegram Bot API with synchronous and asynchronous request patterns.
- Bot Connectivity Configurations - Ships configurations for connecting via webhooks, local servers, or network proxies to bypass restrictions.
- Retry Strategies - Implements a retry-based system that honors server-side wait times to prevent bulk operation errors.
- Message Handling Systems - Processes chat messages using triggers and custom filters to execute defined responses.
- Update Filters - Provides an extensibility feature to define custom logic for complex checks on incoming messages.
- Inline Query Interfaces - Handles real-time search queries and returns formatted interactive selection results to users.
- Webhook Event Filters - Maps incoming events to handler functions by evaluating a sequence of configurable criteria and filters.
- Asynchronous Execution - Supports both synchronous blocking scripts and asynchronous high-concurrency event loops for API requests.
- Composable Middleware Pipelines - Executes a chain of pre- and post-processing functions to modify request context or cancel execution.
- Request Middleware - Intercepts updates before and after handlers for pre-processing, post-processing, or flow cancellation.
- Rate Limiting - Detects server-side throttle errors and pauses execution to respect API rate limits.
- Interactive Chat Controls - Supports the creation of rich user experiences using inline queries, callback buttons, and formatted multimedia content.
- Text Formatting Tools - Provides capabilities to apply inline text styling such as bold, italic, and links for chat client rendering.
- Update Handlers - Maps specific updates to handler functions for responding to various user interactions.
- Update Selection Logic - Evaluates messages using text, roles, or IDs to determine the appropriate handler for an update.
- Bot Frameworks - Simple and extensible Python implementation.
- Telegram Bot Frameworks - Python implementation of the Telegram Bot API.
