From b0e06253ffc368877cd7c46ef0d3b7257b827fa9 Mon Sep 17 00:00:00 2001 From: _run Date: Sun, 24 Jul 2022 23:14:09 +0500 Subject: [PATCH] Completed docstrings for all files except types.py --- telebot/__init__.py | 173 +- telebot/async_telebot.py | 3033 +++++++++++++++++++++------ telebot/asyncio_filters.py | 165 +- telebot/asyncio_handler_backends.py | 33 +- telebot/callback_data.py | 16 +- telebot/custom_filters.py | 172 +- telebot/ext/aio/webhooks.py | 29 +- telebot/ext/sync/webhooks.py | 38 +- telebot/formatting.py | 183 +- telebot/handler_backends.py | 38 +- telebot/types.py | 61 + telebot/util.py | 211 +- 12 files changed, 3286 insertions(+), 866 deletions(-) diff --git a/telebot/__init__.py b/telebot/__init__.py index 21a05ca..da3bf26 100644 --- a/telebot/__init__.py +++ b/telebot/__init__.py @@ -84,10 +84,13 @@ class TeleBot: Usage: - .. code-block:: python + .. code-block:: python3 + :caption: Creating instance of TeleBot from telebot import TeleBot bot = TeleBot('token') # get token from @BotFather + # now you can register other handlers/update listeners, + # and use bot methods. See more examples in examples/ directory: https://github.com/eternnoir/pyTelegramBotAPI/tree/master/examples @@ -243,7 +246,7 @@ class TeleBot: Enable saving states (by default saving disabled) .. note:: - It is recommended to pass a :class:`~telebot.storage.StateMemoryStorage` instance as state_storage + It is recommended to pass a :class:`~telebot.storage.StatePickleStorage` instance as state_storage to TeleBot class. :param filename: Filename of saving file, defaults to "./.state-save/states.pkl" @@ -547,8 +550,6 @@ class TeleBot: Telegram documentation: https://core.telegram.org/bots/api#getupdates - :param allowed_updates: Array of string. List the types of updates you want your bot to receive. - :type allowed_updates: :obj:`list`, optional :param offset: Identifier of the first update to be returned. Must be greater by one than the highest among the identifiers of previously received updates. By default, updates starting with the earliest unconfirmed update are returned. An update is considered confirmed as soon as getUpdates is called with an offset @@ -562,6 +563,9 @@ class TeleBot: :param timeout: Request connection timeout :type timeout: :obj:`int`, optional + :param allowed_updates: Array of string. List the types of updates you want your bot to receive. + :type allowed_updates: :obj:`list`, optional + :param long_polling_timeout: Timeout in seconds for long polling. :type long_polling_timeout: :obj:`int`, optional @@ -604,6 +608,9 @@ class TeleBot: Processes new updates. Just pass list of subclasses of Update to this method. :param updates: List of :class:`telebot.types.Update` objects. + :type updates: :obj:`list` of :class:`telebot.types.Update` + + :return None: """ upd_count = len(updates) logger.debug('Received {0} new updates'.format(upd_count)) @@ -885,11 +892,11 @@ class TeleBot: none_stop: Optional[bool]=None): """ This function creates a new Thread that calls an internal __retrieve_updates function. - This allows the bot to retrieve Updates automagically and notify listeners and message handlers accordingly. + This allows the bot to retrieve Updates automatically and notify listeners and message handlers accordingly. Warning: Do not call this function more than once! - Always get updates. + Always gets updates. .. deprecated:: 4.1.1 Use :meth:`infinity_polling` instead. @@ -921,7 +928,7 @@ class TeleBot: Please note that this parameter doesn't affect updates created before the call to the get_updates, so unwanted updates may be received for a short period of time. - :type allowed_updates: :obj:`list`] of :obj:`str` + :type allowed_updates: :obj:`list` of :obj:`str` :param none_stop: Deprecated, use non_stop. Old typo, kept for backward compatibility. :type none_stop: :obj:`bool` @@ -1104,6 +1111,8 @@ class TeleBot: def stop_polling(self): """ Stops polling. + + Does not accept any arguments. """ self.__stop_polling.set() @@ -1170,6 +1179,15 @@ class TeleBot: def download_file(self, file_path: str) -> bytes: + """ + Downloads file. + + :param file_path: Path where the file should be downloaded. + :type file_path: str + + :return: bytes + :rtype: :obj:`bytes` + """ return apihelper.download_file(self.token, file_path) @@ -1209,7 +1227,7 @@ class TeleBot: limit: Optional[int]=None) -> types.UserProfilePhotos: """ Use this method to get a list of profile pictures for a user. - Returns a UserProfilePhotos object. + Returns a :class:`telebot.types.UserProfilePhotos` object. Telegram documentation: https://core.telegram.org/bots/api#getuserprofilephotos @@ -1240,7 +1258,7 @@ class TeleBot: :param chat_id: Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername) :type chat_id: :obj:`int` or :obj:`str` - :return: :class:`telebot.types.Chat` + :return: Chat information :rtype: :class:`telebot.types.Chat` """ result = apihelper.get_chat(self.token, chat_id) @@ -1384,8 +1402,8 @@ class TeleBot: """ Use this method to send text messages. - Warning: Do not send more than about 4000 characters each message, otherwise you'll risk an HTTP 414 error. - If you must send more than 4000 characters, + Warning: Do not send more than about 4096 characters each message, otherwise you'll risk an HTTP 414 error. + If you must send more than 4096 characters, use the `split_string` or `smart_split` function in util.py. Telegram documentation: https://core.telegram.org/bots/api#sendmessage @@ -3552,7 +3570,12 @@ class TeleBot: message_id: Optional[int]=None, inline_message_id: Optional[str]=None) -> List[types.GameHighScore]: """ - Gets top points and game play. + Use this method to get data for high score tables. Will return the score of the specified user and several of + their neighbors in a game. On success, returns an Array of GameHighScore objects. + + This method will currently return scores for the target user, plus two of their closest neighbors on each side. + Will also return the top three users if the user and their neighbors are not among them. + Please note that this behavior is subject to change. Telegram documentation: https://core.telegram.org/bots/api#getgamehighscores @@ -4430,10 +4453,16 @@ class TeleBot: self.middlewares.append(middleware) - def set_state(self, user_id: int, state: Union[int, str, State], chat_id: int=None) -> None: + def set_state(self, user_id: int, state: Union[int, str, State], chat_id: Optional[int]=None) -> None: """ Sets a new state of a user. + .. note:: + + You should set both user id and chat id in order to set state for a user in a chat. + Otherwise, if you only set user_id, chat_id will equal to user_id, this means that + state will be set for the user in his private chat with a bot. + :param user_id: User's identifier :type user_id: :obj:`int` @@ -4449,7 +4478,7 @@ class TeleBot: chat_id = user_id self.current_states.set_state(chat_id, user_id, state) - def reset_data(self, user_id: int, chat_id: int=None): + def reset_data(self, user_id: int, chat_id: Optional[int]=None): """ Reset data for a user in chat. @@ -4465,7 +4494,7 @@ class TeleBot: chat_id = user_id self.current_states.reset_data(chat_id, user_id) - def delete_state(self, user_id: int, chat_id: int=None) -> None: + def delete_state(self, user_id: int, chat_id: Optional[int]=None) -> None: """ Delete the current state of a user. @@ -4481,12 +4510,24 @@ class TeleBot: chat_id = user_id self.current_states.delete_state(chat_id, user_id) - def retrieve_data(self, user_id: int, chat_id: int=None) -> Optional[Any]: + def retrieve_data(self, user_id: int, chat_id: Optional[int]=None) -> Optional[Any]: + """ + Returns context manager with data for a user in chat. + + :param user_id: User identifier + :type user_id: int + + :param chat_id: Chat's unique identifier, defaults to user_id + :type chat_id: int, optional + + :return: Context manager with data for a user in chat + :rtype: Optional[Any] + """ if chat_id is None: chat_id = user_id return self.current_states.get_interactive_data(chat_id, user_id) - def get_state(self, user_id: int, chat_id: int=None) -> Optional[Union[int, str, State]]: + def get_state(self, user_id: int, chat_id: Optional[int]=None) -> Optional[Union[int, str, State]]: """ Gets current state of a user. Not recommended to use this method. But it is ok for debugging. @@ -4504,7 +4545,7 @@ class TeleBot: chat_id = user_id return self.current_states.get_state(chat_id, user_id) - def add_data(self, user_id: int, chat_id:int=None, **kwargs): + def add_data(self, user_id: int, chat_id: Optional[int]=None, **kwargs): """ Add data to states. @@ -4635,6 +4676,7 @@ class TeleBot: Example: .. code-block:: python3 + :caption: Usage of middleware_handler bot = TeleBot('TOKEN') @@ -4728,13 +4770,14 @@ class TeleBot: def message_handler(self, commands: Optional[List[str]]=None, regexp: Optional[str]=None, func: Optional[Callable]=None, content_types: Optional[List[str]]=None, chat_types: Optional[List[str]]=None, **kwargs): """ - Message handler decorator. - This decorator can be used to decorate functions that must handle certain types of messages. + Handles New incoming message of any kind - text, photo, sticker, etc. + As a parameter to the decorator function, it passes :class:`telebot.types.Message` object. All message handlers are tested in the order they were added. Example: - .. code-block:: python + .. code-block:: python3 + :caption: Usage of message_handler bot = TeleBot('TOKEN') @@ -4768,8 +4811,17 @@ class TeleBot: :param func: Optional lambda function. The lambda receives the message to test as the first parameter. It must return True if the command should handle the message. + :type func: :obj:`lambda` + :param content_types: Supported message content types. Must be a list. Defaults to ['text']. + :type content_types: :obj:`list` of :obj:`str` + :param chat_types: list of chat types + :type chat_types: :obj:`list` of :obj:`str` + + :param kwargs: Optional keyword arguments(custom filters) + + :return: decorated function """ if content_types is None: content_types = ["text"] @@ -4871,7 +4923,8 @@ class TeleBot: def edited_message_handler(self, commands=None, regexp=None, func=None, content_types=None, chat_types=None, **kwargs): """ - Edit message handler decorator + Handles new version of a message that is known to the bot and was edited. + As a parameter to the decorator function, it passes :class:`telebot.types.Message` object. :param commands: Optional list of strings (commands to handle). :type commands: :obj:`list` of :obj:`str` @@ -4889,6 +4942,7 @@ class TeleBot: :type chat_types: :obj:`list` of :obj:`str` :param kwargs: Optional keyword arguments(custom filters) + :return: None """ if content_types is None: @@ -4960,6 +5014,8 @@ class TeleBot: :param pass_bot: True if you need to pass TeleBot instance to handler(useful for separating handlers into different files) :type pass_bot: :obj:`bool` + :param kwargs: Optional keyword arguments(custom filters) + :return: None """ method_name = "register_edited_message_handler" @@ -4988,7 +5044,8 @@ class TeleBot: def channel_post_handler(self, commands=None, regexp=None, func=None, content_types=None, **kwargs): """ - Channel post handler decorator. + Handles new incoming channel post of any kind - text, photo, sticker, etc. + As a parameter to the decorator function, it passes :class:`telebot.types.Message` object. :param commands: Optional list of strings (commands to handle). :type commands: :obj:`list` of :obj:`str` @@ -5003,6 +5060,7 @@ class TeleBot: :type content_types: :obj:`list` of :obj:`str` :param kwargs: Optional keyword arguments(custom filters) + :return: None """ if content_types is None: @@ -5069,6 +5127,8 @@ class TeleBot: :param pass_bot: True if you need to pass TeleBot instance to handler(useful for separating handlers into different files) :type pass_bot: :obj:`bool` + :param kwargs: Optional keyword arguments(custom filters) + :return: None """ method_name = "register_channel_post_handler" @@ -5096,7 +5156,8 @@ class TeleBot: def edited_channel_post_handler(self, commands=None, regexp=None, func=None, content_types=None, **kwargs): """ - Edit channel post handler decorator + Handles new version of a channel post that is known to the bot and was edited. + As a parameter to the decorator function, it passes :class:`telebot.types.Message` object. :param commands: Optional list of strings (commands to handle). :type commands: :obj:`list` of :obj:`str` @@ -5178,6 +5239,8 @@ class TeleBot: :param pass_bot: True if you need to pass TeleBot instance to handler(useful for separating handlers into different files) :type pass_bot: :obj:`bool` + :param kwargs: Optional keyword arguments(custom filters) + :return: decorated function """ method_name = "register_edited_channel_post_handler" @@ -5205,7 +5268,8 @@ class TeleBot: def inline_handler(self, func, **kwargs): """ - Inline call handler decorator + Handles new incoming inline query. + As a parameter to the decorator function, it passes :class:`telebot.types.InlineQuery` object. :param func: Function executed as a filter :type func: :obj:`function` @@ -5246,6 +5310,8 @@ class TeleBot: :param pass_bot: True if you need to pass TeleBot instance to handler(useful for separating handlers into different files) :type pass_bot: :obj:`bool` + :param kwargs: Optional keyword arguments(custom filters) + :return: decorated function """ handler_dict = self._build_handler_dict(callback, func=func, pass_bot=pass_bot, **kwargs) @@ -5253,7 +5319,9 @@ class TeleBot: def chosen_inline_handler(self, func, **kwargs): """ - Description: The result of an inline query that was chosen by a user and sent to their chat partner. + Handles the result of an inline query that was chosen by a user and sent to their chat partner. + Please see our documentation on the feedback collecting for details on how to enable these updates for your bot. + As a parameter to the decorator function, it passes :class:`telebot.types.ChosenInlineResult` object. :param func: Function executed as a filter :type func: :obj:`function` @@ -5294,6 +5362,8 @@ class TeleBot: :param pass_bot: True if you need to pass TeleBot instance to handler(useful for separating handlers into different files) :type pass_bot: :obj:`bool` + :param kwargs: Optional keyword arguments(custom filters) + :return: None """ handler_dict = self._build_handler_dict(callback, func=func, pass_bot=pass_bot, **kwargs) @@ -5301,7 +5371,8 @@ class TeleBot: def callback_query_handler(self, func, **kwargs): """ - Callback request handler decorator + Handles new incoming callback query. + As a parameter to the decorator function, it passes :class:`telebot.types.CallbackQuery` object. :param func: Function executed as a filter :type func: :obj:`function` @@ -5342,6 +5413,8 @@ class TeleBot: :param pass_bot: True if you need to pass TeleBot instance to handler(useful for separating handlers into different files) :type pass_bot: :obj:`bool` + :param kwargs: Optional keyword arguments(custom filters) + :return: None """ handler_dict = self._build_handler_dict(callback, func=func, pass_bot=pass_bot, **kwargs) @@ -5349,7 +5422,8 @@ class TeleBot: def shipping_query_handler(self, func, **kwargs): """ - Shipping request handler + Handles new incoming shipping query. Only for invoices with flexible price. + As a parameter to the decorator function, it passes :class:`telebot.types.ShippingQuery` object. :param func: Function executed as a filter :type func: :obj:`function` @@ -5390,6 +5464,8 @@ class TeleBot: :param pass_bot: True if you need to pass TeleBot instance to handler(useful for separating handlers into different files) :type pass_bot: :obj:`bool` + :param kwargs: Optional keyword arguments(custom filters) + :return: None """ handler_dict = self._build_handler_dict(callback, func=func, pass_bot=pass_bot, **kwargs) @@ -5397,7 +5473,8 @@ class TeleBot: def pre_checkout_query_handler(self, func, **kwargs): """ - Pre-checkout request handler + New incoming pre-checkout query. Contains full information about checkout. + As a parameter to the decorator function, it passes :class:`telebot.types.PreCheckoutQuery` object. :param func: Function executed as a filter :type func: :obj:`function` @@ -5437,6 +5514,8 @@ class TeleBot: :param pass_bot: True if you need to pass TeleBot instance to handler(useful for separating handlers into different files) :type pass_bot: :obj:`bool` + :param kwargs: Optional keyword arguments(custom filters) + :return: decorated function """ handler_dict = self._build_handler_dict(callback, func=func, pass_bot=pass_bot, **kwargs) @@ -5444,7 +5523,8 @@ class TeleBot: def poll_handler(self, func, **kwargs): """ - Poll request handler + Handles new state of a poll. Bots receive only updates about stopped polls and polls, which are sent by the bot + As a parameter to the decorator function, it passes :class:`telebot.types.Poll` object. :param func: Function executed as a filter :type func: :obj:`function` @@ -5484,6 +5564,8 @@ class TeleBot: :param pass_bot: True if you need to pass TeleBot instance to handler(useful for separating handlers into different files) :type pass_bot: :obj:`bool` + :param kwargs: Optional keyword arguments(custom filters) + :return: None """ handler_dict = self._build_handler_dict(callback, func=func, pass_bot=pass_bot, **kwargs) @@ -5491,7 +5573,9 @@ class TeleBot: def poll_answer_handler(self, func=None, **kwargs): """ - Poll_answer request handler + Handles change of user's answer in a non-anonymous poll(when user changes the vote). + Bots receive new votes only in polls that were sent by the bot itself. + As a parameter to the decorator function, it passes :class:`telebot.types.PollAnswer` object. :param func: Function executed as a filter :type func: :obj:`function` @@ -5532,6 +5616,8 @@ class TeleBot: :param pass_bot: True if you need to pass TeleBot instance to handler(useful for separating handlers into different files) :type pass_bot: :obj:`bool` + :param kwargs: Optional keyword arguments(custom filters) + :return: None """ handler_dict = self._build_handler_dict(callback, func=func, pass_bot=pass_bot, **kwargs) @@ -5539,8 +5625,9 @@ class TeleBot: def my_chat_member_handler(self, func=None, **kwargs): """ - The bot's chat member status was updated in a chat. For private chats, + Handles update in a status of a bot. For private chats, this update is received only when the bot is blocked or unblocked by the user. + As a parameter to the decorator function, it passes :class:`telebot.types.ChatMemberUpdated` object. :param func: Function executed as a filter :type func: :obj:`function` @@ -5581,6 +5668,8 @@ class TeleBot: :param pass_bot: True if you need to pass TeleBot instance to handler(useful for separating handlers into different files) :type pass_bot: :obj:`bool` + :param kwargs: Optional keyword arguments(custom filters) + :return: None """ handler_dict = self._build_handler_dict(callback, func=func, pass_bot=pass_bot, **kwargs) @@ -5588,8 +5677,10 @@ class TeleBot: def chat_member_handler(self, func=None, **kwargs): """ - A chat member's status was updated in a chat. The bot must be an administrator - in the chat and must explicitly specify “chat_member” in the list of allowed_updates to receive these updates. + Handles update in a status of a user in a chat. + The bot must be an administrator in the chat and must explicitly specify “chat_member” + in the list of allowed_updates to receive these updates. + As a parameter to the decorator function, it passes :class:`telebot.types.ChatMemberUpdated` object. :param func: Function executed as a filter :type func: :obj:`function` @@ -5639,8 +5730,9 @@ class TeleBot: def chat_join_request_handler(self, func=None, **kwargs): """ - A request to join the chat has been sent. The bot must have the can_invite_users + Handles a request to join the chat has been sent. The bot must have the can_invite_users administrator right in the chat to receive these updates. + As a parameter to the decorator function, it passes :class:`telebot.types.ChatJoinRequest` object. :param func: Function executed as a filter :type func: :obj:`function` @@ -5681,6 +5773,8 @@ class TeleBot: :param pass_bot: True if you need to pass TeleBot instance to handler(useful for separating handlers into different files) :type pass_bot: :obj:`bool` + :param kwargs: Optional keyword arguments(custom filters) + :return: None """ handler_dict = self._build_handler_dict(callback, func=func, pass_bot=pass_bot, **kwargs) @@ -5707,6 +5801,15 @@ class TeleBot: """ Create custom filter. + .. code-block:: python3 + :caption: Example on checking the text of a message + + class TextMatchFilter(AdvancedCustomFilter): + key = 'text' + + async def check(self, message, text): + return text == message.text + :param custom_filter: Class with check(message) method. :param custom_filter: Custom filter class with key. """ diff --git a/telebot/async_telebot.py b/telebot/async_telebot.py index 2241316..569c1d9 100644 --- a/telebot/async_telebot.py +++ b/telebot/async_telebot.py @@ -5,7 +5,7 @@ import logging import re import time import traceback -from typing import Any, List, Optional, Union +from typing import Any, Awaitable, Callable, List, Optional, Union # this imports are used to avoid circular import error import telebot.util @@ -13,7 +13,7 @@ import telebot.types # storages -from telebot.asyncio_storage import StateMemoryStorage, StatePickleStorage +from telebot.asyncio_storage import StateMemoryStorage, StatePickleStorage, StateStorageBase from telebot.asyncio_handler_backends import BaseMiddleware, CancelUpdate, SkipHandler, State from inspect import signature @@ -71,18 +71,38 @@ class AsyncTeleBot: Usage: - .. code-block:: python + .. code-block:: python3 + :caption: Using asynchronous implementation of TeleBot. from telebot.async_telebot import AsyncTeleBot bot = AsyncTeleBot('token') # get token from @BotFather + # now you can register other handlers/update listeners, + # and use bot methods. + # Remember to use async/await keywords when necessary. See more examples in examples/ directory: https://github.com/eternnoir/pyTelegramBotAPI/tree/master/examples + + :param token: Token of a bot, obtained from @BotFather + :type token: :obj:`str` + + :param parse_mode: Default parse mode, defaults to None + :type parse_mode: :obj:`str`, optional + + :param offset: Offset used in get_updates, defaults to None + :type offset: :obj:`int`, optional + + :param exception_handler: Exception handler, which will handle the exception occured, defaults to None + :type exception_handler: Optional[ExceptionHandler], optional + + :param state_storage: Storage for states, defaults to StateMemoryStorage() + :type state_storage: :class:`telebot.asyncio_storage.StateMemoryStorage`, optional + """ - def __init__(self, token: str, parse_mode: Optional[str]=None, offset=None, - exception_handler=None, state_storage=StateMemoryStorage()) -> None: # TODO: ADD TYPEHINTS + def __init__(self, token: str, parse_mode: Optional[str]=None, offset: Optional[int]=None, + exception_handler: Optional[ExceptionHandler]=None, state_storage: Optional[StateStorageBase]=StateMemoryStorage()) -> None: self.token = token self.offset = offset @@ -118,43 +138,73 @@ class AsyncTeleBot: async def close_session(self): """ Closes existing session of aiohttp. - Use this function if you stop polling. + Use this function if you stop polling/webhooks. """ await asyncio_helper.session_manager.session.close() async def get_updates(self, offset: Optional[int]=None, limit: Optional[int]=None, timeout: Optional[int]=20, allowed_updates: Optional[List]=None, request_timeout: Optional[int]=None) -> List[types.Update]: """ - Use this method to receive incoming updates using long polling (wiki). - An Array of Update objects is returned. + Use this method to receive incoming updates using long polling (wiki). An Array of Update objects is returned. - Telegram documentation: https://core.telegram.org/bots/api#making-requests + Telegram documentation: https://core.telegram.org/bots/api#getupdates + + + :param offset: Identifier of the first update to be returned. Must be greater by one than the highest among the identifiers of previously received updates. + By default, updates starting with the earliest unconfirmed update are returned. An update is considered confirmed as soon as getUpdates is called with an offset + higher than its update_id. The negative offset can be specified to retrieve updates starting from -offset update from the end of the updates queue. + All previous updates will forgotten. + :type offset: :obj:`int`, optional + + :param limit: Limits the number of updates to be retrieved. Values between 1-100 are accepted. Defaults to 100. + :type limit: :obj:`int`, optional + + :param timeout: Request connection timeout + :type timeout: :obj:`int`, optional :param allowed_updates: Array of string. List the types of updates you want your bot to receive. - :param offset: Integer. Identifier of the first update to be returned. - :param limit: Integer. Limits the number of updates to be retrieved. - :param timeout: Integer. Request connection timeout - :param request_timeout: Timeout in seconds for a request. - :return: array of Updates + :type allowed_updates: :obj:`list`, optional + + :param long_polling_timeout: Timeout in seconds for long polling. + :type long_polling_timeout: :obj:`int`, optional + + :return: An Array of Update objects is returned. + :rtype: :obj:`list` of :class:`telebot.types.Update` """ json_updates = await asyncio_helper.get_updates(self.token, offset, limit, timeout, allowed_updates, request_timeout) return [types.Update.de_json(ju) for ju in json_updates] async def polling(self, non_stop: bool=False, skip_pending=False, interval: int=0, timeout: int=20, - request_timeout: int=None, allowed_updates: Optional[List[str]]=None, + request_timeout: Optional[int]=None, allowed_updates: Optional[List[str]]=None, none_stop: Optional[bool]=None): """ - This allows the bot to retrieve Updates automatically and notify listeners and message handlers accordingly. + Runs bot in long-polling mode in a main loop. + This allows the bot to retrieve Updates automagically and notify listeners and message handlers accordingly. Warning: Do not call this function more than once! - Always get updates. + Always gets updates. + + .. note:: + + Set non_stop=True if you want your bot to continue receiving updates + if there is an error. + + :param non_stop: Do not stop polling when an ApiException occurs. + :type non_stop: :obj:`bool` + + :param skip_pending: skip old updates + :type skip_pending: :obj:`bool` :param interval: Delay between two update retrivals - :param non_stop: Do not stop polling when an ApiException occurs. + :type interval: :obj:`int` + :param timeout: Request connection timeout - :param skip_pending: skip old updates - :param request_timeout: Timeout in seconds for a request. + :type timeout: :obj:`int` + + :param request_timeout: Timeout in seconds for get_updates(Defaults to None) + :type request_timeout: :obj:`int` + :param allowed_updates: A list of the update types you want your bot to receive. For example, specify [“message”, “edited_channel_post”, “callback_query”] to only receive updates of these types. See util.update_types for a complete list of available update types. @@ -163,7 +213,11 @@ class AsyncTeleBot: Please note that this parameter doesn't affect updates created before the call to the get_updates, so unwanted updates may be received for a short period of time. - :param none_stop: Deprecated, use non_stop. Old typo f***up compatibility + :type allowed_updates: :obj:`list` of :obj:`str` + + :param none_stop: Deprecated, use non_stop. Old typo, kept for backward compatibility. + :type none_stop: :obj:`bool` + :return: """ if none_stop is not None: @@ -174,16 +228,24 @@ class AsyncTeleBot: await self.skip_updates() await self._process_polling(non_stop, interval, timeout, request_timeout, allowed_updates) - async def infinity_polling(self, timeout: int=20, skip_pending: bool=False, request_timeout: int=None, logger_level=logging.ERROR, - allowed_updates: Optional[List[str]]=None, *args, **kwargs): + async def infinity_polling(self, timeout: Optional[int]=20, skip_pending: Optional[bool]=False, request_timeout: Optional[int]=None, + logger_level: Optional[int]=logging.ERROR, allowed_updates: Optional[List[str]]=None, *args, **kwargs): """ Wrap polling with infinite loop and exception handling to avoid bot stops polling. - :param timeout: Request connection timeout - :param request_timeout: Timeout in seconds for long polling (see API docs) + :param timeout: Timeout in seconds for get_updates(Defaults to None) + :type timeout: :obj:`int` + :param skip_pending: skip old updates + :type skip_pending: :obj:`bool` + + :param request_timeout: Aiohttp's request timeout. Defaults to 5 minutes(aiohttp.ClientTimeout). + :type request_timeout: :obj:`int` + :param logger_level: Custom logging level for infinity_polling logging. Use logger levels from logging as a value. None/NOTSET = no error logging + :type logger_level: :obj:`int` + :param allowed_updates: A list of the update types you want your bot to receive. For example, specify [“message”, “edited_channel_post”, “callback_query”] to only receive updates of these types. See util.update_types for a complete list of available update types. @@ -192,13 +254,16 @@ class AsyncTeleBot: Please note that this parameter doesn't affect updates created before the call to the get_updates, so unwanted updates may be received for a short period of time. + :type allowed_updates: :obj:`list` of :obj:`str` + + :return: None """ if skip_pending: await self.skip_updates() self._polling = True while self._polling: try: - await self._process_polling(non_stop=True, timeout=timeout, request_timeout=request_timeout, + await self._process_polling(non_stop=False, timeout=timeout, request_timeout=request_timeout, allowed_updates=allowed_updates, *args, **kwargs) except Exception as e: if logger_level and logger_level >= logging.ERROR: @@ -370,13 +435,16 @@ class AsyncTeleBot: logger.error('Middleware {} does not have post_process_{} method. post_process function execution was skipped.'.format(middleware.__class__.__name__, update_type)) else: await middleware.post_process(message, data, handler_error) # update handling - async def process_new_updates(self, updates): + async def process_new_updates(self, updates: List[types.Update]): """ Process new updates. Just pass list of updates - each update should be instance of Update object. :param updates: list of updates + :type updates: :obj:`list` of :obj:`telebot.types.Update` + + :return: None """ upd_count = len(updates) logger.info('Received {0} new updates'.format(upd_count)) @@ -471,49 +539,94 @@ class AsyncTeleBot: await self.process_chat_join_request(chat_join_request) async def process_new_messages(self, new_messages): + """ + :meta private: + """ await self.__notify_update(new_messages) await self._process_updates(self.message_handlers, new_messages, 'message') async def process_new_edited_messages(self, edited_message): + """ + :meta private: + """ await self._process_updates(self.edited_message_handlers, edited_message, 'edited_message') async def process_new_channel_posts(self, channel_post): + """ + :meta private: + """ await self._process_updates(self.channel_post_handlers, channel_post , 'channel_post') async def process_new_edited_channel_posts(self, edited_channel_post): + """ + :meta private: + """ await self._process_updates(self.edited_channel_post_handlers, edited_channel_post, 'edited_channel_post') async def process_new_inline_query(self, new_inline_querys): + """ + :meta private: + """ await self._process_updates(self.inline_handlers, new_inline_querys, 'inline_query') async def process_new_chosen_inline_query(self, new_chosen_inline_querys): + """ + :meta private: + """ await self._process_updates(self.chosen_inline_handlers, new_chosen_inline_querys, 'chosen_inline_query') async def process_new_callback_query(self, new_callback_querys): + """ + :meta private: + """ await self._process_updates(self.callback_query_handlers, new_callback_querys, 'callback_query') async def process_new_shipping_query(self, new_shipping_querys): + """ + :meta private: + """ await self._process_updates(self.shipping_query_handlers, new_shipping_querys, 'shipping_query') async def process_new_pre_checkout_query(self, pre_checkout_querys): + """ + :meta private: + """ await self._process_updates(self.pre_checkout_query_handlers, pre_checkout_querys, 'pre_checkout_query') async def process_new_poll(self, polls): + """ + :meta private: + """ await self._process_updates(self.poll_handlers, polls, 'poll') async def process_new_poll_answer(self, poll_answers): + """ + :meta private: + """ await self._process_updates(self.poll_answer_handlers, poll_answers, 'poll_answer') async def process_new_my_chat_member(self, my_chat_members): + """ + :meta private: + """ await self._process_updates(self.my_chat_member_handlers, my_chat_members, 'my_chat_member') async def process_new_chat_member(self, chat_members): + """ + :meta private: + """ await self._process_updates(self.chat_member_handlers, chat_members, 'chat_member') async def process_chat_join_request(self, chat_join_request): + """ + :meta private: + """ await self._process_updates(self.chat_join_request_handlers, chat_join_request, 'chat_join_request') async def process_middlewares(self, update_type): + """ + :meta private: + """ if self.middlewares: middlewares = [middleware for middleware in self.middlewares if update_type in middleware.update_types] return middlewares @@ -542,19 +655,43 @@ class AsyncTeleBot: return True - def set_update_listener(self, func): + def set_update_listener(self, func: Awaitable): """ Update listener is a function that gets any update. :param func: function that should get update. + :type func: :obj:`Awaitable` + + .. code-block:: python3 + :caption: Example on asynchronous update listeners. + + async def update_listener(new_messages): + for message in new_messages: + print(message.text) # Prints message text + + bot.set_update_listener(update_listener) + + :return: None """ self.update_listener.append(func) - def add_custom_filter(self, custom_filter): + def add_custom_filter(self, custom_filter: Union[asyncio_filters.SimpleCustomFilter, asyncio_filters.AdvancedCustomFilter]): """ Create custom filter. - custom_filter: Class with check(message) method. + .. code-block:: python3 + :caption: Example on checking the text of a message + + class TextMatchFilter(AdvancedCustomFilter): + key = 'text' + + async def check(self, message, text): + return text == message.text + + :param custom_filter: Class with check(message) method. + :type custom_filter: :class:`telebot.asyncio_filters.SimpleCustomFilter` or :class:`telebot.asyncio_filters.AdvancedCustomFilter` + + :return: None """ self.custom_filters[custom_filter.key] = custom_filter @@ -613,8 +750,14 @@ class AsyncTeleBot: """ Setup middleware. + .. note:: + + Take a look at the :class:`telebot.asyncio_handler_backends.BaseMiddleware` section for more. + :param middleware: Middleware-class. - :return: + :type middleware: :class:`telebot.middlewares.BaseMiddleware` + + :return: None """ if not hasattr(middleware, 'update_types'): logger.error('Middleware has no update_types parameter. Please add list of updates to handle.') @@ -628,44 +771,58 @@ class AsyncTeleBot: def message_handler(self, commands=None, regexp=None, func=None, content_types=None, chat_types=None, **kwargs): """ - Message handler decorator. - This decorator can be used to decorate functions that must handle certain types of messages. + Handles ew incoming message of any kind - text, photo, sticker, etc. + As a parameter to the decorator function, it passes :class:`telebot.types.Message` object. All message handlers are tested in the order they were added. Example: - .. code-block:: python + .. code-block:: python3 + :caption: Usage of message_handler bot = TeleBot('TOKEN') # Handles all messages which text matches regexp. @bot.message_handler(regexp='someregexp') async def command_help(message): - bot.send_message(message.chat.id, 'Did someone call for help?') + await bot.send_message(message.chat.id, 'Did someone call for help?') # Handles messages in private chat @bot.message_handler(chat_types=['private']) # You can add more chat types async def command_help(message): - bot.send_message(message.chat.id, 'Private chat detected, sir!') + await bot.send_message(message.chat.id, 'Private chat detected, sir!') # Handle all sent documents of type 'text/plain'. @bot.message_handler(func=lambda message: message.document.mime_type == 'text/plain', content_types=['document']) async def command_handle_document(message): - bot.send_message(message.chat.id, 'Document received, sir!') + await bot.send_message(message.chat.id, 'Document received, sir!') # Handle all other messages. @bot.message_handler(func=lambda message: True, content_types=['audio', 'photo', 'voice', 'video', 'document', 'text', 'location', 'contact', 'sticker']) - async def async default_command(message): - bot.send_message(message.chat.id, "This is the async default command handler.") + async def default_command(message): + await bot.send_message(message.chat.id, "This is the default command handler.") :param commands: Optional list of strings (commands to handle). + :type commands: :obj:`list` of :obj:`str` + :param regexp: Optional regular expression. + :type regexp: :obj:`str` + :param func: Optional lambda function. The lambda receives the message to test as the first parameter. It must return True if the command should handle the message. - :param content_types: Supported message content types. Must be a list. async defaults to ['text']. + + + :param content_types: Supported message content types. Must be a list. Defaults to ['text']. + :type content_types: :obj:`list` of :obj:`str` + :param chat_types: list of chat types + :type chat_types: :obj:`list` of :obj:`str` + + :param kwargs: Optional keyword arguments(custom filters) + + :return: decorated function """ if content_types is None: @@ -696,24 +853,43 @@ class AsyncTeleBot: """ Adds a message handler. Note that you should use register_message_handler to add message_handler. + + :meta private: :param handler_dict: :return: """ self.message_handlers.append(handler_dict) - def register_message_handler(self, callback, content_types=None, commands=None, regexp=None, func=None, chat_types=None, pass_bot=False, **kwargs): + def register_message_handler(self, callback: Awaitable, content_types: Optional[List[str]]=None, commands: Optional[List[str]]=None, + regexp: Optional[str]=None, func: Optional[Callable]=None, chat_types: Optional[List[str]]=None, pass_bot: Optional[bool]=False, **kwargs): """ Registers message handler. :param callback: function to be called - :param content_types: list of content_types + :type callback: :obj:`Awaitable` + + :param content_types: Supported message content types. Must be a list. Defaults to ['text']. + :type content_types: :obj:`list` of :obj:`str` + :param commands: list of commands + :type commands: :obj:`list` of :obj:`str` + :param regexp: - :param func: - :param chat_types: True for private chat - :param pass_bot: True if you want to get TeleBot instance in your handler - :return: decorated function + :type regexp: :obj:`str` + + :param func: Function executed as a filter + :type func: :obj:`function` + + :param chat_types: List of chat types + :type chat_types: :obj:`list` of :obj:`str` + + :param pass_bot: True if you need to pass TeleBot instance to handler(useful for separating handlers into different files) + :type pass_bot: :obj:`bool` + + :param kwargs: Optional keyword arguments(custom filters) + + :return: None """ if content_types is None: content_types = ["text"] @@ -737,15 +913,28 @@ class AsyncTeleBot: def edited_message_handler(self, commands=None, regexp=None, func=None, content_types=None, chat_types=None, **kwargs): """ - Edit message handler decorator. + Handles new version of a message that is known to the bot and was edited. + + As a parameter to the decorator function, it passes :class:`telebot.types.Message` object. + + :param commands: Optional list of strings (commands to handle). + :type commands: :obj:`list` of :obj:`str` + + :param regexp: Optional regular expression. + :type regexp: :obj:`str` + + :param func: Function executed as a filter + :type func: :obj:`function` + + :param content_types: Supported message content types. Must be a list. Defaults to ['text']. + :type content_types: :obj:`list` of :obj:`str` - :param commands: - :param regexp: - :param func: - :param content_types: :param chat_types: list of chat types - :param kwargs: - :return: + :type chat_types: :obj:`list` of :obj:`str` + + :param kwargs: Optional keyword arguments(custom filters) + + :return: None """ if content_types is None: @@ -777,23 +966,43 @@ class AsyncTeleBot: Adds the edit message handler. Note that you should use register_edited_message_handler to add edited_message_handler. + :meta private: + :param handler_dict: :return: """ self.edited_message_handlers.append(handler_dict) - def register_edited_message_handler(self, callback, content_types=None, commands=None, regexp=None, func=None, chat_types=None, pass_bot=False, **kwargs): + def register_edited_message_handler(self, callback: Awaitable, content_types: Optional[List[str]]=None, + commands: Optional[List[str]]=None, regexp: Optional[str]=None, func: Optional[Callable]=None, + chat_types: Optional[List[str]]=None, pass_bot: Optional[bool]=False, **kwargs): """ Registers edited message handler. - :param pass_bot: :param callback: function to be called - :param content_types: list of content_types + :type callback: :obj:`Awaitable` + + :param content_types: Supported message content types. Must be a list. Defaults to ['text']. + :type content_types: :obj:`list` of :obj:`str` + :param commands: list of commands - :param regexp: - :param func: + :type commands: :obj:`list` of :obj:`str` + + :param regexp: Regular expression + :type regexp: :obj:`str` + + :param func: Function executed as a filter + :type func: :obj:`function` + :param chat_types: True for private chat - :return: decorated function + :type chat_types: :obj:`bool` + + :param pass_bot: True if you need to pass TeleBot instance to handler(useful for separating handlers into different files) + :type pass_bot: :obj:`bool` + + :param kwargs: Optional keyword arguments(custom filters) + + :return: None """ if isinstance(commands, str): logger.warning("register_edited_message_handler: 'commands' filter should be List of strings (commands), not string.") @@ -816,14 +1025,23 @@ class AsyncTeleBot: def channel_post_handler(self, commands=None, regexp=None, func=None, content_types=None, **kwargs): """ - Channel post handler decorator. + Handles new incoming channel post of any kind - text, photo, sticker, etc. + As a parameter to the decorator function, it passes :class:`telebot.types.Message` object. - :param commands: - :param regexp: - :param func: - :param content_types: - :param kwargs: - :return: + :param commands: Optional list of strings (commands to handle). + :type commands: :obj:`list` of :obj:`str` + + :param regexp: Optional regular expression. + :type regexp: :obj:`str` + + :param func: Function executed as a filter + :type func: :obj:`function` + + :param content_types: Supported message content types. Must be a list. Defaults to ['text']. + :type content_types: :obj:`list` of :obj:`str` + + :param kwargs: Optional keyword arguments(custom filters) + :return: None """ if content_types is None: content_types = ["text"] @@ -853,22 +1071,39 @@ class AsyncTeleBot: Adds channel post handler. Note that you should use register_channel_post_handler to add channel_post_handler. + :meta private: + :param handler_dict: :return: """ self.channel_post_handlers.append(handler_dict) - def register_channel_post_handler(self, callback, content_types=None, commands=None, regexp=None, func=None, pass_bot=False, **kwargs): + def register_channel_post_handler(self, callback: Awaitable, content_types: Optional[List[str]]=None, commands: Optional[List[str]]=None, + regexp: Optional[str]=None, func: Optional[Callable]=None, pass_bot: Optional[bool]=False, **kwargs): """ Registers channel post message handler. - :param pass_bot: :param callback: function to be called - :param content_types: list of content_types + :type callback: :obj:`Awaitable` + + :param content_types: Supported message content types. Must be a list. Defaults to ['text']. + :type content_types: :obj:`list` of :obj:`str` + :param commands: list of commands - :param regexp: - :param func: - :return: decorated function + :type commands: :obj:`list` of :obj:`str` + + :param regexp: Regular expression + :type regexp: :obj:`str` + + :param func: Function executed as a filter + :type func: :obj:`function` + + :param pass_bot: True if you need to pass TeleBot instance to handler(useful for separating handlers into different files) + :type pass_bot: :obj:`bool` + + :param kwargs: Optional keyword arguments(custom filters) + + :return: None """ if isinstance(commands, str): logger.warning("register_channel_post_handler: 'commands' filter should be List of strings (commands), not string.") @@ -889,13 +1124,23 @@ class AsyncTeleBot: def edited_channel_post_handler(self, commands=None, regexp=None, func=None, content_types=None, **kwargs): """ - Edit channel post handler decorator. + Handles new version of a channel post that is known to the bot and was edited. + As a parameter to the decorator function, it passes :class:`telebot.types.Message` object. + + :param commands: Optional list of strings (commands to handle). + :type commands: :obj:`list` of :obj:`str` + + :param regexp: Optional regular expression. + :type regexp: :obj:`str` + + :param func: Function executed as a filter + :type func: :obj:`function` + + :param content_types: Supported message content types. Must be a list. Defaults to ['text']. + :type content_types: :obj:`list` of :obj:`str` + + :param kwargs: Optional keyword arguments(custom filters) - :param commands: - :param regexp: - :param func: - :param content_types: - :param kwargs: :return: """ if content_types is None: @@ -926,21 +1171,38 @@ class AsyncTeleBot: Adds the edit channel post handler. Note that you should use register_edited_channel_post_handler to add edited_channel_post_handler. + :meta private: + :param handler_dict: :return: """ self.edited_channel_post_handlers.append(handler_dict) - def register_edited_channel_post_handler(self, callback, content_types=None, commands=None, regexp=None, func=None, pass_bot=False, **kwargs): + def register_edited_channel_post_handler(self, callback: Awaitable, content_types: Optional[List[str]]=None, + commands: Optional[List[str]]=None, regexp: Optional[str]=None, func: Optional[Callable]=None, pass_bot: Optional[bool]=False, **kwargs): """ Registers edited channel post message handler. - :param pass_bot: :param callback: function to be called - :param content_types: list of content_types + :type callback: :obj:`Awaitable` + + :param content_types: Supported message content types. Must be a list. Defaults to ['text']. + :type content_types: :obj:`list` of :obj:`str` + :param commands: list of commands - :param regexp: - :param func: + :type commands: :obj:`list` of :obj:`str` + + :param regexp: Regular expression + :type regexp: :obj:`str` + + :param func: Function executed as a filter + :type func: :obj:`function` + + :param pass_bot: True if you need to pass TeleBot instance to handler(useful for separating handlers into different files) + :type pass_bot: :obj:`bool` + + :param kwargs: Optional keyword arguments(custom filters) + :return: decorated function """ if isinstance(commands, str): @@ -962,11 +1224,15 @@ class AsyncTeleBot: def inline_handler(self, func, **kwargs): """ - Inline call handler decorator. + Handles new incoming inline query. + As a parameter to the decorator function, it passes :class:`telebot.types.InlineQuery` object. - :param func: - :param kwargs: - :return: + :param func: Function executed as a filter + :type func: :obj:`function` + + :param kwargs: Optional keyword arguments(custom filters) + + :return: None """ def decorator(handler): @@ -981,18 +1247,28 @@ class AsyncTeleBot: Adds inline call handler. Note that you should use register_inline_handler to add inline_handler. + :meta private: + :param handler_dict: :return: """ self.inline_handlers.append(handler_dict) - def register_inline_handler(self, callback, func, pass_bot=False, **kwargs): + def register_inline_handler(self, callback: Awaitable, func: Callable, pass_bot: Optional[bool]=False, **kwargs): """ Registers inline handler. - :param pass_bot: :param callback: function to be called - :param func: + :type callback: :obj:`Awaitable` + + :param func: Function executed as a filter + :type func: :obj:`function` + + :param pass_bot: True if you need to pass TeleBot instance to handler(useful for separating handlers into different files) + :type pass_bot: :obj:`bool` + + :param kwargs: Optional keyword arguments(custom filters) + :return: decorated function """ handler_dict = self._build_handler_dict(callback, func=func, pass_bot=pass_bot, **kwargs) @@ -1000,12 +1276,16 @@ class AsyncTeleBot: def chosen_inline_handler(self, func, **kwargs): """ + The result of an inline query that was chosen by a user and sent to their chat partner. + Please see our documentation on the feedback collecting for details on how to enable these updates for your bot. + As a parameter to the decorator function, it passes :class:`telebot.types.ChosenInlineResult` object. - Description: TBD + :param func: Function executed as a filter + :type func: :obj:`function` - :param func: - :param kwargs: - :return: + :param kwargs: Optional keyword arguments(custom filters) + + :return: None """ def decorator(handler): @@ -1020,30 +1300,44 @@ class AsyncTeleBot: Description: TBD Note that you should use register_chosen_inline_handler to add chosen_inline_handler. + :meta private: + :param handler_dict: :return: """ self.chosen_inline_handlers.append(handler_dict) - def register_chosen_inline_handler(self, callback, func, pass_bot=False, **kwargs): + def register_chosen_inline_handler(self, callback: Awaitable, func: Callable, pass_bot: Optional[bool]=False, **kwargs): """ Registers chosen inline handler. - :param pass_bot: :param callback: function to be called - :param func: - :return: decorated function + :type callback: :obj:`Awaitable` + + :param func: Function executed as a filter + :type func: :obj:`function` + + :param pass_bot: True if you need to pass TeleBot instance to handler(useful for separating handlers into different files) + :type pass_bot: :obj:`bool` + + :param kwargs: Optional keyword arguments(custom filters) + + :return: None """ handler_dict = self._build_handler_dict(callback, func=func, pass_bot=pass_bot, **kwargs) self.add_chosen_inline_handler(handler_dict) def callback_query_handler(self, func, **kwargs): """ - Callback request handler decorator. + Handles new incoming callback query. + As a parameter to the decorator function, it passes :class:`telebot.types.CallbackQuery` object. - :param func: - :param kwargs: - :return: + :param func: Function executed as a filter + :type func: :obj:`function` + + :param kwargs: Optional keyword arguments(custom filters) + + :return: None """ def decorator(handler): @@ -1058,30 +1352,44 @@ class AsyncTeleBot: Adds a callback request handler. Note that you should use register_callback_query_handler to add callback_query_handler. + :meta private: + :param handler_dict: :return: """ self.callback_query_handlers.append(handler_dict) - def register_callback_query_handler(self, callback, func, pass_bot=False, **kwargs): + def register_callback_query_handler(self, callback: Awaitable, func: Callable, pass_bot: Optional[bool]=False, **kwargs): """ Registers callback query handler. - :param pass_bot: :param callback: function to be called - :param func: - :return: decorated function + :type callback: :obj:`Awaitable` + + :param func: Function executed as a filter + :type func: :obj:`function` + + :param pass_bot: True if you need to pass TeleBot instance to handler(useful for separating handlers into different files) + :type pass_bot: :obj:`bool` + + :param kwargs: Optional keyword arguments(custom filters) + + :return: None """ handler_dict = self._build_handler_dict(callback, func=func, pass_bot=pass_bot, **kwargs) self.add_callback_query_handler(handler_dict) def shipping_query_handler(self, func, **kwargs): """ - Shipping request handler. + Handles new incoming shipping query. Only for invoices with flexible price. + As a parameter to the decorator function, it passes :class:`telebot.types.ShippingQuery` object. - :param func: - :param kwargs: - :return: + :param func: Function executed as a filter + :type func: :obj:`function` + + :param kwargs: Optional keyword arguments(custom filters) + + :return: None """ def decorator(handler): @@ -1096,30 +1404,44 @@ class AsyncTeleBot: Adds a shipping request handler. Note that you should use register_shipping_query_handler to add shipping_query_handler. + :meta private: + :param handler_dict: :return: """ self.shipping_query_handlers.append(handler_dict) - def register_shipping_query_handler(self, callback, func, pass_bot=False, **kwargs): + def register_shipping_query_handler(self, callback: Awaitable, func: Callable, pass_bot: Optional[bool]=False, **kwargs): """ Registers shipping query handler. - :param pass_bot: :param callback: function to be called - :param func: - :return: decorated function + :type callback: :obj:`Awaitable` + + :param func: Function executed as a filter + :type func: :obj:`function` + + :param pass_bot: True if you need to pass TeleBot instance to handler(useful for separating handlers into different files) + :type pass_bot: :obj:`bool` + + :param kwargs: Optional keyword arguments(custom filters) + + :return: None """ handler_dict = self._build_handler_dict(callback, func=func, pass_bot=pass_bot, **kwargs) self.add_shipping_query_handler(handler_dict) def pre_checkout_query_handler(self, func, **kwargs): """ - Pre-checkout request handler. + New incoming pre-checkout query. Contains full information about checkout. + As a parameter to the decorator function, it passes :class:`telebot.types.PreCheckoutQuery` object. - :param func: - :param kwargs: - :return: + :param func: Function executed as a filter + :type func: :obj:`function` + + :param kwargs: Optional keyword arguments(custom filters) + + :return: None """ def decorator(handler): @@ -1134,18 +1456,27 @@ class AsyncTeleBot: Adds a pre-checkout request handler. Note that you should use register_pre_checkout_query_handler to add pre_checkout_query_handler. + :meta private: + :param handler_dict: :return: """ self.pre_checkout_query_handlers.append(handler_dict) - def register_pre_checkout_query_handler(self, callback, func, pass_bot=False, **kwargs): + def register_pre_checkout_query_handler(self, callback: Awaitable, func: Callable, pass_bot: Optional[bool]=False, **kwargs): """ Registers pre-checkout request handler. - :param pass_bot: :param callback: function to be called - :param func: + :type callback: :obj:`Awaitable` + + :param func: Function executed as a filter + + :param pass_bot: True if you need to pass TeleBot instance to handler(useful for separating handlers into different files) + :type pass_bot: :obj:`bool` + + :param kwargs: Optional keyword arguments(custom filters) + :return: decorated function """ handler_dict = self._build_handler_dict(callback, func=func, pass_bot=pass_bot, **kwargs) @@ -1153,11 +1484,14 @@ class AsyncTeleBot: def poll_handler(self, func, **kwargs): """ - Poll request handler. + Handles new state of a poll. Bots receive only updates about stopped polls and polls, which are sent by the bot + As a parameter to the decorator function, it passes :class:`telebot.types.Poll` object. - :param func: - :param kwargs: - :return: + :param func: Function executed as a filter + :type func: :obj:`function` + + :param kwargs: Optional keyword arguments(custom filters) + :return: None """ def decorator(handler): @@ -1172,30 +1506,45 @@ class AsyncTeleBot: Adds a poll request handler. Note that you should use register_poll_handler to add poll_handler. + :meta private: + :param handler_dict: :return: """ self.poll_handlers.append(handler_dict) - def register_poll_handler(self, callback, func, pass_bot=False, **kwargs): + def register_poll_handler(self, callback: Awaitable, func: Callable, pass_bot: Optional[bool]=False, **kwargs): """ Registers poll handler. - :param pass_bot: :param callback: function to be called - :param func: - :return: decorated function + :type callback: :obj:`Awaitable` + + :param func: Function executed as a filter + :type func: :obj:`function` + + :param pass_bot: True if you need to pass TeleBot instance to handler(useful for separating handlers into different files) + :type pass_bot: :obj:`bool` + + :param kwargs: Optional keyword arguments(custom filters) + + :return: None """ handler_dict = self._build_handler_dict(callback, func=func, pass_bot=pass_bot, **kwargs) self.add_poll_handler(handler_dict) def poll_answer_handler(self, func=None, **kwargs): """ - Poll_answer request handler. + Handles change of user's answer in a non-anonymous poll(when user changes the vote). + Bots receive new votes only in polls that were sent by the bot itself. + As a parameter to the decorator function, it passes :class:`telebot.types.PollAnswer` object. - :param func: - :param kwargs: - :return: + :param func: Function executed as a filter + :type func: :obj:`function` + + :param kwargs: Optional keyword arguments(custom filters) + + :return: None """ def decorator(handler): @@ -1210,30 +1559,45 @@ class AsyncTeleBot: Adds a poll_answer request handler. Note that you should use register_poll_answer_handler to add poll_answer_handler. + :meta private: + :param handler_dict: :return: """ self.poll_answer_handlers.append(handler_dict) - def register_poll_answer_handler(self, callback, func, pass_bot=False, **kwargs): + def register_poll_answer_handler(self, callback: Awaitable, func: Callable, pass_bot: Optional[bool]=False, **kwargs): """ Registers poll answer handler. - :param pass_bot: :param callback: function to be called - :param func: - :return: decorated function + :type callback: :obj:`Awaitable` + + :param func: Function executed as a filter + :type func: :obj:`function` + + :param pass_bot: True if you need to pass TeleBot instance to handler(useful for separating handlers into different files) + :type pass_bot: :obj:`bool` + + :param kwargs: Optional keyword arguments(custom filters) + + :return: None """ handler_dict = self._build_handler_dict(callback, func=func, pass_bot=pass_bot, **kwargs) self.add_poll_answer_handler(handler_dict) def my_chat_member_handler(self, func=None, **kwargs): """ - my_chat_member handler. + Handles update in a status of a bot. For private chats, + this update is received only when the bot is blocked or unblocked by the user. + As a parameter to the decorator function, it passes :class:`telebot.types.ChatMemberUpdated` object. - :param func: - :param kwargs: - :return: + :param func: Function executed as a filter + :type func: :obj:`function` + + :param kwargs: Optional keyword arguments(custom filters) + + :return: None """ def decorator(handler): @@ -1248,30 +1612,46 @@ class AsyncTeleBot: Adds a my_chat_member handler. Note that you should use register_my_chat_member_handler to add my_chat_member_handler. + :meta private: + :param handler_dict: :return: """ self.my_chat_member_handlers.append(handler_dict) - def register_my_chat_member_handler(self, callback, func=None, pass_bot=False, **kwargs): + def register_my_chat_member_handler(self, callback: Awaitable, func: Optional[Callable]=None, pass_bot: Optional[Callable]=False, **kwargs): """ Registers my chat member handler. - :param pass_bot: :param callback: function to be called - :param func: - :return: decorated function + :type callback: :obj:`Awaitable` + + :param func: Function executed as a filter + :type func: :obj:`function` + + :param pass_bot: True if you need to pass TeleBot instance to handler(useful for separating handlers into different files) + :type pass_bot: :obj:`bool` + + :param kwargs: Optional keyword arguments(custom filters) + + :return: None """ handler_dict = self._build_handler_dict(callback, func=func, pass_bot=pass_bot, **kwargs) self.add_my_chat_member_handler(handler_dict) def chat_member_handler(self, func=None, **kwargs): """ - chat_member handler. + Handles update in a status of a user in a chat. + The bot must be an administrator in the chat and must explicitly specify “chat_member” + in the list of allowed_updates to receive these updates. + As a parameter to the decorator function, it passes :class:`telebot.types.ChatMemberUpdated` object. - :param func: - :param kwargs: - :return: + :param func: Function executed as a filter + :type func: :obj:`function` + + :param kwargs: Optional keyword arguments(custom filters) + + :return: None """ def decorator(handler): @@ -1286,30 +1666,45 @@ class AsyncTeleBot: Adds a chat_member handler. Note that you should use register_chat_member_handler to add chat_member_handler. + :meta private: + :param handler_dict: :return: """ self.chat_member_handlers.append(handler_dict) - def register_chat_member_handler(self, callback, func=None, pass_bot=False, **kwargs): + def register_chat_member_handler(self, callback: Awaitable, func: Optional[Callable]=None, pass_bot: Optional[bool]=False, **kwargs): """ Registers chat member handler. - :param pass_bot: :param callback: function to be called - :param func: - :return: decorated function + :type callback: :obj:`Awaitable`` + + :param func: Function executed as a filter + :type func: :obj:`function` + + :param pass_bot: True if you need to pass TeleBot instance to handler(useful for separating handlers into different files) + :type pass_bot: :obj:`bool` + + :param kwargs: Optional keyword arguments(custom filters) + + :return:None """ handler_dict = self._build_handler_dict(callback, func=func, pass_bot=pass_bot, **kwargs) self.add_chat_member_handler(handler_dict) def chat_join_request_handler(self, func=None, **kwargs): """ - chat_join_request handler. + Handles a request to join the chat has been sent. The bot must have the can_invite_users + administrator right in the chat to receive these updates. + As a parameter to the decorator function, it passes :class:`telebot.types.ChatJoinRequest` object. - :param func: - :param kwargs: - :return: + :param func: Function executed as a filter + :type func: :obj:`function` + + :param kwargs: Optional keyword arguments(custom filters) + + :return: None """ def decorator(handler): @@ -1324,19 +1719,29 @@ class AsyncTeleBot: Adds a chat_join_request handler. Note that you should use register_chat_join_request_handler to add chat_join_request_handler. + :meta private: + :param handler_dict: :return: """ self.chat_join_request_handlers.append(handler_dict) - def register_chat_join_request_handler(self, callback, func=None, pass_bot=False, **kwargs): + def register_chat_join_request_handler(self, callback: Awaitable, func: Optional[Callable]=None, pass_bot:Optional[bool]=False, **kwargs): """ Registers chat join request handler. - :param pass_bot: :param callback: function to be called - :param func: - :return: decorated function + :type callback: :obj:`Awaitable` + + :param func: Function executed as a filter + :type func: :obj:`function` + + :param pass_bot: True if you need to pass TeleBot instance to handler(useful for separating handlers into different files) + :type pass_bot: :obj:`bool` + + :param kwargs: Optional keyword arguments(custom filters) + + :return: None """ handler_dict = self._build_handler_dict(callback, func=func, pass_bot=pass_bot, **kwargs) self.add_chat_join_request_handler(handler_dict) @@ -1377,7 +1782,7 @@ class AsyncTeleBot: result = await asyncio_helper.get_me(self.token) return types.User.de_json(result) - async def get_file(self, file_id: str) -> types.File: + async def get_file(self, file_id: Optional[str]) -> types.File: """ Use this method to get basic info about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. @@ -1387,15 +1792,35 @@ class AsyncTeleBot: Telegram documentation: https://core.telegram.org/bots/api#getfile - :param file_id: + :param file_id: File identifier + :type file_id: :obj:`str` + + :return: :class:`telebot.types.File` """ return types.File.de_json(await asyncio_helper.get_file(self.token, file_id)) - async def get_file_url(self, file_id: str) -> str: - + async def get_file_url(self, file_id: Optional[str]) -> str: + """ + Get a valid URL for downloading a file. + + :param file_id: File identifier to get download URL for. + :type file_id: :obj:`str` + + :return: URL for downloading the file. + :rtype: :obj:`str` + """ return await asyncio_helper.get_file_url(self.token, file_id) - async def download_file(self, file_path: str) -> bytes: + async def download_file(self, file_path: Optional[str]) -> bytes: + """ + Downloads file. + + :param file_path: Path where the file should be downloaded. + :type file_path: str + + :return: bytes + :rtype: :obj:`bytes` + """ return await asyncio_helper.download_file(self.token, file_path) async def log_out(self) -> bool: @@ -1408,6 +1833,9 @@ class AsyncTeleBot: Returns True on success. Telegram documentation: https://core.telegram.org/bots/api#logout + + :return: True on success. + :rtype: :obj:`bool` """ return await asyncio_helper.log_out(self.token) @@ -1420,6 +1848,8 @@ class AsyncTeleBot: Returns True on success. Telegram documentation: https://core.telegram.org/bots/api#close + + :return: :obj:`bool` """ return await asyncio_helper.close(self.token) @@ -1427,39 +1857,68 @@ class AsyncTeleBot: """ Enable saving states (by default saving disabled) - :param filename: Filename of saving file + .. note:: + It is recommended to pass a :class:`~telebot.asyncio_storage.StatePickleStorage` instance as state_storage + to TeleBot class. + + :param filename: Filename of saving file, defaults to "./.state-save/states.pkl" + :type filename: :obj:`str`, optional """ self.current_states = StatePickleStorage(file_path=filename) - async def set_webhook(self, url=None, certificate=None, max_connections=None, allowed_updates=None, ip_address=None, - drop_pending_updates = None, timeout=None, secret_token=None): + async def set_webhook(self, url: Optional[str]=None, certificate: Optional[Union[str, Any]]=None, max_connections: Optional[int]=None, + allowed_updates: Optional[List[str]]=None, ip_address: Optional[str]=None, + drop_pending_updates: Optional[bool] = None, timeout: Optional[int]=None, + secret_token: Optional[str]=None) -> bool: """ - Use this method to specify a url and receive incoming updates via an outgoing webhook. Whenever there is an - update for the bot, we will send an HTTPS POST request to the specified url, - containing a JSON-serialized Update. - In case of an unsuccessful request, we will give up after a reasonable amount of attempts. - Returns True on success. + Use this method to specify a URL and receive incoming updates via an outgoing webhook. + Whenever there is an update for the bot, we will send an HTTPS POST request to the specified URL, + containing a JSON-serialized Update. In case of an unsuccessful request, we will give up after + a reasonable amount of attempts. Returns True on success. - Telegram documentation: https://core.telegram.org/bots/api#setwebhook + If you'd like to make sure that the webhook was set by you, you can specify secret data in the parameter secret_token. + If specified, the request will contain a header “X-Telegram-Bot-Api-Secret-Token” with the secret token as content. - :param url: HTTPS url to send updates to. Use an empty string to remove webhook integration - :param certificate: Upload your public key certificate so that the root certificate in use can be checked. - See our self-signed guide for details. - :param max_connections: Maximum allowed number of simultaneous HTTPS connections to the webhook - for update delivery, 1-100. Defaults to 40. Use lower values to limit the load on your bot's server, - and higher values to increase your bot's throughput. - :param allowed_updates: A JSON-serialized list of the update types you want your bot to receive. - For example, specify [“message”, “edited_channel_post”, “callback_query”] to only receive updates - of these types. See Update for a complete list of available update types. - Specify an empty list to receive all updates regardless of type (default). + Telegram Documentation: https://core.telegram.org/bots/api#setwebhook + + :param url: HTTPS URL to send updates to. Use an empty string to remove webhook integration, defaults to None + :type url: :obj:`str`, optional + + :param certificate: Upload your public key certificate so that the root certificate in use can be checked, defaults to None + :type certificate: :class:`str`, optional + + :param max_connections: The maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery, 1-100. + Defaults to 40. Use lower values to limit the load on your bot's server, and higher values to increase your bot's throughput, + defaults to None + :type max_connections: :obj:`int`, optional + + :param allowed_updates: A JSON-serialized list of the update types you want your bot to receive. For example, + specify [“message”, “edited_channel_post”, “callback_query”] to only receive updates of these types. See Update + for a complete list of available update types. Specify an empty list to receive all update types except chat_member (default). If not specified, the previous setting will be used. + + Please note that this parameter doesn't affect updates created before the call to the setWebhook, so unwanted updates may be received + for a short period of time. Defaults to None + + :type allowed_updates: :obj:`list`, optional + :param ip_address: The fixed IP address which will be used to send webhook requests instead of the IP address - resolved through DNS - :param drop_pending_updates: Pass True to drop all pending updates - :param timeout: Integer. Request connection timeout - :param secret_token: Secret token to be used to verify the webhook - :return: + resolved through DNS, defaults to None + :type ip_address: :obj:`str`, optional + + :param drop_pending_updates: Pass True to drop all pending updates, defaults to None + :type drop_pending_updates: :obj:`bool`, optional + + :param timeout: Timeout of a request, defaults to None + :type timeout: :obj:`int`, optional + + :param secret_token: A secret token to be sent in a header “X-Telegram-Bot-Api-Secret-Token” in every webhook request, 1-256 characters. + Only characters A-Z, a-z, 0-9, _ and - are allowed. The header is useful to ensure that the request comes from a webhook set by you. Defaults to None + :type secret_token: :obj:`str`, optional + + :return: True on success. + :rtype: :obj:`bool` if the request was successful. """ return await asyncio_helper.set_webhook(self.token, url, certificate, max_connections, allowed_updates, ip_address, drop_pending_updates, timeout, secret_token) @@ -1545,33 +2004,43 @@ class AsyncTeleBot: - async def delete_webhook(self, drop_pending_updates=None, timeout=None): + async def delete_webhook(self, drop_pending_updates: Optional[bool]=None, timeout: Optional[int]=None) -> bool: """ Use this method to remove webhook integration if you decide to switch back to getUpdates. + Returns True on success. Telegram documentation: https://core.telegram.org/bots/api#deletewebhook - :param drop_pending_updates: Pass True to drop all pending updates - :param timeout: Integer. Request connection timeout - :return: bool + :param drop_pending_updates: Pass True to drop all pending updates, defaults to None + :type drop_pending_updates: :obj: `bool`, optional + + :param timeout: Request connection timeout, defaults to None + :type timeout: :obj:`int`, optional + + :return: Returns True on success. + :rtype: :obj:`bool` """ return await asyncio_helper.delete_webhook(self.token, drop_pending_updates, timeout) - async def remove_webhook(self): + async def remove_webhook(self) -> bool: """ Alternative for delete_webhook but uses set_webhook """ - await self.set_webhook() + result = await self.set_webhook() + return result - async def get_webhook_info(self, timeout=None): + async def get_webhook_info(self, timeout: Optional[int]=None) -> types.WebhookInfo: """ Use this method to get current webhook status. Requires no parameters. - If the bot is using getUpdates, will return an object with the url field empty. + On success, returns a WebhookInfo object. If the bot is using getUpdates, will return an object with the url field empty. Telegram documentation: https://core.telegram.org/bots/api#getwebhookinfo - :param timeout: Integer. Request connection timeout + :param timeout: Request connection timeout + :type timeout: :obj:`int`, optional + :return: On success, returns a WebhookInfo object. + :rtype: :class:`telebot.types.WebhookInfo` """ result = await asyncio_helper.get_webhook_info(self.token, timeout) return types.WebhookInfo.de_json(result) @@ -1579,14 +2048,23 @@ class AsyncTeleBot: async def get_user_profile_photos(self, user_id: int, offset: Optional[int]=None, limit: Optional[int]=None) -> types.UserProfilePhotos: """ - Retrieves the user profile photos of the person with 'user_id' + Use this method to get a list of profile pictures for a user. + Returns a :class:`telebot.types.UserProfilePhotos` object. Telegram documentation: https://core.telegram.org/bots/api#getuserprofilephotos - :param user_id: - :param offset: - :param limit: - :return: API reply. + :param user_id: Unique identifier of the target user + :type user_id: :obj:`int` + + :param offset: Sequential number of the first photo to be returned. By default, all photos are returned. + :type offset: :obj:`int` + + :param limit: Limits the number of photos to be retrieved. Values between 1-100 are accepted. Defaults to 100. + :type limit: :obj:`int` + + :return: `UserProfilePhotos `_ + :rtype: :class:`telebot.types.UserProfilePhotos` + """ result = await asyncio_helper.get_user_profile_photos(self.token, user_id, offset, limit) return types.UserProfilePhotos.de_json(result) @@ -1598,8 +2076,11 @@ class AsyncTeleBot: Telegram documentation: https://core.telegram.org/bots/api#getchat - :param chat_id: - :return: + :param chat_id: Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername) + :type chat_id: :obj:`int` or :obj:`str` + + :return: Chat information + :rtype: :class:`telebot.types.Chat` """ result = await asyncio_helper.get_chat(self.token, chat_id) return types.Chat.de_json(result) @@ -1610,8 +2091,10 @@ class AsyncTeleBot: Telegram documentation: https://core.telegram.org/bots/api#leavechat - :param chat_id: - :return: + :param chat_id: Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername) + :type chat_id: :obj:`int` or :obj:`str` + + :return: :obj:`bool` """ result = await asyncio_helper.leave_chat(self.token, chat_id) return result @@ -1622,10 +2105,12 @@ class AsyncTeleBot: On success, returns an Array of ChatMember objects that contains information about all chat administrators except other bots. - Telegram documentation: https://core.telegram.org/bots/api#getchatadministrators + Telegram documentation: https://core.telegram.org/bots/api#getchatadministrators - :param chat_id: Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername) - :return: API reply. + :param chat_id: Unique identifier for the target chat or username + of the target supergroup or channel (in the format @channelusername) + :return: List made of ChatMember objects. + :rtype: :obj:`list` of :class:`telebot.types.ChatMember` """ result = await asyncio_helper.get_chat_administrators(self.token, chat_id) return [types.ChatMember.de_json(r) for r in result] @@ -1633,35 +2118,55 @@ class AsyncTeleBot: @util.deprecated(deprecation_text="Use get_chat_member_count instead") async def get_chat_members_count(self, chat_id: Union[int, str]) -> int: """ - This function is deprecated. Use `get_chat_member_count` instead + This function is deprecated. Use `get_chat_member_count` instead. + + .. deprecated:: 4.0.0 + This function is deprecated. Use `get_chat_member_count` instead. + + Use this method to get the number of members in a chat. + + Telegram documentation: https://core.telegram.org/bots/api#getchatmembercount + + :param chat_id: Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername) + :type chat_id: :obj:`int` or :obj:`str` + + :return: Number of members in the chat. + :rtype: :obj:`int` """ result = await asyncio_helper.get_chat_member_count(self.token, chat_id) return result async def get_chat_member_count(self, chat_id: Union[int, str]) -> int: """ - Use this method to get the number of members in a chat. Returns Int on success. + Use this method to get the number of members in a chat. Telegram documentation: https://core.telegram.org/bots/api#getchatmembercount - :param chat_id: - :return: + :param chat_id: Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername) + :type chat_id: :obj:`int` or :obj:`str` + + :return: Number of members in the chat. + :rtype: :obj:`int` """ result = await asyncio_helper.get_chat_member_count(self.token, chat_id) return result async def set_chat_sticker_set(self, chat_id: Union[int, str], sticker_set_name: str) -> types.StickerSet: """ - Use this method to set a new group sticker set for a supergroup. The bot must be an administrator - in the chat for this to work and must have the appropriate admin rights. - Use the field can_set_sticker_set optionally returned in getChat requests to check - if the bot can use this method. Returns True on success. - + Use this method to set a new group sticker set for a supergroup. The bot must be an administrator in the chat + for this to work and must have the appropriate administrator rights. Use the field can_set_sticker_set optionally returned + in getChat requests to check if the bot can use this method. Returns True on success. + Telegram documentation: https://core.telegram.org/bots/api#setchatstickerset :param chat_id: Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) + :type chat_id: :obj:`int` or :obj:`str` + :param sticker_set_name: Name of the sticker set to be set as the group sticker set - :return: API reply. + :type sticker_set_name: :obj:`str` + + :return: StickerSet object + :rtype: :class:`telebot.types.StickerSet` """ result = await asyncio_helper.set_chat_sticker_set(self.token, chat_id, sticker_set_name) return result @@ -1673,9 +2178,12 @@ class AsyncTeleBot: optionally returned in getChat requests to check if the bot can use this method. Returns True on success. Telegram documentation: https://core.telegram.org/bots/api#deletechatstickerset - + :param chat_id: Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) - :return: API reply. + :type chat_id: :obj:`int` or :obj:`str` + + :return: Returns True on success. + :rtype: :obj:`bool` """ result = await asyncio_helper.delete_chat_sticker_set(self.token, chat_id) return result @@ -1690,8 +2198,13 @@ class AsyncTeleBot: Telegram Documentation: https://core.telegram.org/bots/api#answerwebappquery :param web_app_query_id: Unique identifier for the query to be answered + :type web_app_query_id: :obj:`str` + :param result: A JSON-serialized object describing the message to be sent - :return: + :type result: :class:`telebot.types.InlineQueryResultBase` + + :return: On success, a SentWebAppMessage object is returned. + :rtype: :class:`telebot.types.SentWebAppMessage` """ return await asyncio_helper.answer_web_app_query(self.token, web_app_query_id, result) @@ -1699,12 +2212,17 @@ class AsyncTeleBot: async def get_chat_member(self, chat_id: Union[int, str], user_id: int) -> types.ChatMember: """ Use this method to get information about a member of a chat. Returns a ChatMember object on success. - + Telegram documentation: https://core.telegram.org/bots/api#getchatmember - :param chat_id: - :param user_id: - :return: API reply. + :param chat_id: Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) + :type chat_id: :obj:`int` or :obj:`str` + + :param user_id: Unique identifier of the target user + :type user_id: :obj:`int` + + :return: Returns ChatMember object on success. + :rtype: :class:`telebot.types.ChatMember` """ result = await asyncio_helper.get_chat_member(self.token, chat_id, user_id) return types.ChatMember.de_json(result) @@ -1723,24 +2241,48 @@ class AsyncTeleBot: """ Use this method to send text messages. - Warning: Do not send more than about 4000 characters each message, otherwise you'll risk an HTTP 414 error. - If you must send more than 4000 characters, + Warning: Do not send more than about 4096 characters each message, otherwise you'll risk an HTTP 414 error. + If you must send more than 4096 characters, use the `split_string` or `smart_split` function in util.py. Telegram documentation: https://core.telegram.org/bots/api#sendmessage - :param chat_id: - :param text: - :param disable_web_page_preview: - :param reply_to_message_id: - :param reply_markup: - :param parse_mode: - :param disable_notification: Boolean, Optional. Sends the message silently. - :param timeout: - :param entities: - :param allow_sending_without_reply: - :param protect_content: - :return: API reply. + :param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername) + :type chat_id: :obj:`int` or :obj:`str` + + :param text: Text of the message to be sent + :type text: :obj:`str` + + :param parse_mode: Mode for parsing entities in the message text. + :type parse_mode: :obj:`str` + + :param entities: List of special entities that appear in message text, which can be specified instead of parse_mode + :type entities: Array of :class:`telebot.types.MessageEntity` + + :param disable_web_page_preview: Disables link previews for links in this message + :type disable_web_page_preview: :obj:`bool` + + :param disable_notification: Sends the message silently. Users will receive a notification with no sound. + :type disable_notification: :obj:`bool` + + :param protect_content: If True, the message content will be hidden for all users except for the target user + :type protect_content: :obj:`bool` + + :param reply_to_message_id: If the message is a reply, ID of the original message + :type reply_to_message_id: :obj:`int` + + :param allow_sending_without_reply: Pass True, if the message should be sent even if the specified replied-to message is not found + :type allow_sending_without_reply: :obj:`bool` + + :param reply_markup: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. + :type reply_markup: :class:`telebot.types.InlineKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardRemove` + or :class:`telebot.types.ForceReply` + + :param timeout: Timeout in seconds for the request. + :type timeout: :obj:`int` + + :return: On success, the sent Message is returned. + :rtype: :class:`telebot.types.Message` """ parse_mode = self.parse_mode if (parse_mode is None) else parse_mode @@ -1760,13 +2302,26 @@ class AsyncTeleBot: Telegram documentation: https://core.telegram.org/bots/api#forwardmessage - :param disable_notification: - :param chat_id: which chat to forward - :param from_chat_id: which chat message from - :param message_id: message id - :param protect_content: - :param timeout: - :return: API reply. + :param disable_notification: Sends the message silently. Users will receive a notification with no sound + :type disable_notification: :obj:`bool` + + :param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername) + :type chat_id: :obj:`int` or :obj:`str` + + :param from_chat_id: Unique identifier for the chat where the original message was sent (or channel username in the format @channelusername) + :type from_chat_id: :obj:`int` or :obj:`str` + + :param message_id: Message identifier in the chat specified in from_chat_id + :type message_id: :obj:`int` + + :param protect_content: Protects the contents of the forwarded message from forwarding and saving + :type protect_content: :obj:`bool` + + :param timeout: Timeout in seconds for the request. + :type timeout: :obj:`int` + + :return: On success, the sent Message is returned. + :rtype: :class:`telebot.types.Message` """ return types.Message.de_json( await asyncio_helper.forward_message(self.token, chat_id, from_chat_id, message_id, disable_notification, timeout, protect_content)) @@ -1789,19 +2344,45 @@ class AsyncTeleBot: Telegram documentation: https://core.telegram.org/bots/api#copymessage - :param chat_id: which chat to forward - :param from_chat_id: which chat message from - :param message_id: message id - :param caption: - :param parse_mode: - :param caption_entities: - :param disable_notification: - :param reply_to_message_id: - :param allow_sending_without_reply: - :param reply_markup: - :param timeout: - :param protect_content: - :return: API reply. + :param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername) + :type chat_id: :obj:`int` or :obj:`str` + + :param from_chat_id: Unique identifier for the chat where the original message was sent (or channel username in the format @channelusername) + :type from_chat_id: :obj:`int` or :obj:`str` + :param message_id: Message identifier in the chat specified in from_chat_id + :type message_id: :obj:`int` + + :param caption: New caption for media, 0-1024 characters after entities parsing. If not specified, the original caption is kept + :type caption: :obj:`str` + + :param parse_mode: Mode for parsing entities in the new caption. + :type parse_mode: :obj:`str` + + :param caption_entities: A JSON-serialized list of special entities that appear in the new caption, which can be specified instead of parse_mode + :type caption_entities: Array of :class:`telebot.types.MessageEntity` + + :param disable_notification: Sends the message silently. Users will receive a notification with no sound. + :type disable_notification: :obj:`bool` + + :param protect_content: Protects the contents of the sent message from forwarding and saving + :type protect_content: :obj:`bool` + + :param reply_to_message_id: If the message is a reply, ID of the original message + :type reply_to_message_id: :obj:`int` + + :param allow_sending_without_reply: Pass True, if the message should be sent even if the specified replied-to message is not found + :type allow_sending_without_reply: :obj:`bool` + + :param reply_markup: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard + or to force a reply from the user. + :type reply_markup: :class:`telebot.types.InlineKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardRemove` + or :class:`telebot.types.ForceReply` + + :param timeout: Timeout in seconds for the request. + :type timeout: :obj:`int` + + :return: On success, the sent Message is returned. + :rtype: :class:`telebot.types.Message` """ parse_mode = self.parse_mode if (parse_mode is None) else parse_mode @@ -1813,14 +2394,29 @@ class AsyncTeleBot: async def delete_message(self, chat_id: Union[int, str], message_id: int, timeout: Optional[int]=None) -> bool: """ - Use this method to delete message. Returns True on success. + Use this method to delete a message, including service messages, with the following limitations: + - A message can only be deleted if it was sent less than 48 hours ago. + - A dice message in a private chat can only be deleted if it was sent more than 24 hours ago. + - Bots can delete outgoing messages in private chats, groups, and supergroups. + - Bots can delete incoming messages in private chats. + - Bots granted can_post_messages permissions can delete outgoing messages in channels. + - If the bot is an administrator of a group, it can delete any message there. + - If the bot has can_delete_messages permission in a supergroup or a channel, it can delete any message there. + Returns True on success. Telegram documentation: https://core.telegram.org/bots/api#deletemessage - :param chat_id: in which chat to delete - :param message_id: which message to delete - :param timeout: - :return: API reply. + :param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername) + :type chat_id: :obj:`int` or :obj:`str` + + :param message_id: Identifier of the message to delete + :type message_id: :obj:`int` + + :param timeout: Timeout in seconds for the request. + :type timeout: :obj:`int` + + :return: Returns True on success. + :rtype: :obj:`bool` """ return await asyncio_helper.delete_message(self.token, chat_id, message_id, timeout) @@ -1833,19 +2429,39 @@ class AsyncTeleBot: allow_sending_without_reply: Optional[bool]=None, protect_content: Optional[bool]=None) -> types.Message: """ - Use this method to send dices. + Use this method to send an animated emoji that will display a random value. On success, the sent Message is returned. Telegram documentation: https://core.telegram.org/bots/api#senddice - :param chat_id: - :param emoji: - :param disable_notification: - :param reply_to_message_id: - :param reply_markup: - :param timeout: - :param allow_sending_without_reply: - :param protect_content: - :return: Message + :param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername) + :type chat_id: :obj:`int` or :obj:`str` + + :param emoji: Emoji on which the dice throw animation is based. Currently, must be one of “🎲”, “🎯”, “🏀”, “⚽”, “🎳”, or “🎰”. + Dice can have values 1-6 for “🎲”, “🎯” and “🎳”, values 1-5 for “🏀” and “⚽”, and values 1-64 for “🎰”. Defaults to “🎲” + :type emoji: :obj:`str` + + :param disable_notification: Sends the message silently. Users will receive a notification with no sound. + :type disable_notification: :obj:`bool` + + :param reply_to_message_id: If the message is a reply, ID of the original message + :type reply_to_message_id: :obj:`int` + + :param reply_markup: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions + to remove reply keyboard or to force a reply from the user. + :type reply_markup: :class:`telebot.types.InlineKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardRemove` + or :class:`telebot.types.ForceReply` + + :param timeout: Timeout in seconds for the request. + :type timeout: :obj:`int` + + :param allow_sending_without_reply: Pass True, if the message should be sent even if the specified replied-to message is not found + :type allow_sending_without_reply: :obj:`bool` + + :param protect_content: Protects the contents of the sent message from forwarding + :type protect_content: :obj:`bool` + + :return: On success, the sent Message is returned. + :rtype: :class:`telebot.types.Message` """ return types.Message.de_json( await asyncio_helper.send_dice( @@ -1864,22 +2480,49 @@ class AsyncTeleBot: reply_markup: Optional[REPLY_MARKUP_TYPES]=None, timeout: Optional[int]=None,) -> types.Message: """ - Use this method to send photos. + Use this method to send photos. On success, the sent Message is returned. Telegram documentation: https://core.telegram.org/bots/api#sendphoto + + :param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername) + :type chat_id: :obj:`int` or :obj:`str` - :param chat_id: - :param photo: - :param caption: - :param parse_mode: - :param disable_notification: - :param reply_to_message_id: - :param reply_markup: - :param timeout: - :param caption_entities: - :param allow_sending_without_reply: - :param protect_content: - :return: API reply. + :param photo: Photo to send. Pass a file_id as String to send a photo that exists on the Telegram servers (recommended), + pass an HTTP URL as a String for Telegram to get a photo from the Internet, or upload a new photo using multipart/form-data. + The photo must be at most 10 MB in size. The photo's width and height must not exceed 10000 in total. Width and height ratio must be at most 20. + :type photo: :obj:`str` or :class:`telebot.types.InputFile` + + :param caption: Photo caption (may also be used when resending photos by file_id), 0-1024 characters after entities parsing + :type caption: :obj:`str` + + :param parse_mode: Mode for parsing entities in the photo caption. + :type parse_mode: :obj:`str` + + :param caption_entities: A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode + :type caption_entities: :obj:`list` of :class:`telebot.types.MessageEntity` + + :param disable_notification: Sends the message silently. Users will receive a notification with no sound. + :type disable_notification: :obj:`bool` + + :param protect_content: Protects the contents of the sent message from forwarding and saving + :type protect_content: :obj:`bool` + + :param reply_to_message_id: If the message is a reply, ID of the original message + :type reply_to_message_id: :obj:`int` + + :param allow_sending_without_reply: Pass True, if the message should be sent even if the specified replied-to message is not found + :type allow_sending_without_reply: :obj:`bool` + + :param reply_markup: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions + to remove reply keyboard or to force a reply from the user. + :type reply_markup: :class:`telebot.types.InlineKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardRemove` + or :class:`telebot.types.ForceReply` + + :param timeout: Timeout in seconds for the request. + :type timeout: :obj:`int` + + :return: On success, the sent Message is returned. + :rtype: :class:`telebot.types.Message` """ parse_mode = self.parse_mode if (parse_mode is None) else parse_mode @@ -1904,26 +2547,66 @@ class AsyncTeleBot: protect_content: Optional[bool]=None) -> types.Message: """ Use this method to send audio files, if you want Telegram clients to display them in the music player. - Your audio must be in the .mp3 format. + Your audio must be in the .MP3 or .M4A format. On success, the sent Message is returned. Bots can currently send audio files of up to 50 MB in size, + this limit may be changed in the future. + + For sending voice messages, use the send_voice method instead. Telegram documentation: https://core.telegram.org/bots/api#sendaudio + + :param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername) + :type chat_id: :obj:`int` or :obj:`str` + + :param audio: Audio file to send. Pass a file_id as String to send an audio file that exists on the Telegram servers (recommended), + pass an HTTP URL as a String for Telegram to get an audio file from the Internet, or upload a new one using multipart/form-data. + Audio must be in the .MP3 or .M4A format. + :type audio: :obj:`str` or :class:`telebot.types.InputFile` + + :param caption: Audio caption, 0-1024 characters after entities parsing + :type caption: :obj:`str` - :param chat_id: Unique identifier for the message recipient - :param audio: Audio file to send. - :param caption: :param duration: Duration of the audio in seconds + :type duration: :obj:`int` + :param performer: Performer + :type performer: :obj:`str` + :param title: Track name + :type title: :obj:`str` + :param reply_to_message_id: If the message is a reply, ID of the original message + :type reply_to_message_id: :obj:`int` + :param reply_markup: - :param parse_mode: - :param disable_notification: - :param timeout: - :param thumb: - :param caption_entities: - :param allow_sending_without_reply: - :param protect_content: - :return: Message + :type reply_markup: :class:`telebot.types.InlineKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardRemove` + or :class:`telebot.types.ForceReply` + + :param parse_mode: Mode for parsing entities in the audio caption. See formatting options for more details. + :type parse_mode: :obj:`str` + + :param disable_notification: Sends the message silently. Users will receive a notification with no sound. + :type disable_notification: :obj:`bool` + + :param timeout: Timeout in seconds for the request. + :type timeout: :obj:`int` + + :param thumb: Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. + The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. + Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, + so you can pass “attach://” if the thumbnail was uploaded using multipart/form-data under + :type thumb: :obj:`str` + + :param caption_entities: A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode + :type caption_entities: :obj:`list` of :class:`telebot.types.MessageEntity` + + :param allow_sending_without_reply: Pass True, if the message should be sent even if the specified replied-to message is not found + :type allow_sending_without_reply: :obj:`bool` + + :param protect_content: Protects the contents of the sent message from forwarding and saving + :type protect_content: :obj:`bool` + + :return: On success, the sent Message is returned. + :rtype: :class:`telebot.types.Message` """ parse_mode = self.parse_mode if (parse_mode is None) else parse_mode @@ -1945,24 +2628,52 @@ class AsyncTeleBot: allow_sending_without_reply: Optional[bool]=None, protect_content: Optional[bool]=None) -> types.Message: """ - Use this method to send audio files, if you want Telegram clients to display the file - as a playable voice message. + Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. + For this to work, your audio must be in an .OGG file encoded with OPUS (other formats may be sent as Audio or Document). + On success, the sent Message is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future. Telegram documentation: https://core.telegram.org/bots/api#sendvoice + + :param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername) + :type chat_id: :obj:`int` or :obj:`str` - :param chat_id: Unique identifier for the message recipient. - :param voice: - :param caption: - :param duration: Duration of sent audio in seconds - :param reply_to_message_id: - :param reply_markup: - :param parse_mode: - :param disable_notification: - :param timeout: - :param caption_entities: - :param allow_sending_without_reply: - :param protect_content: - :return: Message + :param voice: Audio file to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), + pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. + :type voice: :obj:`str` or :class:`telebot.types.InputFile` + + :param caption: Voice message caption, 0-1024 characters after entities parsing + :type caption: :obj:`str` + + :param duration: Duration of the voice message in seconds + :type duration: :obj:`int` + + :param reply_to_message_id: If the message is a reply, ID of the original message + :type reply_to_message_id: :obj:`int` + + :param reply_markup: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions + to remove reply keyboard or to force a reply from the user. + :type reply_markup: :class:`telebot.types.InlineKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardRemove` + or :class:`telebot.types.ForceReply` + + :param parse_mode: Mode for parsing entities in the voice message caption. See formatting options for more details. + :type parse_mode: :obj:`str` + + :param disable_notification: Sends the message silently. Users will receive a notification with no sound. + :type disable_notification: :obj:`bool` + + :param timeout: Timeout in seconds for the request. + :type timeout: :obj:`int` + + :param caption_entities: A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode + :type caption_entities: :obj:`list` of :class:`telebot.types.MessageEntity` + + :param allow_sending_without_reply: Pass True, if the message should be sent even if the specified replied-to message is not found + :type allow_sending_without_reply: :obj:`bool` + + :param protect_content: Protects the contents of the sent message from forwarding and saving + :type protect_content: :obj:`bool` + + :return: On success, the sent Message is returned. """ parse_mode = self.parse_mode if (parse_mode is None) else parse_mode @@ -1991,23 +2702,57 @@ class AsyncTeleBot: Use this method to send general files. Telegram documentation: https://core.telegram.org/bots/api#senddocument - + :param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername) - :param document: (document) File to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data + :type chat_id: :obj:`int` or :obj:`str` + + :param document: (document) File to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a + String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data + :type document: :obj:`str` or :class:`telebot.types.InputFile` + :param reply_to_message_id: If the message is a reply, ID of the original message + :type reply_to_message_id: :obj:`int` + :param caption: Document caption (may also be used when resending documents by file_id), 0-1024 characters after entities parsing - :param reply_markup: + :type caption: :obj:`str` + + :param reply_markup: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard + or to force a reply from the user. + :type reply_markup: :class:`telebot.types.InlineKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardRemove` + or :class:`telebot.types.ForceReply` + :param parse_mode: Mode for parsing entities in the document caption + :type parse_mode: :obj:`str` + :param disable_notification: Sends the message silently. Users will receive a notification with no sound. - :param timeout: + :type disable_notification: :obj:`bool` + + :param timeout: Timeout in seconds for the request. + :type timeout: :obj:`int` + :param thumb: InputFile or String : Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://” if the thumbnail was uploaded using multipart/form-data under - :param caption_entities: - :param allow_sending_without_reply: - :param visible_file_name: allows to async define file name that will be visible in the Telegram instead of original file name + :type thumb: :obj:`str` or :class:`telebot.types.InputFile` + + :param caption_entities: A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode + :type caption_entities: :obj:`list` of :class:`telebot.types.MessageEntity` + + :param allow_sending_without_reply: Pass True, if the message should be sent even if the specified replied-to message is not found + :type allow_sending_without_reply: :obj:`bool` + + :param visible_file_name: allows to define file name that will be visible in the Telegram instead of original file name + :type visible_file_name: :obj:`str` + :param disable_content_type_detection: Disables automatic server-side content type detection for files uploaded using multipart/form-data - :param data: function typo compatibility: do not use it - :param protect_content: - :return: API reply. + :type disable_content_type_detection: :obj:`bool` + + :param data: function typo miss compatibility: do not use it + :type data: :obj:`str` + + :param protect_content: Protects the contents of the sent message from forwarding and saving + :type protect_content: :obj:`bool` + + :return: On success, the sent Message is returned. + :rtype: :class:`telebot.types.Message` """ parse_mode = self.parse_mode if (parse_mode is None) else parse_mode if data and not(document): @@ -2032,20 +2777,43 @@ class AsyncTeleBot: protect_content: Optional[bool]=None, data: Union[Any, str]=None) -> types.Message: """ - Use this method to send .webp stickers. + Use this method to send static .WEBP, animated .TGS, or video .WEBM stickers. + On success, the sent Message is returned. Telegram documentation: https://core.telegram.org/bots/api#sendsticker - :param chat_id: - :param sticker: - :param reply_to_message_id: - :param reply_markup: + :param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername) + :type chat_id: :obj:`int` or :obj:`str` + + :param sticker: Sticker to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL + as a String for Telegram to get a .webp file from the Internet, or upload a new one using multipart/form-data. + :type sticker: :obj:`str` or :class:`telebot.types.InputFile` + + :param reply_to_message_id: If the message is a reply, ID of the original message + :type reply_to_message_id: :obj:`int` + + :param reply_markup: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard + or to force a reply from the user. + :type reply_markup: :class:`telebot.types.InlineKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardRemove` + or :class:`telebot.types.ForceReply` + :param disable_notification: to disable the notification - :param timeout: timeout - :param allow_sending_without_reply: - :param protect_content: - :param data: deprecated, for backward compatibility - :return: API reply. + :type disable_notification: :obj:`bool` + + :param timeout: Timeout in seconds for the request. + :type timeout: :obj:`int` + + :param allow_sending_without_reply: Pass True, if the message should be sent even if the specified replied-to message is not found + :type allow_sending_without_reply: :obj:`bool` + + :param protect_content: Protects the contents of the sent message from forwarding and saving + :type protect_content: :obj:`bool` + + :param data: function typo miss compatibility: do not use it + :type data: :obj:`str` + + :return: On success, the sent Message is returned. + :rtype: :class:`telebot.types.Message` """ if data and not(sticker): # function typo miss compatibility @@ -2082,22 +2850,60 @@ class AsyncTeleBot: Telegram documentation: https://core.telegram.org/bots/api#sendvideo :param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername) + :type chat_id: :obj:`int` or :obj:`str` + :param video: Video to send. You can either pass a file_id as String to resend a video that is already on the Telegram servers, or upload a new video file using multipart/form-data. + :type video: :obj:`str` or :class:`telebot.types.InputFile` + :param duration: Duration of sent video in seconds + :type duration: :obj:`int` + :param width: Video width + :type width: :obj:`int` + :param height: Video height + :type height: :obj:`int` + :param thumb: Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://” if the thumbnail was uploaded using multipart/form-data under . + :type thumb: :obj:`str` or :class:`telebot.types.InputFile` + :param caption: Video caption (may also be used when resending videos by file_id), 0-1024 characters after entities parsing + :type caption: :obj:`str` + :param parse_mode: Mode for parsing entities in the video caption - :param caption_entities: + :type parse_mode: :obj:`str` + + :param caption_entities: List of special entities that appear in the caption, which can be specified instead of parse_mode + :type caption_entities: :obj:`list` of :class:`telebot.types.MessageEntity` + :param supports_streaming: Pass True, if the uploaded video is suitable for streaming + :type supports_streaming: :obj:`bool` + :param disable_notification: Sends the message silently. Users will receive a notification with no sound. - :param protect_content: + :type disable_notification: :obj:`bool` + + :param protect_content: Protects the contents of the sent message from forwarding and saving + :type protect_content: :obj:`bool` + :param reply_to_message_id: If the message is a reply, ID of the original message - :param allow_sending_without_reply: - :param reply_markup: - :param timeout: - :param data: deprecated, for backward compatibility + :type reply_to_message_id: :obj:`int` + + :param allow_sending_without_reply: Pass True, if the message should be sent even if the specified replied-to message is not found + :type allow_sending_without_reply: :obj:`bool` + + :param reply_markup: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard + or to force a reply from the user. + :type reply_markup: :class:`telebot.types.InlineKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardRemove` + or :class:`telebot.types.ForceReply` + + :param timeout: Timeout in seconds for the request. + :type timeout: :obj:`int` + + :param data: function typo miss compatibility: do not use it + :type data: :obj:`str` + + :return: On success, the sent Message is returned. + :rtype: :class:`telebot.types.Message` """ parse_mode = self.parse_mode if (parse_mode is None) else parse_mode if data and not(video): @@ -2128,26 +2934,63 @@ class AsyncTeleBot: timeout: Optional[int]=None, ) -> types.Message: """ Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). + On success, the sent Message is returned. Bots can currently send animation files of up to 50 MB in size, this limit may be changed in the future. Telegram documentation: https://core.telegram.org/bots/api#sendanimation + + :param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername) + :type chat_id: :obj:`int` or :obj:`str` + + :param animation: Animation to send. Pass a file_id as String to send an animation that exists on the Telegram servers (recommended), + pass an HTTP URL as a String for Telegram to get an animation from the Internet, or upload a new animation using multipart/form-data. + :type animation: :obj:`str` or :class:`telebot.types.InputFile` + + :param duration: Duration of sent animation in seconds + :type duration: :obj:`int` + + :param width: Animation width + :type width: :obj:`int` + + :param height: Animation height + :type height: :obj:`int` - :param chat_id: Integer : Unique identifier for the message recipient — User or GroupChat id - :param animation: InputFile or String : Animation to send. You can either pass a file_id as String to resend an - animation that is already on the Telegram server - :param duration: Integer : Duration of sent video in seconds - :param width: Integer : Video width - :param height: Integer : Video height - :param thumb: InputFile or String : Thumbnail of the file sent - :param caption: String : Animation caption (may also be used when resending animation by file_id). - :param parse_mode: - :param protect_content: - :param reply_to_message_id: - :param reply_markup: - :param disable_notification: - :param timeout: - :param caption_entities: - :param allow_sending_without_reply: - :return: + :param thumb: Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. + The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. + Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, + so you can pass “attach://” if the thumbnail was uploaded using multipart/form-data under . + :type thumb: :obj:`str` or :class:`telebot.types.InputFile` + + :param caption: Animation caption (may also be used when resending animation by file_id), 0-1024 characters after entities parsing + :type caption: :obj:`str` + + :param parse_mode: Mode for parsing entities in the animation caption + :type parse_mode: :obj:`str` + + :param protect_content: Protects the contents of the sent message from forwarding and saving + :type protect_content: :obj:`bool` + + :param reply_to_message_id: If the message is a reply, ID of the original message + :type reply_to_message_id: :obj:`int` + + :param reply_markup: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard + or to force a reply from the user. + :type reply_markup: :class:`telebot.types.InlineKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardRemove` + or :class:`telebot.types.ForceReply` + + :param disable_notification: Sends the message silently. Users will receive a notification with no sound. + :type disable_notification: :obj:`bool` + + :param timeout: Timeout in seconds for the request. + :type timeout: :obj:`int` + + :param caption_entities: List of special entities that appear in the caption, which can be specified instead of parse_mode + :type caption_entities: :obj:`list` of :class:`telebot.types.MessageEntity` + + :param allow_sending_without_reply: Pass True, if the message should be sent even if the specified replied-to message is not found + :type allow_sending_without_reply: :obj:`bool` + + :return: On success, the sent Message is returned. + :rtype: :class:`telebot.types.Message` """ parse_mode = self.parse_mode if (parse_mode is None) else parse_mode @@ -2169,24 +3012,52 @@ class AsyncTeleBot: allow_sending_without_reply: Optional[bool]=None, protect_content: Optional[bool]=None) -> types.Message: """ - As of v.4.0, Telegram clients support rounded square mp4 videos of up to 1 minute long. Use this method to send - video messages. + As of v.4.0, Telegram clients support rounded square MPEG4 videos of up to 1 minute long. + Use this method to send video messages. On success, the sent Message is returned. Telegram documentation: https://core.telegram.org/bots/api#sendvideonote + + :param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername) + :type chat_id: :obj:`int` or :obj:`str` + + :param data: Video note to send. Pass a file_id as String to send a video note that exists on the Telegram servers (recommended) + or upload a new video using multipart/form-data. Sending video notes by a URL is currently unsupported + :type data: :obj:`str` or :class:`telebot.types.InputFile` - :param chat_id: Integer : Unique identifier for the message recipient — User or GroupChat id - :param data: InputFile or String : Video note to send. You can either pass a file_id as String to resend - a video that is already on the Telegram server - :param duration: Integer : Duration of sent video in seconds - :param length: Integer : Video width and height, Can't be None and should be in range of (0, 640) - :param reply_to_message_id: - :param reply_markup: - :param disable_notification: - :param timeout: - :param thumb: InputFile or String : Thumbnail of the file sent - :param allow_sending_without_reply: - :param protect_content: - :return: + :param duration: Duration of sent video in seconds + :type duration: :obj:`int` + + :param length: Video width and height, i.e. diameter of the video message + :type length: :obj:`int` + + :param reply_to_message_id: If the message is a reply, ID of the original message + :type reply_to_message_id: :obj:`int` + + :param reply_markup: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard + or to force a reply from the user. + :type reply_markup: :class:`telebot.types.InlineKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardRemove` + or :class:`telebot.types.ForceReply` + + :param disable_notification: Sends the message silently. Users will receive a notification with no sound. + :type disable_notification: :obj:`bool` + + :param timeout: Timeout in seconds for the request. + :type timeout: :obj:`int` + + :param thumb: Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. + The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. + Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, + so you can pass “attach://” if the thumbnail was uploaded using multipart/form-data under . + :type thumb: :obj:`str` or :class:`telebot.types.InputFile` + + :param allow_sending_without_reply: Pass True, if the message should be sent even if the specified replied-to message is not found + :type allow_sending_without_reply: :obj:`bool` + + :param protect_content: Protects the contents of the sent message from forwarding and saving + :type protect_content: :obj:`bool` + + :return: On success, the sent Message is returned. + :rtype: :class:`telebot.types.Message` """ return types.Message.de_json( await asyncio_helper.send_video_note( @@ -2204,18 +3075,34 @@ class AsyncTeleBot: timeout: Optional[int]=None, allow_sending_without_reply: Optional[bool]=None) -> List[types.Message]: """ - send a group of photos or videos as an album. On success, an array of the sent Messages is returned. + Use this method to send a group of photos, videos, documents or audios as an album. Documents and audio files + can be only grouped in an album with messages of the same type. On success, an array of Messages that were sent is returned. Telegram documentation: https://core.telegram.org/bots/api#sendmediagroup - - :param chat_id: - :param media: - :param disable_notification: - :param reply_to_message_id: - :param timeout: - :param allow_sending_without_reply: - :param protect_content: - :return: + + :param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername) + :type chat_id: :obj:`int` or :obj:`str` + + :param media: A JSON-serialized array describing messages to be sent, must include 2-10 items + :type media: :obj:`list` of :obj:`types.InputMedia` + + :param disable_notification: Sends the messages silently. Users will receive a notification with no sound. + :type disable_notification: :obj:`bool` + + :param protect_content: Protects the contents of the sent message from forwarding and saving + :type protect_content: :obj:`bool` + + :param reply_to_message_id: If the message is a reply, ID of the original message + :type reply_to_message_id: :obj:`int` + + :param timeout: Timeout in seconds for the request. + :type timeout: :obj:`int` + + :param allow_sending_without_reply: Pass True, if the message should be sent even if the specified replied-to message is not found + :type allow_sending_without_reply: :obj:`bool` + + :return: On success, an array of Messages that were sent is returned. + :rtype: List[types.Message] """ result = await asyncio_helper.send_media_group( self.token, chat_id, media, disable_notification, reply_to_message_id, timeout, @@ -2235,27 +3122,54 @@ class AsyncTeleBot: proximity_alert_radius: Optional[int]=None, allow_sending_without_reply: Optional[bool]=None, protect_content: Optional[bool]=None) -> types.Message: - - """ - Use this method to send point on the map. + Use this method to send point on the map. On success, the sent Message is returned. Telegram documentation: https://core.telegram.org/bots/api#sendlocation - :param chat_id: - :param latitude: - :param longitude: - :param live_period: - :param reply_to_message_id: - :param reply_markup: - :param disable_notification: - :param timeout: - :param horizontal_accuracy: - :param heading: - :param proximity_alert_radius: - :param allow_sending_without_reply: - :param protect_content: - :return: API reply. + :param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername) + :type chat_id: :obj:`int` or :obj:`str` + + :param latitude: Latitude of the location + :type latitude: :obj:`float` + + :param longitude: Longitude of the location + :type longitude: :obj:`float` + + :param live_period: Period in seconds for which the location will be updated (see Live Locations, should be between 60 and 86400. + :type live_period: :obj:`int` + + :param reply_to_message_id: If the message is a reply, ID of the original message + :type reply_to_message_id: :obj:`int` + + :param reply_markup: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard + or to force a reply from the user. + :type reply_markup: :class:`telebot.types.InlineKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardRemove` + or :class:`telebot.types.ForceReply` + + :param disable_notification: Sends the message silently. Users will receive a notification with no sound. + :type disable_notification: :obj:`bool` + + :param timeout: Timeout in seconds for the request. + :type timeout: :obj:`int` + + :param horizontal_accuracy: The radius of uncertainty for the location, measured in meters; 0-1500 + :type horizontal_accuracy: :obj:`float` + + :param heading: For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified. + :type heading: :obj:`int` + + :param proximity_alert_radius: For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified. + :type proximity_alert_radius: :obj:`int` + + :param allow_sending_without_reply: Pass True, if the message should be sent even if the specified replied-to message is not found + :type allow_sending_without_reply: :obj:`bool` + + :param protect_content: Protects the contents of the sent message from forwarding and saving + :type protect_content: :obj:`bool` + + :return: On success, the sent Message is returned. + :rtype: :class:`telebot.types.Message` """ return types.Message.de_json( await asyncio_helper.send_location( @@ -2275,21 +3189,45 @@ class AsyncTeleBot: heading: Optional[int]=None, proximity_alert_radius: Optional[int]=None) -> types.Message: """ - Use this method to edit live location. + Use this method to edit live location messages. A location can be edited until its live_period expires or editing is explicitly + disabled by a call to stopMessageLiveLocation. On success, if the edited message is not an inline message, the edited Message + is returned, otherwise True is returned. Telegram documentation: https://core.telegram.org/bots/api#editmessagelivelocation - :param latitude: - :param longitude: - :param chat_id: - :param message_id: - :param reply_markup: - :param timeout: - :param inline_message_id: - :param horizontal_accuracy: - :param heading: - :param proximity_alert_radius: - :return: + :param latitude: Latitude of new location + :type latitude: :obj:`float` + + :param longitude: Longitude of new location + :type longitude: :obj:`float` + + :param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername) + :type chat_id: :obj:`int` or :obj:`str` + + :param message_id: Required if inline_message_id is not specified. Identifier of the message to edit + :type message_id: :obj:`int` + + :param reply_markup: A JSON-serialized object for a new inline keyboard. + :type reply_markup: :class:`telebot.types.InlineKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardRemove` + or :class:`telebot.types.ForceReply` + + :param timeout: Timeout in seconds for the request. + :type timeout: :obj:`int` + + :param inline_message_id: Required if chat_id and message_id are not specified. Identifier of the inline message + :type inline_message_id: :obj:`str` + + :param horizontal_accuracy: The radius of uncertainty for the location, measured in meters; 0-1500 + :type horizontal_accuracy: :obj:`float` + + :param heading: Direction in which the user is moving, in degrees. Must be between 1 and 360 if specified. + :type heading: :obj:`int` + + :param proximity_alert_radius: The maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified. + :type proximity_alert_radius: :obj:`int` + + :return: On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. + :rtype: :class:`telebot.types.Message` or bool """ return types.Message.de_json( await asyncio_helper.edit_message_live_location( @@ -2304,17 +3242,29 @@ class AsyncTeleBot: reply_markup: Optional[REPLY_MARKUP_TYPES]=None, timeout: Optional[int]=None) -> types.Message: """ - Use this method to stop updating a live location message sent by the bot - or via the bot (for inline bots) before live_period expires. + Use this method to stop updating a live location message before live_period expires. + On success, if the message is not an inline message, the edited Message is returned, otherwise True is returned. Telegram documentation: https://core.telegram.org/bots/api#stopmessagelivelocation + + :param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername) + :type chat_id: :obj:`int` or :obj:`str` - :param chat_id: - :param message_id: - :param inline_message_id: - :param reply_markup: - :param timeout: - :return: + :param message_id: Required if inline_message_id is not specified. Identifier of the message with live location to stop + :type message_id: :obj:`int` + + :param inline_message_id: Required if chat_id and message_id are not specified. Identifier of the inline message with live location to stop + :type inline_message_id: :obj:`str` + + :param reply_markup: A JSON-serialized object for a new inline keyboard. + :type reply_markup: :class:`telebot.types.InlineKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardRemove` + or :class:`telebot.types.ForceReply` + + :param timeout: Timeout in seconds for the request. + :type timeout: :obj:`int` + + :return: On success, if the message is not an inline message, the edited Message is returned, otherwise True is returned. + :rtype: :class:`telebot.types.Message` or bool """ return types.Message.de_json( await asyncio_helper.stop_message_live_location( @@ -2335,27 +3285,61 @@ class AsyncTeleBot: google_place_type: Optional[str]=None, protect_content: Optional[bool]=None) -> types.Message: """ - Use this method to send information about a venue. - + Use this method to send information about a venue. On success, the sent Message is returned. + Telegram documentation: https://core.telegram.org/bots/api#sendvenue - :param chat_id: Integer or String : Unique identifier for the target chat or username of the target channel - :param latitude: Float : Latitude of the venue - :param longitude: Float : Longitude of the venue - :param title: String : Name of the venue - :param address: String : Address of the venue - :param foursquare_id: String : Foursquare identifier of the venue - :param foursquare_type: Foursquare type of the venue, if known. (For example, “arts_entertainment/async default”, + :param chat_id: Unique identifier for the target chat or username of the target channel + :type chat_id: :obj:`int` or :obj:`str` + + :param latitude: Latitude of the venue + :type latitude: :obj:`float` + + :param longitude: Longitude of the venue + :type longitude: :obj:`float` + + :param title: Name of the venue + :type title: :obj:`str` + + :param address: Address of the venue + :type address: :obj:`str` + + :param foursquare_id: Foursquare identifier of the venue + :type foursquare_id: :obj:`str` + + :param foursquare_type: Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.) - :param disable_notification: - :param reply_to_message_id: - :param reply_markup: - :param timeout: - :param allow_sending_without_reply: - :param google_place_id: - :param google_place_type: - :param protect_content: - :return: + :type foursquare_type: :obj:`str` + + :param disable_notification: Sends the message silently. Users will receive a notification with no sound. + :type disable_notification: :obj:`bool` + + :param reply_to_message_id: If the message is a reply, ID of the original message + :type reply_to_message_id: :obj:`int` + + :param reply_markup: Additional interface options. A JSON-serialized object for an inline keyboard, + custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. + :type reply_markup: :class:`telebot.types.InlineKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardRemove` + or :class:`telebot.types.ForceReply` + + :param timeout: Timeout in seconds for the request. + :type timeout: :obj:`int` + + :param allow_sending_without_reply: Pass True, if the message should be sent even if one of the specified + replied-to messages is not found. + :type allow_sending_without_reply: :obj:`bool` + + :param google_place_id: Google Places identifier of the venue + :type google_place_id: :obj:`str` + + :param google_place_type: Google Places type of the venue. + :type google_place_type: :obj:`str` + + :param protect_content: Protects the contents of the sent message from forwarding and saving + :type protect_content: :obj:`bool` + + :return: On success, the sent Message is returned. + :rtype: :class:`telebot.types.Message` """ return types.Message.de_json( await asyncio_helper.send_venue( @@ -2375,21 +3359,48 @@ class AsyncTeleBot: allow_sending_without_reply: Optional[bool]=None, protect_content: Optional[bool]=None) -> types.Message: """ - Use this method to send phone contacts. + Use this method to send phone contacts. On success, the sent Message is returned. Telegram documentation: https://core.telegram.org/bots/api#sendcontact - :param chat_id: Integer or String : Unique identifier for the target chat or username of the target channel - :param phone_number: String : Contact's phone number - :param first_name: String : Contact's first name - :param last_name: String : Contact's last name - :param vcard: String : Additional data about the contact in the form of a vCard, 0-2048 bytes - :param disable_notification: - :param reply_to_message_id: - :param reply_markup: - :param timeout: - :param allow_sending_without_reply: - :param protect_content: + :param chat_id: Unique identifier for the target chat or username of the target channel + :type chat_id: :obj:`int` or :obj:`str` + + :param phone_number: Contact's phone number + :type phone_number: :obj:`str` + + :param first_name: Contact's first name + :type first_name: :obj:`str` + + :param last_name: Contact's last name + :type last_name: :obj:`str` + + :param vcard: Additional data about the contact in the form of a vCard, 0-2048 bytes + :type vcard: :obj:`str` + + :param disable_notification: Sends the message silently. Users will receive a notification with no sound. + :type disable_notification: :obj:`bool` + + :param reply_to_message_id: If the message is a reply, ID of the original message + :type reply_to_message_id: :obj:`int` + + :param reply_markup: Additional interface options. A JSON-serialized object for an inline keyboard, + custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. + :type reply_markup: :class:`telebot.types.InlineKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardMarkup` or :class:`telebot.types.ReplyKeyboardRemove` + or :class:`telebot.types.ForceReply` + + :param timeout: Timeout in seconds for the request. + :type timeout: :obj:`int` + + :param allow_sending_without_reply: Pass True, if the message should be sent even if one of the specified + replied-to messages is not found. + :type allow_sending_without_reply: :obj:`bool` + + :param protect_content: Protects the contents of the sent message from forwarding and saving + :type protect_content: :obj:`bool` + + :return: On success, the sent Message is returned. + :rtype: :class:`telebot.types.Message` """ return types.Message.de_json( await asyncio_helper.send_contact( @@ -2402,17 +3413,28 @@ class AsyncTeleBot: self, chat_id: Union[int, str], action: str, timeout: Optional[int]=None) -> bool: """ Use this method when you need to tell the user that something is happening on the bot's side. - The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear - its typing status). + The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status). + Returns True on success. + + Example: The ImageBot needs some time to process a request and upload the image. Instead of sending a text message along the lines of + “Retrieving image, please wait…”, the bot may use sendChatAction with action = upload_photo. The user will see a “sending photo” status for the bot. Telegram documentation: https://core.telegram.org/bots/api#sendchataction - :param chat_id: - :param action: One of the following strings: 'typing', 'upload_photo', 'record_video', 'upload_video', - 'record_audio', 'upload_audio', 'upload_document', 'find_location', 'record_video_note', - 'upload_video_note'. - :param timeout: - :return: API reply. :type: boolean + :param chat_id: Unique identifier for the target chat or username of the target channel + :type chat_id: :obj:`int` or :obj:`str` + + :param action: Type of action to broadcast. Choose one, depending on what the user is about + to receive: typing for text messages, upload_photo for photos, record_video or upload_video + for videos, record_voice or upload_voice for voice notes, upload_document for general files, + choose_sticker for stickers, find_location for location data, record_video_note or upload_video_note for video notes. + :type action: :obj:`str` + + :param timeout: Timeout in seconds for the request. + :type timeout: :obj:`int` + + :return: Returns True on success. + :rtype: :obj:`bool` """ return await asyncio_helper.send_chat_action(self.token, chat_id, action, timeout) @@ -2438,14 +3460,24 @@ class AsyncTeleBot: Telegram documentation: https://core.telegram.org/bots/api#banchatmember - :param chat_id: Int or string : Unique identifier for the target group or username of the target supergroup - :param user_id: Int : Unique identifier of the target user + :param chat_id: Unique identifier for the target group or username of the target supergroup + or channel (in the format @channelusername) + :type chat_id: :obj:`int` or :obj:`str` + + :param user_id: Unique identifier of the target user + :type user_id: :obj:`int` + :param until_date: Date when the user will be unbanned, unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever + :type until_date: :obj:`int` or :obj:`datetime` + :param revoke_messages: Bool: Pass True to delete all messages from the chat for the user that is being removed. - If False, the user will be able to see messages in the group that were sent before the user was removed. - Always True for supergroups and channels. - :return: boolean + If False, the user will be able to see messages in the group that were sent before the user was removed. + Always True for supergroups and channels. + :type revoke_messages: :obj:`bool` + + :return: Returns True on success. + :rtype: :obj:`bool` """ return await asyncio_helper.ban_chat_member(self.token, chat_id, user_id, until_date, revoke_messages) @@ -2455,7 +3487,7 @@ class AsyncTeleBot: """ Use this method to unban a previously kicked user in a supergroup or channel. The user will not return to the group or channel automatically, but will be able to join via link, etc. - The bot must be an administrator for this to work. By async default, this method guarantees that after the call + The bot must be an administrator for this to work. By default, this method guarantees that after the call the user is not a member of the chat, but will be able to join it. So if the user is a member of the chat they will also be removed from the chat. If you don't want this, use the parameter only_if_banned. @@ -2463,9 +3495,16 @@ class AsyncTeleBot: :param chat_id: Unique identifier for the target group or username of the target supergroup or channel (in the format @username) + :type chat_id: :obj:`int` or :obj:`str` + :param user_id: Unique identifier of the target user + :type user_id: :obj:`int` + :param only_if_banned: Do nothing if the user is not banned + :type only_if_banned: :obj:`bool` + :return: True on success + :rtype: :obj:`bool` """ return await asyncio_helper.unban_chat_member(self.token, chat_id, user_id, only_if_banned) @@ -2487,22 +3526,48 @@ class AsyncTeleBot: Telegram documentation: https://core.telegram.org/bots/api#restrictchatmember - :param chat_id: Int or String : Unique identifier for the target group or username of the target supergroup or channel (in the format @channelusername) - :param user_id: Int : Unique identifier of the target user + :param chat_id: Unique identifier for the target group or username of the target supergroup + or channel (in the format @channelusername) + :type chat_id: :obj:`int` or :obj:`str` + + :param user_id: Unique identifier of the target user + :type user_id: :obj:`int` + :param until_date: Date when restrictions will be lifted for the user, unix time. If user is restricted for more than 366 days or less than 30 seconds from the current time, they are considered to be restricted forever + :type until_date: :obj:`int` or :obj:`datetime` + :param can_send_messages: Pass True, if the user can send text messages, contacts, locations and venues + :type can_send_messages: :obj:`bool` + :param can_send_media_messages: Pass True, if the user can send audios, documents, photos, videos, video notes and voice notes, implies can_send_messages + :type can_send_media_messages: :obj:`bool` + :param can_send_polls: Pass True, if the user is allowed to send polls, implies can_send_messages - :param can_send_other_messages: Pass True, if the user can send animations, games, stickers and - use inline bots, implies can_send_media_messages - :param can_add_web_page_previews: Pass True, if the user may add web page previews to their messages, implies can_send_media_messages - :param can_change_info: Pass True, if the user is allowed to change the chat title, photo and other settings. Ignored in public supergroups - :param can_invite_users: Pass True, if the user is allowed to invite new users to the chat, implies can_invite_users + :type can_send_polls: :obj:`bool` + + :param can_send_other_messages: Pass True, if the user can send animations, games, stickers and use inline bots, implies can_send_media_messages + :type can_send_other_messages: :obj:`bool` + + :param can_add_web_page_previews: Pass True, if the user may add web page previews to their messages, + implies can_send_media_messages + :type can_add_web_page_previews: :obj:`bool` + + :param can_change_info: Pass True, if the user is allowed to change the chat title, photo and other settings. + Ignored in public supergroups + :type can_change_info: :obj:`bool` + + :param can_invite_users: Pass True, if the user is allowed to invite new users to the chat, + implies can_invite_users + :type can_invite_users: :obj:`bool` + :param can_pin_messages: Pass True, if the user is allowed to pin messages. Ignored in public supergroups + :type can_pin_messages: :obj:`bool` + :return: True on success + :rtype: :obj:`bool` """ return await asyncio_helper.restrict_chat_member( self.token, chat_id, user_id, until_date, @@ -2534,26 +3599,55 @@ class AsyncTeleBot: :param chat_id: Unique identifier for the target chat or username of the target channel ( in the format @channelusername) - :param user_id: Int : Unique identifier of the target user - :param can_change_info: Bool: Pass True, if the administrator can change chat title, photo and other settings - :param can_post_messages: Bool : Pass True, if the administrator can create channel posts, channels only - :param can_edit_messages: Bool : Pass True, if the administrator can edit messages of other users, channels only - :param can_delete_messages: Bool : Pass True, if the administrator can delete messages of other users - :param can_invite_users: Bool : Pass True, if the administrator can invite new users to the chat - :param can_restrict_members: Bool: Pass True, if the administrator can restrict, ban or unban chat members - :param can_pin_messages: Bool: Pass True, if the administrator can pin messages, supergroups only - :param can_promote_members: Bool: Pass True, if the administrator can add new administrators with a subset + :type chat_id: :obj:`int` or :obj:`str` + + :param user_id: Unique identifier of the target user + :type user_id: :obj:`int` + + :param can_change_info: Pass True, if the administrator can change chat title, photo and other settings + :type can_change_info: :obj:`bool` + + :param can_post_messages: Pass True, if the administrator can create channel posts, channels only + :type can_post_messages: :obj:`bool` + + :param can_edit_messages: Pass True, if the administrator can edit messages of other users, channels only + :type can_edit_messages: :obj:`bool` + + :param can_delete_messages: Pass True, if the administrator can delete messages of other users + :type can_delete_messages: :obj:`bool` + + :param can_invite_users: Pass True, if the administrator can invite new users to the chat + :type can_invite_users: :obj:`bool` + + :param can_restrict_members: Pass True, if the administrator can restrict, ban or unban chat members + :type can_restrict_members: :obj:`bool` + + :param can_pin_messages: Pass True, if the administrator can pin messages, supergroups only + :type can_pin_messages: :obj:`bool` + + :param can_promote_members: Pass True, if the administrator can add new administrators with a subset of his own privileges or demote administrators that he has promoted, directly or indirectly (promoted by administrators that were appointed by him) - :param is_anonymous: Bool: Pass True, if the administrator's presence in the chat is hidden - :param can_manage_chat: Bool: Pass True, if the administrator can access the chat event log, chat statistics, + :type can_promote_members: :obj:`bool` + + :param is_anonymous: Pass True, if the administrator's presence in the chat is hidden + :type is_anonymous: :obj:`bool` + + :param can_manage_chat: Pass True, if the administrator can access the chat event log, chat statistics, message statistics in channels, see channel members, see anonymous administrators in supergroups and ignore slow mode. Implied by any other administrator privilege - :param can_manage_video_chats: Bool: Pass True, if the administrator can manage voice chats + :type can_manage_chat: :obj:`bool` + + :param can_manage_video_chats: Pass True, if the administrator can manage voice chats For now, bots can use this privilege only for passing to other administrators. - :param can_manage_voice_chats: Deprecated, use can_manage_video_chats + :type can_manage_video_chats: :obj:`bool` + + :param can_manage_voice_chats: Deprecated, use can_manage_video_chats. + :type can_manage_voice_chats: :obj:`bool` + :return: True on success. + :rtype: :obj:`bool` """ if can_manage_voice_chats is not None: @@ -2570,17 +3664,24 @@ class AsyncTeleBot: async def set_chat_administrator_custom_title( self, chat_id: Union[int, str], user_id: int, custom_title: str) -> bool: """ - Use this method to set a custom title for an administrator - in a supergroup promoted by the bot. + Use this method to set a custom title for an administrator in a supergroup promoted by the bot. + Returns True on success. Telegram documentation: https://core.telegram.org/bots/api#setchatadministratorcustomtitle :param chat_id: Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) + :type chat_id: :obj:`int` or :obj:`str` + :param user_id: Unique identifier of the target user + :type user_id: :obj:`int` + :param custom_title: New custom title for the administrator; 0-16 characters, emoji are not allowed + :type custom_title: :obj:`str` + :return: True on success. + :rtype: :obj:`bool` """ return await asyncio_helper.set_chat_administrator_custom_title(self.token, chat_id, user_id, custom_title) @@ -2597,8 +3698,13 @@ class AsyncTeleBot: Telegram documentation: https://core.telegram.org/bots/api#banchatsenderchat :param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername) + :type chat_id: :obj:`int` or :obj:`str` + :param sender_chat_id: Unique identifier of the target sender chat + :type sender_chat_id: :obj:`int` or :obj:`str` + :return: True on success. + :rtype: :obj:`bool` """ return await asyncio_helper.ban_chat_sender_chat(self.token, chat_id, sender_chat_id) @@ -2611,17 +3717,21 @@ class AsyncTeleBot: Telegram documentation: https://core.telegram.org/bots/api#unbanchatsenderchat - :params: :param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername) - :param sender_chat_id: Unique identifier of the target sender chat + :type chat_id: :obj:`int` or :obj:`str` + + :param sender_chat_id: Unique identifier of the target sender chat. + :type sender_chat_id: :obj:`int` or :obj:`str` + :return: True on success. + :rtype: :obj:`bool` """ return await asyncio_helper.unban_chat_sender_chat(self.token, chat_id, sender_chat_id) async def set_chat_permissions( self, chat_id: Union[int, str], permissions: types.ChatPermissions) -> bool: """ - Use this method to set async default chat permissions for all members. + Use this method to set default chat permissions for all members. The bot must be an administrator in the group or a supergroup for this to work and must have the can_restrict_members admin rights. @@ -2629,8 +3739,13 @@ class AsyncTeleBot: :param chat_id: Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) - :param permissions: New async default chat permissions + :type chat_id: :obj:`int` or :obj:`str` + + :param permissions: New default chat permissions + :type permissions: :class:`telebot.types..ChatPermissions` + :return: True on success + :rtype: :obj:`bool` """ return await asyncio_helper.set_chat_permissions(self.token, chat_id, permissions) @@ -2641,18 +3756,31 @@ class AsyncTeleBot: member_limit: Optional[int]=None, creates_join_request: Optional[bool]=None) -> types.ChatInviteLink: """ - Use this method to create an additional invite link for a chat. - The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. + Use this method to create an additional invite link for a chat. The bot must be an administrator in the chat for this to work and + must have the appropriate administrator rights. + The link can be revoked using the method revokeChatInviteLink. + Returns the new invite link as ChatInviteLink object. Telegram documentation: https://core.telegram.org/bots/api#createchatinvitelink :param chat_id: Id: Unique identifier for the target chat or username of the target channel (in the format @channelusername) + :type chat_id: :obj:`int` or :obj:`str` + :param name: Invite link name; 0-32 characters + :type name: :obj:`str` + :param expire_date: Point in time (Unix timestamp) when the link will expire + :type expire_date: :obj:`int` or :obj:`datetime` + :param member_limit: Maximum number of users that can be members of the chat simultaneously + :type member_limit: :obj:`int` + :param creates_join_request: True, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can't be specified - :return: + :type creates_join_request: :obj:`bool` + + :return: Returns the new invite link as ChatInviteLink object. + :rtype: :class:`telebot.types.ChatInviteLink` """ return types.ChatInviteLink.de_json( await asyncio_helper.create_chat_invite_link(self.token, chat_id, name, expire_date, member_limit, creates_join_request) @@ -2673,12 +3801,25 @@ class AsyncTeleBot: :param chat_id: Id: Unique identifier for the target chat or username of the target channel (in the format @channelusername) + :type chat_id: :obj:`int` or :obj:`str` + :param name: Invite link name; 0-32 characters + :type name: :obj:`str` + :param invite_link: The invite link to edit + :type invite_link: :obj:`str` + :param expire_date: Point in time (Unix timestamp) when the link will expire + :type expire_date: :obj:`int` or :obj:`datetime` + :param member_limit: Maximum number of users that can be members of the chat simultaneously + :type member_limit: :obj:`int` + :param creates_join_request: True, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can't be specified - :return: + :type creates_join_request: :obj:`bool` + + :return: Returns the new invite link as ChatInviteLink object. + :rtype: :class:`telebot.types.ChatInviteLink` """ return types.ChatInviteLink.de_json( await asyncio_helper.edit_chat_invite_link(self.token, chat_id, name, invite_link, expire_date, member_limit, creates_join_request) @@ -2693,9 +3834,15 @@ class AsyncTeleBot: Telegram documentation: https://core.telegram.org/bots/api#revokechatinvitelink - :param chat_id: Id: Unique identifier for the target chat or username of the target channel(in the format @channelusername) + :param chat_id: Id: Unique identifier for the target chat or username of the target channel + (in the format @channelusername) + :type chat_id: :obj:`int` or :obj:`str` + :param invite_link: The invite link to revoke - :return: API reply. + :type invite_link: :obj:`str` + + :return: Returns the new invite link as ChatInviteLink object. + :rtype: :class:`telebot.types.ChatInviteLink` """ return types.ChatInviteLink.de_json( await asyncio_helper.revoke_chat_invite_link(self.token, chat_id, invite_link) @@ -2710,7 +3857,10 @@ class AsyncTeleBot: :param chat_id: Id: Unique identifier for the target chat or username of the target channel (in the format @channelusername) + :type chat_id: :obj:`int` or :obj:`str` + :return: exported invite link as String on success. + :rtype: :obj:`str` """ return await asyncio_helper.export_chat_invite_link(self.token, chat_id) @@ -2725,8 +3875,13 @@ class AsyncTeleBot: :param chat_id: Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) + :type chat_id: :obj:`int` or :obj:`str` + :param user_id: Unique identifier of the target user + :type user_id: :obj:`int` or :obj:`str` + :return: True on success. + :rtype: :obj:`bool` """ return await asyncio_helper.approve_chat_join_request(self.token, chat_id, user_id) @@ -2740,8 +3895,13 @@ class AsyncTeleBot: :param chat_id: Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername) + :type chat_id: :obj:`int` or :obj:`str` + :param user_id: Unique identifier of the target user + :type user_id: :obj:`int` or :obj:`str` + :return: True on success. + :rtype: :obj:`bool` """ return await asyncio_helper.decline_chat_join_request(self.token, chat_id, user_id) @@ -2750,13 +3910,19 @@ class AsyncTeleBot: Use this method to set a new profile photo for the chat. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success. - Note: In regular groups (non-supergroups), this method will only work if the ‘All Members Are Admins’ setting is off in the target group. + Note: In regular groups (non-supergroups), this method will only work if the ‘All Members Are Admins’ + setting is off in the target group. Telegram documentation: https://core.telegram.org/bots/api#setchatphoto - :param chat_id: Int or Str: Unique identifier for the target chat or username of the target channel (in the format @channelusername) + :param chat_id: Int or Str: Unique identifier for the target chat or username of the target channel + (in the format @channelusername) + :type chat_id: :obj:`int` or :obj:`str` + :param photo: InputFile: New chat photo, uploaded using multipart/form-data - :return: + :type photo: :obj:`typing.Union[file_like, str]` + :return: True on success. + :rtype: :obj:`bool` """ return await asyncio_helper.set_chat_photo(self.token, chat_id, photo) @@ -2765,13 +3931,16 @@ class AsyncTeleBot: Use this method to delete a chat photo. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success. - Note: In regular groups (non-supergroups), this method will only work if the ‘All Members Are Admins’ - setting is off in the target group. + Note: In regular groups (non-supergroups), this method will only work if the ‘All Members Are Admins’ setting is off in the target group. Telegram documentation: https://core.telegram.org/bots/api#deletechatphoto :param chat_id: Int or Str: Unique identifier for the target chat or username of the target channel (in the format @channelusername) + :type chat_id: :obj:`int` or :obj:`str` + + :return: True on success. + :rtype: :obj:`bool` """ return await asyncio_helper.delete_chat_photo(self.token, chat_id) @@ -2784,10 +3953,16 @@ class AsyncTeleBot: Telegram documentation: https://core.telegram.org/bots/api#getmycommands :param scope: The scope of users for which the commands are relevant. - async defaults to BotCommandScopeasync default. + Defaults to BotCommandScopeDefault. + :type scope: :class:`telebot.types.BotCommandScope` + :param language_code: A two-letter ISO 639-1 language code. If empty, commands will be applied to all users from the given scope, for whose language there are no dedicated commands + :type language_code: :obj:`str` + + :return: List of BotCommand on success. + :rtype: :obj:`list` of :class:`telebot.types.BotCommand` """ result = await asyncio_helper.get_my_commands(self.token, scope, language_code) return [types.BotCommand.de_json(cmd) for cmd in result] @@ -2803,8 +3978,13 @@ class AsyncTeleBot: :param chat_id: Unique identifier for the target private chat. If not specified, default bot's menu button will be changed. - :param menu_button: A JSON-serialized object for the new bot's menu button. Defaults to MenuButtonDefault + :type chat_id: :obj:`int` or :obj:`str` + :param menu_button: A JSON-serialized object for the new bot's menu button. Defaults to MenuButtonDefault + :type menu_button: :class:`telebot.types.MenuButton` + + :return: True on success. + :rtype: :obj:`bool` """ return await asyncio_helper.set_chat_menu_button(self.token, chat_id, menu_button) @@ -2819,8 +3999,10 @@ class AsyncTeleBot: :param chat_id: Unique identifier for the target private chat. If not specified, default bot's menu button will be returned. - :return: types.MenuButton + :type chat_id: :obj:`int` or :obj:`str` + :return: types.MenuButton + :rtype: :class:`telebot.types.MenuButton` """ return types.MenuButton.de_json(await asyncio_helper.get_chat_menu_button(self.token, chat_id)) @@ -2836,8 +4018,16 @@ class AsyncTeleBot: Telegram documentation: https://core.telegram.org/bots/api#setmydefaultadministratorrights - :param rights: A JSON-serialized object describing new default administrator rights. If not specified, the default administrator rights will be cleared. - :param for_channels: Pass True to change the default administrator rights of the bot in channels. Otherwise, the default administrator rights of the bot for groups and supergroups will be changed. + :param rights: A JSON-serialized object describing new default administrator rights. If not specified, + the default administrator rights will be cleared. + :type rights: :class:`telebot.types.ChatAdministratorRights` + + :param for_channels: Pass True to change the default administrator rights of the bot in channels. + Otherwise, the default administrator rights of the bot for groups and supergroups will be changed. + :type for_channels: :obj:`bool` + + :return: True on success. + :rtype: :obj:`bool` """ return await asyncio_helper.set_my_default_administrator_rights(self.token, rights, for_channels) @@ -2851,7 +4041,10 @@ class AsyncTeleBot: Telegram documentation: https://core.telegram.org/bots/api#getmydefaultadministratorrights :param for_channels: Pass True to get the default administrator rights of the bot in channels. Otherwise, the default administrator rights of the bot for groups and supergroups will be returned. - :return: types.ChatAdministratorRights + :type for_channels: :obj:`bool` + + :return: Returns ChatAdministratorRights on success. + :rtype: :class:`telebot.types.ChatAdministratorRights` """ return types.ChatAdministratorRights.de_json(await asyncio_helper.get_my_default_administrator_rights(self.token, for_channels)) @@ -2865,12 +4058,19 @@ class AsyncTeleBot: Telegram documentation: https://core.telegram.org/bots/api#setmycommands :param commands: List of BotCommand. At most 100 commands can be specified. + :type commands: :obj:`list` of :class:`telebot.types.BotCommand` + :param scope: The scope of users for which the commands are relevant. - async defaults to BotCommandScopeasync default. + Defaults to BotCommandScopeDefault. + :type scope: :class:`telebot.types.BotCommandScope` + :param language_code: A two-letter ISO 639-1 language code. If empty, commands will be applied to all users from the given scope, for whose language there are no dedicated commands - :return: + :type language_code: :obj:`str` + + :return: True on success. + :rtype: :obj:`bool` """ return await asyncio_helper.set_my_commands(self.token, commands, scope, language_code) @@ -2882,12 +4082,18 @@ class AsyncTeleBot: Returns True on success. Telegram documentation: https://core.telegram.org/bots/api#deletemycommands - + :param scope: The scope of users for which the commands are relevant. - async defaults to BotCommandScopeasync default. + Defaults to BotCommandScopeDefault. + :type scope: :class:`telebot.types.BotCommandScope` + :param language_code: A two-letter ISO 639-1 language code. If empty, commands will be applied to all users from the given scope, for whose language there are no dedicated commands + :type language_code: :obj:`str` + + :return: True on success. + :rtype: :obj:`bool` """ return await asyncio_helper.delete_my_commands(self.token, scope, language_code) @@ -2901,10 +4107,15 @@ class AsyncTeleBot: Telegram documentation: https://core.telegram.org/bots/api#setchattitle - :param chat_id: Int or Str: Unique identifier for the target chat or username of the target channel + :param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername) + :type chat_id: :obj:`int` or :obj:`str` + :param title: New chat title, 1-255 characters - :return: + :type title: :obj:`str` + + :return: True on success. + :rtype: :obj:`bool` """ return await asyncio_helper.set_chat_title(self.token, chat_id, title) @@ -2915,10 +4126,15 @@ class AsyncTeleBot: Telegram documentation: https://core.telegram.org/bots/api#setchatdescription - :param chat_id: Int or Str: Unique identifier for the target chat or username of the target channel + :param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername) + :type chat_id: :obj:`int` or :obj:`str` + :param description: Str: New chat description, 0-255 characters + :type description: :obj:`str` + :return: True on success. + :rtype: :obj:`bool` """ return await asyncio_helper.set_chat_description(self.token, chat_id, description) @@ -2932,12 +4148,19 @@ class AsyncTeleBot: Telegram documentation: https://core.telegram.org/bots/api#pinchatmessage - :param chat_id: Int or Str: Unique identifier for the target chat or username of the target channel + :param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername) - :param message_id: Int: Identifier of a message to pin - :param disable_notification: Bool: Pass True, if it is not necessary to send a notification + :type chat_id: :obj:`int` or :obj:`str` + + :param message_id: Identifier of a message to pin + :type message_id: :obj:`int` + + :param disable_notification: Pass True, if it is not necessary to send a notification to all group members about the new pinned message - :return: + :type disable_notification: :obj:`bool` + + :return: True on success. + :rtype: :obj:`bool` """ return await asyncio_helper.pin_chat_message(self.token, chat_id, message_id, disable_notification) @@ -2949,10 +4172,15 @@ class AsyncTeleBot: Telegram documentation: https://core.telegram.org/bots/api#unpinchatmessage - :param chat_id: Int or Str: Unique identifier for the target chat or username of the target channel + :param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername) + :type chat_id: :obj:`int` or :obj:`str` + :param message_id: Int: Identifier of a message to unpin - :return: + :type message_id: :obj:`int` + + :return: True on success. + :rtype: :obj:`bool` """ return await asyncio_helper.unpin_chat_message(self.token, chat_id, message_id) @@ -2963,10 +4191,13 @@ class AsyncTeleBot: Returns True on success. Telegram documentation: https://core.telegram.org/bots/api#unpinallchatmessages - + :param chat_id: Int or Str: Unique identifier for the target chat or username of the target channel (in the format @channelusername) - :return: + :type chat_id: :obj:`int` or :obj:`str` + + :return: True on success. + :rtype: :obj:`bool` """ return await asyncio_helper.unpin_all_chat_messages(self.token, chat_id) @@ -2984,15 +4215,32 @@ class AsyncTeleBot: Telegram documentation: https://core.telegram.org/bots/api#editmessagetext - :param text: - :param chat_id: - :param message_id: - :param inline_message_id: - :param parse_mode: - :param entities: - :param disable_web_page_preview: - :param reply_markup: - :return: + :param text: New text of the message, 1-4096 characters after entities parsing + :type text: :obj:`str` + + :param chat_id: Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername) + :type chat_id: :obj:`int` or :obj:`str` + + :param message_id: Required if inline_message_id is not specified. Identifier of the sent message + :type message_id: :obj:`int` + + :param inline_message_id: Required if chat_id and message_id are not specified. Identifier of the inline message + :type inline_message_id: :obj:`str` + + :param parse_mode: Mode for parsing entities in the message text. + :type parse_mode: :obj:`str` + + :param entities: List of special entities that appear in the message text, which can be specified instead of parse_mode + :type entities: List of :obj:`telebot.types.MessageEntity` + + :param disable_web_page_preview: Disables link previews for links in this message + :type disable_web_page_preview: :obj:`bool` + + :param reply_markup: A JSON-serialized object for an inline keyboard. + :type reply_markup: :obj:`InlineKeyboardMarkup` + + :return: On success, if edited message is sent by the bot, the edited Message is returned, otherwise True is returned. + :rtype: :obj:`types.Message` or :obj:`bool` """ parse_mode = self.parse_mode if (parse_mode is None) else parse_mode @@ -3012,15 +4260,25 @@ class AsyncTeleBot: If a message is a part of a message album, then it can be edited only to a photo or a video. Otherwise, message type can be changed arbitrarily. When inline message is edited, new file can't be uploaded. Use previously uploaded file via its file_id or specify a URL. - + Telegram documentation: https://core.telegram.org/bots/api#editmessagemedia - :param media: - :param chat_id: - :param message_id: - :param inline_message_id: - :param reply_markup: - :return: + :param media: A JSON-serialized object for a new media content of the message + :type media: :obj:`InputMedia` + :param chat_id: Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername) + :type chat_id: :obj:`int` or :obj:`str` + + :param message_id: Required if inline_message_id is not specified. Identifier of the sent message + :type message_id: :obj:`int` + + :param inline_message_id: Required if chat_id and message_id are not specified. Identifier of the inline message + :type inline_message_id: :obj:`str` + + :param reply_markup: A JSON-serialized object for an inline keyboard. + :type reply_markup: :obj:`telebot.types.InlineKeyboardMarkup` or :obj:`ReplyKeyboardMarkup` or :obj:`ReplyKeyboardRemove` or :obj:`ForceReply` + + :return: On success, if edited message is sent by the bot, the edited Message is returned, otherwise True is returned. + :rtype: :obj:`types.Message` or :obj:`bool` """ result = await asyncio_helper.edit_message_media(self.token, media, chat_id, message_id, inline_message_id, reply_markup) if type(result) == bool: # if edit inline message return is bool not Message. @@ -3037,11 +4295,20 @@ class AsyncTeleBot: Telegram documentation: https://core.telegram.org/bots/api#editmessagereplymarkup - :param chat_id: - :param message_id: - :param inline_message_id: - :param reply_markup: - :return: + :param chat_id: Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername) + :type chat_id: :obj:`int` or :obj:`str` + + :param message_id: Required if inline_message_id is not specified. Identifier of the sent message + :type message_id: :obj:`int` + + :param inline_message_id: Required if chat_id and message_id are not specified. Identifier of the inline message + :type inline_message_id: :obj:`str` + + :param reply_markup: A JSON-serialized object for an inline keyboard. + :type reply_markup: :obj:`InlineKeyboardMarkup` or :obj:`ReplyKeyboardMarkup` or :obj:`ReplyKeyboardRemove` or :obj:`ForceReply` + + :return: On success, if edited message is sent by the bot, the edited Message is returned, otherwise True is returned. + :rtype: :obj:`types.Message` or :obj:`bool` """ result = await asyncio_helper.edit_message_reply_markup(self.token, chat_id, message_id, inline_message_id, reply_markup) if type(result) == bool: @@ -3061,15 +4328,32 @@ class AsyncTeleBot: Telegram documentation: https://core.telegram.org/bots/api#sendgame - :param chat_id: - :param game_short_name: - :param disable_notification: - :param reply_to_message_id: - :param reply_markup: - :param timeout: - :param allow_sending_without_reply: - :param protect_content: - :return: + :param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername) + :type chat_id: :obj:`int` or :obj:`str` + + :param game_short_name: Short name of the game, serves as the unique identifier for the game. Set up your games via @BotFather. + :type game_short_name: :obj:`str` + + :param disable_notification: Sends the message silently. Users will receive a notification with no sound. + :type disable_notification: :obj:`bool` + + :param reply_to_message_id: If the message is a reply, ID of the original message + :type reply_to_message_id: :obj:`int` + + :param reply_markup: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user. + :type reply_markup: :obj:`InlineKeyboardMarkup` or :obj:`ReplyKeyboardMarkup` or :obj:`ReplyKeyboardRemove` or :obj:`ForceReply` + + :param timeout: Timeout in seconds for waiting for a response from the bot. + :type timeout: :obj:`int` + + :param allow_sending_without_reply: Pass True, if the message should be sent even if one of the specified replied-to messages is not found. + :type allow_sending_without_reply: :obj:`bool` + + :param protect_content: Pass True, if content of the message needs to be protected from being viewed by the bot. + :type protect_content: :obj:`bool` + + :return: On success, the sent Message is returned. + :rtype: :obj:`types.Message` """ result = await asyncio_helper.send_game( self.token, chat_id, game_short_name, disable_notification, @@ -3089,14 +4373,29 @@ class AsyncTeleBot: Telegram documentation: https://core.telegram.org/bots/api#setgamescore - :param user_id: - :param score: - :param force: - :param chat_id: - :param message_id: - :param inline_message_id: - :param disable_edit_message: - :return: + :param user_id: User identifier + :type user_id: :obj:`int` or :obj:`str` + + :param score: New score, must be non-negative + :type score: :obj:`int` + + :param force: Pass True, if the high score is allowed to decrease. This can be useful when fixing mistakes or banning cheaters + :type force: :obj:`bool` + + :param chat_id: Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername) + :type chat_id: :obj:`int` or :obj:`str` + + :param message_id: Required if inline_message_id is not specified. Identifier of the sent message + :type message_id: :obj:`int` + + :param inline_message_id: Required if chat_id and message_id are not specified. Identifier of the inline message + :type inline_message_id: :obj:`str` + + :param disable_edit_message: Pass True, if the game message should not be automatically edited to include the current scoreboard + :type disable_edit_message: :obj:`bool` + + :return: On success, if the message was sent by the bot, returns the edited Message, otherwise returns True. + :rtype: :obj:`types.Message` or :obj:`bool` """ result = await asyncio_helper.set_game_score(self.token, user_id, score, force, disable_edit_message, chat_id, message_id, inline_message_id) @@ -3109,15 +4408,29 @@ class AsyncTeleBot: message_id: Optional[int]=None, inline_message_id: Optional[str]=None) -> List[types.GameHighScore]: """ - Gets top points and game play. + Use this method to get data for high score tables. Will return the score of the specified user and several of + their neighbors in a game. On success, returns an Array of GameHighScore objects. + + This method will currently return scores for the target user, plus two of their closest neighbors on each side. + Will also return the top three users if the user and their neighbors are not among them. + Please note that this behavior is subject to change. Telegram documentation: https://core.telegram.org/bots/api#getgamehighscores - :param user_id: - :param chat_id: - :param message_id: - :param inline_message_id: - :return: + :param user_id: User identifier + :type user_id: :obj:`int` + + :param chat_id: Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername) + :type chat_id: :obj:`int` or :obj:`str` + + :param message_id: Required if inline_message_id is not specified. Identifier of the sent message + :type message_id: :obj:`int` + + :param inline_message_id: Required if chat_id and message_id are not specified. Identifier of the inline message + :type inline_message_id: :obj:`str` + + :return: On success, returns an Array of GameHighScore objects. + :rtype: List[types.GameHighScore] """ result = await asyncio_helper.get_game_high_scores(self.token, user_id, chat_id, message_id, inline_message_id) return [types.GameHighScore.de_json(r) for r in result] @@ -3148,43 +4461,100 @@ class AsyncTeleBot: Telegram documentation: https://core.telegram.org/bots/api#sendinvoice :param chat_id: Unique identifier for the target private chat - :param title: Product name - :param description: Product description - :param invoice_payload: Bot-async defined invoice payload, 1-128 bytes. This will not be displayed to the user, + :type chat_id: :obj:`int` or :obj:`str` + + :param title: Product name, 1-32 characters + :type title: :obj:`str` + + :param description: Product description, 1-255 characters + :type description: :obj:`str` + + :param invoice_payload: Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes. + :type invoice_payload: :obj:`str` + :param provider_token: Payments provider token, obtained via @Botfather + :type provider_token: :obj:`str` + :param currency: Three-letter ISO 4217 currency code, see https://core.telegram.org/bots/payments#supported-currencies + :type currency: :obj:`str` + :param prices: Price breakdown, a list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.) + :type prices: List[:obj:`types.LabeledPrice`] + :param start_parameter: Unique deep-linking parameter that can be used to generate this invoice when used as a start parameter + :type start_parameter: :obj:`str` + :param photo_url: URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service. People like it better when they see what they are paying for. - :param photo_size: Photo size - :param photo_width: Photo width + :type photo_url: :obj:`str` + + :param photo_size: Photo size in bytes + :type photo_size: :obj:`int` + + :param photo_width: Photo width + :type photo_width: :obj:`int` + :param photo_height: Photo height + :type photo_height: :obj:`int` + :param need_name: Pass True, if you require the user's full name to complete the order + :type need_name: :obj:`bool` + :param need_phone_number: Pass True, if you require the user's phone number to complete the order + :type need_phone_number: :obj:`bool` + :param need_email: Pass True, if you require the user's email to complete the order + :type need_email: :obj:`bool` + :param need_shipping_address: Pass True, if you require the user's shipping address to complete the order + :type need_shipping_address: :obj:`bool` + :param is_flexible: Pass True, if the final price depends on the shipping method + :type is_flexible: :obj:`bool` + :param send_phone_number_to_provider: Pass True, if user's phone number should be sent to provider + :type send_phone_number_to_provider: :obj:`bool` + :param send_email_to_provider: Pass True, if user's email address should be sent to provider + :type send_email_to_provider: :obj:`bool` + :param disable_notification: Sends the message silently. Users will receive a notification with no sound. + :type disable_notification: :obj:`bool` + :param reply_to_message_id: If the message is a reply, ID of the original message + :type reply_to_message_id: :obj:`int` + :param reply_markup: A JSON-serialized object for an inline keyboard. If empty, one 'Pay total price' button will be shown. If not empty, the first button must be a Pay button + :type reply_markup: :obj:`str` + :param provider_data: A JSON-serialized data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider. - :param timeout: - :param allow_sending_without_reply: + :type provider_data: :obj:`str` + + :param timeout: Timeout of a request, defaults to None + :type timeout: :obj:`int` + + :param allow_sending_without_reply: Pass True, if the message should be sent even if the specified replied-to message is not found + :type allow_sending_without_reply: :obj:`bool` + :param max_tip_amount: The maximum accepted amount for tips in the smallest units of the currency + :type max_tip_amount: :obj:`int` + :param suggested_tip_amounts: A JSON-serialized array of suggested amounts of tips in the smallest units of the currency. At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount. - :param protect_content: - :return: + :type suggested_tip_amounts: :obj:`list` of :obj:`int` + + :param protect_content: Protects the contents of the sent message from forwarding and saving + :type protect_content: :obj:`bool` + + :return: On success, the sent Message is returned. + :rtype: :obj:`types.Message` """ result = await asyncio_helper.send_invoice( self.token, chat_id, title, description, invoice_payload, provider_token, @@ -3222,31 +4592,74 @@ class AsyncTeleBot: https://core.telegram.org/bots/api#createinvoicelink :param title: Product name, 1-32 characters + :type title: :obj:`str` + :param description: Product description, 1-255 characters + :type description: :obj:`str` + :param payload: Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes. + :type payload: :obj:`str` + :param provider_token: Payments provider token, obtained via @Botfather + :type provider_token: :obj:`str` + :param currency: Three-letter ISO 4217 currency code, see https://core.telegram.org/bots/payments#supported-currencies + :type currency: :obj:`str` + :param prices: Price breakdown, a list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.) + :type prices: :obj:`list` of :obj:`types.LabeledPrice` + :param max_tip_amount: The maximum accepted amount for tips in the smallest units of the currency + :type max_tip_amount: :obj:`int` + :param suggested_tip_amounts: A JSON-serialized array of suggested amounts of tips in the smallest + units of the currency. At most 4 suggested tip amounts can be specified. The suggested tip + amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount. + :type suggested_tip_amounts: :obj:`list` of :obj:`int` + :param provider_data: A JSON-serialized data about the invoice, which will be shared with the payment provider. A detailed description of required fields should be provided by the payment provider. + :type provider_data: :obj:`str` + :param photo_url: URL of the product photo for the invoice. Can be a photo of the goods + or a photo of the invoice. People like it better when they see a photo of what they are paying for. + :type photo_url: :obj:`str` + :param photo_size: Photo size in bytes + :type photo_size: :obj:`int` + :param photo_width: Photo width + :type photo_width: :obj:`int` + :param photo_height: Photo height + :type photo_height: :obj:`int` + :param need_name: Pass True, if you require the user's full name to complete the order + :type need_name: :obj:`bool` + :param need_phone_number: Pass True, if you require the user's phone number to complete the order + :type need_phone_number: :obj:`bool` + :param need_email: Pass True, if you require the user's email to complete the order + :type need_email: :obj:`bool` + :param need_shipping_address: Pass True, if you require the user's shipping address to complete the order + :type need_shipping_address: :obj:`bool` + :param send_phone_number_to_provider: Pass True, if user's phone number should be sent to provider + :type send_phone_number_to_provider: :obj:`bool` + :param send_email_to_provider: Pass True, if user's email address should be sent to provider + :type send_email_to_provider: :obj:`bool` + :param is_flexible: Pass True, if the final price depends on the shipping method + :type is_flexible: :obj:`bool` :return: Created invoice link as String on success. + :rtype: :obj:`str` """ result = await asyncio_helper.create_invoice_link( self.token, title, description, payload, provider_token, @@ -3275,30 +4688,74 @@ class AsyncTeleBot: explanation_entities: Optional[List[types.MessageEntity]]=None, protect_content: Optional[bool]=None) -> types.Message: """ - Send polls. + Use this method to send a native poll. + On success, the sent Message is returned. Telegram documentation: https://core.telegram.org/bots/api#sendpoll - :param chat_id: - :param question: - :param options: array of str with answers - :param is_anonymous: - :param type: - :param allows_multiple_answers: - :param correct_option_id: - :param explanation: - :param explanation_parse_mode: - :param open_period: - :param close_date: - :param is_closed: - :param disable_notification: - :param reply_to_message_id: - :param allow_sending_without_reply: - :param reply_markup: - :param timeout: - :param explanation_entities: - :param protect_content: - :return: + :param chat_id: Unique identifier for the target chat or username of the target channel + :type chat_id: :obj:`int` | :obj:`str` + + :param question: Poll question, 1-300 characters + :type question: :obj:`str` + + :param options: A JSON-serialized list of answer options, 2-10 strings 1-100 characters each + :type options: :obj:`list` of :obj:`str` + + :param is_anonymous: True, if the poll needs to be anonymous, defaults to True + :type is_anonymous: :obj:`bool` + + :param type: Poll type, “quiz” or “regular”, defaults to “regular” + :type type: :obj:`str` + + :param allows_multiple_answers: True, if the poll allows multiple answers, ignored for polls in quiz mode, defaults to False + :type allows_multiple_answers: :obj:`bool` + + :param correct_option_id: 0-based identifier of the correct answer option. Available only for polls in quiz mode, + defaults to None + :type correct_option_id: :obj:`int` + + :param explanation: Text that is shown when a user chooses an incorrect answer or taps on the lamp icon in a quiz-style poll, + 0-200 characters with at most 2 line feeds after entities parsing + :type explanation: :obj:`str` + + :param explanation_parse_mode: Mode for parsing entities in the explanation. See formatting options for more details. + :type explanation_parse_mode: :obj:`str` + + :param open_period: Amount of time in seconds the poll will be active after creation, 5-600. Can't be used together with close_date. + :type open_period: :obj:`int` + + :param close_date: Point in time (Unix timestamp) when the poll will be automatically closed. + :type close_date: :obj:`int` | :obj:`datetime` + + :param is_closed: Pass True, if the poll needs to be immediately closed. This can be useful for poll preview. + :type is_closed: :obj:`bool` + + :param disable_notification: Sends the message silently. Users will receive a notification with no sound. + :type disable_notification: :obj:`bool` + + :param reply_to_message_id: If the message is a reply, ID of the original message + :type reply_to_message_id: :obj:`int` + + :param allow_sending_without_reply: Pass True, if the poll allows multiple options to be voted simultaneously. + :type allow_sending_without_reply: :obj:`bool` + + :param reply_markup: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, + instructions to remove reply keyboard or to force a reply from the user. + :type reply_markup: :obj:`InlineKeyboardMarkup` | :obj:`ReplyKeyboardMarkup` | :obj:`ReplyKeyboardRemove` | :obj:`ForceReply` + + :param timeout: Timeout in seconds for waiting for a response from the user. + :type timeout: :obj:`int` + + :param explanation_entities: A JSON-serialized list of special entities that appear in the explanation, + which can be specified instead of parse_mode + :type explanation_entities: :obj:`list` of :obj:`MessageEntity` + + :param protect_content: Protects the contents of the sent message from forwarding and saving + :type protect_content: :obj:`bool` + + :return: On success, the sent Message is returned. + :rtype: :obj:`types.Message` """ if isinstance(question, types.Poll): @@ -3319,14 +4776,21 @@ class AsyncTeleBot: self, chat_id: Union[int, str], message_id: int, reply_markup: Optional[REPLY_MARKUP_TYPES]=None) -> types.Poll: """ - Stops poll. + Use this method to stop a poll which was sent by the bot. On success, the stopped Poll is returned. Telegram documentation: https://core.telegram.org/bots/api#stoppoll - :param chat_id: - :param message_id: - :param reply_markup: - :return: + :param chat_id: Unique identifier for the target chat or username of the target channel + :type chat_id: :obj:`int` | :obj:`str` + + :param message_id: Identifier of the original message with the poll + :type message_id: :obj:`int` + + :param reply_markup: A JSON-serialized object for a new message markup. + :type reply_markup: :obj:`InlineKeyboardMarkup` | :obj:`ReplyKeyboardMarkup` | :obj:`ReplyKeyboardRemove` | :obj:`ForceReply` + + :return: On success, the stopped Poll is returned. + :rtype: :obj:`types.Poll` """ return types.Poll.de_json(await asyncio_helper.stop_poll(self.token, chat_id, message_id, reply_markup)) @@ -3339,11 +4803,21 @@ class AsyncTeleBot: Telegram documentation: https://core.telegram.org/bots/api#answershippingquery - :param shipping_query_id: - :param ok: - :param shipping_options: - :param error_message: - :return: + :param shipping_query_id: Unique identifier for the query to be answered + :type shipping_query_id: :obj:`str` + + :param ok: Specify True if delivery to the specified address is possible and False if there are any problems (for example, if delivery to the specified address is not possible) + :type ok: :obj:`bool` + + :param shipping_options: Required if ok is True. A JSON-serialized array of available shipping options. + :type shipping_options: :obj:`list` of :obj:`ShippingOption` + + :param error_message: Required if ok is False. Error message in human readable form that explains why it is impossible to complete the order + (e.g. "Sorry, delivery to your desired address is unavailable'). Telegram will display this message to the user. + :type error_message: :obj:`str` + + :return: On success, True is returned. + :rtype: :obj:`bool` """ return await asyncio_helper.answer_shipping_query(self.token, shipping_query_id, ok, shipping_options, error_message) @@ -3351,14 +4825,28 @@ class AsyncTeleBot: self, pre_checkout_query_id: int, ok: bool, error_message: Optional[str]=None) -> bool: """ - Response to a request for pre-inspection. + Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an Update with the + field pre_checkout_query. Use this method to respond to such pre-checkout queries. + On success, True is returned. + + .. note:: + The Bot API must receive an answer within 10 seconds after the pre-checkout query was sent. Telegram documentation: https://core.telegram.org/bots/api#answerprecheckoutquery - :param pre_checkout_query_id: - :param ok: - :param error_message: - :return: + :param pre_checkout_query_id: Unique identifier for the query to be answered + :type pre_checkout_query_id: :obj:`int` + + :param ok: Specify True if everything is alright (goods are available, etc.) and the bot is ready to proceed with the order. Use False if there are any problems. + :type ok: :obj:`bool` + + :param error_message: Required if ok is False. Error message in human readable form that explains the reason for failure to proceed with the checkout + (e.g. "Sorry, somebody just bought the last of our amazing black T-shirts while you were busy filling out your payment details. Please choose a different + color or garment!"). Telegram will display this message to the user. + :type error_message: :obj:`str` + + :return: On success, True is returned. + :rtype: :obj:`bool` """ return await asyncio_helper.answer_pre_checkout_query(self.token, pre_checkout_query_id, ok, error_message) @@ -3374,14 +4862,29 @@ class AsyncTeleBot: Telegram documentation: https://core.telegram.org/bots/api#editmessagecaption - :param caption: - :param chat_id: - :param message_id: - :param inline_message_id: - :param parse_mode: - :param caption_entities: - :param reply_markup: - :return: + :param caption: New caption of the message + :type caption: :obj:`str` + + :param chat_id: Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel + :type chat_id: :obj:`int` | :obj:`str` + + :param message_id: Required if inline_message_id is not specified. + :type message_id: :obj:`int` + + :param inline_message_id: Required if inline_message_id is not specified. Identifier of the inline message. + :type inline_message_id: :obj:`str` + + :param parse_mode: New caption of the message, 0-1024 characters after entities parsing + :type parse_mode: :obj:`str` + + :param caption_entities: A JSON-serialized array of objects that describe how the caption should be parsed. + :type caption_entities: :obj:`list` of :obj:`types.MessageEntity` + + :param reply_markup: A JSON-serialized object for an inline keyboard. + :type reply_markup: :obj:`InlineKeyboardMarkup` + + :return: On success, if edited message is sent by the bot, the edited Message is returned, otherwise True is returned. + :rtype: :obj:`types.Message` | :obj:`bool` """ parse_mode = self.parse_mode if (parse_mode is None) else parse_mode @@ -3395,10 +4898,16 @@ class AsyncTeleBot: """ Convenience function for `send_message(message.chat.id, text, reply_to_message_id=message.message_id, **kwargs)` - :param message: - :param text: - :param kwargs: - :return: + :param message: Instance of :class:`telebot.types.Message` + :type message: :obj:`types.Message` + + :param text: Text of the message. + :type text: :obj:`str` + + :param kwargs: Additional keyword arguments which are passed to :meth:`telebot.TeleBot.send_message` + + :return: On success, the sent Message is returned. + :rtype: :class:`telebot.types.Message` """ return await self.send_message(message.chat.id, text, reply_to_message_id=message.message_id, **kwargs) @@ -3413,21 +4922,40 @@ class AsyncTeleBot: """ Use this method to send answers to an inline query. On success, True is returned. No more than 50 results per query are allowed. - + Telegram documentation: https://core.telegram.org/bots/api#answerinlinequery - + :param inline_query_id: Unique identifier for the answered query + :type inline_query_id: :obj:`str` + :param results: Array of results for the inline query + :type results: :obj:`list` of :obj:`types.InlineQueryResult` + :param cache_time: The maximum amount of time in seconds that the result of the inline query may be cached on the server. + :type cache_time: :obj:`int` + :param is_personal: Pass True, if results may be cached on the server side only for the user that sent the query. + :type is_personal: :obj:`bool` + :param next_offset: Pass the offset that a client should send in the next query with the same text to receive more results. - :param switch_pm_parameter: If passed, clients will display a button with specified text that switches the user - to a private chat with the bot and sends the bot a start message with the parameter switch_pm_parameter - :param switch_pm_text: Parameter for the start message sent to the bot when user presses the switch button - :return: True means success. + :type next_offset: :obj:`str` + + :param switch_pm_parameter: Deep-linking parameter for the /start message sent to the bot when user presses the switch button. 1-64 characters, + only A-Z, a-z, 0-9, _ and - are allowed. + Example: An inline bot that sends YouTube videos can ask the user to connect the bot to their YouTube account to adapt search results accordingly. + To do this, it displays a 'Connect your YouTube account' button above the results, or even before showing any. The user presses the button, switches to a + private chat with the bot and, in doing so, passes a start parameter that instructs the bot to return an OAuth link. Once done, the bot can offer a switch_inline + button so that the user can easily return to the chat where they wanted to use the bot's inline capabilities. + :type switch_pm_parameter: :obj:`str` + + :param switch_pm_text: Parameter for the start message sent to the bot when user presses the switch button + :type switch_pm_text: :obj:`str` + + :return: On success, True is returned. + :rtype: :obj:`bool` """ return await asyncio_helper.answer_inline_query(self.token, inline_query_id, results, cache_time, is_personal, next_offset, switch_pm_text, switch_pm_parameter) @@ -3439,15 +4967,27 @@ class AsyncTeleBot: """ Use this method to send answers to callback queries sent from inline keyboards. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. - + Telegram documentation: https://core.telegram.org/bots/api#answercallbackquery - :param callback_query_id: - :param text: - :param show_alert: - :param url: - :param cache_time: - :return: + :param callback_query_id: Unique identifier for the query to be answered + :type callback_query_id: :obj:`int` + + :param text: Text of the notification. If not specified, nothing will be shown to the user, 0-200 characters + :type text: :obj:`str` + + :param show_alert: If True, an alert will be shown by the client instead of a notification at the top of the chat screen. Defaults to false. + :type show_alert: :obj:`bool` + + :param url: URL that will be opened by the user's client. If you have created a Game and accepted the conditions via @BotFather, specify the URL that opens your + game - note that this will only work if the query comes from a callback_game button. + :type url: :obj:`str` + + :param cache_time: The maximum amount of time in seconds that the result of the callback query may be cached client-side. Telegram apps will support caching + starting in version 3.14. Defaults to 0. + + :return: On success, True is returned. + :rtype: :obj:`bool` """ return await asyncio_helper.answer_callback_query(self.token, callback_query_id, text, show_alert, url, cache_time) @@ -3460,22 +5000,30 @@ class AsyncTeleBot: Telegram documentation: https://core.telegram.org/bots/api#setstickersetthumb :param name: Sticker set name - :param user_id: User identifier - :param thumb: A PNG image with the thumbnail, must be up to 128 kilobytes in size and have width and height - exactly 100px, or a TGS animation with the thumbnail up to 32 kilobytes in size; - see https://core.telegram.org/animated_stickers#technical-requirements - + :type name: :obj:`str` + + :param user_id: User identifier + :type user_id: :obj:`int` + + :param thumb: + :type thumb: :obj:`filelike object` + + :return: On success, True is returned. + :rtype: :obj:`bool` """ return await asyncio_helper.set_sticker_set_thumb(self.token, name, user_id, thumb) async def get_sticker_set(self, name: str) -> types.StickerSet: """ Use this method to get a sticker set. On success, a StickerSet object is returned. - + Telegram documentation: https://core.telegram.org/bots/api#getstickerset - :param name: - :return: + :param name: Sticker set name + :type name: :obj:`str` + + :return: On success, a StickerSet object is returned. + :rtype: :class:`telebot.types.StickerSet` """ result = await asyncio_helper.get_sticker_set(self.token, name) return types.StickerSet.de_json(result) @@ -3485,12 +5033,17 @@ class AsyncTeleBot: Use this method to upload a .png file with a sticker for later use in createNewStickerSet and addStickerToSet methods (can be used multiple times). Returns the uploaded File on success. - Telegram documentation: https://core.telegram.org/bots/api#uploadstickerfile - :param user_id: - :param png_sticker: - :return: + :param user_id: User identifier of sticker set owner + :type user_id: :obj:`int` + + :param png_sticker: PNG image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, + and either width or height must be exactly 512px. + :type png_sticker: :obj:`filelike object` + + :return: On success, the sent file is returned. + :rtype: :class:`telebot.types.File` """ result = await asyncio_helper.upload_sticker_file(self.token, user_id, png_sticker) return types.File.de_json(result) @@ -3510,16 +5063,39 @@ class AsyncTeleBot: Telegram documentation: https://core.telegram.org/bots/api#createnewstickerset - :param user_id: - :param name: - :param title: - :param emojis: - :param png_sticker: - :param tgs_sticker: - :webm_sticker: - :param contains_masks: - :param mask_position: - :return: + :param user_id: User identifier of created sticker set owner + :type user_id: :obj:`int` + + :param name: Short name of sticker set, to be used in t.me/addstickers/ URLs (e.g., animals). Can contain only English letters, + digits and underscores. Must begin with a letter, can't contain consecutive underscores and must end in "_by_". + is case insensitive. 1-64 characters. + :type name: :obj:`str` + + :param title: Sticker set title, 1-64 characters + :type title: :obj:`str` + + :param emojis: One or more emoji corresponding to the sticker + :type emojis: :obj:`str` + + :param png_sticker: PNG image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width + or height must be exactly 512px. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an HTTP URL + as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. + :type png_sticker: :obj:`str` + + :param tgs_sticker: TGS animation with the sticker, uploaded using multipart/form-data. + :type tgs_sticker: :obj:`str` + + :param webm_sticker: WebM animation with the sticker, uploaded using multipart/form-data. + :type webm_sticker: :obj:`str` + + :param contains_masks: Pass True, if a set of mask stickers should be created + :type contains_masks: :obj:`bool` + + :param mask_position: A JSON-serialized object for position where the mask should be placed on faces + :type mask_position: :class:`telebot.types.MaskPosition` + + :return: On success, True is returned. + :rtype: :obj:`bool` """ return await asyncio_helper.create_new_sticker_set( self.token, user_id, name, title, emojis, png_sticker, tgs_sticker, @@ -3539,14 +5115,31 @@ class AsyncTeleBot: Telegram documentation: https://core.telegram.org/bots/api#addstickertoset - :param user_id: - :param name: - :param emojis: - :param png_sticker: Required if `tgs_sticker` is None - :param tgs_sticker: Required if `png_sticker` is None - :webm_sticker: - :param mask_position: - :return: + :param user_id: User identifier of created sticker set owner + :type user_id: :obj:`int` + + :param name: Sticker set name + :type name: :obj:`str` + + :param emojis: One or more emoji corresponding to the sticker + :type emojis: :obj:`str` + + :param png_sticker: PNG image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either + width or height must be exactly 512px. Pass a file_id as a String to send a file that already exists on the Telegram servers, + pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. + :type png_sticker: :obj:`str` or :obj:`filelike object` + + :param tgs_sticker: TGS animation with the sticker, uploaded using multipart/form-data. + :type tgs_sticker: :obj:`str` or :obj:`filelike object` + + :param webm_sticker: WebM animation with the sticker, uploaded using multipart/form-data. + :type webm_sticker: :obj:`str` or :obj:`filelike object` + + :param mask_position: A JSON-serialized object for position where the mask should be placed on faces + :type mask_position: :class:`telebot.types.MaskPosition` + + :return: On success, True is returned. + :rtype: :obj:`bool` """ return await asyncio_helper.add_sticker_to_set( self.token, user_id, name, emojis, png_sticker, tgs_sticker, mask_position, webm_sticker) @@ -3555,85 +5148,137 @@ class AsyncTeleBot: async def set_sticker_position_in_set(self, sticker: str, position: int) -> bool: """ Use this method to move a sticker in a set created by the bot to a specific position . Returns True on success. - + Telegram documentation: https://core.telegram.org/bots/api#setstickerpositioninset - :param sticker: - :param position: - :return: + :param sticker: File identifier of the sticker + :type sticker: :obj:`str` + + :param position: New sticker position in the set, zero-based + :type position: :obj:`int` + + :return: On success, True is returned. + :rtype: :obj:`bool` """ return await asyncio_helper.set_sticker_position_in_set(self.token, sticker, position) async def delete_sticker_from_set(self, sticker: str) -> bool: """ Use this method to delete a sticker from a set created by the bot. Returns True on success. - + Telegram documentation: https://core.telegram.org/bots/api#deletestickerfromset - :param sticker: - :return: + :param sticker: File identifier of the sticker + :return: On success, True is returned. + :rtype: :obj:`bool` """ return await asyncio_helper.delete_sticker_from_set(self.token, sticker) - async def set_state(self, user_id: int, state: Union[State, int, str], chat_id: int=None): + async def set_state(self, user_id: int, state: Union[State, int, str], chat_id: Optional[int]=None): """ Sets a new state of a user. - :param user_id: - :param chat_id: - :param state: new state. can be string or integer. + .. note:: + + You should set both user id and chat id in order to set state for a user in a chat. + Otherwise, if you only set user_id, chat_id will equal to user_id, this means that + state will be set for the user in his private chat with a bot. + + :param user_id: User's identifier + :type user_id: :obj:`int` + + :param state: new state. can be string, integer, or :class:`telebot.types.State` + :type state: :obj:`int` or :obj:`str` or :class:`telebot.types.State` + + :param chat_id: Chat's identifier + :type chat_id: :obj:`int` + + :return: None """ if not chat_id: chat_id = user_id await self.current_states.set_state(chat_id, user_id, state) - async def reset_data(self, user_id: int, chat_id: int=None): + async def reset_data(self, user_id: int, chat_id: Optional[int]=None): """ Reset data for a user in chat. - :param user_id: - :param chat_id: + :param user_id: User's identifier + :type user_id: :obj:`int` + + :param chat_id: Chat's identifier + :type chat_id: :obj:`int` + + :return: None """ if chat_id is None: chat_id = user_id await self.current_states.reset_data(chat_id, user_id) - async def delete_state(self, user_id: int, chat_id:int=None): + async def delete_state(self, user_id: int, chat_id: Optional[int]=None): """ Delete the current state of a user. - :param user_id: - :param chat_id: - :return: + :param user_id: User's identifier + :type user_id: :obj:`int` + + :param chat_id: Chat's identifier + :type chat_id: :obj:`int` + + :return: None """ if not chat_id: chat_id = user_id await self.current_states.delete_state(chat_id, user_id) - def retrieve_data(self, user_id: int, chat_id: int=None): + def retrieve_data(self, user_id: int, chat_id: Optional[int]=None): + """ + Returns context manager with data for a user in chat. + + :param user_id: User identifier + :type user_id: int + + :param chat_id: Chat's unique identifier, defaults to user_id + :type chat_id: int, optional + + :return: Context manager with data for a user in chat + :rtype: Optional[Any] + """ if not chat_id: chat_id = user_id return self.current_states.get_interactive_data(chat_id, user_id) - async def get_state(self, user_id, chat_id: int=None): + async def get_state(self, user_id, chat_id: Optional[int]=None): """ - Get current state of a user. + Gets current state of a user. + Not recommended to use this method. But it is ok for debugging. + + :param user_id: User's identifier + :type user_id: :obj:`int` + + :param chat_id: Chat's identifier + :type chat_id: :obj:`int` - :param user_id: - :param chat_id: :return: state of a user + :rtype: :obj:`int` or :obj:`str` or :class:`telebot.types.State` """ if not chat_id: chat_id = user_id return await self.current_states.get_state(chat_id, user_id) - async def add_data(self, user_id: int, chat_id: int=None, **kwargs): + async def add_data(self, user_id: int, chat_id: Optional[int]=None, **kwargs): """ Add data to states. - :param user_id: - :param chat_id: + :param user_id: User's identifier + :type user_id: :obj:`int` + + :param chat_id: Chat's identifier + :type chat_id: :obj:`int` + + :param kwargs: Data to add + :return: None """ if not chat_id: chat_id = user_id diff --git a/telebot/asyncio_filters.py b/telebot/asyncio_filters.py index 8cce1bb..f138455 100644 --- a/telebot/asyncio_filters.py +++ b/telebot/asyncio_filters.py @@ -10,8 +10,19 @@ class SimpleCustomFilter(ABC): Simple Custom Filter base class. Create child class with check() method. Accepts only message, returns bool value, that is compared with given in handler. - + Child classes should have .key property. + + .. code-block:: python3 + :caption: Example on creating a simple custom filter. + + class ForwardFilter(SimpleCustomFilter): + # Check whether message was forwarded from channel or group. + key = 'is_forwarded' + + def check(self, message): + return message.forward_date is not None + """ key: str = None @@ -25,13 +36,23 @@ class SimpleCustomFilter(ABC): class AdvancedCustomFilter(ABC): """ - Simple Custom Filter base class. + Advanced Custom Filter base class. Create child class with check() method. Accepts two parameters, returns bool: True - filter passed, False - filter failed. message: Message class text: Filter value given in handler Child classes should have .key property. + + .. code-block:: python3 + :caption: Example on creating an advanced custom filter. + + class TextStartsFilter(AdvancedCustomFilter): + # Filter to check whether message starts with some text. + key = 'text_startswith' + + def check(self, message, text): + return message.text.startswith(text) """ key: str = None @@ -48,6 +69,25 @@ class TextFilter: Advanced text filter to check (types.Message, types.CallbackQuery, types.InlineQuery, types.Poll) example of usage is in examples/asynchronous_telebot/custom_filters/advanced_text_filter.py + + :param equals: string, True if object's text is equal to passed string + :type equals: :obj:`str` + + :param contains: list[str] or tuple[str], True if any string element of iterable is in text + :type contains: list[str] or tuple[str] + + :param starts_with: string, True if object's text starts with passed string + :type starts_with: :obj:`str` + + :param ends_with: string, True if object's text starts with passed string + :type ends_with: :obj:`str` + + :param ignore_case: bool (default False), case insensitive + :type ignore_case: :obj:`bool` + + :raises ValueError: if incorrect value for a parameter was supplied + + :return: None """ def __init__(self, @@ -56,13 +96,25 @@ class TextFilter: starts_with: Optional[Union[str, list, tuple]] = None, ends_with: Optional[Union[str, list, tuple]] = None, ignore_case: bool = False): - """ :param equals: string, True if object's text is equal to passed string + :type equals: :obj:`str` + :param contains: list[str] or tuple[str], True if any string element of iterable is in text + :type contains: list[str] or tuple[str] + :param starts_with: string, True if object's text starts with passed string + :type starts_with: :obj:`str` + :param ends_with: string, True if object's text starts with passed string + :type ends_with: :obj:`str` + :param ignore_case: bool (default False), case insensitive + :type ignore_case: :obj:`bool` + + :raises ValueError: if incorrect value for a parameter was supplied + + :return: None """ to_check = sum((pattern is not None for pattern in (equals, contains, starts_with, ends_with))) @@ -87,7 +139,9 @@ class TextFilter: return iterable async def check(self, obj: Union[types.Message, types.CallbackQuery, types.InlineQuery, types.Poll]): - + """ + :meta private: + """ if isinstance(obj, types.Poll): text = obj.question elif isinstance(obj, types.Message): @@ -135,15 +189,20 @@ class TextFilter: class TextMatchFilter(AdvancedCustomFilter): """ Filter to check Text message. - key: text - Example: - @bot.message_handler(text=['account']) + .. code-block:: python3 + :caption: Example on using this filter: + + @bot.message_handler(text=['account']) + # your function """ key = 'text' async def check(self, message, text): + """ + :meta private: + """ if isinstance(text, TextFilter): return await text.check(message) elif type(text) is list: @@ -157,14 +216,21 @@ class TextContainsFilter(AdvancedCustomFilter): Filter to check Text message. key: text - Example: - # Will respond if any message.text contains word 'account' - @bot.message_handler(text_contains=['account']) + + .. code-block:: python3 + :caption: Example on using this filter: + + # Will respond if any message.text contains word 'account' + @bot.message_handler(text_contains=['account']) + # your function """ key = 'text_contains' async def check(self, message, text): + """ + :meta private: + """ if not isinstance(text, str) and not isinstance(text, list) and not isinstance(text, tuple): raise ValueError("Incorrect text_contains value") elif isinstance(text, str): @@ -179,14 +245,20 @@ class TextStartsFilter(AdvancedCustomFilter): """ Filter to check whether message starts with some text. - Example: - # Will work if message.text starts with 'Sir'. - @bot.message_handler(text_startswith='Sir') + .. code-block:: python3 + :caption: Example on using this filter: + + # Will work if message.text starts with 'sir'. + @bot.message_handler(text_startswith='sir') + # your function """ key = 'text_startswith' async def check(self, message, text): + """ + :meta private: + """ return message.text.startswith(text) @@ -194,13 +266,19 @@ class ChatFilter(AdvancedCustomFilter): """ Check whether chat_id corresponds to given chat_id. - Example: - @bot.message_handler(chat_id=[99999]) + .. code-block:: python3 + :caption: Example on using this filter: + + @bot.message_handler(chat_id=[99999]) + # your function """ key = 'chat_id' async def check(self, message, text): + """ + :meta private: + """ if isinstance(message, types.CallbackQuery): return message.message.chat.id in text return message.chat.id in text @@ -210,14 +288,19 @@ class ForwardFilter(SimpleCustomFilter): """ Check whether message was forwarded from channel or group. - Example: + .. code-block:: python3 + :caption: Example on using this filter: - @bot.message_handler(is_forwarded=True) + @bot.message_handler(is_forwarded=True) + # your function """ key = 'is_forwarded' async def check(self, message): + """ + :meta private: + """ return message.forward_date is not None @@ -225,14 +308,19 @@ class IsReplyFilter(SimpleCustomFilter): """ Check whether message is a reply. - Example: + .. code-block:: python3 + :caption: Example on using this filter: - @bot.message_handler(is_reply=True) + @bot.message_handler(is_reply=True) + # your function """ key = 'is_reply' async def check(self, message): + """ + :meta private: + """ if isinstance(message, types.CallbackQuery): return message.message.reply_to_message is not None return message.reply_to_message is not None @@ -242,14 +330,19 @@ class LanguageFilter(AdvancedCustomFilter): """ Check users language_code. - Example: + .. code-block:: python3 + :caption: Example on using this filter: - @bot.message_handler(language_code=['ru']) + @bot.message_handler(language_code=['ru']) + # your function """ key = 'language_code' async def check(self, message, text): + """ + :meta private: + """ if type(text) is list: return message.from_user.language_code in text else: @@ -260,8 +353,11 @@ class IsAdminFilter(SimpleCustomFilter): """ Check whether the user is administrator / owner of the chat. - Example: - @bot.message_handler(chat_types=['supergroup'], is_chat_admin=True) + .. code-block:: python3 + :caption: Example on using this filter: + + @bot.message_handler(chat_types=['supergroup'], is_chat_admin=True) + # your function """ key = 'is_chat_admin' @@ -270,6 +366,9 @@ class IsAdminFilter(SimpleCustomFilter): self._bot = bot async def check(self, message): + """ + :meta private: + """ if isinstance(message, types.CallbackQuery): result = await self._bot.get_chat_member(message.message.chat.id, message.from_user.id) return result.status ('creator', 'administrator') @@ -281,8 +380,11 @@ class StateFilter(AdvancedCustomFilter): """ Filter to check state. - Example: - @bot.message_handler(state=1) + .. code-block:: python3 + :caption: Example on using this filter: + + @bot.message_handler(state=1) + # your function """ def __init__(self, bot): @@ -291,6 +393,9 @@ class StateFilter(AdvancedCustomFilter): key = 'state' async def check(self, message, text): + """ + :meta private: + """ if text == '*': return True # needs to work with callbackquery @@ -334,10 +439,16 @@ class IsDigitFilter(SimpleCustomFilter): """ Filter to check whether the string is made up of only digits. - Example: - @bot.message_handler(is_digit=True) + .. code-block:: python3 + :caption: Example on using this filter: + + @bot.message_handler(is_digit=True) + # your function """ key = 'is_digit' async def check(self, message): + """ + :meta private: + """ return message.text.isdigit() diff --git a/telebot/asyncio_handler_backends.py b/telebot/asyncio_handler_backends.py index 4f0d174..34cc19a 100644 --- a/telebot/asyncio_handler_backends.py +++ b/telebot/asyncio_handler_backends.py @@ -1,3 +1,10 @@ +""" +File with all middleware classes, states. +""" + + + + class BaseMiddleware: """ Base class for middleware. @@ -9,23 +16,25 @@ class BaseMiddleware: so on. Same applies to post_process. .. code-block:: python + :caption: Example of class-based middlewares + class MyMiddleware(BaseMiddleware): def __init__(self): self.update_sensitive = True self.update_types = ['message', 'edited_message'] - def pre_process_message(self, message, data): + async def pre_process_message(self, message, data): # only message update here pass - def post_process_message(self, message, data, exception): + async def post_process_message(self, message, data, exception): pass # only message update here for post_process - def pre_process_edited_message(self, message, data): + async def pre_process_edited_message(self, message, data): # only edited_message update here pass - def post_process_edited_message(self, message, data, exception): + async def post_process_edited_message(self, message, data, exception): pass # only edited_message update here for post_process """ @@ -42,6 +51,14 @@ class BaseMiddleware: class State: + """ + Class representing a state. + + .. code-block:: python3 + + class MyStates(StatesGroup): + my_state = State() # returns my_state:State string. + """ def __init__(self) -> None: self.name = None @@ -50,6 +67,14 @@ class State: class StatesGroup: + """ + Class representing common states. + + .. code-block:: python3 + + class MyStates(StatesGroup): + my_state = State() # returns my_state:State string. + """ def __init_subclass__(cls) -> None: for name, value in cls.__dict__.items(): diff --git a/telebot/callback_data.py b/telebot/callback_data.py index 58fa0d5..57e4833 100644 --- a/telebot/callback_data.py +++ b/telebot/callback_data.py @@ -1,3 +1,7 @@ +""" +Callback data factory's file. +""" + """ Copyright (c) 2017-2018 Alex Root Junior @@ -29,17 +33,23 @@ import typing class CallbackDataFilter: + """ + Filter for CallbackData. + """ def __init__(self, factory, config: typing.Dict[str, str]): self.config = config self.factory = factory - def check(self, query): + def check(self, query) -> bool: """ Checks if query.data appropriates to specified config :param query: telebot.types.CallbackQuery - :return: bool + :type query: telebot.types.CallbackQuery + + :return: True if query.data appropriates to specified config + :rtype: bool """ try: @@ -135,7 +145,7 @@ class CallbackData: """ Generate filter - :param config: specified named parameters will be checked with CallbackQury.data + :param config: specified named parameters will be checked with CallbackQuery.data :return: CallbackDataFilter class """ diff --git a/telebot/custom_filters.py b/telebot/custom_filters.py index 161c74a..dd6a27f 100644 --- a/telebot/custom_filters.py +++ b/telebot/custom_filters.py @@ -14,6 +14,17 @@ class SimpleCustomFilter(ABC): Accepts only message, returns bool value, that is compared with given in handler. Child classes should have .key property. + + .. code-block:: python3 + :caption: Example on creating a simple custom filter. + + class ForwardFilter(SimpleCustomFilter): + # Check whether message was forwarded from channel or group. + key = 'is_forwarded' + + def check(self, message): + return message.forward_date is not None + """ key: str = None @@ -27,13 +38,23 @@ class SimpleCustomFilter(ABC): class AdvancedCustomFilter(ABC): """ - Simple Custom Filter base class. + Advanced Custom Filter base class. Create child class with check() method. Accepts two parameters, returns bool: True - filter passed, False - filter failed. message: Message class text: Filter value given in handler Child classes should have .key property. + + .. code-block:: python3 + :caption: Example on creating an advanced custom filter. + + class TextStartsFilter(AdvancedCustomFilter): + # Filter to check whether message starts with some text. + key = 'text_startswith' + + def check(self, message, text): + return message.text.startswith(text) """ key: str = None @@ -50,6 +71,25 @@ class TextFilter: Advanced text filter to check (types.Message, types.CallbackQuery, types.InlineQuery, types.Poll) example of usage is in examples/custom_filters/advanced_text_filter.py + + :param equals: string, True if object's text is equal to passed string + :type equals: :obj:`str` + + :param contains: list[str] or tuple[str], True if any string element of iterable is in text + :type contains: list[str] or tuple[str] + + :param starts_with: string, True if object's text starts with passed string + :type starts_with: :obj:`str` + + :param ends_with: string, True if object's text starts with passed string + :type ends_with: :obj:`str` + + :param ignore_case: bool (default False), case insensitive + :type ignore_case: :obj:`bool` + + :raises ValueError: if incorrect value for a parameter was supplied + + :return: None """ def __init__(self, @@ -58,15 +98,27 @@ class TextFilter: starts_with: Optional[Union[str, list, tuple]] = None, ends_with: Optional[Union[str, list, tuple]] = None, ignore_case: bool = False): - """ :param equals: string, True if object's text is equal to passed string - :param contains: list[str] or tuple[str], True if any string element of iterable is in text - :param starts_with: string, True if object's text starts with passed string - :param ends_with: string, True if object's text starts with passed string - :param ignore_case: bool (default False), case insensitive - """ + :type equals: :obj:`str` + :param contains: list[str] or tuple[str], True if any string element of iterable is in text + :type contains: list[str] or tuple[str] + + :param starts_with: string, True if object's text starts with passed string + :type starts_with: :obj:`str` + + :param ends_with: string, True if object's text starts with passed string + :type ends_with: :obj:`str` + + :param ignore_case: bool (default False), case insensitive + :type ignore_case: :obj:`bool` + + :raises ValueError: if incorrect value for a parameter was supplied + + :return: None + """ + to_check = sum((pattern is not None for pattern in (equals, contains, starts_with, ends_with))) if to_check == 0: raise ValueError('None of the check modes was specified') @@ -89,6 +141,9 @@ class TextFilter: return iterable def check(self, obj: Union[types.Message, types.CallbackQuery, types.InlineQuery, types.Poll]): + """ + :meta private: + """ if isinstance(obj, types.Poll): text = obj.question @@ -142,15 +197,20 @@ class TextFilter: class TextMatchFilter(AdvancedCustomFilter): """ Filter to check Text message. - key: text - Example: - @bot.message_handler(text=['account']) + .. code-block:: python3 + :caption: Example on using this filter: + + @bot.message_handler(text=['account']) + # your function """ key = 'text' def check(self, message, text): + """ + :meta private: + """ if isinstance(text, TextFilter): return text.check(message) elif type(text) is list: @@ -164,14 +224,21 @@ class TextContainsFilter(AdvancedCustomFilter): Filter to check Text message. key: text - Example: - # Will respond if any message.text contains word 'account' - @bot.message_handler(text_contains=['account']) + + .. code-block:: python3 + :caption: Example on using this filter: + + # Will respond if any message.text contains word 'account' + @bot.message_handler(text_contains=['account']) + # your function """ key = 'text_contains' def check(self, message, text): + """ + :meta private: + """ if not isinstance(text, str) and not isinstance(text, list) and not isinstance(text, tuple): raise ValueError("Incorrect text_contains value") elif isinstance(text, str): @@ -186,14 +253,20 @@ class TextStartsFilter(AdvancedCustomFilter): """ Filter to check whether message starts with some text. - Example: - # Will work if message.text starts with 'Sir'. - @bot.message_handler(text_startswith='Sir') + .. code-block:: python3 + :caption: Example on using this filter: + + # Will work if message.text starts with 'sir'. + @bot.message_handler(text_startswith='sir') + # your function """ key = 'text_startswith' def check(self, message, text): + """ + :meta private: + """ return message.text.startswith(text) @@ -201,13 +274,19 @@ class ChatFilter(AdvancedCustomFilter): """ Check whether chat_id corresponds to given chat_id. - Example: - @bot.message_handler(chat_id=[99999]) + .. code-block:: python3 + :caption: Example on using this filter: + + @bot.message_handler(chat_id=[99999]) + # your function """ key = 'chat_id' def check(self, message, text): + """ + :meta private: + """ if isinstance(message, types.CallbackQuery): return message.message.chat.id in text return message.chat.id in text @@ -217,14 +296,19 @@ class ForwardFilter(SimpleCustomFilter): """ Check whether message was forwarded from channel or group. - Example: + .. code-block:: python3 + :caption: Example on using this filter: - @bot.message_handler(is_forwarded=True) + @bot.message_handler(is_forwarded=True) + # your function """ key = 'is_forwarded' def check(self, message): + """ + :meta private: + """ return message.forward_date is not None @@ -232,14 +316,19 @@ class IsReplyFilter(SimpleCustomFilter): """ Check whether message is a reply. - Example: + .. code-block:: python3 + :caption: Example on using this filter: - @bot.message_handler(is_reply=True) + @bot.message_handler(is_reply=True) + # your function """ key = 'is_reply' def check(self, message): + """ + :meta private: + """ if isinstance(message, types.CallbackQuery): return message.message.reply_to_message is not None return message.reply_to_message is not None @@ -249,14 +338,19 @@ class LanguageFilter(AdvancedCustomFilter): """ Check users language_code. - Example: + .. code-block:: python3 + :caption: Example on using this filter: - @bot.message_handler(language_code=['ru']) + @bot.message_handler(language_code=['ru']) + # your function """ key = 'language_code' def check(self, message, text): + """ + :meta private: + """ if type(text) is list: return message.from_user.language_code in text else: @@ -267,8 +361,11 @@ class IsAdminFilter(SimpleCustomFilter): """ Check whether the user is administrator / owner of the chat. - Example: - @bot.message_handler(chat_types=['supergroup'], is_chat_admin=True) + .. code-block:: python3 + :caption: Example on using this filter: + + @bot.message_handler(chat_types=['supergroup'], is_chat_admin=True) + # your function """ key = 'is_chat_admin' @@ -277,6 +374,9 @@ class IsAdminFilter(SimpleCustomFilter): self._bot = bot def check(self, message): + """ + :meta private: + """ if isinstance(message, types.CallbackQuery): return self._bot.get_chat_member(message.message.chat.id, message.from_user.id).status in ['creator', 'administrator'] return self._bot.get_chat_member(message.chat.id, message.from_user.id).status in ['creator', 'administrator'] @@ -286,8 +386,11 @@ class StateFilter(AdvancedCustomFilter): """ Filter to check state. - Example: - @bot.message_handler(state=1) + .. code-block:: python3 + :caption: Example on using this filter: + + @bot.message_handler(state=1) + # your function """ def __init__(self, bot): @@ -296,6 +399,9 @@ class StateFilter(AdvancedCustomFilter): key = 'state' def check(self, message, text): + """ + :meta private: + """ if text == '*': return True # needs to work with callbackquery @@ -341,10 +447,16 @@ class IsDigitFilter(SimpleCustomFilter): """ Filter to check whether the string is made up of only digits. - Example: - @bot.message_handler(is_digit=True) + .. code-block:: python3 + :caption: Example on using this filter: + + @bot.message_handler(is_digit=True) + # your function """ key = 'is_digit' def check(self, message): + """ + :meta private: + """ return message.text.isdigit() diff --git a/telebot/ext/aio/webhooks.py b/telebot/ext/aio/webhooks.py index 13e28ab..03c4566 100644 --- a/telebot/ext/aio/webhooks.py +++ b/telebot/ext/aio/webhooks.py @@ -34,14 +34,34 @@ class AsyncWebhookListener: """ Aynchronous implementation of webhook listener for asynchronous version of telebot. + Not supposed to be used manually by user. + Use AsyncTeleBot.run_webhooks() instead. + + :param bot: AsyncTeleBot instance. + :type bot: telebot.async_telebot.AsyncTeleBot - :param bot: TeleBot instance :param secret_token: Telegram secret token + :type secret_token: str + :param host: Webhook host + :type host: str + :param port: Webhook port + :type port: int + :param ssl_context: SSL context + :type ssl_context: tuple + :param url_path: Webhook url path + :type url_path: str + :param debug: Debug mode + :type debug: bool + + :raises ImportError: If FastAPI or uvicorn is not installed. + :raises ImportError: If Starlette version is too old. + + :return: None """ self._check_dependencies() @@ -73,6 +93,8 @@ class AsyncWebhookListener: async def process_update(self, request: Request, update: dict): """ Processes updates. + + :meta private: """ # header containsX-Telegram-Bot-Api-Secret-Token if request.headers.get('X-Telegram-Bot-Api-Secret-Token') != self._secret_token: @@ -88,7 +110,10 @@ class AsyncWebhookListener: async def run_app(self): """ - Run app with the given parameters. + Run app with the given parameters to init. + Not supposed to be used manually by user. + + :return: None """ config = Config(app=self.app, diff --git a/telebot/ext/sync/webhooks.py b/telebot/ext/sync/webhooks.py index 89a3ec9..6e1714b 100644 --- a/telebot/ext/sync/webhooks.py +++ b/telebot/ext/sync/webhooks.py @@ -1,8 +1,7 @@ """ -This file is used by TeleBot.run_webhooks() & -AsyncTeleBot.run_webhooks() functions. +This file is used by TeleBot.run_webhooks() function. -Flask/fastapi is required to run this script. +Fastapi is required to run this script. """ # modules required for running this script @@ -34,16 +33,36 @@ class SyncWebhookListener: debug: Optional[bool]=False ) -> None: """ - Synchronous implementation of webhook listener - for synchronous version of telebot. + Aynchronous implementation of webhook listener + for asynchronous version of telebot. + Not supposed to be used manually by user. + Use AsyncTeleBot.run_webhooks() instead. + + :param bot: AsyncTeleBot instance. + :type bot: telebot.async_telebot.AsyncTeleBot - :param bot: TeleBot instance :param secret_token: Telegram secret token + :type secret_token: str + :param host: Webhook host + :type host: str + :param port: Webhook port + :type port: int + :param ssl_context: SSL context + :type ssl_context: tuple + :param url_path: Webhook url path + :type url_path: str + :param debug: Debug mode + :type debug: bool + + :raises ImportError: If FastAPI or uvicorn is not installed. + :raises ImportError: If Starlette version is too old. + + :return: None """ self._check_dependencies() @@ -75,6 +94,8 @@ class SyncWebhookListener: def process_update(self, request: Request, update: dict): """ Processes updates. + + :meta private: """ # header containsX-Telegram-Bot-Api-Secret-Token if request.headers.get('X-Telegram-Bot-Api-Secret-Token') != self._secret_token: @@ -89,7 +110,10 @@ class SyncWebhookListener: def run_app(self): """ - Run app with the given parameters. + Run app with the given parameters to init. + Not supposed to be used manually by user. + + :return: None """ uvicorn.run(app=self.app, diff --git a/telebot/formatting.py b/telebot/formatting.py index abec962..7b6a9f3 100644 --- a/telebot/formatting.py +++ b/telebot/formatting.py @@ -5,14 +5,17 @@ Markdown & HTML formatting functions. """ import html + import re +from typing import Optional + def format_text(*args, separator="\n"): """ Formats a list of strings into a single string. - .. code:: python + .. code:: python3 format_text( # just an example mbold('Hello'), @@ -20,7 +23,13 @@ def format_text(*args, separator="\n"): ) :param args: Strings to format. + :type args: :obj:`str` + :param separator: The separator to use between each string. + :type separator: :obj:`str` + + :return: The formatted string. + :rtype: :obj:`str` """ return separator.join(args) @@ -31,6 +40,10 @@ def escape_html(content: str) -> str: Escapes HTML characters in a string of HTML. :param content: The string of HTML to escape. + :type content: :obj:`str` + + :return: The escaped string. + :rtype: :obj:`str` """ return html.escape(content) @@ -39,9 +52,13 @@ def escape_markdown(content: str) -> str: """ Escapes Markdown characters in a string of Markdown. - Credits: simonsmh + Credits to: simonsmh :param content: The string of Markdown to escape. + :type content: :obj:`str` + + :return: The escaped string. + :rtype: :obj:`str` """ parse = re.sub(r"([_*\[\]()~`>\#\+\-=|\.!])", r"\\\1", content) @@ -49,154 +66,249 @@ def escape_markdown(content: str) -> str: return reparse -def mbold(content: str, escape: bool=True) -> str: +def mbold(content: str, escape: Optional[bool]=True) -> str: """ Returns a Markdown-formatted bold string. :param content: The string to bold. - :param escape: True if you need to escape special characters. + :type content: :obj:`str` + + :param escape: True if you need to escape special characters. Defaults to True. + :type escape: :obj:`bool` + + :return: The formatted string. + :rtype: :obj:`str` """ return '*{}*'.format(escape_markdown(content) if escape else content) -def hbold(content: str, escape: bool=True) -> str: +def hbold(content: str, escape: Optional[bool]=True) -> str: """ Returns an HTML-formatted bold string. :param content: The string to bold. - :param escape: True if you need to escape special characters. + :type content: :obj:`str` + + :param escape: True if you need to escape special characters. Defaults to True. + :type escape: :obj:`bool` + + :return: The formatted string. + :rtype: :obj:`str` """ return '{}'.format(escape_html(content) if escape else content) -def mitalic(content: str, escape: bool=True) -> str: +def mitalic(content: str, escape: Optional[bool]=True) -> str: """ Returns a Markdown-formatted italic string. :param content: The string to italicize. - :param escape: True if you need to escape special characters. + :type content: :obj:`str` + + :param escape: True if you need to escape special characters. Defaults to True. + :type escape: :obj:`bool` + + :return: The formatted string. + :rtype: :obj:`str` """ return '_{}_\r'.format(escape_markdown(content) if escape else content) -def hitalic(content: str, escape: bool=True) -> str: +def hitalic(content: str, escape: Optional[bool]=True) -> str: """ Returns an HTML-formatted italic string. :param content: The string to italicize. - :param escape: True if you need to escape special characters. + :type content: :obj:`str` + + :param escape: True if you need to escape special characters. Defaults to True. + :type escape: :obj:`bool` + + :return: The formatted string. + :rtype: :obj:`str` """ return '{}'.format(escape_html(content) if escape else content) -def munderline(content: str, escape: bool=True) -> str: +def munderline(content: str, escape: Optional[bool]=True) -> str: """ Returns a Markdown-formatted underline string. :param content: The string to underline. - :param escape: True if you need to escape special characters. + :type content: :obj:`str` + + :param escape: True if you need to escape special characters. Defaults to True. + :type escape: :obj:`bool` + + :return: The formatted string. + :rtype: :obj:`str` """ return '__{}__'.format(escape_markdown(content) if escape else content) -def hunderline(content: str, escape: bool=True) -> str: +def hunderline(content: str, escape: Optional[bool]=True) -> str: """ Returns an HTML-formatted underline string. :param content: The string to underline. - :param escape: True if you need to escape special characters. + :type content: :obj:`str` + + :param escape: True if you need to escape special characters. Defaults to True. + :type escape: :obj:`bool` + + :return: The formatted string. + :rtype: :obj:`str` + """ return '{}'.format(escape_html(content) if escape else content) -def mstrikethrough(content: str, escape: bool=True) -> str: +def mstrikethrough(content: str, escape: Optional[bool]=True) -> str: """ Returns a Markdown-formatted strikethrough string. :param content: The string to strikethrough. - :param escape: True if you need to escape special characters. + :type content: :obj:`str` + + :param escape: True if you need to escape special characters. Defaults to True. + :type escape: :obj:`bool` + + :return: The formatted string. + :rtype: :obj:`str` """ return '~{}~'.format(escape_markdown(content) if escape else content) -def hstrikethrough(content: str, escape: bool=True) -> str: +def hstrikethrough(content: str, escape: Optional[bool]=True) -> str: """ Returns an HTML-formatted strikethrough string. :param content: The string to strikethrough. - :param escape: True if you need to escape special characters. + :type content: :obj:`str` + + :param escape: True if you need to escape special characters. Defaults to True. + :type escape: :obj:`bool` + + :return: The formatted string. + :rtype: :obj:`str` """ return '{}'.format(escape_html(content) if escape else content) -def mspoiler(content: str, escape: bool=True) -> str: +def mspoiler(content: str, escape: Optional[bool]=True) -> str: """ Returns a Markdown-formatted spoiler string. :param content: The string to spoiler. - :param escape: True if you need to escape special characters. + :type content: :obj:`str` + + :param escape: True if you need to escape special characters. Defaults to True. + :type escape: :obj:`bool` + + :return: The formatted string. + :rtype: :obj:`str` """ return '||{}||'.format(escape_markdown(content) if escape else content) -def hspoiler(content: str, escape: bool=True) -> str: +def hspoiler(content: str, escape: Optional[bool]=True) -> str: """ Returns an HTML-formatted spoiler string. :param content: The string to spoiler. - :param escape: True if you need to escape special characters. + :type content: :obj:`str` + + :param escape: True if you need to escape special characters. Defaults to True. + :type escape: :obj:`bool` + + :return: The formatted string. + :rtype: :obj:`str` """ return '{}'.format(escape_html(content) if escape else content) -def mlink(content: str, url: str, escape: bool=True) -> str: +def mlink(content: str, url: str, escape: Optional[bool]=True) -> str: """ Returns a Markdown-formatted link string. :param content: The string to link. + :type content: :obj:`str` + :param url: The URL to link to. - :param escape: True if you need to escape special characters. + :type url: str + + :param escape: True if you need to escape special characters. Defaults to True. + :type escape: :obj:`bool` + + :return: The formatted string. + :rtype: :obj:`str` """ return '[{}]({})'.format(escape_markdown(content), escape_markdown(url) if escape else content) -def hlink(content: str, url: str, escape: bool=True) -> str: +def hlink(content: str, url: str, escape: Optional[bool]=True) -> str: """ Returns an HTML-formatted link string. :param content: The string to link. + :type content: :obj:`str` + :param url: The URL to link to. - :param escape: True if you need to escape special characters. + :type url: :obj:`str` + + :param escape: True if you need to escape special characters. Defaults to True. + :type escape: :obj:`bool` + + :return: The formatted string. + :rtype: :obj:`str` """ return '{}'.format(escape_html(url), escape_html(content) if escape else content) -def mcode(content: str, language: str="", escape: bool=True) -> str: +def mcode(content: str, language: str="", escape: Optional[bool]=True) -> str: """ Returns a Markdown-formatted code string. :param content: The string to code. - :param escape: True if you need to escape special characters. + :type content: :obj:`str` + + :param escape: True if you need to escape special characters. Defaults to True. + :type escape: :obj:`bool` + + :return: The formatted string. + :rtype: :obj:`str` """ return '```{}\n{}```'.format(language, escape_markdown(content) if escape else content) -def hcode(content: str, escape: bool=True) -> str: +def hcode(content: str, escape: Optional[bool]=True) -> str: """ Returns an HTML-formatted code string. :param content: The string to code. - :param escape: True if you need to escape special characters. + :type content: :obj:`str` + + :param escape: True if you need to escape special characters. Defaults to True. + :type escape: :obj:`bool` + + :return: The formatted string. + :rtype: :obj:`str` """ return '{}'.format(escape_html(content) if escape else content) -def hpre(content: str, escape: bool=True, language: str="") -> str: +def hpre(content: str, escape: Optional[bool]=True, language: str="") -> str: """ Returns an HTML-formatted preformatted string. :param content: The string to preformatted. - :param escape: True if you need to escape special characters. + :type content: :obj:`str` + + :param escape: True if you need to escape special characters. Defaults to True. + :type escape: :obj:`bool` + + :return: The formatted string. + :rtype: :obj:`str` """ return '
{}
'.format(language, escape_html(content) if escape else content) @@ -205,7 +317,10 @@ def hide_link(url: str) -> str: """ Hide url of an image. - :param url: - :return: str + :param url: The url of the image. + :type url: :obj:`str` + + :return: The hidden url. + :rtype: :obj:`str` """ return f'⁠' \ No newline at end of file diff --git a/telebot/handler_backends.py b/telebot/handler_backends.py index 9f4a3a9..42c5804 100644 --- a/telebot/handler_backends.py +++ b/telebot/handler_backends.py @@ -12,7 +12,9 @@ except: class HandlerBackend(object): """ - Class for saving (next step|reply) handlers + Class for saving (next step|reply) handlers. + + :meta private: """ def __init__(self, handlers=None): if handlers is None: @@ -30,6 +32,9 @@ class HandlerBackend(object): class MemoryHandlerBackend(HandlerBackend): + """ + :meta private: + """ def register_handler(self, handler_group_id, handler): if handler_group_id in self.handlers: self.handlers[handler_group_id].append(handler) @@ -47,6 +52,9 @@ class MemoryHandlerBackend(HandlerBackend): class FileHandlerBackend(HandlerBackend): + """ + :meta private: + """ def __init__(self, handlers=None, filename='./.handler-saves/handlers.save', delay=120): super(FileHandlerBackend, self).__init__(handlers) self.filename = filename @@ -119,6 +127,9 @@ class FileHandlerBackend(HandlerBackend): class RedisHandlerBackend(HandlerBackend): + """ + :meta private: + """ def __init__(self, handlers=None, host='localhost', port=6379, db=0, prefix='telebot', password=None): super(RedisHandlerBackend, self).__init__(handlers) if not redis_installed: @@ -150,6 +161,14 @@ class RedisHandlerBackend(HandlerBackend): class State: + """ + Class representing a state. + + .. code-block:: python3 + + class MyStates(StatesGroup): + my_state = State() # returns my_state:State string. + """ def __init__(self) -> None: self.name = None def __str__(self) -> str: @@ -158,6 +177,14 @@ class State: class StatesGroup: + """ + Class representing common states. + + .. code-block:: python3 + + class MyStates(StatesGroup): + my_state = State() # returns my_state:State string. + """ def __init_subclass__(cls) -> None: for name, value in cls.__dict__.items(): if not name.startswith('__') and not callable(value) and isinstance(value, State): @@ -179,8 +206,13 @@ class BaseMiddleware: message update, then you will have to create pre_process_message function, and so on. Same applies to post_process. - .. code-block:: python - + .. note:: + If you want to use middleware, you have to set use_class_middlewares=True in your + TeleBot instance. + + .. code-block:: python3 + :caption: Example of class-based middlewares. + class MyMiddleware(BaseMiddleware): def __init__(self): self.update_sensitive = True diff --git a/telebot/types.py b/telebot/types.py index 5bab9c4..c2d932b 100644 --- a/telebot/types.py +++ b/telebot/types.py @@ -20,6 +20,7 @@ class JsonSerializable(object): """ Subclasses of this class are guaranteed to be able to be converted to JSON format. All subclasses of this class must override to_json. + """ def to_json(self): @@ -36,6 +37,7 @@ class Dictionaryable(object): """ Subclasses of this class are guaranteed to be able to be converted to dictionary. All subclasses of this class must override to_dict. + """ def to_dict(self): @@ -90,6 +92,65 @@ class JsonDeserializable(object): class Update(JsonDeserializable): + """ + This object represents an incoming update. + + https://core.telegram.org/bots/api#update + + :attribute update_id: The update's unique identifier. Update identifiers start from a certain positive number and increase sequentially. + This ID becomes especially handy if you're using webhooks, since it allows you to ignore repeated updates or to restore the correct + update sequence, should they get out of order. If there are no new updates for at least a week, then identifier of the next update will + be chosen randomly instead of sequentially. + :type update_id: int + + :attribute message: New incoming message of any kind — text, photo, sticker, etc. + :type message: :class:`telebot.types.Message` + + :attribute edited_message: New version of a message that is known to the bot and was edited. + :type edited_message: :class:`telebot.types.Message` + + :attribute channel_post: New incoming channel post of any kind — text, photo, sticker, etc. + :type channel_post: :class:`telebot.types.Message` + + :attribute edited_channel_post: New version of a channel post that is known to the bot and was edited. + :type edited_channel_post: :class:`telebot.types.Message` + + :attribute inline_query: New incoming query from a user, which is answered by a bot and can be further processed. + :type inline_query: :class:`telebot.types.InlineQuery` + + :attribute chosen_inline_result: New incoming result of an inline query that was chosen by a user and sent to their chat partner. + :type chosen_inline_result: :class:`telebot.types.ChosenInlineResult` + + :attribute callback_query: New incoming callback query from a user. + :type callback_query: :class:`telebot.types.CallbackQuery` + + :attribute shipping_query: New incoming shipping query. Only for invoices with flexible price + :type shipping_query: :class:`telebot.types.ShippingQuery` + + :attribute pre_checkout_query: New incoming pre-checkout query. Contains full information about checkout + :type pre_checkout_query: :class:`telebot.types.PreCheckoutQuery` + + :attribute poll: New poll state. Bots receive only updates about stopped polls and polls, which are sent by the bot + :type poll: :class:`telebot.types.Poll` + + :attribute poll_answer: A user changed their answer in a non-anonymous poll. Bots receive new votes only in polls that were sent by the bot itself. + :type poll_answer: :class:`telebot.types.PollAnswer` + + :attribute my_chat_member: The bot's chat member status was updated in a chat. For private chats, + this update is received only when the bot is blocked or unblocked by the user. + :type my_chat_member: :class:`telebot.types.ChatMember` + + :attribute chat_member: A chat member's status was updated in a chat. The bot must be an administrator in the chat and must + explicitly specify “chat_member” in the list of allowed_updates to receive these updates. + :type chat_member: :class:`telebot.types.ChatMember` + + :attribute chat_join_request: A request to join the chat has been sent. The bot must have the can_invite_users + administrator right in the chat to receive these updates. + :type chat_join_request: :class:`telebot.types.ChatJoinRequest` + + :return: An Update object. + :rtype: :class:`telebot.types.Update` + """ @classmethod def de_json(cls, json_string): if json_string is None: return None diff --git a/telebot/util.py b/telebot/util.py index b9d7f7d..8170f67 100644 --- a/telebot/util.py +++ b/telebot/util.py @@ -35,11 +35,13 @@ logger = logging.getLogger('TeleBot') thread_local = threading.local() +#: Contains all media content types. content_type_media = [ 'text', 'audio', 'animation', 'document', 'photo', 'sticker', 'video', 'video_note', 'voice', 'contact', 'dice', 'poll', 'venue', 'location' ] +#: Contains all service content types such as `User joined the group`. content_type_service = [ 'new_chat_members', 'left_chat_member', 'new_chat_title', 'new_chat_photo', 'delete_chat_photo', 'group_chat_created', 'supergroup_chat_created', 'channel_chat_created', 'migrate_to_chat_id', 'migrate_from_chat_id', 'pinned_message', @@ -47,6 +49,7 @@ content_type_service = [ 'video_chat_participants_invited', 'message_auto_delete_timer_changed' ] +#: All update types, should be used for allowed_updates parameter in polling. update_types = [ "message", "edited_message", "channel_post", "edited_channel_post", "inline_query", "chosen_inline_result", "callback_query", "shipping_query", "pre_checkout_query", "poll", "poll_answer", @@ -55,6 +58,9 @@ update_types = [ class WorkerThread(threading.Thread): + """ + :meta private: + """ count = 0 def __init__(self, exception_callback=None, queue=None, name=None): @@ -118,7 +124,9 @@ class WorkerThread(threading.Thread): class ThreadPool: - + """ + :meta private: + """ def __init__(self, telebot, num_threads=2): self.telebot = telebot self.tasks = Queue.Queue() @@ -156,6 +164,9 @@ class ThreadPool: class AsyncTask: + """ + :meta private: + """ def __init__(self, target, *args, **kwargs): self.target = target self.args = args @@ -182,6 +193,9 @@ class AsyncTask: class CustomRequestResponse(): + """ + :meta private: + """ def __init__(self, json_text, status_code = 200, reason = ""): self.status_code = status_code self.text = json_text @@ -192,6 +206,9 @@ class CustomRequestResponse(): def async_dec(): + """ + :meta private: + """ def decorator(fn): def wrapper(*args, **kwargs): return AsyncTask(fn, *args, **kwargs) @@ -201,19 +218,49 @@ def async_dec(): return decorator -def is_string(var): +def is_string(var) -> bool: + """ + Returns True if the given object is a string. + """ return isinstance(var, str) -def is_dict(var): +def is_dict(var) -> bool: + """ + Returns True if the given object is a dictionary. + + :param var: object to be checked + :type var: :obj:`object` + + :return: True if the given object is a dictionary. + :rtype: :obj:`bool` + """ return isinstance(var, dict) -def is_bytes(var): +def is_bytes(var) -> bool: + """ + Returns True if the given object is a bytes object. + + :param var: object to be checked + :type var: :obj:`object` + + :return: True if the given object is a bytes object. + :rtype: :obj:`bool` + """ return isinstance(var, bytes) -def is_pil_image(var): +def is_pil_image(var) -> bool: + """ + Returns True if the given object is a PIL.Image.Image object. + + :param var: object to be checked + :type var: :obj:`object` + + :return: True if the given object is a PIL.Image.Image object. + :rtype: :obj:`bool` + """ return pil_imported and isinstance(var, Image.Image) @@ -233,7 +280,10 @@ def is_command(text: str) -> bool: Checks if `text` is a command. Telegram chat commands start with the '/' character. :param text: Text to check. + :type text: :obj:`str` + :return: True if `text` is a command, else False. + :rtype: :obj:`bool` """ if text is None: return False return text.startswith('/') @@ -244,30 +294,40 @@ def extract_command(text: str) -> Union[str, None]: Extracts the command from `text` (minus the '/') if `text` is a command (see is_command). If `text` is not a command, this function returns None. - Examples: - extract_command('/help'): 'help' - extract_command('/help@BotName'): 'help' - extract_command('/search black eyed peas'): 'search' - extract_command('Good day to you'): None + .. code-block:: python3 + :caption: Examples: + + extract_command('/help'): 'help' + extract_command('/help@BotName'): 'help' + extract_command('/search black eyed peas'): 'search' + extract_command('Good day to you'): None :param text: String to extract the command from + :type text: :obj:`str` + :return: the command if `text` is a command (according to is_command), else None. + :rtype: :obj:`str` or :obj:`None` """ if text is None: return None return text.split()[0].split('@')[0][1:] if is_command(text) else None -def extract_arguments(text: str) -> str: +def extract_arguments(text: str) -> str or None: """ Returns the argument after the command. - Examples: - extract_arguments("/get name"): 'name' - extract_arguments("/get"): '' - extract_arguments("/get@botName name"): 'name' + .. code-block:: python3 + :caption: Examples: + + extract_arguments("/get name"): 'name' + extract_arguments("/get"): '' + extract_arguments("/get@botName name"): 'name' :param text: String to extract the arguments from a command + :type text: :obj:`str` + :return: the arguments if `text` is a command (according to is_command), else None. + :rtype: :obj:`str` or :obj:`None` """ regexp = re.compile(r"/\w*(@\w*)*\s*([\s\S]*)", re.IGNORECASE) result = regexp.match(text) @@ -280,8 +340,13 @@ def split_string(text: str, chars_per_string: int) -> List[str]: This is very useful for splitting one giant message into multiples. :param text: The text to split + :type text: :obj:`str` + :param chars_per_string: The number of characters per line the text is split into. + :type chars_per_string: :obj:`int` + :return: The splitted text as a list of strings. + :rtype: :obj:`list` of :obj:`str` """ return [text[i:i + chars_per_string] for i in range(0, len(text), chars_per_string)] @@ -294,8 +359,13 @@ def smart_split(text: str, chars_per_string: int=MAX_MESSAGE_LENGTH) -> List[str Splits by '\n', '. ' or ' ' in exactly this priority. :param text: The text to split + :type text: :obj:`str` + :param chars_per_string: The number of maximum characters per part the text is split to. + :type chars_per_string: :obj:`int` + :return: The splitted text as a list of strings. + :rtype: :obj:`list` of :obj:`str` """ def _text_before_last(substr: str) -> str: @@ -336,12 +406,25 @@ def user_link(user: types.User, include_id: bool=False) -> str: Returns an HTML user link. This is useful for reports. Attention: Don't forget to set parse_mode to 'HTML'! - Example: - bot.send_message(your_user_id, user_link(message.from_user) + ' started the bot!', parse_mode='HTML') + + .. code-block:: python3 + :caption: Example: + + bot.send_message(your_user_id, user_link(message.from_user) + ' started the bot!', parse_mode='HTML') + + .. note:: + You can use formatting.* for all other formatting options(bold, italic, links, and etc.) + This method is kept for backward compatibility, and it is recommended to use formatting.* for + more options. :param user: the user (not the user_id) + :type user: :obj:`telebot.types.User` + :param include_id: include the user_id + :type include_id: :obj:`bool` + :return: HTML user link + :rtype: :obj:`str` """ name = escape(user.first_name) return (f"{name}" @@ -355,15 +438,16 @@ def quick_markup(values: Dict[str, Dict[str, Any]], row_width: int=2) -> types.I Example: - .. code-block:: python + .. code-block:: python3 + :caption: Using quick_markup: quick_markup({ 'Twitter': {'url': 'https://twitter.com'}, 'Facebook': {'url': 'https://facebook.com'}, 'Back': {'callback_data': 'whatever'} }, row_width=2): - # returns an InlineKeyboardMarkup with two buttons in a row, one leading to Twitter, the other to facebook - # and a back button below + # returns an InlineKeyboardMarkup with two buttons in a row, one leading to Twitter, the other to facebook + # and a back button below # kwargs can be: { @@ -378,8 +462,13 @@ def quick_markup(values: Dict[str, Dict[str, Any]], row_width: int=2) -> types.I } :param values: a dict containing all buttons to create in this format: {text: kwargs} {str:} + :type values: :obj:`dict` + :param row_width: int row width + :type row_width: :obj:`int` + :return: InlineKeyboardMarkup + :rtype: :obj:`types.InlineKeyboardMarkup` """ markup = types.InlineKeyboardMarkup(row_width=row_width) buttons = [ @@ -392,16 +481,25 @@ def quick_markup(values: Dict[str, Dict[str, Any]], row_width: int=2) -> types.I # CREDITS TO http://stackoverflow.com/questions/12317940#answer-12320352 def or_set(self): + """ + :meta private: + """ self._set() self.changed() def or_clear(self): + """ + :meta private: + """ self._clear() self.changed() def orify(e, changed_callback): + """ + :meta private: + """ if not hasattr(e, "_set"): e._set = e.set if not hasattr(e, "_clear"): @@ -412,6 +510,9 @@ def orify(e, changed_callback): def OrEvent(*events): + """ + :meta private: + """ or_event = threading.Event() def changed(): @@ -435,6 +536,9 @@ def OrEvent(*events): def per_thread(key, construct_value, reset=False): + """ + :meta private: + """ if reset or not hasattr(thread_local, key): value = construct_value() setattr(thread_local, key, value) @@ -449,7 +553,13 @@ def chunks(lst, n): yield lst[i:i + n] -def generate_random_token(): +def generate_random_token() -> str: + """ + Generates a random token consisting of letters and digits, 16 characters long. + + :return: a random token + :rtype: :obj:`str` + """ return ''.join(random.sample(string.ascii_letters, 16)) @@ -457,10 +567,19 @@ def deprecated(warn: bool=True, alternative: Optional[Callable]=None, deprecatio """ Use this decorator to mark functions as deprecated. When the function is used, an info (or warning if `warn` is True) is logged. + + :meta private: :param warn: If True a warning is logged else an info + :type warn: :obj:`bool` + :param alternative: The new function to use instead + :type alternative: :obj:`Callable` + :param deprecation_text: Custom deprecation text + :type deprecation_text: :obj:`str` + + :return: The decorated function """ def decorator(function): def wrapper(*args, **kwargs): @@ -480,7 +599,17 @@ def deprecated(warn: bool=True, alternative: Optional[Callable]=None, deprecatio # Cloud helpers def webhook_google_functions(bot, request): - """A webhook endpoint for Google Cloud Functions FaaS.""" + """ + A webhook endpoint for Google Cloud Functions FaaS. + + :param bot: The bot instance + :type bot: :obj:`telebot.TeleBot` or :obj:`telebot.async_telebot.AsyncTeleBot` + + :param request: The request object + :type request: :obj:`flask.Request` + + :return: The response object + """ if request.is_json: try: request_json = request.get_json() @@ -494,7 +623,7 @@ def webhook_google_functions(bot, request): return 'Bot ON' -def antiflood(function, *args, **kwargs): +def antiflood(function: Callable, *args, **kwargs): """ Use this function inside loops in order to avoid getting TooManyRequests error. Example: @@ -505,9 +634,15 @@ def antiflood(function, *args, **kwargs): for chat_id in chat_id_list: msg = antiflood(bot.send_message, chat_id, text) - :param function: - :param args: - :param kwargs: + :param function: The function to call + :type function: :obj:`Callable` + + :param args: The arguments to pass to the function + :type args: :obj:`tuple` + + :param kwargs: The keyword arguments to pass to the function + :type kwargs: :obj:`dict` + :return: None """ from telebot.apihelper import ApiTelegramException @@ -524,6 +659,17 @@ def antiflood(function, *args, **kwargs): def parse_web_app_data(token: str, raw_init_data: str): + """ + Parses web app data. + + :param token: The bot token + :type token: :obj:`str` + + :param raw_init_data: The raw init data + :type raw_init_data: :obj:`str` + + :return: The parsed init data + """ is_valid = validate_web_app_data(token, raw_init_data) if not is_valid: return False @@ -539,7 +685,18 @@ def parse_web_app_data(token: str, raw_init_data: str): return result -def validate_web_app_data(token, raw_init_data): +def validate_web_app_data(token: str, raw_init_data: str): + """ + Validates web app data. + + :param token: The bot token + :type token: :obj:`str` + + :param raw_init_data: The raw init data + :type raw_init_data: :obj:`str` + + :return: The parsed init data + """ try: parsed_data = dict(parse_qsl(raw_init_data)) except ValueError: