Merge pull request #1860 from Badiboy/master

Bump version to 4.9/0

.github/PULL_REQUEST_TEMPLATE.md

@@ -10,6 +10,5 @@ OS:
 
 ## Checklist:
 - [ ] I added/edited example on new feature/change (if exists)
-- [ ] My changes won't break backend compatibility
-- [ ] I made changes for async and sync
-
+- [ ] My changes won't break backward compatibility
+- [ ] I made changes both for sync and async

.github/workflows/setup_python.yml

@@ -20,7 +20,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [ '3.6','3.7','3.8','3.9', '3.10', 'pypy-3.7', 'pypy-3.8', 'pypy-3.9']
+        python-version: [ '3.7', '3.8', '3.9', '3.10', '3.11', 'pypy-3.7', 'pypy-3.8', 'pypy-3.9']
     name: ${{ matrix.python-version }} and tests
     steps:
       - uses: actions/checkout@v2

.gitignore

@@ -64,6 +64,7 @@ testMain.py
 #VS Code
 .vscode/
 .DS_Store
+*.code-workspace
 
 # documentation
 _build/

.travis.yml

@@ -4,6 +4,7 @@ python:
     - "3.8"
     - "3.9"
     - "3.10"
+    - "3.11"
     - "pypy3"
 install: "pip install -r requirements.txt"
 script:

README.md

@@ -11,7 +11,7 @@
 <p align="center">A simple, but extensible Python implementation for the <a href="https://core.telegram.org/bots/api">Telegram Bot API</a>.</p>
 <p align="center">Both synchronous and asynchronous.</p>
 
-## <p align="center">Supported Bot API version: <a href="https://core.telegram.org/bots/api#january-31-2022">5.7</a>!
+## <p align="center">Supported Bot API version: <a href="https://core.telegram.org/bots/api#december-30-2022">6.4</a>!
 
 <h2><a href='https://pytba.readthedocs.io/en/latest/index.html'>Official documentation</a></h2>
 	
@@ -56,7 +56,7 @@
     * [Logging](#logging)
     * [Proxy](#proxy)
     * [Testing](#testing)
-  * [API conformance](#api-conformance)
+  * [API conformance limitations](#api-conformance-limitations)
   * [AsyncTeleBot](#asynctelebot)
   * [F.A.Q.](#faq)
     * [How can I distinguish a User and a GroupChat in message.chat?](#how-can-i-distinguish-a-user-and-a-groupchat-in-messagechat)
@@ -65,11 +65,11 @@
   * [Telegram Channel](#telegram-channel)
   * [More examples](#more-examples)
   * [Code Template](#code-template)
-  * [Bots using this API](#bots-using-this-api)
+  * [Bots using this library](#bots-using-this-library)
 
 ## Getting started
 
-This API is tested with Python 3.6-3.10 and Pypy 3.
+This API is tested with Python 3.7-3.11 and Pypy 3.
 There are two ways to install the library:
 
 * Installation using pip (a Python package manager):
@@ -165,7 +165,7 @@ To start the bot, simply open up a terminal and enter `python echo_bot.py` to ru
 All types are defined in types.py. They are all completely in line with the [Telegram API's definition of the types](https://core.telegram.org/bots/api#available-types), except for the Message's `from` field, which is renamed to `from_user` (because `from` is a Python reserved token). Thus, attributes such as `message_id` can be accessed directly with `message.message_id`. Note that `message.chat` can be either an instance of `User` or `GroupChat` (see [How can I distinguish a User and a GroupChat in message.chat?](#how-can-i-distinguish-a-user-and-a-groupchat-in-messagechat)).
 
 The Message object also has a `content_type`attribute, which defines the type of the Message. `content_type` can be one of the following strings:
-`text`, `audio`, `document`, `photo`, `sticker`, `video`, `video_note`, `voice`, `location`, `contact`, `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`.
+`text`, `audio`, `document`, `photo`, `sticker`, `video`, `video_note`, `voice`, `location`, `contact`, `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`, `web_app_data`.
 
 You can use some types in one function. Example:
 
@@ -358,7 +358,25 @@ def start(message):
 There are other examples using middleware handler in the [examples/middleware](examples/middleware) directory.
 
 #### Class-based middlewares
-There are class-based middlewares. Check out in [examples](https://github.com/eternnoir/pyTelegramBotAPI/tree/master/examples/middleware/class_based)	
+There are class-based middlewares. 
+Basic class-based middleware looks like this:
+```python
+class Middleware(BaseMiddleware):
+    def __init__(self):
+        self.update_types = ['message']
+    def pre_process(self, message, data):
+        data['foo'] = 'Hello' # just for example
+        # we edited the data. now, this data is passed to handler.
+        # return SkipHandler() -> this will skip handler
+        # return CancelUpdate() -> this will cancel update
+    def post_process(self, message, data, exception=None):
+        print(data['foo'])
+        if exception: # check for exception
+            print(exception)
+```
+Class-based middleware should have to functions: post and pre process.
+So, as you can see, class-based middlewares work before and after handler execution.
+For more, check out in [examples](https://github.com/eternnoir/pyTelegramBotAPI/tree/master/examples/middleware/class_based)	
 	
 #### Custom filters
 Also, you can use built-in custom filters. Or, you can create your own filter.	
@@ -380,7 +398,7 @@ Here is example of creating filter-class:
 ```python
 class IsAdmin(telebot.custom_filters.SimpleCustomFilter):
     # Class will check whether the user is admin or creator in group or not
-    key='is_admin'
+    key='is_chat_admin'
     @staticmethod
     def check(message: telebot.types.Message):
         return bot.get_chat_member(message.chat.id,message.from_user.id).status in ['administrator','creator']
@@ -389,7 +407,7 @@ class IsAdmin(telebot.custom_filters.SimpleCustomFilter):
 bot.add_custom_filter(IsAdmin())
 	
 # Now, you can use it in handler.
-@bot.message_handler(is_admin=True)
+@bot.message_handler(is_chat_admin=True)
 def admin_of_group(message):
 	bot.send_message(message.chat.id, 'You are admin of this group!')
 
@@ -656,6 +674,8 @@ telebot.logger.setLevel(logging.DEBUG) # Outputs debug messages to console.
 ```
 
 ### Proxy
+For sync:
+
 You can use proxy for request. `apihelper.proxy` object will use by call `requests` proxies argument.
 
 ```python
@@ -670,6 +690,14 @@ If you want to use socket5 proxy you need install dependency `pip install reques
 apihelper.proxy = {'https':'socks5://userproxy:password@proxy_address:port'}
 ```
 
+For async:
+```python
+from telebot import asyncio_helper
+
+asyncio_helper.proxy = 'http://127.0.0.1:3128' #url
+```
+
+
 ### Testing
 You can disable or change the interaction with real Telegram server by using
 ```python
@@ -698,26 +726,10 @@ Result will be:
 
 
 
-## API conformance
-	
-* ✔ [Bot API 5.7](https://core.telegram.org/bots/api#january-31-2022)
-* ✔ [Bot API 5.6](https://core.telegram.org/bots/api#december-30-2021)
-* ✔ [Bot API 5.5](https://core.telegram.org/bots/api#december-7-2021)
-* ✔ [Bot API 5.4](https://core.telegram.org/bots/api#november-5-2021)
-* ➕ [Bot API 5.3](https://core.telegram.org/bots/api#june-25-2021) - ChatMember* classes are full copies of ChatMember
-* ✔ [Bot API 5.2](https://core.telegram.org/bots/api#april-26-2021)
-* ✔ [Bot API 5.1](https://core.telegram.org/bots/api#march-9-2021)
-* ✔ [Bot API 5.0](https://core.telegram.org/bots/api-changelog#november-4-2020)
-* ✔ [Bot API 4.9](https://core.telegram.org/bots/api-changelog#june-4-2020)
-* ✔ [Bot API 4.8](https://core.telegram.org/bots/api-changelog#april-24-2020)
-* ✔ [Bot API 4.7](https://core.telegram.org/bots/api-changelog#march-30-2020)
-* ✔ [Bot API 4.6](https://core.telegram.org/bots/api-changelog#january-23-2020)
+## API conformance limitations
 * ➕ [Bot API 4.5](https://core.telegram.org/bots/api-changelog#december-31-2019) - No nested MessageEntities and Markdown2 support
-* ✔ [Bot API 4.4](https://core.telegram.org/bots/api-changelog#july-29-2019)
-* ✔ [Bot API 4.3](https://core.telegram.org/bots/api-changelog#may-31-2019)
-* ✔ [Bot API 4.2](https://core.telegram.org/bots/api-changelog#april-14-2019)
-* ➕ [Bot API 4.1](https://core.telegram.org/bots/api-changelog#august-27-2018) - No Passport support
-* ➕ [Bot API 4.0](https://core.telegram.org/bots/api-changelog#july-26-2018)   - No Passport support
+* ➕ [Bot API 4.1](https://core.telegram.org/bots/api-changelog#august-27-2018)   - No Passport support
+* ➕ [Bot API 4.0](https://core.telegram.org/bots/api-changelog#july-26-2018)     - No Passport support
 
 
 ## AsyncTeleBot
@@ -816,7 +828,7 @@ Here are some examples of template:
 * [TeleBot template](https://github.com/coder2020official/telebot_template)
 	
 	
-## Bots using this API
+## Bots using this library
 * [SiteAlert bot](https://telegram.me/SiteAlert_bot) ([source](https://github.com/ilteoood/SiteAlert-Python)) by *ilteoood* - Monitors websites and sends a notification on changes
 * [TelegramLoggingBot](https://github.com/aRandomStranger/TelegramLoggingBot) by *aRandomStranger*
 * [Telegram LMGTFY_bot](https://github.com/GabrielRF/telegram-lmgtfy_bot) by *GabrielRF* - Let me Google that for you.
@@ -865,7 +877,15 @@ Here are some examples of template:
 * [GrandQuiz Bot](https://github.com/Carlosma7/TFM-GrandQuiz) by [Carlosma7](https://github.com/Carlosma7). This bot is a trivia game that allows you to play with people from different ages. This project addresses the use of a system through chatbots to carry out a social and intergenerational game as an alternative to traditional game development.
 * [Diccionario de la RAE](https://t.me/dleraebot) ([source](https://github.com/studentenherz/dleraebot)) This bot lets you find difinitions of words in Spanish using [RAE's dictionary](https://dle.rae.es/). It features direct message and inline search.
 * [remoteTelegramShell](https://github.com/EnriqueMoran/remoteTelegramShell) by [EnriqueMoran](https://github.com/EnriqueMoran). Control your LinuxOS computer through Telegram.
+* [Commerce Telegram Bot](https://github.com/ayitinya/commerce-telegram-bot/). Make purchases of items in a store with an Admin panel for data control and notifications.
 * [Pyfram-telegram-bot](https://github.com/skelly37/pyfram-telegram-bot) Query wolframalpha.com and make use of its API through Telegram.
 * [TranslateThisVideoBot](https://gitlab.com/WuerfelDev/translatethisvideo) This Bot can understand spoken text in videos and translate it to English
+* [Zyprexa](https://t.me/mathemathicsBot) ([source](https://github.com/atif5/zyprexa)) Zyprexa can solve, help you solve any mathematical problem you encounter and convert your regular mathematical expressions into beautiful imagery using LaTeX.
+* [Bincode-telegram-bot](https://github.com/tusharhero/bincode-telegram-bot) by [tusharhero](https://github.com/tusharhero) - Makes [bincodes](https://github.com/tusharhero/bincode) from text provides and also converts them back to text.
+* [hydrolib_bot](https://github.com/Mayson90/hydrolib_bot) Toolset for Hydrophilia tabletop game (game cards, rules, structure...).
+* [Gugumoe-bot](http://t.me/gugumoe_bot) ([source](https://github.com/GooGuJiang/Gugumoe-bot)) by [咕谷酱](https://gmoe.cc) GuXiaoJiang is a multi-functional robot, such as OSU game information query, IP test, animation screenshot search and other functions.
+* [Feedback-bot](https://github.com/coder2020official/feedbackbot) A feedback bot for user-admin communication. Made on AsyncTeleBot, using [template](https://github.com/coder2020official/asynctelebot_template).
+* [TeleServ](https://github.com/ablakely/TeleServ) by [ablakely](https://github.com/ablakely) This is a Telegram to IRC bridge which links as an IRC server and makes Telegram users appear as native IRC users.
+* [Simple Store Bot](https://github.com/AntonGlyzin/myshopbot) by [Anton Glyzin](https://github.com/AntonGlyzin) This is a simple telegram-store with an admin panel. Designed according to a template.
 
 **Want to have your bot listed here? Just make a pull request. Only bots with public source code are accepted.**

docs/source/async_version/index.rst

@@ -2,6 +2,12 @@
 AsyncTeleBot
 ====================
 
+
+.. meta::
+   :description: Asynchronous pyTelegramBotAPI
+   :keywords: ptba, pytba, pyTelegramBotAPI, asynctelebot, documentation
+
+
 AsyncTeleBot methods
 --------------------
 
@@ -20,15 +26,6 @@ Asyncio filters
    :undoc-members:
    :show-inheritance:
 
-Asynchronous storage for states
--------------------------------
-
-.. automodule:: telebot.asyncio_storage
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-
 Asyncio handler backends
 ------------------------
 
@@ -40,4 +37,12 @@ Asyncio handler backends
    :show-inheritance:
 
 
+Extensions
+------------------------
 
+
+
+.. automodule:: telebot.ext.aio.webhooks
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/calldata.rst

@@ -3,6 +3,10 @@
 Callback data factory
 =====================
 
+.. meta::
+   :description: Callback data factory in pyTelegramBotAPI
+   :keywords: ptba, pytba, pyTelegramBotAPI, callbackdatafactory, guide, callbackdata, factory
+
 
 callback\_data file
 -----------------------------

docs/source/conf.py

@@ -17,12 +17,12 @@
 
 # -- Project information -----------------------------------------------------
 
-project = 'pyTelegramBotAPI'
+project = 'pyTelegramBotAPI Documentation'
 copyright = '2022, coder2020official'
 author = 'coder2020official'
 
 # The full version, including alpha/beta/rc tags
-release = '4.4.1'
+release = '4.9.0'
 
 
 # -- General configuration ---------------------------------------------------
@@ -68,3 +68,5 @@ html_theme_options = {
     "light_logo": "logo.png",
     "dark_logo": "logo2.png",
 }
+
+locale_dirs = ["locales/"]

docs/source/formatting.rst

@@ -0,0 +1,12 @@
+==================
+Formatting options
+==================
+
+.. meta::
+   :description: Formatting options in pyTelegramBotAPI
+   :keywords: html, markdown, parse_mode, formatting, ptba, pytba, pyTelegramBotAPI
+
+.. automodule:: telebot.formatting
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/index.rst

@@ -7,6 +7,11 @@
 Welcome to pyTelegramBotAPI's documentation!
 ============================================
 
+.. meta::
+   :description: Official documentation of pyTelegramBotAPI
+   :keywords: ptba, pytba, pyTelegramBotAPI, documentation, guide
+
+
 =======
 TeleBot
 =======
@@ -49,6 +54,7 @@ Content
    async_version/index
    calldata
    util
+   formatting
 
 
 

docs/source/install.rst

@@ -2,6 +2,10 @@
 Installation Guide
 ==================
 
+.. meta::
+   :description: Installation of pyTelegramBotAPI
+   :keywords: ptba, pytba, pyTelegramBotAPI, installation, guide
+
 
 Using PIP
 ----------

docs/source/locales/en/LC_MESSAGES/calldata.po

@@ -0,0 +1,127 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) 2022, coder2020official
+# This file is distributed under the same license as the pyTelegramBotAPI
+# Documentation package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, 2022.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: pyTelegramBotAPI Documentation \n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2022-11-29 14:44+0400\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=utf-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Generated-By: Babel 2.9.1\n"
+
+#: ../../calldata.rst:4
+msgid "Callback data factory"
+msgstr ""
+
+#: ../../calldata.rst:6
+msgid "Callback data factory in pyTelegramBotAPI"
+msgstr ""
+
+#: ../../calldata.rst:6
+msgid ""
+"ptba, pytba, pyTelegramBotAPI, callbackdatafactory, guide, callbackdata, "
+"factory"
+msgstr ""
+
+#: ../../calldata.rst:12
+msgid "callback\\_data file"
+msgstr ""
+
+#: of telebot.callback_data:1
+msgid "Callback data factory's file."
+msgstr ""
+
+#: of telebot.callback_data.CallbackData:1
+#: telebot.callback_data.CallbackDataFilter:1
+msgid "Bases: :py:class:`object`"
+msgstr ""
+
+#: of telebot.callback_data.CallbackData:1
+msgid "Callback data factory This class will help you to work with CallbackQuery"
+msgstr ""
+
+#: of telebot.callback_data.CallbackData.filter:1
+msgid "Generate filter"
+msgstr ""
+
+#: of telebot.callback_data.CallbackData.filter
+#: telebot.callback_data.CallbackData.new
+#: telebot.callback_data.CallbackData.parse
+#: telebot.callback_data.CallbackDataFilter.check
+msgid "Parameters"
+msgstr ""
+
+#: of telebot.callback_data.CallbackData.filter:3
+msgid "specified named parameters will be checked with CallbackQuery.data"
+msgstr ""
+
+#: of telebot.callback_data.CallbackData.filter
+#: telebot.callback_data.CallbackData.new
+#: telebot.callback_data.CallbackData.parse
+#: telebot.callback_data.CallbackDataFilter.check
+msgid "Returns"
+msgstr ""
+
+#: of telebot.callback_data.CallbackData.filter:4
+msgid "CallbackDataFilter class"
+msgstr ""
+
+#: of telebot.callback_data.CallbackData.new:1
+msgid "Generate callback data"
+msgstr ""
+
+#: of telebot.callback_data.CallbackData.new:3
+msgid "positional parameters of CallbackData instance parts"
+msgstr ""
+
+#: of telebot.callback_data.CallbackData.new:4
+msgid "named parameters"
+msgstr ""
+
+#: of telebot.callback_data.CallbackData.new:5
+msgid "str"
+msgstr ""
+
+#: of telebot.callback_data.CallbackData.parse:1
+msgid "Parse data from the callback data"
+msgstr ""
+
+#: of telebot.callback_data.CallbackData.parse:3
+msgid ""
+"string, use to telebot.types.CallbackQuery to parse it from string to a "
+"dict"
+msgstr ""
+
+#: of telebot.callback_data.CallbackData.parse:4
+msgid "dict parsed from callback data"
+msgstr ""
+
+#: of telebot.callback_data.CallbackDataFilter:1
+msgid "Filter for CallbackData."
+msgstr ""
+
+#: of telebot.callback_data.CallbackDataFilter.check:1
+msgid "Checks if query.data appropriates to specified config"
+msgstr ""
+
+#: of telebot.callback_data.CallbackDataFilter.check:3
+msgid "telebot.types.CallbackQuery"
+msgstr ""
+
+#: of telebot.callback_data.CallbackDataFilter.check:6
+msgid "True if query.data appropriates to specified config"
+msgstr ""
+
+#: of telebot.callback_data.CallbackDataFilter.check
+msgid "Return type"
+msgstr ""
+

docs/source/locales/en/LC_MESSAGES/formatting.po

@@ -0,0 +1,251 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) 2022, coder2020official
+# This file is distributed under the same license as the pyTelegramBotAPI
+# Documentation package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, 2022.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: pyTelegramBotAPI Documentation \n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2022-11-29 14:44+0400\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=utf-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Generated-By: Babel 2.9.1\n"
+
+#: ../../formatting.rst:3
+msgid "Formatting options"
+msgstr ""
+
+#: ../../formatting.rst:5
+msgid "Formatting options in pyTelegramBotAPI"
+msgstr ""
+
+#: ../../formatting.rst:5
+msgid "html, markdown, parse_mode, formatting, ptba, pytba, pyTelegramBotAPI"
+msgstr ""
+
+#: of telebot.formatting:1
+msgid "Markdown & HTML formatting functions."
+msgstr ""
+
+#: of telebot.formatting.escape_html:1
+msgid "Escapes HTML characters in a string of HTML."
+msgstr ""
+
+#: of telebot.formatting.escape_html telebot.formatting.escape_markdown
+#: telebot.formatting.format_text telebot.formatting.hbold
+#: telebot.formatting.hcode telebot.formatting.hide_link
+#: telebot.formatting.hitalic telebot.formatting.hlink telebot.formatting.hpre
+#: telebot.formatting.hspoiler telebot.formatting.hstrikethrough
+#: telebot.formatting.hunderline telebot.formatting.mbold
+#: telebot.formatting.mcode telebot.formatting.mitalic telebot.formatting.mlink
+#: telebot.formatting.mspoiler telebot.formatting.mstrikethrough
+#: telebot.formatting.munderline
+msgid "Parameters"
+msgstr ""
+
+#: of telebot.formatting.escape_html:3
+msgid "The string of HTML to escape."
+msgstr ""
+
+#: of telebot.formatting.escape_html telebot.formatting.escape_markdown
+#: telebot.formatting.format_text telebot.formatting.hbold
+#: telebot.formatting.hcode telebot.formatting.hide_link
+#: telebot.formatting.hitalic telebot.formatting.hlink telebot.formatting.hpre
+#: telebot.formatting.hspoiler telebot.formatting.hstrikethrough
+#: telebot.formatting.hunderline telebot.formatting.mbold
+#: telebot.formatting.mcode telebot.formatting.mitalic telebot.formatting.mlink
+#: telebot.formatting.mspoiler telebot.formatting.mstrikethrough
+#: telebot.formatting.munderline
+msgid "Returns"
+msgstr ""
+
+#: of telebot.formatting.escape_html:6 telebot.formatting.escape_markdown:8
+msgid "The escaped string."
+msgstr ""
+
+#: of telebot.formatting.escape_html telebot.formatting.escape_markdown
+#: telebot.formatting.format_text telebot.formatting.hbold
+#: telebot.formatting.hcode telebot.formatting.hide_link
+#: telebot.formatting.hitalic telebot.formatting.hlink telebot.formatting.hpre
+#: telebot.formatting.hspoiler telebot.formatting.hstrikethrough
+#: telebot.formatting.hunderline telebot.formatting.mbold
+#: telebot.formatting.mcode telebot.formatting.mitalic telebot.formatting.mlink
+#: telebot.formatting.mspoiler telebot.formatting.mstrikethrough
+#: telebot.formatting.munderline
+msgid "Return type"
+msgstr ""
+
+#: of telebot.formatting.escape_html:7 telebot.formatting.escape_markdown:9
+#: telebot.formatting.format_text:17 telebot.formatting.hbold:10
+#: telebot.formatting.hcode:10 telebot.formatting.hide_link:7
+#: telebot.formatting.hitalic:10 telebot.formatting.hlink:13
+#: telebot.formatting.hpre:10 telebot.formatting.hspoiler:10
+#: telebot.formatting.hstrikethrough:10 telebot.formatting.hunderline:10
+#: telebot.formatting.mbold:10 telebot.formatting.mcode:10
+#: telebot.formatting.mitalic:10 telebot.formatting.mlink:13
+#: telebot.formatting.mspoiler:10 telebot.formatting.mstrikethrough:10
+#: telebot.formatting.munderline:10
+msgid ":obj:`str`"
+msgstr ""
+
+#: of telebot.formatting.escape_markdown:1
+msgid "Escapes Markdown characters in a string of Markdown."
+msgstr ""
+
+#: of telebot.formatting.escape_markdown:3
+msgid "Credits to: simonsmh"
+msgstr ""
+
+#: of telebot.formatting.escape_markdown:5
+msgid "The string of Markdown to escape."
+msgstr ""
+
+#: of telebot.formatting.format_text:1
+msgid "Formats a list of strings into a single string."
+msgstr ""
+
+#: of telebot.formatting.format_text:10
+msgid "Strings to format."
+msgstr ""
+
+#: of telebot.formatting.format_text:13
+msgid "The separator to use between each string."
+msgstr ""
+
+#: of telebot.formatting.format_text:16 telebot.formatting.hbold:9
+#: telebot.formatting.hcode:9 telebot.formatting.hitalic:9
+#: telebot.formatting.hlink:12 telebot.formatting.hpre:9
+#: telebot.formatting.hspoiler:9 telebot.formatting.hstrikethrough:9
+#: telebot.formatting.hunderline:9 telebot.formatting.mbold:9
+#: telebot.formatting.mcode:9 telebot.formatting.mitalic:9
+#: telebot.formatting.mlink:12 telebot.formatting.mspoiler:9
+#: telebot.formatting.mstrikethrough:9 telebot.formatting.munderline:9
+msgid "The formatted string."
+msgstr ""
+
+#: of telebot.formatting.hbold:1
+msgid "Returns an HTML-formatted bold string."
+msgstr ""
+
+#: of telebot.formatting.hbold:3 telebot.formatting.mbold:3
+msgid "The string to bold."
+msgstr ""
+
+#: of telebot.formatting.hbold:6 telebot.formatting.hcode:6
+#: telebot.formatting.hitalic:6 telebot.formatting.hlink:9
+#: telebot.formatting.hpre:6 telebot.formatting.hspoiler:6
+#: telebot.formatting.hstrikethrough:6 telebot.formatting.hunderline:6
+#: telebot.formatting.mbold:6 telebot.formatting.mcode:6
+#: telebot.formatting.mitalic:6 telebot.formatting.mlink:9
+#: telebot.formatting.mspoiler:6 telebot.formatting.mstrikethrough:6
+#: telebot.formatting.munderline:6
+msgid "True if you need to escape special characters. Defaults to True."
+msgstr ""
+
+#: of telebot.formatting.hcode:1
+msgid "Returns an HTML-formatted code string."
+msgstr ""
+
+#: of telebot.formatting.hcode:3 telebot.formatting.mcode:3
+msgid "The string to code."
+msgstr ""
+
+#: of telebot.formatting.hide_link:1
+msgid "Hide url of an image."
+msgstr ""
+
+#: of telebot.formatting.hide_link:3
+msgid "The url of the image."
+msgstr ""
+
+#: of telebot.formatting.hide_link:6
+msgid "The hidden url."
+msgstr ""
+
+#: of telebot.formatting.hitalic:1
+msgid "Returns an HTML-formatted italic string."
+msgstr ""
+
+#: of telebot.formatting.hitalic:3 telebot.formatting.mitalic:3
+msgid "The string to italicize."
+msgstr ""
+
+#: of telebot.formatting.hlink:1
+msgid "Returns an HTML-formatted link string."
+msgstr ""
+
+#: of telebot.formatting.hlink:3 telebot.formatting.mlink:3
+msgid "The string to link."
+msgstr ""
+
+#: of telebot.formatting.hlink:6 telebot.formatting.mlink:6
+msgid "The URL to link to."
+msgstr ""
+
+#: of telebot.formatting.hpre:1
+msgid "Returns an HTML-formatted preformatted string."
+msgstr ""
+
+#: of telebot.formatting.hpre:3
+msgid "The string to preformatted."
+msgstr ""
+
+#: of telebot.formatting.hspoiler:1
+msgid "Returns an HTML-formatted spoiler string."
+msgstr ""
+
+#: of telebot.formatting.hspoiler:3 telebot.formatting.mspoiler:3
+msgid "The string to spoiler."
+msgstr ""
+
+#: of telebot.formatting.hstrikethrough:1
+msgid "Returns an HTML-formatted strikethrough string."
+msgstr ""
+
+#: of telebot.formatting.hstrikethrough:3 telebot.formatting.mstrikethrough:3
+msgid "The string to strikethrough."
+msgstr ""
+
+#: of telebot.formatting.hunderline:1
+msgid "Returns an HTML-formatted underline string."
+msgstr ""
+
+#: of telebot.formatting.hunderline:3 telebot.formatting.munderline:3
+msgid "The string to underline."
+msgstr ""
+
+#: of telebot.formatting.mbold:1
+msgid "Returns a Markdown-formatted bold string."
+msgstr ""
+
+#: of telebot.formatting.mcode:1
+msgid "Returns a Markdown-formatted code string."
+msgstr ""
+
+#: of telebot.formatting.mitalic:1
+msgid "Returns a Markdown-formatted italic string."
+msgstr ""
+
+#: of telebot.formatting.mlink:1
+msgid "Returns a Markdown-formatted link string."
+msgstr ""
+
+#: of telebot.formatting.mspoiler:1
+msgid "Returns a Markdown-formatted spoiler string."
+msgstr ""
+
+#: of telebot.formatting.mstrikethrough:1
+msgid "Returns a Markdown-formatted strikethrough string."
+msgstr ""
+
+#: of telebot.formatting.munderline:1
+msgid "Returns a Markdown-formatted underline string."
+msgstr ""
+

docs/source/locales/en/LC_MESSAGES/index.po

@@ -0,0 +1,120 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) 2022, coder2020official
+# This file is distributed under the same license as the pyTelegramBotAPI
+# Documentation package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, 2022.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: pyTelegramBotAPI Documentation \n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2022-11-29 14:44+0400\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=utf-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Generated-By: Babel 2.9.1\n"
+
+#: ../../index.rst:8
+msgid "Welcome to pyTelegramBotAPI's documentation!"
+msgstr ""
+
+#: ../../index.rst:10
+msgid "Official documentation of pyTelegramBotAPI"
+msgstr ""
+
+#: ../../index.rst:10
+msgid "ptba, pytba, pyTelegramBotAPI, documentation, guide"
+msgstr ""
+
+#: ../../index.rst:17
+msgid "TeleBot"
+msgstr ""
+
+#: ../../index.rst:18
+msgid ""
+"TeleBot is synchronous and asynchronous implementation of  `Telegram Bot "
+"API <https://core.telegram.org/bots/api>`_."
+msgstr ""
+
+#: ../../index.rst:21
+msgid "Chats"
+msgstr ""
+
+#: ../../index.rst:22
+msgid ""
+"English chat: `Private chat "
+"<https://telegram.me/joinchat/Bn4ixj84FIZVkwhk2jag6A>`__"
+msgstr ""
+
+#: ../../index.rst:24
+msgid ""
+"Russian chat: `@pytelegrambotapi_talks_ru "
+"<https://t.me/pytelegrambotapi_talks_ru>`__"
+msgstr ""
+
+#: ../../index.rst:26
+msgid "News: `@pyTelegramBotAPI <https://t.me/pytelegrambotapi>`__"
+msgstr ""
+
+#: ../../index.rst:28
+msgid "Pypi: `Pypi <https://pypi.org/project/pyTelegramBotAPI/>`__"
+msgstr ""
+
+#: ../../index.rst:30
+msgid ""
+"Source: `Github repository "
+"<https://github.com/eternnoir/pyTelegramBotAPI>`__"
+msgstr ""
+
+#: ../../index.rst:33
+msgid "Some features:"
+msgstr ""
+
+#: ../../index.rst:34
+msgid "Easy to learn and use."
+msgstr ""
+
+#: ../../index.rst:36
+msgid "Easy to understand."
+msgstr ""
+
+#: ../../index.rst:38
+msgid "Both sync and async."
+msgstr ""
+
+#: ../../index.rst:40
+msgid "Examples on features."
+msgstr ""
+
+#: ../../index.rst:42
+msgid "States"
+msgstr ""
+
+#: ../../index.rst:44
+msgid "And more..."
+msgstr ""
+
+#: ../../index.rst:47
+msgid "Content"
+msgstr ""
+
+#: ../../index.rst:63
+msgid "Indices and tables"
+msgstr ""
+
+#: ../../index.rst:65
+msgid ":ref:`genindex`"
+msgstr ""
+
+#: ../../index.rst:66
+msgid ":ref:`modindex`"
+msgstr ""
+
+#: ../../index.rst:67
+msgid ":ref:`search`"
+msgstr ""
+

docs/source/locales/en/LC_MESSAGES/install.po

@@ -0,0 +1,58 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) 2022, coder2020official
+# This file is distributed under the same license as the pyTelegramBotAPI
+# Documentation package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, 2022.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: pyTelegramBotAPI Documentation \n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2022-11-29 14:44+0400\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=utf-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Generated-By: Babel 2.9.1\n"
+
+#: ../../install.rst:3
+msgid "Installation Guide"
+msgstr ""
+
+#: ../../install.rst:5
+msgid "Installation of pyTelegramBotAPI"
+msgstr ""
+
+#: ../../install.rst:5
+msgid "ptba, pytba, pyTelegramBotAPI, installation, guide"
+msgstr ""
+
+#: ../../install.rst:11
+msgid "Using PIP"
+msgstr ""
+
+#: ../../install.rst:17
+msgid "Using pipenv"
+msgstr ""
+
+#: ../../install.rst:23
+msgid "By cloning repository"
+msgstr ""
+
+#: ../../install.rst:31
+msgid "Directly using pip"
+msgstr ""
+
+#: ../../install.rst:37
+msgid "It is generally recommended to use the first option."
+msgstr ""
+
+#: ../../install.rst:39
+msgid ""
+"While the API is production-ready, it is still under development and it "
+"has regular updates, do not forget to update it regularly by calling:"
+msgstr ""
+

docs/source/locales/en/LC_MESSAGES/quick_start.po

@@ -0,0 +1,40 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) 2022, coder2020official
+# This file is distributed under the same license as the pyTelegramBotAPI
+# Documentation package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, 2022.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: pyTelegramBotAPI Documentation \n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2022-11-29 14:44+0400\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=utf-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Generated-By: Babel 2.9.1\n"
+
+#: ../../quick_start.rst:4
+msgid "Quick start"
+msgstr ""
+
+#: ../../quick_start.rst:6
+msgid "Quickstart guide"
+msgstr ""
+
+#: ../../quick_start.rst:6
+msgid "ptba, pytba, pyTelegramBotAPI, quickstart, guide"
+msgstr ""
+
+#: ../../quick_start.rst:11
+msgid "Synchronous TeleBot"
+msgstr ""
+
+#: ../../quick_start.rst:16
+msgid "Asynchronous TeleBot"
+msgstr ""
+

docs/source/locales/en/LC_MESSAGES/util.po

@@ -0,0 +1,345 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) 2022, coder2020official
+# This file is distributed under the same license as the pyTelegramBotAPI
+# Documentation package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, 2022.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: pyTelegramBotAPI Documentation \n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2022-11-29 14:44+0400\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=utf-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Generated-By: Babel 2.9.1\n"
+
+#: ../../util.rst:3
+msgid "Utils"
+msgstr ""
+
+#: ../../util.rst:5
+msgid "Utils in pyTelegramBotAPI"
+msgstr ""
+
+#: ../../util.rst:5
+msgid "ptba, pytba, pyTelegramBotAPI, utils, guide"
+msgstr ""
+
+#: ../../util.rst:11
+msgid "util file"
+msgstr ""
+
+#: of telebot.util.antiflood:1
+msgid ""
+"Use this function inside loops in order to avoid getting TooManyRequests "
+"error. Example:"
+msgstr ""
+
+#: of telebot.util.antiflood telebot.util.escape telebot.util.extract_arguments
+#: telebot.util.extract_command telebot.util.is_bytes telebot.util.is_command
+#: telebot.util.is_dict telebot.util.is_pil_image
+#: telebot.util.parse_web_app_data telebot.util.quick_markup
+#: telebot.util.smart_split telebot.util.split_string telebot.util.user_link
+#: telebot.util.validate_web_app_data telebot.util.webhook_google_functions
+msgid "Parameters"
+msgstr ""
+
+#: of telebot.util.antiflood:10
+msgid "The function to call"
+msgstr ""
+
+#: of telebot.util.antiflood:13
+msgid "The arguments to pass to the function"
+msgstr ""
+
+#: of telebot.util.antiflood:16
+msgid "The keyword arguments to pass to the function"
+msgstr ""
+
+#: of telebot.util.antiflood telebot.util.escape telebot.util.extract_arguments
+#: telebot.util.extract_command telebot.util.generate_random_token
+#: telebot.util.is_bytes telebot.util.is_command telebot.util.is_dict
+#: telebot.util.is_pil_image telebot.util.parse_web_app_data
+#: telebot.util.quick_markup telebot.util.smart_split telebot.util.split_string
+#: telebot.util.user_link telebot.util.validate_web_app_data
+#: telebot.util.webhook_google_functions
+msgid "Returns"
+msgstr ""
+
+#: of telebot.util.antiflood:19
+msgid "None"
+msgstr ""
+
+#: of telebot.util.chunks:1
+msgid "Yield successive n-sized chunks from lst."
+msgstr ""
+
+#: ../../docstring of telebot.util.content_type_media:1
+msgid "Contains all media content types."
+msgstr ""
+
+#: ../../docstring of telebot.util.content_type_service:1
+msgid "Contains all service content types such as `User joined the group`."
+msgstr ""
+
+#: of telebot.util.escape:1
+msgid ""
+"Replaces the following chars in `text` ('&' with '&amp;', '<' with '&lt;'"
+" and '>' with '&gt;')."
+msgstr ""
+
+#: of telebot.util.escape:3
+msgid "the text to escape"
+msgstr ""
+
+#: of telebot.util.escape:4
+msgid "the escaped text"
+msgstr ""
+
+#: of telebot.util.extract_arguments:1
+msgid "Returns the argument after the command."
+msgstr ""
+
+#: of telebot.util.extract_arguments:3 telebot.util.extract_command:4
+msgid "Examples:"
+msgstr ""
+
+#: of telebot.util.extract_arguments:10
+msgid "String to extract the arguments from a command"
+msgstr ""
+
+#: of telebot.util.extract_arguments:13
+msgid "the arguments if `text` is a command (according to is_command), else None."
+msgstr ""
+
+#: of telebot.util.extract_arguments telebot.util.extract_command
+#: telebot.util.generate_random_token telebot.util.is_bytes
+#: telebot.util.is_command telebot.util.is_dict telebot.util.is_pil_image
+#: telebot.util.quick_markup telebot.util.smart_split telebot.util.split_string
+#: telebot.util.user_link
+msgid "Return type"
+msgstr ""
+
+#: of telebot.util.extract_arguments:14 telebot.util.extract_command:16
+msgid ":obj:`str` or :obj:`None`"
+msgstr ""
+
+#: of telebot.util.extract_command:1
+msgid ""
+"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."
+msgstr ""
+
+#: of telebot.util.extract_command:12
+msgid "String to extract the command from"
+msgstr ""
+
+#: of telebot.util.extract_command:15
+msgid "the command if `text` is a command (according to is_command), else None."
+msgstr ""
+
+#: of telebot.util.generate_random_token:1
+msgid ""
+"Generates a random token consisting of letters and digits, 16 characters "
+"long."
+msgstr ""
+
+#: of telebot.util.generate_random_token:3
+msgid "a random token"
+msgstr ""
+
+#: of telebot.util.generate_random_token:4 telebot.util.user_link:22
+msgid ":obj:`str`"
+msgstr ""
+
+#: of telebot.util.is_bytes:1
+msgid "Returns True if the given object is a bytes object."
+msgstr ""
+
+#: of telebot.util.is_bytes:3 telebot.util.is_dict:3
+#: telebot.util.is_pil_image:3
+msgid "object to be checked"
+msgstr ""
+
+#: of telebot.util.is_bytes:6
+msgid "True if the given object is a bytes object."
+msgstr ""
+
+#: of telebot.util.is_bytes:7 telebot.util.is_command:7 telebot.util.is_dict:7
+#: telebot.util.is_pil_image:7
+msgid ":obj:`bool`"
+msgstr ""
+
+#: of telebot.util.is_command:1
+msgid ""
+"Checks if `text` is a command. Telegram chat commands start with the '/' "
+"character."
+msgstr ""
+
+#: of telebot.util.is_command:3
+msgid "Text to check."
+msgstr ""
+
+#: of telebot.util.is_command:6
+msgid "True if `text` is a command, else False."
+msgstr ""
+
+#: of telebot.util.is_dict:1
+msgid "Returns True if the given object is a dictionary."
+msgstr ""
+
+#: of telebot.util.is_dict:6
+msgid "True if the given object is a dictionary."
+msgstr ""
+
+#: of telebot.util.is_pil_image:1
+msgid "Returns True if the given object is a PIL.Image.Image object."
+msgstr ""
+
+#: of telebot.util.is_pil_image:6
+msgid "True if the given object is a PIL.Image.Image object."
+msgstr ""
+
+#: of telebot.util.is_string:1
+msgid "Returns True if the given object is a string."
+msgstr ""
+
+#: of telebot.util.parse_web_app_data:1
+msgid "Parses web app data."
+msgstr ""
+
+#: of telebot.util.parse_web_app_data:3 telebot.util.validate_web_app_data:3
+msgid "The bot token"
+msgstr ""
+
+#: of telebot.util.parse_web_app_data:6 telebot.util.validate_web_app_data:6
+msgid "The raw init data"
+msgstr ""
+
+#: of telebot.util.parse_web_app_data:9 telebot.util.validate_web_app_data:9
+msgid "The parsed init data"
+msgstr ""
+
+#: of telebot.util.quick_markup:1
+msgid ""
+"Returns a reply markup from a dict in this format: {'text': kwargs} This "
+"is useful to avoid always typing 'btn1 = InlineKeyboardButton(...)' 'btn2"
+" = InlineKeyboardButton(...)'"
+msgstr ""
+
+#: of telebot.util.quick_markup:4 telebot.util.user_link:5
+msgid "Example:"
+msgstr ""
+
+#: of telebot.util.quick_markup:6
+msgid "Using quick_markup:"
+msgstr ""
+
+#: of telebot.util.quick_markup:29
+msgid ""
+"a dict containing all buttons to create in this format: {text: kwargs} "
+"{str:}"
+msgstr ""
+
+#: of telebot.util.quick_markup:32
+msgid "int row width"
+msgstr ""
+
+#: of telebot.util.quick_markup:35
+msgid "InlineKeyboardMarkup"
+msgstr ""
+
+#: of telebot.util.quick_markup:36
+msgid ":obj:`types.InlineKeyboardMarkup`"
+msgstr ""
+
+#: of telebot.util.smart_split:1
+msgid ""
+"Splits one string into multiple strings, with a maximum amount of "
+"`chars_per_string` characters per string. This is very useful for "
+"splitting one giant message into multiples. If `chars_per_string` > 4096:"
+" `chars_per_string` = 4096. Splits by '\\n', '. ' or ' ' in exactly this "
+"priority."
+msgstr ""
+
+#: of telebot.util.smart_split:6 telebot.util.split_string:4
+msgid "The text to split"
+msgstr ""
+
+#: of telebot.util.smart_split:9
+msgid "The number of maximum characters per part the text is split to."
+msgstr ""
+
+#: of telebot.util.smart_split:12 telebot.util.split_string:10
+msgid "The splitted text as a list of strings."
+msgstr ""
+
+#: of telebot.util.smart_split:13 telebot.util.split_string:11
+msgid ":obj:`list` of :obj:`str`"
+msgstr ""
+
+#: of telebot.util.split_string:1
+msgid ""
+"Splits one string into multiple strings, with a maximum amount of "
+"`chars_per_string` characters per string. This is very useful for "
+"splitting one giant message into multiples."
+msgstr ""
+
+#: of telebot.util.split_string:7
+msgid "The number of characters per line the text is split into."
+msgstr ""
+
+#: ../../docstring of telebot.util.update_types:1
+msgid "All update types, should be used for allowed_updates parameter in polling."
+msgstr ""
+
+#: of telebot.util.user_link:1
+msgid ""
+"Returns an HTML user link. This is useful for reports. Attention: Don't "
+"forget to set parse_mode to 'HTML'!"
+msgstr ""
+
+#: of telebot.util.user_link:11
+msgid ""
+"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."
+msgstr ""
+
+#: of telebot.util.user_link:15
+msgid "the user (not the user_id)"
+msgstr ""
+
+#: of telebot.util.user_link:18
+msgid "include the user_id"
+msgstr ""
+
+#: of telebot.util.user_link:21
+msgid "HTML user link"
+msgstr ""
+
+#: of telebot.util.validate_web_app_data:1
+msgid "Validates web app data."
+msgstr ""
+
+#: of telebot.util.webhook_google_functions:1
+msgid "A webhook endpoint for Google Cloud Functions FaaS."
+msgstr ""
+
+#: of telebot.util.webhook_google_functions:3
+msgid "The bot instance"
+msgstr ""
+
+#: of telebot.util.webhook_google_functions:6
+msgid "The request object"
+msgstr ""
+
+#: of telebot.util.webhook_google_functions:9
+msgid "The response object"
+msgstr ""
+

docs/source/locales/ru/LC_MESSAGES/calldata.po

@@ -0,0 +1,127 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) 2022, coder2020official
+# This file is distributed under the same license as the pyTelegramBotAPI
+# Documentation package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, 2022.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: pyTelegramBotAPI Documentation \n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2022-11-29 14:44+0400\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=utf-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Generated-By: Babel 2.9.1\n"
+
+#: ../../calldata.rst:4
+msgid "Callback data factory"
+msgstr ""
+
+#: ../../calldata.rst:6
+msgid "Callback data factory in pyTelegramBotAPI"
+msgstr ""
+
+#: ../../calldata.rst:6
+msgid ""
+"ptba, pytba, pyTelegramBotAPI, callbackdatafactory, guide, callbackdata, "
+"factory"
+msgstr ""
+
+#: ../../calldata.rst:12
+msgid "callback\\_data file"
+msgstr ""
+
+#: of telebot.callback_data:1
+msgid "Callback data factory's file."
+msgstr ""
+
+#: of telebot.callback_data.CallbackData:1
+#: telebot.callback_data.CallbackDataFilter:1
+msgid "Bases: :py:class:`object`"
+msgstr ""
+
+#: of telebot.callback_data.CallbackData:1
+msgid "Callback data factory This class will help you to work with CallbackQuery"
+msgstr ""
+
+#: of telebot.callback_data.CallbackData.filter:1
+msgid "Generate filter"
+msgstr ""
+
+#: of telebot.callback_data.CallbackData.filter
+#: telebot.callback_data.CallbackData.new
+#: telebot.callback_data.CallbackData.parse
+#: telebot.callback_data.CallbackDataFilter.check
+msgid "Parameters"
+msgstr ""
+
+#: of telebot.callback_data.CallbackData.filter:3
+msgid "specified named parameters will be checked with CallbackQuery.data"
+msgstr ""
+
+#: of telebot.callback_data.CallbackData.filter
+#: telebot.callback_data.CallbackData.new
+#: telebot.callback_data.CallbackData.parse
+#: telebot.callback_data.CallbackDataFilter.check
+msgid "Returns"
+msgstr ""
+
+#: of telebot.callback_data.CallbackData.filter:4
+msgid "CallbackDataFilter class"
+msgstr ""
+
+#: of telebot.callback_data.CallbackData.new:1
+msgid "Generate callback data"
+msgstr ""
+
+#: of telebot.callback_data.CallbackData.new:3
+msgid "positional parameters of CallbackData instance parts"
+msgstr ""
+
+#: of telebot.callback_data.CallbackData.new:4
+msgid "named parameters"
+msgstr ""
+
+#: of telebot.callback_data.CallbackData.new:5
+msgid "str"
+msgstr ""
+
+#: of telebot.callback_data.CallbackData.parse:1
+msgid "Parse data from the callback data"
+msgstr ""
+
+#: of telebot.callback_data.CallbackData.parse:3
+msgid ""
+"string, use to telebot.types.CallbackQuery to parse it from string to a "
+"dict"
+msgstr ""
+
+#: of telebot.callback_data.CallbackData.parse:4
+msgid "dict parsed from callback data"
+msgstr ""
+
+#: of telebot.callback_data.CallbackDataFilter:1
+msgid "Filter for CallbackData."
+msgstr ""
+
+#: of telebot.callback_data.CallbackDataFilter.check:1
+msgid "Checks if query.data appropriates to specified config"
+msgstr ""
+
+#: of telebot.callback_data.CallbackDataFilter.check:3
+msgid "telebot.types.CallbackQuery"
+msgstr ""
+
+#: of telebot.callback_data.CallbackDataFilter.check:6
+msgid "True if query.data appropriates to specified config"
+msgstr ""
+
+#: of telebot.callback_data.CallbackDataFilter.check
+msgid "Return type"
+msgstr ""
+

docs/source/locales/ru/LC_MESSAGES/formatting.po

@@ -0,0 +1,251 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) 2022, coder2020official
+# This file is distributed under the same license as the pyTelegramBotAPI
+# Documentation package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, 2022.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: pyTelegramBotAPI Documentation \n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2022-11-29 14:44+0400\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=utf-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Generated-By: Babel 2.9.1\n"
+
+#: ../../formatting.rst:3
+msgid "Formatting options"
+msgstr "Параметры форматирования"
+
+#: ../../formatting.rst:5
+msgid "Formatting options in pyTelegramBotAPI"
+msgstr "Параметры форматирования в pyTelegramBotAPI"
+
+#: ../../formatting.rst:5
+msgid "html, markdown, parse_mode, formatting, ptba, pytba, pyTelegramBotAPI"
+msgstr "html, markdown, parse_mode, форматирование, ptba, pytba, pyTelegramBotAPI"
+
+#: of telebot.formatting:1
+msgid "Markdown & HTML formatting functions."
+msgstr "Функции форматирования Markdown & HTML."
+
+#: of telebot.formatting.escape_html:1
+msgid "Escapes HTML characters in a string of HTML."
+msgstr "Пропускает HTML символы в HTML строке."
+
+#: of telebot.formatting.escape_html telebot.formatting.escape_markdown
+#: telebot.formatting.format_text telebot.formatting.hbold
+#: telebot.formatting.hcode telebot.formatting.hide_link
+#: telebot.formatting.hitalic telebot.formatting.hlink telebot.formatting.hpre
+#: telebot.formatting.hspoiler telebot.formatting.hstrikethrough
+#: telebot.formatting.hunderline telebot.formatting.mbold
+#: telebot.formatting.mcode telebot.formatting.mitalic telebot.formatting.mlink
+#: telebot.formatting.mspoiler telebot.formatting.mstrikethrough
+#: telebot.formatting.munderline
+msgid "Parameters"
+msgstr ""
+
+#: of telebot.formatting.escape_html:3
+msgid "The string of HTML to escape."
+msgstr "HTML строка, которую нужно пропустить."
+
+#: of telebot.formatting.escape_html telebot.formatting.escape_markdown
+#: telebot.formatting.format_text telebot.formatting.hbold
+#: telebot.formatting.hcode telebot.formatting.hide_link
+#: telebot.formatting.hitalic telebot.formatting.hlink telebot.formatting.hpre
+#: telebot.formatting.hspoiler telebot.formatting.hstrikethrough
+#: telebot.formatting.hunderline telebot.formatting.mbold
+#: telebot.formatting.mcode telebot.formatting.mitalic telebot.formatting.mlink
+#: telebot.formatting.mspoiler telebot.formatting.mstrikethrough
+#: telebot.formatting.munderline
+msgid "Returns"
+msgstr ""
+
+#: of telebot.formatting.escape_html:6 telebot.formatting.escape_markdown:8
+msgid "The escaped string."
+msgstr "Пропускаемая строка."
+
+#: of telebot.formatting.escape_html telebot.formatting.escape_markdown
+#: telebot.formatting.format_text telebot.formatting.hbold
+#: telebot.formatting.hcode telebot.formatting.hide_link
+#: telebot.formatting.hitalic telebot.formatting.hlink telebot.formatting.hpre
+#: telebot.formatting.hspoiler telebot.formatting.hstrikethrough
+#: telebot.formatting.hunderline telebot.formatting.mbold
+#: telebot.formatting.mcode telebot.formatting.mitalic telebot.formatting.mlink
+#: telebot.formatting.mspoiler telebot.formatting.mstrikethrough
+#: telebot.formatting.munderline
+msgid "Return type"
+msgstr ""
+
+#: of telebot.formatting.escape_html:7 telebot.formatting.escape_markdown:9
+#: telebot.formatting.format_text:17 telebot.formatting.hbold:10
+#: telebot.formatting.hcode:10 telebot.formatting.hide_link:7
+#: telebot.formatting.hitalic:10 telebot.formatting.hlink:13
+#: telebot.formatting.hpre:10 telebot.formatting.hspoiler:10
+#: telebot.formatting.hstrikethrough:10 telebot.formatting.hunderline:10
+#: telebot.formatting.mbold:10 telebot.formatting.mcode:10
+#: telebot.formatting.mitalic:10 telebot.formatting.mlink:13
+#: telebot.formatting.mspoiler:10 telebot.formatting.mstrikethrough:10
+#: telebot.formatting.munderline:10
+msgid ":obj:`str`"
+msgstr ""
+
+#: of telebot.formatting.escape_markdown:1
+msgid "Escapes Markdown characters in a string of Markdown."
+msgstr "Пропускает Markdown символы в Markdown строке."
+
+#: of telebot.formatting.escape_markdown:3
+msgid "Credits to: simonsmh"
+msgstr ""
+
+#: of telebot.formatting.escape_markdown:5
+msgid "The string of Markdown to escape."
+msgstr "Markdown строка, которую нужно пропустить."
+
+#: of telebot.formatting.format_text:1
+msgid "Formats a list of strings into a single string."
+msgstr "Преобразовывает набор строк в одну."
+
+#: of telebot.formatting.format_text:10
+msgid "Strings to format."
+msgstr "Строки для преобразования."
+
+#: of telebot.formatting.format_text:13
+msgid "The separator to use between each string."
+msgstr "Символ для разделения строк."
+
+#: of telebot.formatting.format_text:16 telebot.formatting.hbold:9
+#: telebot.formatting.hcode:9 telebot.formatting.hitalic:9
+#: telebot.formatting.hlink:12 telebot.formatting.hpre:9
+#: telebot.formatting.hspoiler:9 telebot.formatting.hstrikethrough:9
+#: telebot.formatting.hunderline:9 telebot.formatting.mbold:9
+#: telebot.formatting.mcode:9 telebot.formatting.mitalic:9
+#: telebot.formatting.mlink:12 telebot.formatting.mspoiler:9
+#: telebot.formatting.mstrikethrough:9 telebot.formatting.munderline:9
+msgid "The formatted string."
+msgstr "Преобразованная строка."
+
+#: of telebot.formatting.hbold:1
+msgid "Returns an HTML-formatted bold string."
+msgstr "Возвращает выделенную жирным шрифтом HTML строку."
+
+#: of telebot.formatting.hbold:3 telebot.formatting.mbold:3
+msgid "The string to bold."
+msgstr "Строка для выделения жирным шрифтом."
+
+#: of telebot.formatting.hbold:6 telebot.formatting.hcode:6
+#: telebot.formatting.hitalic:6 telebot.formatting.hlink:9
+#: telebot.formatting.hpre:6 telebot.formatting.hspoiler:6
+#: telebot.formatting.hstrikethrough:6 telebot.formatting.hunderline:6
+#: telebot.formatting.mbold:6 telebot.formatting.mcode:6
+#: telebot.formatting.mitalic:6 telebot.formatting.mlink:9
+#: telebot.formatting.mspoiler:6 telebot.formatting.mstrikethrough:6
+#: telebot.formatting.munderline:6
+msgid "True if you need to escape special characters. Defaults to True."
+msgstr "True если вам нужно пропустить спец. символы. По умолчанию True."
+
+#: of telebot.formatting.hcode:1
+msgid "Returns an HTML-formatted code string."
+msgstr "Возвращает выделенную как код HTML строку."
+
+#: of telebot.formatting.hcode:3 telebot.formatting.mcode:3
+msgid "The string to code."
+msgstr "Строка для выделения как код."
+
+#: of telebot.formatting.hide_link:1
+msgid "Hide url of an image."
+msgstr "Делает невидимым URL изображения."
+
+#: of telebot.formatting.hide_link:3
+msgid "The url of the image."
+msgstr "URL изображения."
+
+#: of telebot.formatting.hide_link:6
+msgid "The hidden url."
+msgstr "Невидимый URL."
+
+#: of telebot.formatting.hitalic:1
+msgid "Returns an HTML-formatted italic string."
+msgstr "Возвращает выделенную курсивом HTML строку."
+
+#: of telebot.formatting.hitalic:3 telebot.formatting.mitalic:3
+msgid "The string to italicize."
+msgstr "Строка для выделения курсивом."
+
+#: of telebot.formatting.hlink:1
+msgid "Returns an HTML-formatted link string."
+msgstr "Возвращает HTML строку с гиперссылкой."
+
+#: of telebot.formatting.hlink:3 telebot.formatting.mlink:3
+msgid "The string to link."
+msgstr "Строка для добавления гиперссылки."
+
+#: of telebot.formatting.hlink:6 telebot.formatting.mlink:6
+msgid "The URL to link to."
+msgstr "URL для создания гиперссылки."
+
+#: of telebot.formatting.hpre:1
+msgid "Returns an HTML-formatted preformatted string."
+msgstr "Возвращает предварительно отформатированную HTML строку."
+
+#: of telebot.formatting.hpre:3
+msgid "The string to preformatted."
+msgstr "Строка для предварительного форматирования."
+
+#: of telebot.formatting.hspoiler:1
+msgid "Returns an HTML-formatted spoiler string."
+msgstr "Возвращает выделенную как спойлер HTML строку."
+
+#: of telebot.formatting.hspoiler:3 telebot.formatting.mspoiler:3
+msgid "The string to spoiler."
+msgstr "Строка для выделения как спойлер."
+
+#: of telebot.formatting.hstrikethrough:1
+msgid "Returns an HTML-formatted strikethrough string."
+msgstr "Возвращает зачеркнутую HTML строку."
+
+#: of telebot.formatting.hstrikethrough:3 telebot.formatting.mstrikethrough:3
+msgid "The string to strikethrough."
+msgstr "Строка для зачеркивания."
+
+#: of telebot.formatting.hunderline:1
+msgid "Returns an HTML-formatted underline string."
+msgstr "Возвращает подчеркнутую HTML строку."
+
+#: of telebot.formatting.hunderline:3 telebot.formatting.munderline:3
+msgid "The string to underline."
+msgstr "Строка для подчёркивания."
+
+#: of telebot.formatting.mbold:1
+msgid "Returns a Markdown-formatted bold string."
+msgstr "Возвращает выделенную жирным шрифтом Markdown строку."
+
+#: of telebot.formatting.mcode:1
+msgid "Returns a Markdown-formatted code string."
+msgstr "Возвращает выделенную как код Markdown строку."
+
+#: of telebot.formatting.mitalic:1
+msgid "Returns a Markdown-formatted italic string."
+msgstr "Возвращает выделенную курсивом Markdown строку."
+
+#: of telebot.formatting.mlink:1
+msgid "Returns a Markdown-formatted link string."
+msgstr "Возвращает Markdown строку с гиперссылкой."
+
+#: of telebot.formatting.mspoiler:1
+msgid "Returns a Markdown-formatted spoiler string."
+msgstr "Возвращает выделенную как спойлер Markdown строку."
+
+#: of telebot.formatting.mstrikethrough:1
+msgid "Returns a Markdown-formatted strikethrough string."
+msgstr "Возвращает зачеркнутую Markdown строку."
+
+#: of telebot.formatting.munderline:1
+msgid "Returns a Markdown-formatted underline string."
+msgstr "Возвращает подчеркнутую Markdown строку."
+

docs/source/locales/ru/LC_MESSAGES/index.po

@@ -0,0 +1,120 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) 2022, coder2020official
+# This file is distributed under the same license as the pyTelegramBotAPI
+# Documentation package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, 2022.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: pyTelegramBotAPI Documentation \n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2022-11-29 14:44+0400\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=utf-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Generated-By: Babel 2.9.1\n"
+
+#: ../../index.rst:8
+msgid "Welcome to pyTelegramBotAPI's documentation!"
+msgstr ""
+
+#: ../../index.rst:10
+msgid "Official documentation of pyTelegramBotAPI"
+msgstr ""
+
+#: ../../index.rst:10
+msgid "ptba, pytba, pyTelegramBotAPI, documentation, guide"
+msgstr ""
+
+#: ../../index.rst:17
+msgid "TeleBot"
+msgstr ""
+
+#: ../../index.rst:18
+msgid ""
+"TeleBot is synchronous and asynchronous implementation of  `Telegram Bot "
+"API <https://core.telegram.org/bots/api>`_."
+msgstr ""
+
+#: ../../index.rst:21
+msgid "Chats"
+msgstr ""
+
+#: ../../index.rst:22
+msgid ""
+"English chat: `Private chat "
+"<https://telegram.me/joinchat/Bn4ixj84FIZVkwhk2jag6A>`__"
+msgstr ""
+
+#: ../../index.rst:24
+msgid ""
+"Russian chat: `@pytelegrambotapi_talks_ru "
+"<https://t.me/pytelegrambotapi_talks_ru>`__"
+msgstr ""
+
+#: ../../index.rst:26
+msgid "News: `@pyTelegramBotAPI <https://t.me/pytelegrambotapi>`__"
+msgstr ""
+
+#: ../../index.rst:28
+msgid "Pypi: `Pypi <https://pypi.org/project/pyTelegramBotAPI/>`__"
+msgstr ""
+
+#: ../../index.rst:30
+msgid ""
+"Source: `Github repository "
+"<https://github.com/eternnoir/pyTelegramBotAPI>`__"
+msgstr ""
+
+#: ../../index.rst:33
+msgid "Some features:"
+msgstr ""
+
+#: ../../index.rst:34
+msgid "Easy to learn and use."
+msgstr ""
+
+#: ../../index.rst:36
+msgid "Easy to understand."
+msgstr ""
+
+#: ../../index.rst:38
+msgid "Both sync and async."
+msgstr ""
+
+#: ../../index.rst:40
+msgid "Examples on features."
+msgstr ""
+
+#: ../../index.rst:42
+msgid "States"
+msgstr ""
+
+#: ../../index.rst:44
+msgid "And more..."
+msgstr ""
+
+#: ../../index.rst:47
+msgid "Content"
+msgstr ""
+
+#: ../../index.rst:63
+msgid "Indices and tables"
+msgstr ""
+
+#: ../../index.rst:65
+msgid ":ref:`genindex`"
+msgstr ""
+
+#: ../../index.rst:66
+msgid ":ref:`modindex`"
+msgstr ""
+
+#: ../../index.rst:67
+msgid ":ref:`search`"
+msgstr ""
+

docs/source/locales/ru/LC_MESSAGES/install.po

@@ -0,0 +1,59 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) 2022, coder2020official
+# This file is distributed under the same license as the pyTelegramBotAPI
+# Documentation package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, 2022.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: pyTelegramBotAPI Documentation \n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2022-11-29 14:44+0400\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=utf-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Generated-By: Babel 2.9.1\n"
+
+#: ../../install.rst:3
+msgid "Installation Guide"
+msgstr "Гайд по установке"
+
+#: ../../install.rst:5
+msgid "Installation of pyTelegramBotAPI"
+msgstr "Установка pyTelegramBotAPI"
+
+#: ../../install.rst:5
+msgid "ptba, pytba, pyTelegramBotAPI, installation, guide"
+msgstr "ptba, pytba, pyTelegramBotAPI, установка, гайд"
+
+#: ../../install.rst:11
+msgid "Using PIP"
+msgstr "Используя PIP"
+
+#: ../../install.rst:17
+msgid "Using pipenv"
+msgstr "Используя pipenv"
+
+#: ../../install.rst:23
+msgid "By cloning repository"
+msgstr "Клонируя репозиторий"
+
+#: ../../install.rst:31
+msgid "Directly using pip"
+msgstr "Напрямую используя pip"
+
+#: ../../install.rst:37
+msgid "It is generally recommended to use the first option."
+msgstr "Рекомендуется использовать первый вариант."
+
+#: ../../install.rst:39
+msgid ""
+"While the API is production-ready, it is still under development and it "
+"has regular updates, do not forget to update it regularly by calling:"
+msgstr "Новые версии библиотеки имеют больше фич, улучшений и баг фиксов. Не забывайте"
+" обновляться вызывая:"
+

docs/source/locales/ru/LC_MESSAGES/quick_start.po

@@ -0,0 +1,40 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) 2022, coder2020official
+# This file is distributed under the same license as the pyTelegramBotAPI
+# Documentation package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, 2022.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: pyTelegramBotAPI Documentation \n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2022-11-29 14:44+0400\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=utf-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Generated-By: Babel 2.9.1\n"
+
+#: ../../quick_start.rst:4
+msgid "Quick start"
+msgstr "Быстрый старт"
+
+#: ../../quick_start.rst:6
+msgid "Quickstart guide"
+msgstr "Быстрый старт - гайд"
+
+#: ../../quick_start.rst:6
+msgid "ptba, pytba, pyTelegramBotAPI, quickstart, guide"
+msgstr "ptba, pytba, pyTelegramBotAPI, быстрый старт, гайд"
+
+#: ../../quick_start.rst:11
+msgid "Synchronous TeleBot"
+msgstr "Синхронный телебот"
+
+#: ../../quick_start.rst:16
+msgid "Asynchronous TeleBot"
+msgstr "Асинхронный телебот"
+

docs/source/locales/ru/LC_MESSAGES/util.po

@@ -0,0 +1,366 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) 2022, coder2020official
+# This file is distributed under the same license as the pyTelegramBotAPI
+# Documentation package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, 2022.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: pyTelegramBotAPI Documentation \n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2022-11-29 14:44+0400\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=utf-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Generated-By: Babel 2.9.1\n"
+
+#: ../../util.rst:3
+msgid "Utils"
+msgstr "Утилиты"
+
+#: ../../util.rst:5
+msgid "Utils in pyTelegramBotAPI"
+msgstr "Утилиты в pyTelegramBotAPI"
+
+#: ../../util.rst:5
+msgid "ptba, pytba, pyTelegramBotAPI, utils, guide"
+msgstr "ptba, pytba, pyTelegramBotAPI, утилиты, гайд"
+
+#: ../../util.rst:11
+msgid "util file"
+msgstr "Файл util"
+
+#: of telebot.util.antiflood:1
+msgid ""
+"Use this function inside loops in order to avoid getting TooManyRequests "
+"error. Example:"
+msgstr "Используйте эту функцию в циклах, чтобы избежать ошибки TooManyRequests. Пример:"
+
+#: of telebot.util.antiflood telebot.util.escape telebot.util.extract_arguments
+#: telebot.util.extract_command telebot.util.is_bytes telebot.util.is_command
+#: telebot.util.is_dict telebot.util.is_pil_image
+#: telebot.util.parse_web_app_data telebot.util.quick_markup
+#: telebot.util.smart_split telebot.util.split_string telebot.util.user_link
+#: telebot.util.validate_web_app_data telebot.util.webhook_google_functions
+msgid "Parameters"
+msgstr ""
+
+#: of telebot.util.antiflood:10
+msgid "The function to call"
+msgstr "Вызываемая функция"
+
+#: of telebot.util.antiflood:13
+msgid "The arguments to pass to the function"
+msgstr "Аргументы, для передачи в функцию"
+
+#: of telebot.util.antiflood:16
+msgid "The keyword arguments to pass to the function"
+msgstr "Именованные аргументы для передачи в функцию"
+
+#: of telebot.util.antiflood telebot.util.escape telebot.util.extract_arguments
+#: telebot.util.extract_command telebot.util.generate_random_token
+#: telebot.util.is_bytes telebot.util.is_command telebot.util.is_dict
+#: telebot.util.is_pil_image telebot.util.parse_web_app_data
+#: telebot.util.quick_markup telebot.util.smart_split telebot.util.split_string
+#: telebot.util.user_link telebot.util.validate_web_app_data
+#: telebot.util.webhook_google_functions
+msgid "Returns"
+msgstr ""
+
+#: of telebot.util.antiflood:19
+msgid "None"
+msgstr ""
+
+#: of telebot.util.chunks:1
+msgid "Yield successive n-sized chunks from lst."
+msgstr "Генерирует последовательные части списка, состоящие из n элементов."
+
+#: ../../docstring of telebot.util.content_type_media:1
+msgid "Contains all media content types."
+msgstr "Содержит все виды медиа."
+
+#: ../../docstring of telebot.util.content_type_service:1
+msgid "Contains all service content types such as `User joined the group`."
+msgstr "Содержит все виды сервисных сообщений, такие как `User joined the group`."
+
+#: of telebot.util.escape:1
+msgid ""
+"Replaces the following chars in `text` ('&' with '&amp;', '<' with '&lt;'"
+" and '>' with '&gt;')."
+msgstr "Заменяет следующие символы в `text` ('&' на '&amp;', '<' на '&lt;'"
+" и '>' на '&gt;')."
+
+#: of telebot.util.escape:3
+msgid "the text to escape"
+msgstr "Текст для замены символов"
+
+#: of telebot.util.escape:4
+msgid "the escaped text"
+msgstr "Отформатированный текст"
+
+#: of telebot.util.extract_arguments:1
+msgid "Returns the argument after the command."
+msgstr "Возвращает аргументы команды."
+
+#: of telebot.util.extract_arguments:3 telebot.util.extract_command:4
+msgid "Examples:"
+msgstr "Примеры:"
+
+#: of telebot.util.extract_arguments:10
+msgid "String to extract the arguments from a command"
+msgstr "Строка для извлечения аргументов команды"
+
+#: of telebot.util.extract_arguments:13
+msgid "the arguments if `text` is a command (according to is_command), else None."
+msgstr "Аргументы, если `text` является командой (согласно is_command), в остальных случаях None."
+
+#: of telebot.util.extract_arguments telebot.util.extract_command
+#: telebot.util.generate_random_token telebot.util.is_bytes
+#: telebot.util.is_command telebot.util.is_dict telebot.util.is_pil_image
+#: telebot.util.quick_markup telebot.util.smart_split telebot.util.split_string
+#: telebot.util.user_link
+msgid "Return type"
+msgstr ""
+
+#: of telebot.util.extract_arguments:14 telebot.util.extract_command:16
+msgid ":obj:`str` or :obj:`None`"
+msgstr ":obj:`str` или :obj:`None`"
+
+#: of telebot.util.extract_command:1
+msgid ""
+"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."
+msgstr ""
+"Извлекает команду из `text` (исключает '/') если `text` является командой "
+"(см. is_command). Если `text` не является командой, эта функция возвращает None."
+
+#: of telebot.util.extract_command:12
+msgid "String to extract the command from"
+msgstr "Строка, из которой нужно извлечь команду"
+
+#: of telebot.util.extract_command:15
+msgid "the command if `text` is a command (according to is_command), else None."
+msgstr "Команда, если `text` является командой (согласно is_command), в остальных случаях None."
+
+#: of telebot.util.generate_random_token:1
+msgid ""
+"Generates a random token consisting of letters and digits, 16 characters "
+"long."
+msgstr "Генерирует рандомный токен, состоящий из латинских букв и цифр длиной 16 символов."
+
+#: of telebot.util.generate_random_token:3
+msgid "a random token"
+msgstr "Сгенерированный токен"
+
+#: of telebot.util.generate_random_token:4 telebot.util.user_link:22
+msgid ":obj:`str`"
+msgstr ""
+
+#: of telebot.util.is_bytes:1
+msgid "Returns True if the given object is a bytes object."
+msgstr "Возвращает True если полученный объект является bytes."
+
+#: of telebot.util.is_bytes:3 telebot.util.is_dict:3
+#: telebot.util.is_pil_image:3
+msgid "object to be checked"
+msgstr "Объект для проверки"
+
+#: of telebot.util.is_bytes:6
+msgid "True if the given object is a bytes object."
+msgstr "True, если полученный объект является bytes."
+
+#: of telebot.util.is_bytes:7 telebot.util.is_command:7 telebot.util.is_dict:7
+#: telebot.util.is_pil_image:7
+msgid ":obj:`bool`"
+msgstr ""
+
+#: of telebot.util.is_command:1
+msgid ""
+"Checks if `text` is a command. Telegram chat commands start with the '/' "
+"character."
+msgstr ""
+"Проверяет, является ли `text` командой. Команды в Telegram начинаются "
+"с символа '/'."
+
+#: of telebot.util.is_command:3
+msgid "Text to check."
+msgstr "Текст для проверки."
+
+#: of telebot.util.is_command:6
+msgid "True if `text` is a command, else False."
+msgstr "True, если `text` является командой, иначе False."
+
+#: of telebot.util.is_dict:1
+msgid "Returns True if the given object is a dictionary."
+msgstr "Возвращает True, если полученный объект является словарём (dict)."
+
+#: of telebot.util.is_dict:6
+msgid "True if the given object is a dictionary."
+msgstr "True, если полученный объект является словарём (dict)."
+
+#: of telebot.util.is_pil_image:1
+msgid "Returns True if the given object is a PIL.Image.Image object."
+msgstr "Возвращает True, если полученный объект является PIL.Image.Image."
+
+#: of telebot.util.is_pil_image:6
+msgid "True if the given object is a PIL.Image.Image object."
+msgstr "True, если полученный объект является PIL.Image.Image."
+
+#: of telebot.util.is_string:1
+msgid "Returns True if the given object is a string."
+msgstr "Возвращает True, если полученный объект является строкой (str)."
+
+#: of telebot.util.parse_web_app_data:1
+msgid "Parses web app data."
+msgstr "Обрабатывает данные, полученные от web app."
+
+#: of telebot.util.parse_web_app_data:3 telebot.util.validate_web_app_data:3
+msgid "The bot token"
+msgstr "Токен бота"
+
+#: of telebot.util.parse_web_app_data:6 telebot.util.validate_web_app_data:6
+msgid "The raw init data"
+msgstr "Необработанные данные"
+
+#: of telebot.util.parse_web_app_data:9 telebot.util.validate_web_app_data:9
+msgid "The parsed init data"
+msgstr "Обработанные данные"
+
+#: of telebot.util.quick_markup:1
+msgid ""
+"Returns a reply markup from a dict in this format: {'text': kwargs} This "
+"is useful to avoid always typing 'btn1 = InlineKeyboardButton(...)' 'btn2"
+" = InlineKeyboardButton(...)'"
+msgstr ""
+"Возвращает reply markup из словаря следующего формата: {'text': kwargs}. Удобно "
+"использовать вместо постоянного использования 'btn1 = InlineKeyboardButton(...)' 'btn2"
+" = InlineKeyboardButton(...)'"
+
+#: of telebot.util.quick_markup:4 telebot.util.user_link:5
+msgid "Example:"
+msgstr "Пример:"
+
+#: of telebot.util.quick_markup:6
+msgid "Using quick_markup:"
+msgstr "Используя quick_markup:"
+
+#: of telebot.util.quick_markup:29
+msgid ""
+"a dict containing all buttons to create in this format: {text: kwargs} "
+"{str:}"
+msgstr ""
+"Словарь, содержащий все кнопки для создания reply markup в следующем "
+"формате: {text: kwargs} {str:}"
+
+#: of telebot.util.quick_markup:32
+msgid "int row width"
+msgstr "Количество кнопок в одной строке, int"
+
+#: of telebot.util.quick_markup:35
+msgid "InlineKeyboardMarkup"
+msgstr ""
+
+#: of telebot.util.quick_markup:36
+msgid ":obj:`types.InlineKeyboardMarkup`"
+msgstr ""
+
+#: of telebot.util.smart_split:1
+msgid ""
+"Splits one string into multiple strings, with a maximum amount of "
+"`chars_per_string` characters per string. This is very useful for "
+"splitting one giant message into multiples. If `chars_per_string` > 4096:"
+" `chars_per_string` = 4096. Splits by '\\n', '. ' or ' ' in exactly this "
+"priority."
+msgstr ""
+"Разбивает строку на несколько, каждая из которых будет не длиннее `characters_per_string`. "
+"Удобно использовать для разбиения одного гигантского сообщения на несколько. "
+"Если `chars_per_string` > 4096: `chars_per_string` = 4096. Разбивает строку по '\\n', '. ' или ' ' "
+"именно в таком порядке."
+
+#: of telebot.util.smart_split:6 telebot.util.split_string:4
+msgid "The text to split"
+msgstr "Текст для разбиения"
+
+#: of telebot.util.smart_split:9
+msgid "The number of maximum characters per part the text is split to."
+msgstr "Максимальное количество символов в части текста, на которые он будет разбит."
+
+#: of telebot.util.smart_split:12 telebot.util.split_string:10
+msgid "The splitted text as a list of strings."
+msgstr "Список частей разбитого текста."
+
+#: of telebot.util.smart_split:13 telebot.util.split_string:11
+msgid ":obj:`list` of :obj:`str`"
+msgstr ""
+
+#: of telebot.util.split_string:1
+msgid ""
+"Splits one string into multiple strings, with a maximum amount of "
+"`chars_per_string` characters per string. This is very useful for "
+"splitting one giant message into multiples."
+msgstr ""
+"Разбивает одну строку на несколько, каждая из которых будет не длиннее `characters_per_string`. "
+"Удобно использовать для разбиения одного гигантского сообщения на несколько."
+
+#: of telebot.util.split_string:7
+msgid "The number of characters per line the text is split into."
+msgstr "Количество символов в одной строке, на которые будет разбит текст."
+
+#: ../../docstring of telebot.util.update_types:1
+msgid "All update types, should be used for allowed_updates parameter in polling."
+msgstr "Все виды апдейтов, рекомендуется использовать в качестве параметра allowed_updates функции polling."
+
+#: of telebot.util.user_link:1
+msgid ""
+"Returns an HTML user link. This is useful for reports. Attention: Don't "
+"forget to set parse_mode to 'HTML'!"
+msgstr ""
+"Возвращает HTML ссылку на пользователя. Удобно использовать для отчетов. Важно: Не "
+"забудьте установить значение 'HTML' в parse_mode!"
+
+#: of telebot.util.user_link:11
+msgid ""
+"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."
+msgstr ""
+"Вы можете использовать formatting.* во всех остальных вариантах форматирования(bold, italic, "
+"links, и прочее). Этот метод сохранён для обратной совместимости, рекомендуется "
+"использовать formatting.* для большего количества вариантов."
+
+#: of telebot.util.user_link:15
+msgid "the user (not the user_id)"
+msgstr "Пользователь (не id пользователя)"
+
+#: of telebot.util.user_link:18
+msgid "include the user_id"
+msgstr "Добавить id пользователя"
+
+#: of telebot.util.user_link:21
+msgid "HTML user link"
+msgstr "Ссылка на пользователя в формате HTML"
+
+#: of telebot.util.validate_web_app_data:1
+msgid "Validates web app data."
+msgstr "Проверяет данные, полученные от web app."
+
+#: of telebot.util.webhook_google_functions:1
+msgid "A webhook endpoint for Google Cloud Functions FaaS."
+msgstr "Endpoint вебхука для Google Cloud Functions FaaS."
+
+#: of telebot.util.webhook_google_functions:3
+msgid "The bot instance"
+msgstr "Инстанс бота"
+
+#: of telebot.util.webhook_google_functions:6
+msgid "The request object"
+msgstr "HTTP-запрос"
+
+#: of telebot.util.webhook_google_functions:9
+msgid "The response object"
+msgstr "Объект, полученный в качестве ответа"
+

docs/source/quick_start.rst

@@ -3,6 +3,10 @@
 Quick start
 ===========
 
+.. meta::
+   :description: Quickstart guide
+   :keywords: ptba, pytba, pyTelegramBotAPI, quickstart, guide
+
 Synchronous TeleBot
 -------------------
 .. literalinclude:: ../../examples/echo_bot.py

docs/source/sync_version/index.rst

@@ -2,6 +2,10 @@
 TeleBot version
 ===============
 
+.. meta::
+   :description: Synchronous pyTelegramBotAPI documentation
+   :keywords: ptba, pytba, pyTelegramBotAPI, methods, guide, files, sync
+
 TeleBot methods
 ---------------
 .. automodule:: telebot
@@ -17,14 +21,6 @@ custom_filters file
    :undoc-members:
    :show-inheritance:
 
-Synchronous storage for states
--------------------------------
-
-.. automodule:: telebot.storage
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
 handler_backends file
 --------------------------------
 
@@ -33,3 +29,13 @@ handler_backends file
    :undoc-members:
    :show-inheritance:
 
+
+Extensions
+------------------------
+
+
+
+.. automodule:: telebot.ext.sync.webhooks
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/util.rst

@@ -2,6 +2,10 @@
 Utils
 ============
 
+.. meta::
+   :description: Utils in pyTelegramBotAPI
+   :keywords: ptba, pytba, pyTelegramBotAPI, utils, guide
+
 
 util file
 -------------------

examples/asynchronous_telebot/chat_member_example.py

@@ -23,8 +23,8 @@ async def my_chat_m(message: types.ChatMemberUpdated):
 #content_Type_service is:
 #'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',
-#'proximity_alert_triggered', 'voice_chat_scheduled', 'voice_chat_started', 'voice_chat_ended', 
-#'voice_chat_participants_invited', 'message_auto_delete_timer_changed'
+#'proximity_alert_triggered', 'video_chat_scheduled', 'video_chat_started', 'video_chat_ended', 
+#'video_chat_participants_invited', 'message_auto_delete_timer_changed'
 # this handler deletes service messages
 
 @bot.message_handler(content_types=util.content_type_service)

examples/asynchronous_telebot/continue_handling.py

@@ -0,0 +1,27 @@
+from telebot.async_telebot import AsyncTeleBot
+from telebot.asyncio_handler_backends import ContinueHandling
+
+
+bot = AsyncTeleBot('TOKEN')
+
+@bot.message_handler(commands=['start'])
+async def start(message):
+    await bot.send_message(message.chat.id, 'Hello World!')
+    return ContinueHandling()
+
+@bot.message_handler(commands=['start'])
+async def start2(message):
+    """
+    This handler comes after the first one, but it will never be called.
+    But you can call it by returning ContinueHandling() in the first handler.
+
+    If you return ContinueHandling() in the first handler, the next 
+    registered handler with appropriate filters will be called.
+    """
+    await bot.send_message(message.chat.id, 'Hello World2!')
+
+import asyncio 
+asyncio.run(bot.polling()) # just a reminder that infinity polling
+# wraps polling into try/except block just as sync version,
+# but you can use any of them because neither of them stops if you
+# pass non_stop=True

examples/asynchronous_telebot/detect_changes.py

@@ -0,0 +1,28 @@
+#!/usr/bin/python
+
+# This is a simple echo bot using the decorator mechanism.
+# It echoes any incoming text messages.
+
+from telebot.async_telebot import AsyncTeleBot
+bot = AsyncTeleBot('TOKEN')
+
+
+
+# Handle '/start' and '/help'
+@bot.message_handler(commands=['help', 'start'])
+async def send_welcome(message):
+    await bot.reply_to(message, """\
+Hi there, I am EchoBot.
+I am here to echo your kind words back to you. Just say anything nice and I'll say the exact same thing to you!\
+""")
+
+
+# Handle all other messages with content_type 'text' (content_types defaults to ['text'])
+@bot.message_handler(func=lambda message: True)
+async def echo_message(message):
+    await bot.reply_to(message, message.text)
+
+
+import asyncio
+# only for versions 4.7.0+
+asyncio.run(bot.polling(restart_on_change=True))

examples/asynchronous_telebot/formatting_example.py

@@ -0,0 +1,54 @@
+from telebot.async_telebot import AsyncTeleBot
+from telebot import formatting
+
+bot = AsyncTeleBot('token')
+
+
+@bot.message_handler(commands=['start'])
+async def start_message(message):
+    await bot.send_message(
+        message.chat.id,
+        # function which connects all strings
+        formatting.format_text(
+            formatting.mbold(message.from_user.first_name),
+            formatting.mitalic(message.from_user.first_name),
+            formatting.munderline(message.from_user.first_name),
+            formatting.mstrikethrough(message.from_user.first_name),
+            formatting.mcode(message.from_user.first_name),
+            separator=" " # separator separates all strings
+        ),
+        parse_mode='MarkdownV2'
+    )
+
+    # just a bold text using markdownv2
+    await bot.send_message(
+        message.chat.id,
+        formatting.mbold(message.from_user.first_name),
+        parse_mode='MarkdownV2'
+    )
+
+    # html
+    await bot.send_message(
+        message.chat.id,
+        formatting.format_text(
+            formatting.hbold(message.from_user.first_name),
+            formatting.hitalic(message.from_user.first_name),
+            formatting.hunderline(message.from_user.first_name),
+            formatting.hstrikethrough(message.from_user.first_name),
+            formatting.hcode(message.from_user.first_name),
+            # hide_link is only for html
+            formatting.hide_link('https://telegra.ph/file/c158e3a6e2a26a160b253.jpg'),
+            separator=" "
+        ),
+        parse_mode='HTML'
+    )
+
+    # just a bold text in html
+    await bot.send_message(
+        message.chat.id,
+        formatting.hbold(message.from_user.first_name),
+        parse_mode='HTML'
+    )
+
+import asyncio
+asyncio.run(bot.polling())

examples/asynchronous_telebot/middleware/i18n_middleware_example/main.py

@@ -56,7 +56,7 @@ import keyboards
 from telebot import types
 from telebot.async_telebot import AsyncTeleBot
 from telebot.asyncio_filters import TextMatchFilter, TextFilter
-from i18n_base_midddleware import I18N
+from i18n_base_middleware import I18N
 from telebot.asyncio_storage.memory_storage import StateMemoryStorage
 
 

examples/asynchronous_telebot/multibot/README.MD

@@ -0,0 +1,17 @@
+You probably have seen bots which allow you to send them token of your bot and then handle updates providing some functionality for your bot.
+<br>
+This type of bots are called <b>multibots</b>. They are created using webhooks.
+<br>
+
+This is the example of simple multibot.<br>
+In order to reproduce this example you need to have <b>domain and ssl connection</b>.
+<br>
+If you have, go to config.py and specify your data.
+<br>
+There is also file called <b>nginx_conf.conf</b>,  we will use nginx as proxy-server and this file is example nginx.conf file.
+<br>
+Make sure that server_name and port are the same in both config and nginx_conf
+<br>
+(nginx_conf.conf IS NOT complete, you would probably use tools like certbot to add ssl connection to it)
+<br>
+Also, in this example I used dictionary as tokens storage, but in production you should use database so that you can re-set webhooks in case bot restarts.

examples/asynchronous_telebot/multibot/config.py

@@ -0,0 +1,6 @@
+MAIN_BOT_TOKEN = "your_main_bot_token"
+
+WEBHOOK_HOST = "your_domain.com"
+WEBHOOK_PATH = "telegram_webhook"
+WEBAPP_HOST = "0.0.0.0"
+WEBAPP_PORT = 3500

examples/asynchronous_telebot/multibot/handlers.py

@@ -0,0 +1,15 @@
+from telebot.async_telebot import AsyncTeleBot
+from telebot import types
+
+
+async def hello_handler(message: types.Message, bot: AsyncTeleBot):
+    await bot.send_message(message.chat.id, "Hi :)")
+
+
+async def echo_handler(message: types.Message, bot: AsyncTeleBot):
+    await bot.send_message(message.chat.id, message.text)
+
+
+def register_handlers(bot: AsyncTeleBot):
+    bot.register_message_handler(hello_handler, func=lambda message: message.text == 'Hello', pass_bot=True)
+    bot.register_message_handler(echo_handler, pass_bot=True)

examples/asynchronous_telebot/multibot/main.py

@@ -0,0 +1,56 @@
+import asyncio
+
+from aiohttp import web
+from telebot import types, util
+from telebot.async_telebot import AsyncTeleBot
+from handlers import register_handlers
+
+import config
+
+main_bot = AsyncTeleBot(config.MAIN_BOT_TOKEN)
+app = web.Application()
+tokens = {config.MAIN_BOT_TOKEN: True}
+
+
+async def webhook(request):
+    token = request.match_info.get('token')
+    if not tokens.get(token):
+        return web.Response(status=404)
+
+    if request.headers.get('content-type') != 'application/json':
+        return web.Response(status=403)
+
+    json_string = await request.json()
+    update = types.Update.de_json(json_string)
+    if token == main_bot.token:
+        await main_bot.process_new_updates([update])
+        return web.Response()
+
+    from_update_bot = AsyncTeleBot(token)
+    register_handlers(from_update_bot)
+    await from_update_bot.process_new_updates([update])
+    return web.Response()
+
+
+app.router.add_post("/" + config.WEBHOOK_PATH + "/{token}", webhook)
+
+
+@main_bot.message_handler(commands=['add_bot'])
+async def add_bot(message: types.Message):
+    token = util.extract_arguments(message.text)
+    tokens[token] = True
+
+    new_bot = AsyncTeleBot(token)
+    await new_bot.delete_webhook()
+    await new_bot.set_webhook(f"{config.WEBHOOK_HOST}/{config.WEBHOOK_PATH}/{token}")
+
+    await new_bot.send_message(message.chat.id, "Webhook was set.")
+
+
+async def main():
+    await main_bot.delete_webhook()
+    await main_bot.set_webhook(f"{config.WEBHOOK_HOST}/{config.WEBHOOK_PATH}/{config.MAIN_BOT_TOKEN}")
+    web.run_app(app, host=config.WEBAPP_HOST, port=config.WEBAPP_PORT)
+
+if __name__ == '__main__':
+    asyncio.run(main())

examples/asynchronous_telebot/multibot/nginx_conf.conf

@@ -0,0 +1,8 @@
+server {
+    server_name your_domain.com;
+
+    location /telegram_webhook/ {
+        proxy_pass http://localhost:3500;
+    }
+
+}

examples/asynchronous_telebot/webhooks/async_webhook_aiohttp_echo_bot.py

@@ -0,0 +1,93 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+# This is an async echo bot using decorators and webhook with aiohttp
+# It echoes any incoming text messages and does not use the polling method.
+
+import logging
+import ssl
+import asyncio
+from aiohttp import web
+import telebot
+from telebot.async_telebot import AsyncTeleBot
+
+API_TOKEN = '<api_token>'
+WEBHOOK_HOST = '<ip/host where the bot is running>'
+WEBHOOK_PORT = 8443  # 443, 80, 88 or 8443 (port need to be 'open')
+WEBHOOK_LISTEN = '0.0.0.0'  # In some VPS you may need to put here the IP addr
+WEBHOOK_SSL_CERT = './webhook_cert.pem'  # Path to the ssl certificate
+WEBHOOK_SSL_PRIV = './webhook_pkey.pem'  # Path to the ssl private key
+WEBHOOK_URL_BASE = "https://{}:{}".format(WEBHOOK_HOST, WEBHOOK_PORT)
+WEBHOOK_URL_PATH = "/{}/".format(API_TOKEN)
+
+# Quick'n'dirty SSL certificate generation:
+#
+# openssl genrsa -out webhook_pkey.pem 2048
+# openssl req -new -x509 -days 3650 -key webhook_pkey.pem -out webhook_cert.pem
+#
+# When asked for "Common Name (e.g. server FQDN or YOUR name)" you should reply
+# with the same value in you put in WEBHOOK_HOST
+
+logger = telebot.logger
+telebot.logger.setLevel(logging.INFO)
+bot = AsyncTeleBot(API_TOKEN)
+
+
+# Process webhook calls
+async def handle(request):
+    if request.match_info.get('token') == bot.token:
+        request_body_dict = await request.json()
+        update = telebot.types.Update.de_json(request_body_dict)
+        asyncio.ensure_future(bot.process_new_updates([update]))
+        return web.Response()
+    else:
+        return web.Response(status=403)
+
+
+# Handle '/start' and '/help'
+@bot.message_handler(commands=['help', 'start'])
+async def send_welcome(message):
+    await bot.reply_to(message,
+                 ("Hi there, I am EchoBot.\n"
+                  "I am here to echo your kind words back to you."))
+
+
+# Handle all other messages
+@bot.message_handler(func=lambda message: True, content_types=['text'])
+async def echo_message(message):
+    await bot.reply_to(message, message.text)
+
+
+# Remove webhook and closing session before exiting
+async def shutdown(app):
+    logger.info('Shutting down: removing webhook')
+    await bot.remove_webhook()
+    logger.info('Shutting down: closing session')
+    await bot.close_session()
+
+
+async def setup():
+    # Remove webhook, it fails sometimes the set if there is a previous webhook
+    logger.info('Starting up: removing old webhook')
+    await bot.remove_webhook()
+    # Set webhook
+    logger.info('Starting up: setting webhook')
+    await bot.set_webhook(url=WEBHOOK_URL_BASE + WEBHOOK_URL_PATH,
+                certificate=open(WEBHOOK_SSL_CERT, 'r'))
+    app = web.Application()
+    app.router.add_post('/{token}/', handle)
+    app.on_cleanup.append(shutdown)
+    return app
+
+
+if __name__ == '__main__':
+    # Build ssl context
+    context = ssl.SSLContext(ssl.PROTOCOL_TLSv1_2)
+    context.load_cert_chain(WEBHOOK_SSL_CERT, WEBHOOK_SSL_PRIV)
+    # Start aiohttp server
+    web.run_app(
+        setup(),
+        host=WEBHOOK_LISTEN,
+        port=WEBHOOK_PORT,
+        ssl_context=context,
+    )

examples/asynchronous_telebot/webhooks/run_webhooks.py

@@ -0,0 +1,45 @@
+#!/usr/bin/python
+
+# This is a simple echo bot using the decorator mechanism.
+# It echoes any incoming text messages.
+# Example on built-in function to receive and process webhooks.
+
+from telebot.async_telebot import AsyncTeleBot
+import asyncio
+bot = AsyncTeleBot('TOKEN')
+
+
+WEBHOOK_SSL_CERT = './webhook_cert.pem'  # Path to the ssl certificate
+WEBHOOK_SSL_PRIV = './webhook_pkey.pem'  # Path to the ssl private key
+DOMAIN = '1.2.3.4' # either domain, or ip address of vps
+
+# Quick'n'dirty SSL certificate generation:
+#
+# openssl genrsa -out webhook_pkey.pem 2048
+# openssl req -new -x509 -days 3650 -key webhook_pkey.pem -out webhook_cert.pem
+#
+# When asked for "Common Name (e.g. server FQDN or YOUR name)" you should reply
+# with the same value in you put in WEBHOOK_HOST
+
+
+# Handle '/start' and '/help'
+@bot.message_handler(commands=['help', 'start'])
+async def send_welcome(message):
+    await bot.reply_to(message, """\
+Hi there, I am EchoBot.
+I am here to echo your kind words back to you. Just say anything nice and I'll say the exact same thing to you!\
+""")
+
+
+# Handle all other messages with content_type 'text' (content_types defaults to ['text'])
+@bot.message_handler(func=lambda message: True)
+async def echo_message(message):
+    await bot.reply_to(message, message.text)
+
+
+# it uses fastapi + uvicorn
+asyncio.run(bot.run_webhooks(
+    listen=DOMAIN,
+    certificate=WEBHOOK_SSL_CERT,
+    certificate_key=WEBHOOK_SSL_PRIV
+))

examples/asynchronous_telebot/webhooks/webhook_starlette_echo_bot.py

@@ -0,0 +1,89 @@
+#!/usr/bin/env python
+"""
+Asynchronous Telegram Echo Bot example.
+
+This is a simple bot that echoes each message that is received onto the chat.
+It uses the Starlette ASGI framework to receive updates via webhook requests.
+"""
+
+import uvicorn
+from starlette.applications import Starlette
+from starlette.requests import Request
+from starlette.responses import PlainTextResponse, Response
+from starlette.routing import Route
+from telebot.async_telebot import AsyncTeleBot
+from telebot.types import Message, Update
+
+API_TOKEN = "TOKEN"
+
+WEBHOOK_HOST = "<ip/domain>"
+WEBHOOK_PORT = 8443  # 443, 80, 88 or 8443 (port need to be 'open')
+WEBHOOK_LISTEN = "0.0.0.0"
+WEBHOOK_SSL_CERT = "./webhook_cert.pem"  # Path to the ssl certificate
+WEBHOOK_SSL_PRIV = "./webhook_pkey.pem"  # Path to the ssl private key
+WEBHOOK_URL = f"https://{WEBHOOK_HOST}:{WEBHOOK_PORT}/telegram"
+WEBHOOK_SECRET_TOKEN = "SECRET_TOKEN"
+
+logger = telebot.logger
+telebot.logger.setLevel(logging.INFO)
+
+bot = AsyncTeleBot(token=API_TOKEN)
+
+# BOT HANDLERS
+@bot.message_handler(commands=["help", "start"])
+async def send_welcome(message: Message):
+    """
+    Handle '/start' and '/help'
+    """
+    await bot.reply_to(
+        message,
+        ("Hi there, I am EchoBot.\n" "I am here to echo your kind words back to you."),
+    )
+
+
+@bot.message_handler(func=lambda _: True, content_types=["text"])
+async def echo_message(message: Message):
+    """
+    Handle all other messages
+    """
+    await bot.reply_to(message, message.text)
+
+
+# WEBSERVER HANDLERS
+async def telegram(request: Request) -> Response:
+    """Handle incoming Telegram updates."""
+    token_header_name = "X-Telegram-Bot-Api-Secret-Token"
+    if request.headers.get(token_header_name) != WEBHOOK_SECRET_TOKEN:
+        return PlainTextResponse("Forbidden", status_code=403)
+    await bot.process_new_updates([Update.de_json(await request.json())])
+    return Response()
+
+
+async def startup() -> None:
+    """Register webhook for telegram updates."""
+    webhook_info = await bot.get_webhook_info(30)
+    if WEBHOOK_URL != webhook_info.url:
+        logger.debug(
+            f"updating webhook url, old: {webhook_info.url}, new: {WEBHOOK_URL}"
+        )
+        if not await bot.set_webhook(
+            url=WEBHOOK_URL, secret_token=WEBHOOK_SECRET_TOKEN
+        ):
+            raise RuntimeError("unable to set webhook")
+
+
+app = Starlette(
+    routes=[
+        Route("/telegram", telegram, methods=["POST"]),
+    ],
+    on_startup=[startup],
+)
+
+
+uvicorn.run(
+    app,
+    host=WEBHOOK_HOST,
+    port=WEBHOOK_LISTEN,
+    ssl_certfile=WEBHOOK_SSL_CERT,
+    ssl_keyfile=WEBHOOK_SSL_PRIV,
+)

examples/chat_member_example.py

@@ -23,8 +23,8 @@ def my_chat_m(message: types.ChatMemberUpdated):
 #content_Type_service is:
 #'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',
-#'proximity_alert_triggered', 'voice_chat_scheduled', 'voice_chat_started', 'voice_chat_ended', 
-#'voice_chat_participants_invited', 'message_auto_delete_timer_changed'
+#'proximity_alert_triggered', 'video_chat_scheduled', 'video_chat_started', 'video_chat_ended',
+#'video_chat_participants_invited', 'message_auto_delete_timer_changed'
 # this handler deletes service messages
 
 @bot.message_handler(content_types=util.content_type_service)

examples/continue_handling.py

@@ -0,0 +1,23 @@
+from telebot import TeleBot
+from telebot.handler_backends import ContinueHandling
+
+
+bot = TeleBot('TOKEN')
+
+@bot.message_handler(commands=['start'])
+def start(message):
+    bot.send_message(message.chat.id, 'Hello World!')
+    return ContinueHandling()
+
+@bot.message_handler(commands=['start'])
+def start2(message):
+    """
+    This handler comes after the first one, but it will never be called.
+    But you can call it by returning ContinueHandling() in the first handler.
+
+    If you return ContinueHandling() in the first handler, the next 
+    registered handler with appropriate filters will be called.
+    """
+    bot.send_message(message.chat.id, 'Hello World2!')
+
+bot.infinity_polling()

examples/create_invite_link.py

@@ -0,0 +1,33 @@
+import telebot
+from time import sleep, time
+from telebot.types import InlineKeyboardMarkup, InlineKeyboardButton #Only for creating Inline Buttons, not necessary for creating Invite Links
+
+Token = "api_token" #Your Bot Access Token
+Group_ID = -1234567890 #Group ID for which invite link is to be created
+
+bot = telebot.TeleBot(Token, parse_mode="HTML")
+
+#/start command message
+@bot.message_handler(commands=['start'])
+def startmsg(msg):
+    bot.reply_to(msg, "Hey there, I'm a bot made by pyTelegramBotAPI!")
+
+#Get notified of incoming members in group
+@bot.message_handler(content_types=['new_chat_members'])
+def newmember(msg):
+    #Create an invite link class that contains info about the created invite link using create_chat_invite_link() with parameters
+    invite = bot.create_chat_invite_link(Group_ID, member_limit=1, expire_date=int(time())+45) #Here, the link will auto-expire in 45 seconds
+    InviteLink = invite.invite_link #Get the actual invite link from 'invite' class
+    
+    mrkplink = InlineKeyboardMarkup() #Created Inline Keyboard Markup
+    mrkplink.add(InlineKeyboardButton("Join our group 🚀", url=InviteLink)) #Added Invite Link to Inline Keyboard
+    
+    bot.send_message(msg.chat.id, f"Hey there {msg.from_user.first_name}, Click the link below to join our Official Group.", reply_markup=mrkplink)
+    
+    #This will send a message with the newly-created invite link as markup button.
+    #The member limit will be 1 and expiring time will be 45 sec.
+
+
+
+
+bot.infinity_polling()

examples/custom_states.py

@@ -47,7 +47,7 @@ def start_ex(message):
  
 
 # Any state
-@bot.message_handler(state="*", commands='cancel')
+@bot.message_handler(state="*", commands=['cancel'])
 def any_state(message):
     """
     Cancel state
@@ -60,7 +60,7 @@ def name_get(message):
     """
     State 1. Will process when user's state is MyStates.name.
     """
-    bot.send_message(message.chat.id, f'Now write me a surname')
+    bot.send_message(message.chat.id, 'Now write me a surname')
     bot.set_state(message.from_user.id, MyStates.surname, message.chat.id)
     with bot.retrieve_data(message.from_user.id, message.chat.id) as data:
         data['name'] = message.text
@@ -83,7 +83,11 @@ def ready_for_answer(message):
     State 3. Will process when user's state is MyStates.age.
     """
     with bot.retrieve_data(message.from_user.id, message.chat.id) as data:
-        bot.send_message(message.chat.id, "Ready, take a look:\n<b>Name: {name}\nSurname: {surname}\nAge: {age}</b>".format(name=data['name'], surname=data['surname'], age=message.text), parse_mode="html")
+        msg = ("Ready, take a look:\n<b>"
+               f"Name: {data['name']}\n"
+               f"Surname: {data['surname']}\n"
+               f"Age: {message.text}</b>")
+        bot.send_message(message.chat.id, msg, parse_mode="html")
     bot.delete_state(message.from_user.id, message.chat.id)
 
 #incorrect number
@@ -99,4 +103,4 @@ def age_incorrect(message):
 bot.add_custom_filter(custom_filters.StateFilter(bot))
 bot.add_custom_filter(custom_filters.IsDigitFilter())
 
-bot.infinity_polling(skip_pending=True)
+bot.infinity_polling(skip_pending=True)

examples/detect_changes.py

@@ -0,0 +1,28 @@
+#!/usr/bin/python
+
+# This is a simple echo bot using the decorator mechanism.
+# It echoes any incoming text messages.
+
+import telebot
+
+API_TOKEN = '<api_token>'
+
+bot = telebot.TeleBot(API_TOKEN)
+
+
+# Handle '/start' and '/help'
+@bot.message_handler(commands=['help', 'start'])
+def send_welcome(message):
+    bot.reply_to(message, """\
+Hi there, I am EchoBot.
+I am here to echo your kind words back to you. Just say anything nice and I'll say the exact same thing to you!\
+""")
+
+
+# Handle all other messages with content_type 'text' (content_types defaults to ['text'])
+@bot.message_handler(func=lambda message: True)
+def echo_message(message):
+    bot.reply_to(message, message.text)
+
+# only for versions 4.7.0+
+bot.infinity_polling(restart_on_change=True)

examples/formatting_example.py

@@ -0,0 +1,53 @@
+from telebot import TeleBot
+from telebot import formatting
+
+bot = TeleBot('TOKEN')
+
+
+@bot.message_handler(commands=['start'])
+def start_message(message):
+    bot.send_message(
+        message.chat.id,
+        # function which connects all strings
+        formatting.format_text(
+            formatting.mbold(message.from_user.first_name),
+            formatting.mitalic(message.from_user.first_name),
+            formatting.munderline(message.from_user.first_name),
+            formatting.mstrikethrough(message.from_user.first_name),
+            formatting.mcode(message.from_user.first_name),
+            separator=" " # separator separates all strings
+        ),
+        parse_mode='MarkdownV2'
+    )
+
+    # just a bold text using markdownv2
+    bot.send_message(
+        message.chat.id,
+        formatting.mbold(message.from_user.first_name),
+        parse_mode='MarkdownV2'
+    )
+
+    # html
+    bot.send_message(
+        message.chat.id,
+        formatting.format_text(
+            formatting.hbold(message.from_user.first_name),
+            formatting.hitalic(message.from_user.first_name),
+            formatting.hunderline(message.from_user.first_name),
+            formatting.hstrikethrough(message.from_user.first_name),
+            formatting.hcode(message.from_user.first_name),
+            # hide_link is only for html
+            formatting.hide_link('https://telegra.ph/file/c158e3a6e2a26a160b253.jpg'),
+            separator=" "
+        ),
+        parse_mode='HTML'
+    )
+
+    # just a bold text in html
+    bot.send_message(
+        message.chat.id,
+        formatting.hbold(message.from_user.first_name),
+        parse_mode='HTML'
+    )
+
+bot.infinity_polling()

examples/inline_example.py

@@ -42,7 +42,7 @@ def query_video(inline_query):
     try:
         r = types.InlineQueryResultVideo('1',
                                          'https://github.com/eternnoir/pyTelegramBotAPI/blob/master/tests/test_data/test_video.mp4?raw=true',
-                                         'video/mp4', 'Video',
+                                         'video/mp4', 
                                          'https://raw.githubusercontent.com/eternnoir/pyTelegramBotAPI/master/examples/detailed_example/rooster.jpg',
                                          'Title'
                                          )

examples/middleware/class_based/i18n_middleware/i18n_base_middleware.py

@@ -0,0 +1,121 @@
+import gettext
+import os
+import threading
+
+from telebot.handler_backends import BaseMiddleware
+
+try:
+    from babel.support import LazyProxy
+
+    babel_imported = True
+except ImportError:
+    babel_imported = False
+
+
+class I18N(BaseMiddleware):
+    """
+    This middleware provides high-level tool for internationalization
+    It is based on gettext util.
+    """
+
+    context_lang = threading.local()
+
+    def __init__(self, translations_path, domain_name: str):
+        super().__init__()
+        self.update_types = self.process_update_types()
+
+        self.path = translations_path
+        self.domain = domain_name
+        self.translations = self.find_translations()
+
+    @property
+    def available_translations(self):
+        return list(self.translations)
+
+    def gettext(self, text: str, lang: str = None):
+        """
+        Singular translations
+        """
+
+        if lang is None:
+            lang = self.context_lang.language
+
+        if lang not in self.translations:
+            return text
+
+        translator = self.translations[lang]
+        return translator.gettext(text)
+
+    def ngettext(self, singular: str, plural: str, lang: str = None, n=1):
+        """
+        Plural translations
+        """
+        if lang is None:
+            lang = self.context_lang.language
+
+        if lang not in self.translations:
+            if n == 1:
+                return singular
+            return plural
+
+        translator = self.translations[lang]
+        return translator.ngettext(singular, plural, n)
+
+    def lazy_gettext(self, text: str, lang: str = None):
+        if not babel_imported:
+            raise RuntimeError('babel module is not imported. Check that you installed it.')
+        return LazyProxy(self.gettext, text, lang, enable_cache=False)
+
+    def lazy_ngettext(self, singular: str, plural: str, lang: str = None, n=1):
+        if not babel_imported:
+            raise RuntimeError('babel module is not imported. Check that you installed it.')
+        return LazyProxy(self.ngettext, singular, plural, lang, n, enable_cache=False)
+
+    def get_user_language(self, obj):
+        """
+        You need to override this method and return user language
+        """
+        raise NotImplementedError
+
+    def process_update_types(self) -> list:
+        """
+        You need to override this method and return any update types which you want to be processed
+        """
+        raise NotImplementedError
+
+    def pre_process(self, message, data):
+        """
+        context language variable will be set each time when update from 'process_update_types' comes
+        value is the result of 'get_user_language' method
+        """
+
+        self.context_lang.language = self.get_user_language(obj=message)
+
+    def post_process(self, message, data, exception):
+        pass
+
+    def find_translations(self):
+        """
+        Looks for translations with passed 'domain' in passed 'path'
+        """
+        if not os.path.exists(self.path):
+            raise RuntimeError(f"Translations directory by path: {self.path!r} was not found")
+
+        result = {}
+
+        for name in os.listdir(self.path):
+            translations_path = os.path.join(self.path, name, 'LC_MESSAGES')
+
+            if not os.path.isdir(translations_path):
+                continue
+
+            po_file = os.path.join(translations_path, self.domain + '.po')
+            mo_file = po_file[:-2] + 'mo'
+
+            if os.path.isfile(po_file) and not os.path.isfile(mo_file):
+                raise FileNotFoundError(f"Translations for: {name!r} were not compiled!")
+
+            with open(mo_file, 'rb') as file:
+                result[name] = gettext.GNUTranslations(file)
+
+        return result

examples/middleware/class_based/i18n_middleware/keyboards.py

@@ -0,0 +1,34 @@
+from telebot.types import InlineKeyboardMarkup, InlineKeyboardButton, ReplyKeyboardMarkup, KeyboardButton
+
+
+def languages_keyboard():
+    return InlineKeyboardMarkup(
+        keyboard=[
+            [
+                InlineKeyboardButton(text="English", callback_data='en'),
+                InlineKeyboardButton(text="Русский", callback_data='ru'),
+                InlineKeyboardButton(text="O'zbekcha", callback_data='uz_Latn')
+            ]
+        ]
+    )
+
+
+def clicker_keyboard(_):
+    return InlineKeyboardMarkup(
+        keyboard=[
+            [
+                InlineKeyboardButton(text=_("click"), callback_data='click'),
+            ]
+        ]
+    )
+
+
+def menu_keyboard(_):
+    keyboard = ReplyKeyboardMarkup(resize_keyboard=True)
+    keyboard.add(
+        KeyboardButton(text=_("My user id")),
+        KeyboardButton(text=_("My user name")),
+        KeyboardButton(text=_("My first name"))
+    )
+
+    return keyboard

examples/middleware/class_based/i18n_middleware/locales/en/LC_MESSAGES/messages.po

@@ -0,0 +1,81 @@
+# English translations for PROJECT.
+# Copyright (C) 2022 ORGANIZATION
+# This file is distributed under the same license as the PROJECT project.
+# FIRST AUTHOR <EMAIL@ADDRESS>, 2022.
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: PROJECT VERSION\n"
+"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
+"POT-Creation-Date: 2022-02-19 18:37+0500\n"
+"PO-Revision-Date: 2022-02-18 16:22+0500\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language: en\n"
+"Language-Team: en <LL@li.org>\n"
+"Plural-Forms: nplurals=2; plural=(n != 1)\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=utf-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Generated-By: Babel 2.9.1\n"
+
+#: keyboards.py:20
+msgid "click"
+msgstr ""
+
+#: keyboards.py:29
+msgid "My user id"
+msgstr ""
+
+#: keyboards.py:30
+msgid "My user name"
+msgstr ""
+
+#: keyboards.py:31
+msgid "My first name"
+msgstr ""
+
+#: main.py:97
+msgid ""
+"Hello, {user_fist_name}!\n"
+"This is the example of multilanguage bot.\n"
+"Available commands:\n"
+"\n"
+"/lang - change your language\n"
+"/plural - pluralization example\n"
+"/menu - text menu example"
+msgstr ""
+
+#: main.py:121
+msgid "Language has been changed"
+msgstr ""
+
+#: main.py:130 main.py:150
+#, fuzzy
+msgid "You have {number} click"
+msgid_plural "You have {number} clicks"
+msgstr[0] ""
+msgstr[1] ""
+
+#: main.py:135 main.py:155
+msgid ""
+"This is clicker.\n"
+"\n"
+msgstr ""
+
+#: main.py:163
+msgid "This is ReplyKeyboardMarkup menu example in multilanguage bot."
+msgstr ""
+
+#: main.py:203
+msgid "Seems you confused language"
+msgstr ""
+
+#~ msgid ""
+#~ "Hello, {user_fist_name}!\n"
+#~ "This is the example of multilanguage bot.\n"
+#~ "Available commands:\n"
+#~ "\n"
+#~ "/lang - change your language\n"
+#~ "/plural - pluralization example"
+#~ msgstr ""
+

examples/middleware/class_based/i18n_middleware/locales/ru/LC_MESSAGES/messages.po

@@ -0,0 +1,82 @@
+# Russian translations for PROJECT.
+# Copyright (C) 2022 ORGANIZATION
+# This file is distributed under the same license as the PROJECT project.
+# FIRST AUTHOR <EMAIL@ADDRESS>, 2022.
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: PROJECT VERSION\n"
+"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
+"POT-Creation-Date: 2022-02-19 18:37+0500\n"
+"PO-Revision-Date: 2022-02-18 16:22+0500\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language: ru\n"
+"Language-Team: ru <LL@li.org>\n"
+"Plural-Forms: nplurals=3; plural=(n%10==1 && n%100!=11 ? 0 : n%10>=2 && "
+"n%10<=4 && (n%100<10 || n%100>=20) ? 1 : 2)\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=utf-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Generated-By: Babel 2.9.1\n"
+
+#: keyboards.py:20
+msgid "click"
+msgstr "Клик"
+
+#: keyboards.py:29
+msgid "My user id"
+msgstr "Мой user id"
+
+#: keyboards.py:30
+msgid "My user name"
+msgstr "Мой user name"
+
+#: keyboards.py:31
+msgid "My first name"
+msgstr "Мой first name"
+
+#: main.py:97
+msgid ""
+"Hello, {user_fist_name}!\n"
+"This is the example of multilanguage bot.\n"
+"Available commands:\n"
+"\n"
+"/lang - change your language\n"
+"/plural - pluralization example\n"
+"/menu - text menu example"
+msgstr ""
+"Привет, {user_fist_name}!\n"
+"Это пример мультиязычного бота.\n"
+"Доступные команды:\n"
+"\n"
+"/lang - изменить язык\n"
+"/plural - пример плюрализации\n"
+"/menu - Пример текстового меню"
+
+#: main.py:121
+msgid "Language has been changed"
+msgstr "Язык был сменён"
+
+#: main.py:130 main.py:150
+msgid "You have {number} click"
+msgid_plural "You have {number} clicks"
+msgstr[0] "У вас {number} клик"
+msgstr[1] "У вас {number} клика"
+msgstr[2] "У вас {number} кликов"
+
+#: main.py:135 main.py:155
+msgid ""
+"This is clicker.\n"
+"\n"
+msgstr ""
+"Это кликер.\n"
+"\n"
+
+#: main.py:163
+msgid "This is ReplyKeyboardMarkup menu example in multilanguage bot."
+msgstr "Это пример ReplyKeyboardMarkup меню в мультиязычном боте."
+
+#: main.py:203
+msgid "Seems you confused language"
+msgstr "Кажется, вы перепутали язык"
+

examples/middleware/class_based/i18n_middleware/locales/uz_Latn/LC_MESSAGES/messages.po

@@ -0,0 +1,80 @@
+# Uzbek (Latin) translations for PROJECT.
+# Copyright (C) 2022 ORGANIZATION
+# This file is distributed under the same license as the PROJECT project.
+# FIRST AUTHOR <EMAIL@ADDRESS>, 2022.
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: PROJECT VERSION\n"
+"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
+"POT-Creation-Date: 2022-02-19 18:37+0500\n"
+"PO-Revision-Date: 2022-02-18 16:22+0500\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language: uz_Latn\n"
+"Language-Team: uz_Latn <LL@li.org>\n"
+"Plural-Forms: nplurals=2; plural=(n != 1)\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=utf-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Generated-By: Babel 2.9.1\n"
+
+#: keyboards.py:20
+msgid "click"
+msgstr "clik"
+
+#: keyboards.py:29
+msgid "My user id"
+msgstr "Mani user id"
+
+#: keyboards.py:30
+msgid "My user name"
+msgstr "Mani user name"
+
+#: keyboards.py:31
+msgid "My first name"
+msgstr "Mani first name"
+
+#: main.py:97
+msgid ""
+"Hello, {user_fist_name}!\n"
+"This is the example of multilanguage bot.\n"
+"Available commands:\n"
+"\n"
+"/lang - change your language\n"
+"/plural - pluralization example\n"
+"/menu - text menu example"
+msgstr ""
+"Salom, {user_fist_name}!\n"
+"Bu multilanguage bot misoli.\n"
+"Mavjud buyruqlar:\n"
+"\n"
+"/lang - tilni ozgartirish\n"
+"/plural - pluralizatsiya misoli\n"
+"/menu - text menu misoli"
+
+#: main.py:121
+msgid "Language has been changed"
+msgstr "Til ozgartirildi"
+
+#: main.py:130 main.py:150
+msgid "You have {number} click"
+msgid_plural "You have {number} clicks"
+msgstr[0] "Sizda {number}ta clik"
+msgstr[1] "Sizda {number}ta clik"
+
+#: main.py:135 main.py:155
+msgid ""
+"This is clicker.\n"
+"\n"
+msgstr ""
+"Bu clicker.\n"
+"\n"
+
+#: main.py:163
+msgid "This is ReplyKeyboardMarkup menu example in multilanguage bot."
+msgstr "Bu multilanguage bot da replykeyboardmarkup menyu misoli."
+
+#: main.py:203
+msgid "Seems you confused language"
+msgstr "Tilni adashtirdiz"
+

examples/middleware/class_based/i18n_middleware/main.py

@@ -0,0 +1,211 @@
+"""
+In this example you will learn how to adapt your bot to different languages
+Using built-in middleware I18N.
+
+You need to install babel package 'https://pypi.org/project/Babel/'
+Babel provides a command-line interface for working with message catalogs
+After installing babel package you have a script called 'pybabel'
+Too see all the commands open terminal and type 'pybabel --help'
+Full description for pybabel commands can be found here: 'https://babel.pocoo.org/en/latest/cmdline.html'
+
+Create a directory 'locales' where our translations will be stored
+
+First we need to extract texts:
+    pybabel extract -o locales/{domain_name}.pot --input-dirs .
+{domain_name}.pot - is the file where all translations are saved
+The name of this file should be the same as domain which you pass to I18N class
+In this example domain_name will be 'messages'
+
+For gettext (singular texts) we use '_' alias and it works perfect
+You may also you some alias for ngettext (plural texts) but you can face with a problem that
+your plural texts are not being extracted
+That is because by default 'pybabel extract' recognizes the following keywords:
+ _, gettext, ngettext, ugettext, ungettext, dgettext, dngettext, N_
+To add your own keyword you can use '-k' flag
+In this example for 'ngettext' i will assign double underscore alias '__'
+
+Full command with pluralization support will look so:
+    pybabel extract -o locales/{domain_name}.pot -k __:1,2 --input-dirs .
+
+Then create directories with translations (get list of all locales: 'pybabel --list-locales'):
+    pybabel init -i locales/{domain_name}.pot -d locales -l en
+    pybabel init -i locales/{domain_name}.pot -d locales -l ru
+    pybabel init -i locales/{domain_name}.pot -d locales -l uz_Latn
+
+Now you can translate the texts located in locales/{language}/LC_MESSAGES/{domain_name}.po
+After you translated all the texts you need to compile .po files:
+    pybabel compile -d locales
+
+When you delete/update your texts you also need to update them in .po files:
+    pybabel extract -o locales/{domain_name}.pot -k __:1,2 --input-dirs .
+    pybabel update -i locales/{domain_name}.pot -d locales
+    - translate
+    pybabel compile -d locales
+
+If you have any exceptions check:
+    - you have installed babel
+    - translations are ready, so you just compiled it
+    - in the commands above you replaced {domain_name} to messages
+    - you are writing commands from correct path in terminal
+"""
+
+import asyncio
+from typing import Union
+
+import keyboards
+from i18n_base_middleware import I18N
+from telebot import TeleBot
+from telebot import types, StateMemoryStorage
+from telebot.custom_filters import TextMatchFilter, TextFilter
+
+class I18NMiddleware(I18N):
+
+    def process_update_types(self) -> list:
+        """
+        Here you need to return a list of update types which you want to be processed
+        """
+        return ['message', 'callback_query']
+
+    def get_user_language(self, obj: Union[types.Message, types.CallbackQuery]):
+        """
+        This method is called when new update comes (only updates which you return in 'process_update_types' method)
+        Returned language will be used in 'pre_process' method of parent class
+        Returned language will be set to context language variable.
+        If you need to get translation with user's actual language you don't have to pass it manually
+        It will be automatically passed from context language value.
+        However if you need some other language you can always pass it.
+        """
+
+        user_id = obj.from_user.id
+
+        if user_id not in users_lang:
+            users_lang[user_id] = 'en'
+
+        return users_lang[user_id]
+
+
+storage = StateMemoryStorage()
+bot = TeleBot("", state_storage=storage, use_class_middlewares=True)
+
+i18n = I18NMiddleware(translations_path='locales', domain_name='messages')
+_ = i18n.gettext  # for singular translations
+__ = i18n.ngettext  # for plural translations
+
+# These are example storages, do not use it in a production development
+users_lang = {}
+users_clicks = {}
+
+@bot.message_handler(commands=['start'])
+def start_handler(message: types.Message):
+    text = _("Hello, {user_fist_name}!\n"
+             "This is the example of multilanguage bot.\n"
+             "Available commands:\n\n"
+             "/lang - change your language\n"
+             "/plural - pluralization example\n"
+             "/menu - text menu example")
+
+    # remember don't use f string for interpolation, use .format method instead
+    text = text.format(user_fist_name=message.from_user.first_name)
+    bot.send_message(message.from_user.id, text)
+
+
+@bot.message_handler(commands=['lang'])
+def change_language_handler(message: types.Message):
+    bot.send_message(message.chat.id, "Choose language\nВыберите язык\nTilni tanlang",
+                     reply_markup=keyboards.languages_keyboard())
+
+
+@bot.callback_query_handler(func=None, text=TextFilter(contains=['en', 'ru', 'uz_Latn']))
+def language_handler(call: types.CallbackQuery):
+    lang = call.data
+    users_lang[call.from_user.id] = lang
+
+    # When you changed user language, you have to pass it manually beacause it is not changed in context
+    bot.edit_message_text(_("Language has been changed", lang=lang), call.from_user.id, call.message.id)
+
+
+@bot.message_handler(commands=['plural'])
+def pluralization_handler(message: types.Message):
+    if not users_clicks.get(message.from_user.id):
+        users_clicks[message.from_user.id] = 0
+    clicks = users_clicks[message.from_user.id]
+
+    text = __(
+        singular="You have {number} click",
+        plural="You have {number} clicks",
+        n=clicks
+    )
+    text = _("This is clicker.\n\n") + text.format(number=clicks)
+
+    bot.send_message(message.chat.id, text, reply_markup=keyboards.clicker_keyboard(_))
+
+
+@bot.callback_query_handler(func=None, text=TextFilter(equals='click'))
+def click_handler(call: types.CallbackQuery):
+    if not users_clicks.get(call.from_user.id):
+        users_clicks[call.from_user.id] = 1
+    else:
+        users_clicks[call.from_user.id] += 1
+
+    clicks = users_clicks[call.from_user.id]
+
+    text = __(
+        singular="You have {number} click",
+        plural="You have {number} clicks",
+        n=clicks
+    )
+    text = _("This is clicker.\n\n") + text.format(number=clicks)
+
+    bot.edit_message_text(text, call.from_user.id, call.message.message_id,
+                          reply_markup=keyboards.clicker_keyboard(_))
+
+
+@bot.message_handler(commands=['menu'])
+def menu_handler(message: types.Message):
+    text = _("This is ReplyKeyboardMarkup menu example in multilanguage bot.")
+    bot.send_message(message.chat.id, text, reply_markup=keyboards.menu_keyboard(_))
+
+
+# For lazy tranlations
+# lazy gettext is used when you don't know user's locale
+# It can be used for example to handle text buttons in multilanguage bot
+# The actual translation will be delayed until update comes and context language is set
+l_ = i18n.lazy_gettext
+
+
+# Handlers below will handle text according to user's language
+@bot.message_handler(text=l_("My user id"))
+def return_user_id(message: types.Message):
+    bot.send_message(message.chat.id, str(message.from_user.id))
+
+
+@bot.message_handler(text=l_("My user name"))
+def return_user_id(message: types.Message):
+    username = message.from_user.username
+    if not username:
+        username = '-'
+    bot.send_message(message.chat.id, username)
+
+
+# You can make it case-insensitive
+@bot.message_handler(text=TextFilter(equals=l_("My first name"), ignore_case=True))
+def return_user_id(message: types.Message):
+    bot.send_message(message.chat.id, message.from_user.first_name)
+
+
+all_menu_texts = []
+for language in i18n.available_translations:
+    for menu_text in ("My user id", "My user name", "My first name"):
+        all_menu_texts.append(_(menu_text, language))
+
+
+# When user confused language. (handles all menu buttons texts)
+@bot.message_handler(text=TextFilter(contains=all_menu_texts, ignore_case=True))
+def missed_message(message: types.Message):
+    bot.send_message(message.chat.id, _("Seems you confused language"), reply_markup=keyboards.menu_keyboard(_))
+
+
+if __name__ == '__main__':
+    bot.setup_middleware(i18n)
+    bot.add_custom_filter(TextMatchFilter())
+    asyncio.run(bot.infinity_polling())

examples/middleware/function_based/i18n_gettext/i18n_class.py

@@ -1,5 +1,6 @@
 import gettext
 import os
+import threading
 
 
 class I18N:
@@ -8,6 +9,8 @@ class I18N:
     It is based on gettext util.
     """
 
+    context_lang = threading.local()
+
     def __init__(self, translations_path, domain_name: str):
         self.path = translations_path
         self.domain = domain_name
@@ -21,7 +24,11 @@ class I18N:
         """
         Singular translations
         """
-        if not lang or lang not in self.translations:
+
+        if lang is None:
+            lang = self.context_lang.language
+
+        if lang not in self.translations:
             return text
 
         translator = self.translations[lang]
@@ -31,7 +38,10 @@ class I18N:
         """
         Plural translations
         """
-        if not lang or lang not in self.translations:
+        if lang is None:
+            lang = self.context_lang.language
+
+        if lang not in self.translations:
             if n == 1:
                 return singular
             return plural
@@ -39,6 +49,7 @@ class I18N:
         translator = self.translations[lang]
         return translator.ngettext(singular, plural, n)
 
+
     def find_translations(self):
         """
         Looks for translations with passed 'domain' in passed 'path'

examples/middleware/function_based/i18n_gettext/keyboards.py

@@ -13,11 +13,11 @@ def languages_keyboard():
     )
 
 
-def clicker_keyboard(_, lang):
+def clicker_keyboard(_):
     return InlineKeyboardMarkup(
         keyboard=[
             [
-                InlineKeyboardButton(text=_("click", lang=lang), callback_data='click'),
+                InlineKeyboardButton(text=_("click"), callback_data='click'),
             ]
         ]
     )

examples/middleware/function_based/i18n_gettext/locales/en/LC_MESSAGES/messages.po

@@ -47,5 +47,4 @@ msgstr[1] ""
 msgid ""
 "This is clicker.\n"
 "\n"
-msgstr ""
-
+msgstr ""

examples/middleware/function_based/i18n_gettext/locales/ru/LC_MESSAGES/messages.po

@@ -56,5 +56,4 @@ msgid ""
 "\n"
 msgstr ""
 "Это кликер.\n"
-"\n"
-
+"\n"

examples/middleware/function_based/i18n_gettext/locales/uz_Latn/LC_MESSAGES/messages.po

@@ -55,4 +55,3 @@ msgid ""
 msgstr ""
 "Bu clicker.\n"
 "\n"
-

examples/middleware/function_based/i18n_gettext/main.py

@@ -1,21 +1,17 @@
 """
 In this example you will learn how to adapt your bot to different languages
 Using built-in class I18N.
-
 You need to install babel package 'https://pypi.org/project/Babel/'
 Babel provides a command-line interface for working with message catalogs
 After installing babel package you have a script called 'pybabel'
 Too see all the commands open terminal and type 'pybabel --help'
 Full description for pybabel commands can be found here: 'https://babel.pocoo.org/en/latest/cmdline.html'
-
 Create a directory 'locales' where our translations will be stored
-
 First we need to extract texts:
     pybabel extract -o locales/{domain_name}.pot --input-dirs .
 {domain_name}.pot - is the file where all translations are saved
 The name of this file should be the same as domain which you pass to I18N class
 In this example domain_name will be 'messages'
-
 For gettext (singular texts) we use '_' alias and it works perfect
 You may also you some alias for ngettext (plural texts) but you can face with a problem that
 your plural texts are not being extracted
@@ -23,25 +19,20 @@ That is because by default 'pybabel extract' recognizes the following keywords:
  _, gettext, ngettext, ugettext, ungettext, dgettext, dngettext, N_
 To add your own keyword you can use '-k' flag
 In this example for 'ngettext' i will assign double underscore alias '__'
-
 Full command with pluralization support will look so:
     pybabel extract -o locales/{domain_name}.pot -k __:1,2 --input-dirs .
-
 Then create directories with translations (get list of all locales: 'pybabel --list-locales'):
     pybabel init -i locales/{domain_name}.pot -d locales -l en
     pybabel init -i locales/{domain_name}.pot -d locales -l ru
     pybabel init -i locales/{domain_name}.pot -d locales -l uz_Latn
-
 Now you can translate the texts located in locales/{language}/LC_MESSAGES/{domain_name}.po
 After you translated all the texts you need to compile .po files:
     pybabel compile -d locales
-
 When you delete/update your texts you also need to update them in .po files:
     pybabel extract -o locales/{domain_name}.pot -k __:1,2 --input-dirs .
     pybabel update -i locales/{domain_name}.pot -d locales
     - translate
     pybabel compile -d locales
-
 If you have any exceptions check:
     - you have installed babel
     - translations are ready, so you just compiled it
@@ -49,14 +40,17 @@ If you have any exceptions check:
     - you are writing commands from correct path in terminal
 """
 
-from functools import wraps
-import keyboards
 from telebot import TeleBot, types, custom_filters
+from telebot import apihelper
 from telebot.storage.memory_storage import StateMemoryStorage
+
+import keyboards
 from i18n_class import I18N
 
+apihelper.ENABLE_MIDDLEWARE = True
 storage = StateMemoryStorage()
-bot = TeleBot("", state_storage=storage)
+# IMPORTANT! This example works only if polling is non-threaded.
+bot = TeleBot("", state_storage=storage, threaded=False)
 
 i18n = I18N(translations_path='locales', domain_name='messages')
 _ = i18n.gettext  # for singular translations
@@ -67,35 +61,25 @@ users_lang = {}
 users_clicks = {}
 
 
-def get_user_language(func):
-    """
-    This decorator will pass to your handler current user's language
-    """
-
-    @wraps(func)
-    def inner(*args, **kwargs):
-        obj = args[0]
-        kwargs.update(lang=users_lang.get(obj.from_user.id, 'en'))
-        return func(*args, **kwargs)
-
-    return inner
+@bot.middleware_handler(update_types=['message', 'callback_query'])
+def set_contex_language(bot_instance, message):
+    i18n.context_lang.language = users_lang.get(message.from_user.id, 'en')
 
 
-@bot.message_handler(commands='start')
-@get_user_language
-def start_handler(message: types.Message, lang):
+@bot.message_handler(commands=['start'])
+def start_handler(message: types.Message):
     text = _("Hello, {user_fist_name}!\n"
              "This is the example of multilanguage bot.\n"
              "Available commands:\n\n"
              "/lang - change your language\n"
-             "/plural - pluralization example", lang=lang)
+             "/plural - pluralization example")
 
     # remember don't use f string for interpolation, use .format method instead
     text = text.format(user_fist_name=message.from_user.first_name)
     bot.send_message(message.from_user.id, text)
 
 
-@bot.message_handler(commands='lang')
+@bot.message_handler(commands=['lang'])
 def change_language_handler(message: types.Message):
     bot.send_message(message.chat.id, "Choose language\nВыберите язык\nTilni tanlang",
                      reply_markup=keyboards.languages_keyboard())
@@ -106,13 +90,13 @@ def language_handler(call: types.CallbackQuery):
     lang = call.data
     users_lang[call.from_user.id] = lang
 
+    # When you change user's language, pass language explicitly coz it's not changed in context
     bot.edit_message_text(_("Language has been changed", lang=lang), call.from_user.id, call.message.id)
     bot.delete_state(call.from_user.id)
 
 
-@bot.message_handler(commands='plural')
-@get_user_language
-def pluralization_handler(message: types.Message, lang):
+@bot.message_handler(commands=['plural'])
+def pluralization_handler(message: types.Message):
     if not users_clicks.get(message.from_user.id):
         users_clicks[message.from_user.id] = 0
     clicks = users_clicks[message.from_user.id]
@@ -121,15 +105,13 @@ def pluralization_handler(message: types.Message, lang):
         singular="You have {number} click",
         plural="You have {number} clicks",
         n=clicks,
-        lang=lang
     )
-    text = _("This is clicker.\n\n", lang=lang) + text.format(number=clicks)
-    bot.send_message(message.chat.id, text, reply_markup=keyboards.clicker_keyboard(_, lang))
+    text = _("This is clicker.\n\n") + text.format(number=clicks)
+    bot.send_message(message.chat.id, text, reply_markup=keyboards.clicker_keyboard(_))
 
 
 @bot.callback_query_handler(func=None, text=custom_filters.TextFilter(equals='click'))
-@get_user_language
-def click_handler(call: types.CallbackQuery, lang):
+def click_handler(call: types.CallbackQuery):
     if not users_clicks.get(call.from_user.id):
         users_clicks[call.from_user.id] = 1
     else:
@@ -140,12 +122,11 @@ def click_handler(call: types.CallbackQuery, lang):
     text = __(
         singular="You have {number} click",
         plural="You have {number} clicks",
-        n=clicks,
-        lang=lang
+        n=clicks
     )
-    text = _("This is clicker.\n\n", lang=lang) + text.format(number=clicks)
+    text = _("This is clicker.\n\n") + text.format(number=clicks)
     bot.edit_message_text(text, call.from_user.id, call.message.message_id,
-                          reply_markup=keyboards.clicker_keyboard(_, lang))
+                          reply_markup=keyboards.clicker_keyboard(_))
 
 
 if __name__ == '__main__':

examples/multibot/README.MD

@@ -0,0 +1,17 @@
+You probably have seen bots which allow you to send them token of your bot and then handle updates providing some functionality for your bot.
+<br>
+This type of bots are called <b>multibots</b>. They are created using webhooks.
+<br>
+
+This is the example of simple multibot.<br>
+In order to reproduce this example you need to have <b>domain and ssl connection</b>.
+<br>
+If you have, go to config.py and specify your data.
+<br>
+There is also file called <b>nginx_conf.conf</b>,  we will use nginx as proxy-server and this file is example nginx.conf file.
+<br>
+Make sure that server_name and port are the same in both config and nginx_conf
+<br>
+(nginx_conf.conf IS NOT complete, you would probably use tools like certbot to add ssl connection to it)
+<br>
+Also, in this example I used dictionary as tokens storage, but in production you should use database so that you can re-set webhooks in case bot restarts.

examples/multibot/config.py

@@ -0,0 +1,6 @@
+MAIN_BOT_TOKEN = "your_main_bot_token"
+
+WEBHOOK_HOST = "your_domain.com"
+WEBHOOK_PATH = "telegram_webhook"
+WEBAPP_HOST = "0.0.0.0"
+WEBAPP_PORT = 3500

examples/multibot/handlers.py

@@ -0,0 +1,14 @@
+from telebot import types, TeleBot
+
+
+def hello_handler(message: types.Message, bot: TeleBot):
+    bot.send_message(message.chat.id, "Hi :)")
+
+
+def echo_handler(message: types.Message, bot: TeleBot):
+    bot.send_message(message.chat.id, message.text)
+
+
+def register_handlers(bot: TeleBot):
+    bot.register_message_handler(hello_handler, func=lambda message: message.text == 'Hello', pass_bot=True)
+    bot.register_message_handler(echo_handler, pass_bot=True)

examples/multibot/main.py

@@ -0,0 +1,48 @@
+from flask import Flask
+from flask import request, abort
+from telebot import TeleBot, types, util
+from handlers import register_handlers
+
+import config
+
+main_bot = TeleBot(config.MAIN_BOT_TOKEN)
+app = Flask(__name__)
+tokens = {config.MAIN_BOT_TOKEN: True}
+
+
+@app.route(f"/{config.WEBHOOK_PATH}/<token>", methods=['POST'])
+def webhook(token: str):
+    if not tokens.get(token):
+        return abort(404)
+
+    if request.headers.get('content-type') != 'application/json':
+        return abort(403)
+
+    json_string = request.get_data().decode('utf-8')
+    update = types.Update.de_json(json_string)
+    if token == main_bot.token:
+        main_bot.process_new_updates([update])
+        return ''
+
+    from_update_bot = TeleBot(token)
+    register_handlers(from_update_bot)
+    from_update_bot.process_new_updates([update])
+    return ''
+
+
+@main_bot.message_handler(commands=['add_bot'])
+def add_bot(message: types.Message):
+    token = util.extract_arguments(message.text)
+    tokens[token] = True
+
+    new_bot = TeleBot(token)
+    new_bot.delete_webhook()
+    new_bot.set_webhook(f"{config.WEBHOOK_HOST}/{config.WEBHOOK_PATH}/{token}")
+
+    new_bot.send_message(message.chat.id, "Webhook was set.")
+
+
+if __name__ == '__main__':
+    main_bot.delete_webhook()
+    main_bot.set_webhook(f"{config.WEBHOOK_HOST}/{config.WEBHOOK_PATH}/{config.MAIN_BOT_TOKEN}")
+    app.run(host=config.WEBAPP_HOST, port=config.WEBAPP_PORT)

examples/multibot/nginx_conf.conf

@@ -0,0 +1,8 @@
+server {
+    server_name your_domain.com;
+
+    location /telegram_webhook/ {
+        proxy_pass http://localhost:3500;
+    }
+
+}

examples/payments_example.py

@@ -38,21 +38,20 @@ def command_pay(message):
                      "Real cards won't work with me, no money will be debited from your account."
                      " Use this test card number to pay for your Time Machine: `4242 4242 4242 4242`"
                      "\n\nThis is your demo invoice:", parse_mode='Markdown')
-    bot.send_invoice(message.chat.id, title='Working Time Machine',
-                     description='Want to visit your great-great-great-grandparents?'
-                                 ' Make a fortune at the races?'
-                                 ' Shake hands with Hammurabi and take a stroll in the Hanging Gardens?'
-                                 ' Order our Working Time Machine today!',
-                     provider_token=provider_token,
-                     currency='usd',
+    bot.send_invoice(
+                     message.chat.id,  #chat_id
+                     'Working Time Machine', #title
+                     ' Want to visit your great-great-great-grandparents? Make a fortune at the races? Shake hands with Hammurabi and take a stroll in the Hanging Gardens? Order our Working Time Machine today!', #description
+                     'HAPPY FRIDAYS COUPON', #invoice_payload
+                     provider_token, #provider_token
+                     'usd', #currency
+                     prices, #prices
                      photo_url='http://erkelzaar.tsudao.com/models/perrotta/TIME_MACHINE.jpg',
                      photo_height=512,  # !=0/None or picture won't be shown
                      photo_width=512,
                      photo_size=512,
                      is_flexible=False,  # True If you need to set up Shipping Fee
-                     prices=prices,
-                     start_parameter='time-machine-example',
-                     invoice_payload='HAPPY FRIDAYS COUPON')
+                     start_parameter='time-machine-example')
 
 
 @bot.shipping_query_handler(func=lambda query: True)

examples/serverless/aws_lambda_function.py

@@ -0,0 +1,50 @@
+"""
+Example of running PyTelegramBotAPI serverless in Amazon AWS Lambdaю
+You have to set your lambda's url as telegram webhook manually https://core.telegram.org/bots/api#setwebhook
+"""
+
+import logging
+
+import telebot
+import json
+import os
+
+API_TOKEN = os.environ['TELEGRAM_TOKEN']
+
+
+logger = telebot.logger
+telebot.logger.setLevel(logging.INFO)
+
+bot = telebot.TeleBot(API_TOKEN, threaded=False)
+
+
+def process_event(event):
+    # Get telegram webhook json from event
+    request_body_dict = json.loads(event['body'])
+    # Parse updates from json
+    update = telebot.types.Update.de_json(request_body_dict)
+    # Run handlers and etc for updates
+    bot.process_new_updates([update])
+
+
+def lambda_handler(event, context):
+    # Process event from aws and respond
+    process_event(event)
+    return {
+        'statusCode': 200
+    }
+
+
+# Handle '/start' and '/help'
+@bot.message_handler(commands=['help', 'start'])
+def send_welcome(message):
+    bot.reply_to(message,
+                 ("Hi there, I am EchoBot.\n"
+                  "I am here to echo your kind words back to you."))
+
+
+# Handle all other messages
+@bot.message_handler(func=lambda message: True, content_types=['text'])
+def echo_message(message):
+    bot.reply_to(message, message.text)
+

examples/webhook_examples/run_webhooks.py

@@ -0,0 +1,45 @@
+#!/usr/bin/python
+
+# This is a simple echo bot using the decorator mechanism.
+# It echoes any incoming text messages.
+# Example on built-in function to receive and process webhooks.
+
+import telebot
+
+API_TOKEN = 'TOKEN'
+
+bot = telebot.TeleBot(API_TOKEN)
+
+WEBHOOK_SSL_CERT = './webhook_cert.pem'  # Path to the ssl certificate
+WEBHOOK_SSL_PRIV = './webhook_pkey.pem'  # Path to the ssl private key
+DOMAIN = '1.2.3.4' # either domain, or ip address of vps
+
+# Quick'n'dirty SSL certificate generation:
+#
+# openssl genrsa -out webhook_pkey.pem 2048
+# openssl req -new -x509 -days 3650 -key webhook_pkey.pem -out webhook_cert.pem
+#
+# When asked for "Common Name (e.g. server FQDN or YOUR name)" you should reply
+# with the same value in you put in WEBHOOK_HOST
+
+
+# Handle '/start' and '/help'
+@bot.message_handler(commands=['help', 'start'])
+def send_welcome(message):
+    bot.reply_to(message, """\
+Hi there, I am EchoBot.
+I am here to echo your kind words back to you. Just say anything nice and I'll say the exact same thing to you!\
+""")
+
+
+# Handle all other messages with content_type 'text' (content_types defaults to ['text'])
+@bot.message_handler(func=lambda message: True)
+def echo_message(message):
+    bot.reply_to(message, message.text)
+
+
+bot.run_webhooks(
+    listen=DOMAIN,
+    certificate=WEBHOOK_SSL_CERT,
+    certificate_key=WEBHOOK_SSL_PRIV
+)

examples/webhook_examples/webhook_fastapi_echo_bot.py

@@ -6,6 +6,7 @@
 
 import logging
 import fastapi
+import uvicorn
 import telebot
 
 API_TOKEN = 'TOKEN'
@@ -33,12 +34,14 @@ telebot.logger.setLevel(logging.INFO)
 
 bot = telebot.TeleBot(API_TOKEN)
 
-app = fastapi.FastAPI()
+app = fastapi.FastAPI(docs=None, redoc_url=None)
 
 
-# Process webhook calls
 @app.post(f'/{API_TOKEN}/')
 def process_webhook(update: dict):
+    """
+    Process webhook calls
+    """
     if update:
         update = telebot.types.Update.de_json(update)
         bot.process_new_updates([update])
@@ -46,18 +49,21 @@ def process_webhook(update: dict):
         return
 
 
-
-# Handle '/start' and '/help'
 @bot.message_handler(commands=['help', 'start'])
 def send_welcome(message):
+    """
+    Handle '/start' and '/help'
+    """
     bot.reply_to(message,
                  ("Hi there, I am EchoBot.\n"
                   "I am here to echo your kind words back to you."))
 
 
-# Handle all other messages
 @bot.message_handler(func=lambda message: True, content_types=['text'])
 def echo_message(message):
+    """
+    Handle all other messages
+    """
     bot.reply_to(message, message.text)
 
 
@@ -65,11 +71,12 @@ def echo_message(message):
 bot.remove_webhook()
 
 # Set webhook
-bot.set_webhook(url=WEBHOOK_URL_BASE + WEBHOOK_URL_PATH,
-                certificate=open(WEBHOOK_SSL_CERT, 'r'))
+bot.set_webhook(
+    url=WEBHOOK_URL_BASE + WEBHOOK_URL_PATH,
+    certificate=open(WEBHOOK_SSL_CERT, 'r')
+)
 
 
-import uvicorn
 uvicorn.run(
     app,
     host=WEBHOOK_LISTEN,

requirements.txt

@@ -1,4 +1,4 @@
 pytest
 requests==2.20.0
-wheel==0.24.0
-aiohttp>=3.8.0,<3.9.0
+wheel==0.38.1
+aiohttp>=3.8.0,<3.9.0

setup.py

@@ -26,7 +26,14 @@ setup(name='pyTelegramBotAPI',
       extras_require={
           'json': 'ujson',
           'PIL': 'Pillow',
-          'redis': 'redis>=3.4.1'
+          'redis': 'redis>=3.4.1',
+          'aioredis': 'aioredis',
+          'aiohttp': 'aiohttp',
+          'fastapi': 'fastapi',
+          'uvicorn': 'uvicorn',
+          'psutil': 'psutil',
+          'coloredlogs': 'coloredlogs',
+          'watchdog': 'watchdog'
       },
       classifiers=[
           'Development Status :: 5 - Production/Stable',

telebot/apihelper.py

@@ -47,7 +47,6 @@ CUSTOM_REQUEST_SENDER = None
 ENABLE_MIDDLEWARE = False
 
 
-
 def _get_req_session(reset=False):
     if SESSION_TIME_TO_LIVE:
         # If session TTL is set - check time passed
@@ -88,28 +87,37 @@ def _make_request(token, method_name, method='get', params=None, files=None):
     logger.debug("Request: method={0} url={1} params={2} files={3}".format(method, request_url, params, files).replace(token, token.split(':')[0] + ":{TOKEN}"))
     read_timeout = READ_TIMEOUT
     connect_timeout = CONNECT_TIMEOUT
+
+    if files:
+        files_copy = dict(files)
+        # process types.InputFile
+        for key, value in files_copy.items():
+            if isinstance(value, types.InputFile):
+                files[key] = value.file
+                
+    
     if files and format_header_param:
         fields.format_header_param = _no_encode(format_header_param)
     if params:
         if 'timeout' in params:
             read_timeout = params.pop('timeout')
             connect_timeout = read_timeout
-#        if 'connect-timeout' in params:
-#            connect_timeout = params.pop('connect-timeout') + 10
         if 'long_polling_timeout' in params:
-            # For getUpdates: it's the only function with timeout parameter on the BOT API side
+            # For getUpdates. It's the only function with timeout parameter on the BOT API side
             long_polling_timeout = params.pop('long_polling_timeout')
             params['timeout'] = long_polling_timeout
             # Long polling hangs for a given time. Read timeout should be greater that long_polling_timeout
             read_timeout = max(long_polling_timeout + 5, read_timeout)
-    # Lets stop suppose that user is stupid and assume that he knows what he do...
-    # read_timeout = read_timeout + 10
-    # connect_timeout = connect_timeout + 10
 
     params = params or None # Set params to None if empty
-
     result = None
-    if RETRY_ON_ERROR and RETRY_ENGINE == 1:
+
+    if CUSTOM_REQUEST_SENDER:
+        # noinspection PyCallingNonCallable
+        result = CUSTOM_REQUEST_SENDER(
+            method, request_url, params=params, files=files,
+            timeout=(connect_timeout, read_timeout), proxies=proxy)
+    elif RETRY_ON_ERROR and RETRY_ENGINE == 1:
         got_result = False
         current_try = 0
         while not got_result and current_try<MAX_RETRIES-1:
@@ -134,6 +142,7 @@ def _make_request(token, method_name, method='get', params=None, files=None):
                     timeout=(connect_timeout, read_timeout), proxies=proxy)
     elif RETRY_ON_ERROR and RETRY_ENGINE == 2:
         http = _get_req_session()
+        # noinspection PyUnresolvedReferences
         retry_strategy = requests.packages.urllib3.util.retry.Retry(
             total=MAX_RETRIES,
         )
@@ -143,11 +152,6 @@ def _make_request(token, method_name, method='get', params=None, files=None):
         result = http.request(
             method, request_url, params=params, files=files,
             timeout=(connect_timeout, read_timeout), proxies=proxy)
-    elif CUSTOM_REQUEST_SENDER:
-        # noinspection PyCallingNonCallable
-        result = CUSTOM_REQUEST_SENDER(
-            method, request_url, params=params, files=files,
-            timeout=(connect_timeout, read_timeout), proxies=proxy)
     else:
         result = _get_req_session().request(
             method, request_url, params=params, files=files,
@@ -233,23 +237,8 @@ def send_message(
         token, chat_id, text,
         disable_web_page_preview=None, reply_to_message_id=None, reply_markup=None,
         parse_mode=None, disable_notification=None, timeout=None,
-        entities=None, allow_sending_without_reply=None, protect_content=None):
-    """
-    Use this method to send text messages. On success, the sent Message is returned.
-    :param token:
-    :param chat_id:
-    :param text:
-    :param disable_web_page_preview:
-    :param reply_to_message_id:
-    :param reply_markup:
-    :param parse_mode:
-    :param disable_notification:
-    :param timeout:
-    :param entities:
-    :param allow_sending_without_reply:
-    :param protect_content:
-    :return:
-    """
+        entities=None, allow_sending_without_reply=None, protect_content=None,
+        message_thread_id=None):
     method_url = r'sendMessage'
     payload = {'chat_id': str(chat_id), 'text': text}
     if disable_web_page_preview is not None:
@@ -270,11 +259,13 @@ def send_message(
         payload['allow_sending_without_reply'] = allow_sending_without_reply
     if protect_content is not None:
         payload['protect_content'] = protect_content
+    if message_thread_id:
+        payload['message_thread_id'] = message_thread_id
     return _make_request(token, method_url, params=payload, method='post')
 
 
 def set_webhook(token, url=None, certificate=None, max_connections=None, allowed_updates=None, ip_address=None,
-                drop_pending_updates = None, timeout=None):
+                drop_pending_updates = None, timeout=None, secret_token=None):
     method_url = r'setWebhook'
     payload = {
         'url': url if url else "",
@@ -292,6 +283,8 @@ def set_webhook(token, url=None, certificate=None, max_connections=None, allowed
         payload['drop_pending_updates'] = drop_pending_updates
     if timeout:
         payload['timeout'] = timeout
+    if secret_token:
+        payload['secret_token'] = secret_token
     return _make_request(token, method_url, params=payload, files=files)
 
 
@@ -394,7 +387,7 @@ def get_chat_member(token, chat_id, user_id):
 
 def forward_message(
         token, chat_id, from_chat_id, message_id,
-        disable_notification=None, timeout=None, protect_content=None):
+        disable_notification=None, timeout=None, protect_content=None, message_thread_id=None):
     method_url = r'forwardMessage'
     payload = {'chat_id': chat_id, 'from_chat_id': from_chat_id, 'message_id': message_id}
     if disable_notification is not None:
@@ -403,12 +396,14 @@ def forward_message(
         payload['timeout'] = timeout
     if protect_content is not None:
         payload['protect_content'] = protect_content
+    if message_thread_id:
+        payload['message_thread_id'] = message_thread_id
     return _make_request(token, method_url, params=payload)
 
 
 def copy_message(token, chat_id, from_chat_id, message_id, caption=None, parse_mode=None, caption_entities=None,
                  disable_notification=None, reply_to_message_id=None, allow_sending_without_reply=None,
-                 reply_markup=None, timeout=None, protect_content=None):
+                 reply_markup=None, timeout=None, protect_content=None, message_thread_id=None):
     method_url = r'copyMessage'
     payload = {'chat_id': chat_id, 'from_chat_id': from_chat_id, 'message_id': message_id}
     if caption is not None:
@@ -429,13 +424,15 @@ def copy_message(token, chat_id, from_chat_id, message_id, caption=None, parse_m
         payload['timeout'] = timeout
     if protect_content is not None:
         payload['protect_content'] = protect_content
+    if message_thread_id is not None:
+        payload['message_thread_id'] = message_thread_id
     return _make_request(token, method_url, params=payload)
 
 
 def send_dice(
         token, chat_id,
         emoji=None, disable_notification=None, reply_to_message_id=None,
-        reply_markup=None, timeout=None, allow_sending_without_reply=None, protect_content=None):
+        reply_markup=None, timeout=None, allow_sending_without_reply=None, protect_content=None, message_thread_id=None):
     method_url = r'sendDice'
     payload = {'chat_id': chat_id}
     if emoji:
@@ -452,6 +449,8 @@ def send_dice(
         payload['allow_sending_without_reply'] = allow_sending_without_reply
     if protect_content is not None:
         payload['protect_content'] = protect_content
+    if message_thread_id:
+        payload['message_thread_id'] = message_thread_id
     return _make_request(token, method_url, params=payload)
 
 
@@ -459,7 +458,8 @@ def send_photo(
         token, chat_id, photo,
         caption=None, reply_to_message_id=None, reply_markup=None,
         parse_mode=None, disable_notification=None, timeout=None,
-        caption_entities=None, allow_sending_without_reply=None, protect_content=None):
+        caption_entities=None, allow_sending_without_reply=None, protect_content=None,
+        message_thread_id=None, has_spoiler=None):
     method_url = r'sendPhoto'
     payload = {'chat_id': chat_id}
     files = None
@@ -487,13 +487,17 @@ def send_photo(
         payload['allow_sending_without_reply'] = allow_sending_without_reply
     if protect_content is not None:
         payload['protect_content'] = protect_content
+    if message_thread_id is not None:
+        payload['message_thread_id'] = message_thread_id
+    if has_spoiler is not None:
+        payload['has_spoiler'] = has_spoiler
     return _make_request(token, method_url, params=payload, files=files, method='post')
 
 
 def send_media_group(
         token, chat_id, media,
         disable_notification=None, reply_to_message_id=None,
-        timeout=None, allow_sending_without_reply=None, protect_content=None):
+        timeout=None, allow_sending_without_reply=None, protect_content=None, message_thread_id=None):
     method_url = r'sendMediaGroup'
     media_json, files = convert_input_media_array(media)
     payload = {'chat_id': chat_id, 'media': media_json}
@@ -507,6 +511,8 @@ def send_media_group(
         payload['allow_sending_without_reply'] = allow_sending_without_reply
     if protect_content is not None:
         payload['protect_content'] = protect_content
+    if message_thread_id is not None:
+        payload['message_thread_id'] = message_thread_id
     return _make_request(
         token, method_url, params=payload,
         method='post' if files else 'get',
@@ -518,7 +524,8 @@ def send_location(
         live_period=None, reply_to_message_id=None, 
         reply_markup=None, disable_notification=None, 
         timeout=None, horizontal_accuracy=None, heading=None,
-        proximity_alert_radius=None, allow_sending_without_reply=None, protect_content=None):
+        proximity_alert_radius=None, allow_sending_without_reply=None, protect_content=None,
+        message_thread_id=None):
     method_url = r'sendLocation'
     payload = {'chat_id': chat_id, 'latitude': latitude, 'longitude': longitude}
     if live_period:
@@ -541,6 +548,8 @@ def send_location(
         payload['timeout'] = timeout
     if protect_content is not None:
         payload['protect_content'] = protect_content
+    if message_thread_id is not None:
+        payload['message_thread_id'] = message_thread_id
     return _make_request(token, method_url, params=payload)
 
 
@@ -592,7 +601,7 @@ def send_venue(
         foursquare_id=None, foursquare_type=None, disable_notification=None,
         reply_to_message_id=None, reply_markup=None, timeout=None,
         allow_sending_without_reply=None, google_place_id=None,
-        google_place_type=None, protect_content=None):
+        google_place_type=None, protect_content=None, message_thread_id=None):
     method_url = r'sendVenue'
     payload = {'chat_id': chat_id, 'latitude': latitude, 'longitude': longitude, 'title': title, 'address': address}
     if foursquare_id:
@@ -615,13 +624,15 @@ def send_venue(
         payload['google_place_type'] = google_place_type
     if protect_content is not None:
         payload['protect_content'] = protect_content
+    if message_thread_id is not None:
+        payload['message_thread_id'] = message_thread_id
     return _make_request(token, method_url, params=payload)
 
 
 def send_contact(
         token, chat_id, phone_number, first_name, last_name=None, vcard=None,
         disable_notification=None, reply_to_message_id=None, reply_markup=None, timeout=None,
-        allow_sending_without_reply=None, protect_content=None):
+        allow_sending_without_reply=None, protect_content=None, message_thread_id=None):
     method_url = r'sendContact'
     payload = {'chat_id': chat_id, 'phone_number': phone_number, 'first_name': first_name}
     if last_name:
@@ -640,21 +651,26 @@ def send_contact(
         payload['allow_sending_without_reply'] = allow_sending_without_reply
     if protect_content is not None:
         payload['protect_content'] = protect_content
+    if message_thread_id is not None:
+        payload['message_thread_id'] = message_thread_id
 
     return _make_request(token, method_url, params=payload)
 
 
-def send_chat_action(token, chat_id, action, timeout=None):
+def send_chat_action(token, chat_id, action, timeout=None, message_thread_id=None):
     method_url = r'sendChatAction'
     payload = {'chat_id': chat_id, 'action': action}
     if timeout:
         payload['timeout'] = timeout
+    if message_thread_id is not None:
+        payload['message_thread_id'] = message_thread_id
     return _make_request(token, method_url, params=payload)
 
 
 def send_video(token, chat_id, data, duration=None, caption=None, reply_to_message_id=None, reply_markup=None,
                parse_mode=None, supports_streaming=None, disable_notification=None, timeout=None, 
-               thumb=None, width=None, height=None, caption_entities=None, allow_sending_without_reply=None, protect_content=None):
+               thumb=None, width=None, height=None, caption_entities=None, allow_sending_without_reply=None, protect_content=None,
+               message_thread_id=None, has_spoiler=None):
     method_url = r'sendVideo'
     payload = {'chat_id': chat_id}
     files = None
@@ -696,13 +712,18 @@ def send_video(token, chat_id, data, duration=None, caption=None, reply_to_messa
         payload['allow_sending_without_reply'] = allow_sending_without_reply
     if protect_content is not None:
         payload['protect_content'] = protect_content
+    if message_thread_id:
+        payload['message_thread_id'] = message_thread_id
+    if has_spoiler is not None:
+        payload['has_spoiler'] = has_spoiler
     return _make_request(token, method_url, params=payload, files=files, method='post')
 
 
 def send_animation(
         token, chat_id, data, duration=None, caption=None, reply_to_message_id=None, reply_markup=None,
         parse_mode=None, disable_notification=None, timeout=None, thumb=None, caption_entities=None,
-        allow_sending_without_reply=None, protect_content=None, width=None, height=None):
+        allow_sending_without_reply=None, protect_content=None, width=None, height=None, message_thread_id=None,
+        has_spoiler=None):
     method_url = r'sendAnimation'
     payload = {'chat_id': chat_id}
     files = None
@@ -742,12 +763,16 @@ def send_animation(
         payload['width'] = width
     if height:
         payload['height'] = height
+    if message_thread_id:
+        payload['message_thread_id'] = message_thread_id
+    if has_spoiler is not None:
+        payload['has_spoiler'] = has_spoiler
     return _make_request(token, method_url, params=payload, files=files, method='post')
 
 
 def send_voice(token, chat_id, voice, caption=None, duration=None, reply_to_message_id=None, reply_markup=None,
                parse_mode=None, disable_notification=None, timeout=None, caption_entities=None,
-               allow_sending_without_reply=None, protect_content=None):
+               allow_sending_without_reply=None, protect_content=None, message_thread_id=None):
     method_url = r'sendVoice'
     payload = {'chat_id': chat_id}
     files = None
@@ -775,11 +800,14 @@ def send_voice(token, chat_id, voice, caption=None, duration=None, reply_to_mess
         payload['allow_sending_without_reply'] = allow_sending_without_reply
     if protect_content is not None:
         payload['protect_content'] = protect_content
+    if message_thread_id:
+        payload['message_thread_id'] = message_thread_id
     return _make_request(token, method_url, params=payload, files=files, method='post')
 
 
 def send_video_note(token, chat_id, data, duration=None, length=None, reply_to_message_id=None, reply_markup=None,
-                    disable_notification=None, timeout=None, thumb=None, allow_sending_without_reply=None, protect_content=None):
+                    disable_notification=None, timeout=None, thumb=None, allow_sending_without_reply=None, protect_content=None,
+                    message_thread_id=None):
     method_url = r'sendVideoNote'
     payload = {'chat_id': chat_id}
     files = None
@@ -813,12 +841,14 @@ def send_video_note(token, chat_id, data, duration=None, length=None, reply_to_m
         payload['allow_sending_without_reply'] = allow_sending_without_reply
     if protect_content is not None:
         payload['protect_content'] = protect_content
+    if message_thread_id:
+        payload['message_thread_id'] = message_thread_id
     return _make_request(token, method_url, params=payload, files=files, method='post')
 
 
 def send_audio(token, chat_id, audio, caption=None, duration=None, performer=None, title=None, reply_to_message_id=None,
                reply_markup=None, parse_mode=None, disable_notification=None, timeout=None, thumb=None,
-               caption_entities=None, allow_sending_without_reply=None, protect_content=None):
+               caption_entities=None, allow_sending_without_reply=None, protect_content=None, message_thread_id=None):
     method_url = r'sendAudio'
     payload = {'chat_id': chat_id}
     files = None
@@ -858,13 +888,15 @@ def send_audio(token, chat_id, audio, caption=None, duration=None, performer=Non
         payload['allow_sending_without_reply'] = allow_sending_without_reply
     if protect_content is not None:
         payload['protect_content'] = protect_content
+    if message_thread_id:
+        payload['message_thread_id'] = message_thread_id
     return _make_request(token, method_url, params=payload, files=files, method='post')
 
 
 def send_data(token, chat_id, data, data_type, reply_to_message_id=None, reply_markup=None, parse_mode=None,
               disable_notification=None, timeout=None, caption=None, thumb=None, caption_entities=None,
               allow_sending_without_reply=None, disable_content_type_detection=None, visible_file_name=None,
-              protect_content = None):
+              protect_content = None, message_thread_id=None):
     method_url = get_method_by_type(data_type)
     payload = {'chat_id': chat_id}
     files = None
@@ -903,6 +935,8 @@ def send_data(token, chat_id, data, data_type, reply_to_message_id=None, reply_m
         payload['protect_content'] = protect_content
     if method_url == 'sendDocument' and disable_content_type_detection is not None:
         payload['disable_content_type_detection'] = disable_content_type_detection
+    if message_thread_id:
+        payload['message_thread_id'] = message_thread_id
     return _make_request(token, method_url, params=payload, files=files, method='post')
 
 
@@ -971,7 +1005,8 @@ def promote_chat_member(
         token, chat_id, user_id, can_change_info=None, can_post_messages=None,
         can_edit_messages=None, can_delete_messages=None, can_invite_users=None,
         can_restrict_members=None, can_pin_messages=None, can_promote_members=None,
-        is_anonymous=None, can_manage_chat=None, can_manage_voice_chats=None):
+        is_anonymous=None, can_manage_chat=None, can_manage_video_chats=None,
+        can_manage_topics=None):
     method_url = 'promoteChatMember'
     payload = {'chat_id': chat_id, 'user_id': user_id}
     if can_change_info is not None:
@@ -994,8 +1029,10 @@ def promote_chat_member(
         payload['is_anonymous'] = is_anonymous
     if can_manage_chat is not None:
         payload['can_manage_chat'] = can_manage_chat
-    if can_manage_voice_chats is not None:
-        payload['can_manage_voice_chats'] = can_manage_voice_chats
+    if can_manage_video_chats is not None:
+        payload['can_manage_video_chats'] = can_manage_video_chats
+    if can_manage_topics is not None:
+        payload['can_manage_topics'] = can_manage_topics
     return _make_request(token, method_url, params=payload, method='post')
 
 
@@ -1139,6 +1176,40 @@ def get_my_commands(token, scope=None, language_code=None):
         payload['language_code'] = language_code
     return _make_request(token, method_url, params=payload)
 
+def set_chat_menu_button(token, chat_id=None, menu_button=None):
+    method_url = r'setChatMenuButton'
+    payload = {}
+    if chat_id:
+        payload['chat_id'] = chat_id
+    if menu_button:
+        payload['menu_button'] = menu_button.to_json()
+    return _make_request(token, method_url, params=payload, method='post')
+
+def get_chat_menu_button(token, chat_id=None):
+    method_url = r'getChatMenuButton'
+    payload = {}
+    if chat_id:
+        payload['chat_id'] = chat_id
+    return _make_request(token, method_url, params=payload, method='post')
+
+
+def set_my_default_administrator_rights(token, rights=None, for_channels=None):
+    method_url = r'setMyDefaultAdministratorRights'
+    payload = {}
+    if rights:
+        payload['rights'] = rights.to_json()
+    if for_channels is not None:
+        payload['for_channels'] = for_channels
+    return _make_request(token, method_url, params=payload, method='post')
+
+
+def get_my_default_administrator_rights(token, for_channels=None):
+    method_url = r'getMyDefaultAdministratorRights'
+    payload = {}
+    if for_channels:
+        payload['for_channels'] = for_channels
+    return _make_request(token, method_url, params=payload, method='post')
+
 
 def set_my_commands(token, commands, scope=None, language_code=None):
     method_url = r'setMyCommands'
@@ -1274,7 +1345,7 @@ def delete_message(token, chat_id, message_id, timeout=None):
 def send_game(
         token, chat_id, game_short_name,
         disable_notification=None, reply_to_message_id=None, reply_markup=None, timeout=None,
-        allow_sending_without_reply=None, protect_content=None):
+        allow_sending_without_reply=None, protect_content=None, message_thread_id=None):
     method_url = r'sendGame'
     payload = {'chat_id': chat_id, 'game_short_name': game_short_name}
     if disable_notification is not None:
@@ -1289,7 +1360,8 @@ def send_game(
         payload['allow_sending_without_reply'] = allow_sending_without_reply
     if protect_content is not None:
         payload['protect_content'] = protect_content
-    
+    if message_thread_id:
+        payload['message_thread_id'] = message_thread_id
     return _make_request(token, method_url, params=payload)
 
 
@@ -1355,7 +1427,7 @@ def send_invoice(
         send_phone_number_to_provider = None, send_email_to_provider = None, is_flexible=None,
         disable_notification=None, reply_to_message_id=None, reply_markup=None, provider_data=None,
         timeout=None, allow_sending_without_reply=None, max_tip_amount=None, suggested_tip_amounts=None,
-        protect_content=None):
+        protect_content=None, message_thread_id=None):
     """
     Use this method to send invoices. On success, the sent Message is returned.
     :param token: Bot's token (you don't need to fill this)
@@ -1436,6 +1508,8 @@ def send_invoice(
         payload['suggested_tip_amounts'] = json.dumps(suggested_tip_amounts)
     if protect_content is not None:
         payload['protect_content'] = protect_content
+    if message_thread_id:
+        payload['message_thread_id'] = message_thread_id
     return _make_request(token, method_url, params=payload)
 
 
@@ -1523,7 +1597,10 @@ def get_sticker_set(token, name):
     method_url = 'getStickerSet'
     return _make_request(token, method_url, params={'name': name})
 
-
+def get_custom_emoji_stickers(token, custom_emoji_ids):
+    method_url = r'getCustomEmojiStickers'
+    return _make_request(token, method_url, params={'custom_emoji_ids': custom_emoji_ids})
+    
 def upload_sticker_file(token, user_id, png_sticker):
     method_url = 'uploadStickerFile'
     payload = {'user_id': user_id}
@@ -1533,10 +1610,9 @@ def upload_sticker_file(token, user_id, png_sticker):
 
 def create_new_sticker_set(
         token, user_id, name, title, emojis, png_sticker, tgs_sticker,
-        contains_masks=None, mask_position=None, webm_sticker=None):
+        mask_position=None, webm_sticker=None, sticker_type=None):
     method_url = 'createNewStickerSet'
     payload = {'user_id': user_id, 'name': name, 'title': title, 'emojis': emojis}
-    stype = None
     if png_sticker:
         stype = 'png_sticker'
     elif webm_sticker:
@@ -1549,19 +1625,18 @@ def create_new_sticker_set(
         files = {stype: sticker}
     else:
         payload[stype] = sticker
-    if contains_masks is not None:
-        payload['contains_masks'] = contains_masks
     if mask_position:
         payload['mask_position'] = mask_position.to_json()
     if webm_sticker:
         payload['webm_sticker'] = webm_sticker
+    if sticker_type:
+        payload['sticker_type'] = sticker_type
     return _make_request(token, method_url, params=payload, files=files, method='post')
 
 
 def add_sticker_to_set(token, user_id, name, emojis, png_sticker, tgs_sticker, mask_position, webm_sticker):
     method_url = 'addStickerToSet'
     payload = {'user_id': user_id, 'name': name, 'emojis': emojis}
-    stype = None
     if png_sticker:
         stype = 'png_sticker'
     elif webm_sticker:
@@ -1591,6 +1666,51 @@ def delete_sticker_from_set(token, sticker):
     return _make_request(token, method_url, params=payload, method='post')
 
 
+def answer_web_app_query(token, web_app_query_id, result: types.InlineQueryResultBase):
+    method_url = 'answerWebAppQuery'
+    payload = {'web_app_query_id': web_app_query_id, 'result': result.to_json()}
+    return _make_request(token, method_url, params=payload, method='post')
+
+
+def create_invoice_link(token, title, description, payload, provider_token,
+            currency, prices, max_tip_amount=None, suggested_tip_amounts=None, provider_data=None,
+            photo_url=None, photo_size=None, photo_width=None, photo_height=None, need_name=None, need_phone_number=None,
+            need_email=None, need_shipping_address=None, send_phone_number_to_provider=None,
+            send_email_to_provider=None, is_flexible=None):
+    method_url = r'createInvoiceLink'
+    payload = {'title': title, 'description': description, 'payload': payload, 'provider_token': provider_token,
+                'currency': currency, 'prices': _convert_list_json_serializable(prices)}
+    if max_tip_amount:
+        payload['max_tip_amount'] = max_tip_amount
+    if suggested_tip_amounts:
+        payload['suggested_tip_amounts'] = json.dumps(suggested_tip_amounts)
+    if provider_data:
+        payload['provider_data'] = provider_data
+    if photo_url:
+        payload['photo_url'] = photo_url
+    if photo_size:
+        payload['photo_size'] = photo_size
+    if photo_width:
+        payload['photo_width'] = photo_width
+    if photo_height:
+        payload['photo_height'] = photo_height
+    if need_name is not None:
+        payload['need_name'] = need_name
+    if need_phone_number is not None:
+        payload['need_phone_number'] = need_phone_number
+    if need_email is not None:
+        payload['need_email'] = need_email
+    if need_shipping_address is not None:
+        payload['need_shipping_address'] = need_shipping_address
+    if send_phone_number_to_provider is not None:
+        payload['send_phone_number_to_provider'] = send_phone_number_to_provider
+    if send_email_to_provider is not None:
+        payload['send_email_to_provider'] = send_email_to_provider
+    if is_flexible is not None:
+        payload['is_flexible'] = is_flexible
+    return _make_request(token, method_url, params=payload, method='post')
+
+
 # noinspection PyShadowingBuiltins
 def send_poll(
         token, chat_id,
@@ -1598,7 +1718,7 @@ def send_poll(
         is_anonymous = None, type = None, allows_multiple_answers = None, correct_option_id = None,
         explanation = None, explanation_parse_mode=None, open_period = None, close_date = None, is_closed = None,
         disable_notification=False, reply_to_message_id=None, allow_sending_without_reply=None,
-        reply_markup=None, timeout=None, explanation_entities=None, protect_content=None):
+        reply_markup=None, timeout=None, explanation_entities=None, protect_content=None, message_thread_id=None):
     method_url = r'sendPoll'
     payload = {
         'chat_id': str(chat_id),
@@ -1642,8 +1762,51 @@ def send_poll(
             types.MessageEntity.to_list_of_dicts(explanation_entities))
     if protect_content:
         payload['protect_content'] = protect_content
+    if message_thread_id:
+        payload['message_thread_id'] = message_thread_id
     return _make_request(token, method_url, params=payload)
 
+def create_forum_topic(token, chat_id, name, icon_color=None, icon_custom_emoji_id=None):
+    method_url = r'createForumTopic'
+    payload = {'chat_id': chat_id, 'name': name}
+    if icon_color:
+        payload['icon_color'] = icon_color
+    if icon_custom_emoji_id:
+        payload['icon_custom_emoji_id'] = icon_custom_emoji_id
+    return _make_request(token, method_url, params=payload)
+
+def edit_forum_topic(token, chat_id, message_thread_id, name=None, icon_custom_emoji_id=None):
+    method_url = r'editForumTopic'
+    payload = {'chat_id': chat_id, 'message_thread_id': message_thread_id}
+    if name is not None:
+        payload['name'] = name
+    if icon_custom_emoji_id is not None:
+        payload['icon_custom_emoji_id'] = icon_custom_emoji_id
+    return _make_request(token, method_url, params=payload)
+
+def close_forum_topic(token, chat_id, message_thread_id):
+    method_url = r'closeForumTopic'
+    payload = {'chat_id': chat_id, 'message_thread_id': message_thread_id}
+    return _make_request(token, method_url, params=payload)
+
+def reopen_forum_topic(token, chat_id, message_thread_id):
+    method_url = r'reopenForumTopic'
+    payload = {'chat_id': chat_id, 'message_thread_id': message_thread_id}
+    return _make_request(token, method_url, params=payload)
+
+def delete_forum_topic(token, chat_id, message_thread_id):
+    method_url = r'deleteForumTopic'
+    payload = {'chat_id': chat_id, 'message_thread_id': message_thread_id}
+    return _make_request(token, method_url, params=payload)
+
+def unpin_all_forum_topic_messages(token, chat_id, message_thread_id):
+    method_url = r'unpinAllForumTopicMessages'
+    payload = {'chat_id': chat_id, 'message_thread_id': message_thread_id}
+    return _make_request(token, method_url, params=payload)
+
+def get_forum_topic_icon_stickers(token):
+    method_url = r'getForumTopicIconStickers'
+    return _make_request(token, method_url)
 
 def stop_poll(token, chat_id, message_id, reply_markup=None):
     method_url = r'stopPoll'
@@ -1652,6 +1815,31 @@ def stop_poll(token, chat_id, message_id, reply_markup=None):
         payload['reply_markup'] = _convert_markup(reply_markup)
     return _make_request(token, method_url, params=payload)
 
+def edit_general_forum_topic(token, chat_id, name):
+    method_url = r'editGeneralForumTopic'
+    payload = {'chat_id': chat_id, 'name': name}
+    return _make_request(token, method_url, params=payload)
+
+def close_general_forum_topic(token, chat_id):
+    method_url = r'closeGeneralForumTopic'
+    payload = {'chat_id': chat_id}
+    return _make_request(token, method_url, params=payload)
+
+def reopen_general_forum_topic(token, chat_id):
+    method_url = r'reopenGeneralForumTopic'
+    payload = {'chat_id': chat_id}
+    return _make_request(token, method_url, params=payload)
+
+def hide_general_forum_topic(token, chat_id):
+    method_url = r'hideGeneralForumTopic'
+    payload = {'chat_id': chat_id}
+    return _make_request(token, method_url, params=payload)
+
+def unhide_general_forum_topic(token, chat_id):
+    method_url = r'unhideGeneralForumTopic'
+    payload = {'chat_id': chat_id}
+    return _make_request(token, method_url, params=payload)
+
 
 def _convert_list_json_serializable(results):
     ret = ''
@@ -1735,7 +1923,8 @@ class ApiException(Exception):
         super(ApiException, self).__init__("A request to the Telegram API was unsuccessful. {0}".format(msg))
         self.function_name = function_name
         self.result = result
-    
+
+
 class ApiHTTPException(ApiException):
     """
     This class represents an Exception thrown when a call to the 
@@ -1747,7 +1936,8 @@ class ApiHTTPException(ApiException):
             .format(result.status_code, result.reason, result.text.encode('utf8')),
             function_name,
             result)
-    
+
+
 class ApiInvalidJSONException(ApiException):
     """
     This class represents an Exception thrown when a call to the 
@@ -1759,7 +1949,8 @@ class ApiInvalidJSONException(ApiException):
             .format(result.text.encode('utf8')),
             function_name,
             result)
-    
+
+
 class ApiTelegramException(ApiException):
     """
     This class represents an Exception thrown when a Telegram API returns error code.
@@ -1773,4 +1964,3 @@ class ApiTelegramException(ApiException):
         self.result_json = result_json
         self.error_code = result_json['error_code']
         self.description = result_json['description']
-        

telebot/asyncio_filters.py

@@ -10,8 +10,23 @@ 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
+
     async def check(self, message):
         """
         Perform a check.
@@ -21,13 +36,27 @@ 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
+
     async def check(self, message, text):
         """
         Perform a check.
@@ -39,7 +68,26 @@ 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
+    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,
@@ -48,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)))
@@ -79,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):
@@ -127,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:
@@ -149,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):
@@ -171,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)
 
 
@@ -186,13 +266,21 @@ 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
 
 
@@ -200,29 +288,41 @@ 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):
-        return message.forward_from_chat is not None
+        """
+        :meta private:
+        """
+        return message.forward_date is not None
 
 
 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
 
 
@@ -230,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:
@@ -248,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'
@@ -258,6 +366,12 @@ 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')
         result = await self._bot.get_chat_member(message.chat.id, message.from_user.id)
         return result.status in ['creator', 'administrator']
 
@@ -266,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):
@@ -276,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
@@ -299,8 +419,8 @@ class StateFilter(AdvancedCustomFilter):
         elif isinstance(text, State):
             text = text.name
 
-        if message.chat.type == 'group':
-            group_state = await self.bot.current_states.get_state(user_id, chat_id)
+        if message.chat.type in ['group', 'supergroup']:
+            group_state = await self.bot.current_states.get_state(chat_id, user_id)
             if group_state == text:
                 return True
             elif type(text) is list and group_state in text:
@@ -308,7 +428,7 @@ class StateFilter(AdvancedCustomFilter):
 
 
         else:
-            user_state = await self.bot.current_states.get_state(user_id, chat_id)
+            user_state = await self.bot.current_states.get_state(chat_id, user_id)
             if user_state == text:
                 return True
             elif type(text) is list and user_state in text:
@@ -319,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()

telebot/asyncio_handler_backends.py

@@ -1,9 +1,43 @@
+"""
+File with all middleware classes, states.
+"""
+
+
 class BaseMiddleware:
     """
     Base class for middleware.
     Your middlewares should be inherited from this class.
+
+    Set update_sensitive=True if you want to get different updates on
+    different functions. For example, if you want to handle pre_process for
+    message update, then you will have to create pre_process_message function, and
+    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']
+            
+            async def pre_process_message(self, message, data):
+                # only message update here
+                pass
+
+            async def post_process_message(self, message, data, exception):
+                pass # only message update here for post_process
+
+            async def pre_process_edited_message(self, message, data):
+                # only edited_message update here
+                pass
+
+            async def post_process_edited_message(self, message, data, exception):
+                pass # only edited_message update here for post_process
     """
 
+    update_sensitive: bool = False
+
     def __init__(self):
         pass
 
@@ -15,6 +49,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
 
@@ -23,12 +65,21 @@ 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):
                 # change value of that variable
                 value.name = ':'.join((cls.__name__, name))
+                value.group = cls
 
 
 class SkipHandler:
@@ -43,6 +94,7 @@ class SkipHandler:
     def __init__(self) -> None:
         pass
 
+
 class CancelUpdate:
     """
     Class for canceling updates.
@@ -53,4 +105,27 @@ class CancelUpdate:
     """
 
     def __init__(self) -> None:
-        pass
+        pass
+
+
+class ContinueHandling:
+    """
+    Class for continue updates in handlers.
+    Just return instance of this class 
+    in handlers to continue process.
+    
+    .. code-block:: python3
+        :caption: Example of using ContinueHandling
+
+        @bot.message_handler(commands=['start'])
+        async def start(message):
+            await bot.send_message(message.chat.id, 'Hello World!')
+            return ContinueHandling()
+        
+        @bot.message_handler(commands=['start'])
+        async def start2(message):
+            await bot.send_message(message.chat.id, 'Hello World2!')
+   
+    """
+    def __init__(self) -> None:
+        pass

telebot/asyncio_helper.py

@@ -1,5 +1,7 @@
 import asyncio # for future uses
+import ssl
 import aiohttp
+import certifi
 from telebot import types
 
 try:
@@ -11,35 +13,39 @@ API_URL = 'https://api.telegram.org/bot{0}/{1}'
 
 from datetime import datetime
 
-import telebot
-from telebot import util, logger
+from telebot import util
+import logging
 
+logger = logging.getLogger('TeleBot')
 
 proxy = None
 session = None
 
 FILE_URL = None
 
-CONNECT_TIMEOUT = 15
-READ_TIMEOUT = 30
-
-LONG_POLLING_TIMEOUT = 10 # Should be positive, short polling should be used for testing purposes only (https://core.telegram.org/bots/api#getupdates)
-REQUEST_TIMEOUT = 10
+REQUEST_TIMEOUT = 300
 MAX_RETRIES = 3
-logger = telebot.logger
-
 
 REQUEST_LIMIT = 50
 
 class SessionManager:
     def __init__(self) -> None:
-        self.session = aiohttp.ClientSession(connector=aiohttp.TCPConnector(limit=REQUEST_LIMIT))
+        self.session = None
+        self.ssl_context = ssl.create_default_context(cafile=certifi.where())
+
 
     async def create_session(self):
-        self.session = aiohttp.ClientSession(connector=aiohttp.TCPConnector(limit=REQUEST_LIMIT))
+        self.session = aiohttp.ClientSession(connector=aiohttp.TCPConnector(
+            limit=REQUEST_LIMIT,
+            ssl_context=self.ssl_context
+        ))
         return self.session
 
     async def get_session(self):
+        if self.session is None:
+            self.session = await self.create_session()
+            return self.session
+            
         if self.session.closed:
             self.session = await self.create_session()
 
@@ -52,10 +58,29 @@ class SessionManager:
 
 session_manager = SessionManager()
 
-async def _process_request(token, url, method='get', params=None, files=None, request_timeout=None):
-    params = prepare_data(params, files)
-    if request_timeout is None:
-        request_timeout = REQUEST_TIMEOUT
+async def _process_request(token, url, method='get', params=None, files=None, **kwargs):
+    # Let's resolve all timeout parameters.
+    # getUpdates parameter may contain 2 parameters: request_timeout & timeout.
+    # other methods may contain timeout parameter that should be applied to
+    # ClientTimeout only.
+    # timeout should be added to params for getUpdates. All other timeout's should be used
+    # for request timeout.
+    # here we got request_timeout, so this is getUpdates method.
+    if 'request_timeout' in kwargs:
+        request_timeout = kwargs.pop('request_timeout')
+
+    else:
+        # let's check for timeout in params
+        request_timeout = params.pop('timeout', None) if params else None
+        # we will apply default request_timeout if there is no timeout in params
+        # otherwise, we will use timeout parameter applied for payload.
+    
+    request_timeout = REQUEST_TIMEOUT if request_timeout is None else request_timeout
+    
+
+    # Preparing data by adding all parameters and files to FormData
+    params = _prepare_data(params, files)
+
     timeout = aiohttp.ClientTimeout(total=request_timeout)
     got_result = False
     current_try=0
@@ -63,39 +88,33 @@ async def _process_request(token, url, method='get', params=None, files=None, re
     while not got_result and current_try<MAX_RETRIES-1:
         current_try +=1
         try:
-            async with session.request(method=method, url=API_URL.format(token, url), data=params, timeout=timeout) as resp:
+            async with session.request(method=method, url=API_URL.format(token, url), data=params, timeout=timeout, proxy=proxy) as resp:
+                got_result = True
                 logger.debug("Request: method={0} url={1} params={2} files={3} request_timeout={4} current_try={5}".format(method, url, params, files, request_timeout, current_try).replace(token, token.split(':')[0] + ":{TOKEN}"))
+                
                 json_result = await _check_result(url, resp)
                 if json_result:
-                    got_result = True
                     return json_result['result']
         except (ApiTelegramException,ApiInvalidJSONException, ApiHTTPException) as e:
             raise e
         except aiohttp.ClientError as e:
             logger.error('Aiohttp ClientError: {0}'.format(e.__class__.__name__))
         except Exception as e:
-            logger.error(f'Unkown error: {e.__class__.__name__}')
+            logger.error(f'Unknown error: {e.__class__.__name__}')
         if not got_result:
             raise RequestTimeout("Request timeout. Request: method={0} url={1} params={2} files={3} request_timeout={4}".format(method, url, params, files, request_timeout, current_try))
         
-
-
-
-def prepare_file(obj):
+def _prepare_file(obj):
     """
-    returns os.path.basename for a given file
-
-    :param obj:
-    :return:
+    Prepares file for upload.
     """
     name = getattr(obj, 'name', None)
     if name and isinstance(name, str) and name[0] != '<' and name[-1] != '>':
         return os.path.basename(name)
 
-
-def prepare_data(params=None, files=None):
+def _prepare_data(params=None, files=None):
     """
-    prepare data for request.
+    Adds the parameters and files to the request.
 
     :param params:
     :param files:
@@ -106,18 +125,20 @@ def prepare_data(params=None, files=None):
     if params:
         for key, value in params.items():
             data.add_field(key, str(value))
-
     if files:
         for key, f in files.items():
             if isinstance(f, tuple):
                 if len(f) == 2:
-                    filename, fileobj = f
+                    file_name, file = f
                 else:
                     raise ValueError('Tuple must have exactly 2 elements: filename, fileobj')
+            elif isinstance(f, types.InputFile):
+                file_name = f.file_name
+                file = f.file
             else:
-                filename, fileobj = prepare_file(f) or key, f
+                file_name, file = _prepare_file(f) or key, f
 
-            data.add_field(key, fileobj, filename=filename)
+            data.add_field(key, file, filename=file_name)
 
     return data
 
@@ -150,29 +171,27 @@ async def get_file(token, file_id):
 
 async def get_file_url(token, file_id):
     if FILE_URL is None:
-        return "https://api.telegram.org/file/bot{0}/{1}".format(token, get_file(token, file_id)['file_path'])
+        return "https://api.telegram.org/file/bot{0}/{1}".format(token, (await get_file(token, file_id))['file_path'])
     else:
         # noinspection PyUnresolvedReferences
-        return FILE_URL.format(token, get_file(token, file_id)['file_path'])
+        return FILE_URL.format(token, (await get_file(token, file_id))['file_path'])
 
 
 async def download_file(token, file_path):
     if FILE_URL is None:
         url =  "https://api.telegram.org/file/bot{0}/{1}".format(token, file_path)
-    else:
-        # noinspection PyUnresolvedReferences
-        url =  FILE_URL.format(token, file_path)
-    async with await session_manager.get_session() as session:
-        async with session.get(url, proxy=proxy) as response:
-            result = await response.read()
-            if response.status != 200:
-                raise ApiHTTPException('Download file', result)
-        
+    else: url =  FILE_URL.format(token, file_path)
+    session = await session_manager.get_session()
+    async with session.get(url, proxy=proxy) as response:
+        if response.status != 200:
+            raise ApiHTTPException('Download file', result)
+        result = await response.read()
+    
     return result
 
 
 async def set_webhook(token, url=None, certificate=None, max_connections=None, allowed_updates=None, ip_address=None,
-                drop_pending_updates = None, timeout=None):
+                drop_pending_updates = None, timeout=None, secret_token=None):
     method_url = r'setWebhook'
     payload = {
         'url': url if url else "",
@@ -190,6 +209,8 @@ async def set_webhook(token, url=None, certificate=None, max_connections=None, a
         payload['drop_pending_updates'] = drop_pending_updates
     if timeout:
         payload['timeout'] = timeout
+    if secret_token:
+        payload['secret_token'] = secret_token
     return await _process_request(token, method_url, params=payload, files=files)
 
 
@@ -218,11 +239,11 @@ async def get_updates(token, offset=None, limit=None,
     params = {}
     if offset:
         params['offset'] = offset
-    elif limit:
+    if limit:
         params['limit'] = limit
-    elif timeout:
+    if timeout:
         params['timeout'] = timeout
-    elif allowed_updates:
+    if allowed_updates:
         params['allowed_updates'] = allowed_updates
     return await _process_request(token, method_name, params=params, request_timeout=request_timeout)
 
@@ -257,23 +278,8 @@ async def send_message(
         token, chat_id, text,
         disable_web_page_preview=None, reply_to_message_id=None, reply_markup=None,
         parse_mode=None, disable_notification=None, timeout=None,
-        entities=None, allow_sending_without_reply=None, protect_content=None):
-    """
-    Use this method to send text messages. On success, the sent Message is returned.
-    :param token:
-    :param chat_id:
-    :param text:
-    :param disable_web_page_preview:
-    :param reply_to_message_id:
-    :param reply_markup:
-    :param parse_mode:
-    :param disable_notification:
-    :param timeout:
-    :param entities:
-    :param allow_sending_without_reply:
-    :param protect_content:
-    :return:
-    """
+        entities=None, allow_sending_without_reply=None, protect_content=None,
+        message_thread_id=None):
     method_name = 'sendMessage'
     params = {'chat_id': str(chat_id), 'text': text}
     if disable_web_page_preview is not None:
@@ -294,6 +300,8 @@ async def send_message(
         params['allow_sending_without_reply'] = allow_sending_without_reply
     if protect_content is not None:
         params['protect_content'] = protect_content
+    if message_thread_id:
+        params['message_thread_id'] = message_thread_id
     
     return await _process_request(token, method_name, params=params)
 
@@ -357,6 +365,12 @@ async def delete_chat_sticker_set(token, chat_id):
     return await _process_request(token, method_url, params=payload)
 
 
+async def answer_web_app_query(token, web_app_query_id, result: types.InlineQueryResultBase):
+    method_url = 'answerWebAppQuery'
+    payload = {'web_app_query_id': web_app_query_id, 'result': result.to_json()}
+    return await _process_request(token, method_url, params=payload, method='post')
+
+
 async def get_chat_member(token, chat_id, user_id):
     method_url = r'getChatMember'
     payload = {'chat_id': chat_id, 'user_id': user_id}
@@ -365,7 +379,8 @@ async def get_chat_member(token, chat_id, user_id):
 
 async def forward_message(
         token, chat_id, from_chat_id, message_id,
-        disable_notification=None, timeout=None, protect_content=None):
+        disable_notification=None, timeout=None, protect_content=None,
+        message_thread_id=None):
     method_url = r'forwardMessage'
     payload = {'chat_id': chat_id, 'from_chat_id': from_chat_id, 'message_id': message_id}
     if disable_notification is not None:
@@ -374,12 +389,14 @@ async def forward_message(
         payload['timeout'] = timeout
     if protect_content is not None:
         payload['protect_content'] = protect_content
+    if message_thread_id:
+        payload['message_thread_id'] = message_thread_id
     return await _process_request(token, method_url, params=payload)
 
 
 async def copy_message(token, chat_id, from_chat_id, message_id, caption=None, parse_mode=None, caption_entities=None,
                  disable_notification=None, reply_to_message_id=None, allow_sending_without_reply=None,
-                 reply_markup=None, timeout=None, protect_content=None):
+                 reply_markup=None, timeout=None, protect_content=None, message_thread_id=None):
     method_url = r'copyMessage'
     payload = {'chat_id': chat_id, 'from_chat_id': from_chat_id, 'message_id': message_id}
     if caption is not None:
@@ -400,13 +417,16 @@ async def copy_message(token, chat_id, from_chat_id, message_id, caption=None, p
         payload['timeout'] = timeout
     if protect_content is not None:
         payload['protect_content'] = protect_content
+    if message_thread_id:
+        payload['message_thread_id'] = message_thread_id
     return await _process_request(token, method_url, params=payload)
 
 
 async def send_dice(
         token, chat_id,
         emoji=None, disable_notification=None, reply_to_message_id=None,
-        reply_markup=None, timeout=None, allow_sending_without_reply=None, protect_content=None):
+        reply_markup=None, timeout=None, allow_sending_without_reply=None, protect_content=None,
+        message_thread_id=None):
     method_url = r'sendDice'
     payload = {'chat_id': chat_id}
     if emoji:
@@ -423,6 +443,8 @@ async def send_dice(
         payload['allow_sending_without_reply'] = allow_sending_without_reply
     if protect_content is not None:
         payload['protect_content'] = protect_content
+    if message_thread_id:
+        payload['message_thread_id'] = message_thread_id
     return await _process_request(token, method_url, params=payload)
 
 
@@ -430,7 +452,8 @@ async def send_photo(
         token, chat_id, photo,
         caption=None, reply_to_message_id=None, reply_markup=None,
         parse_mode=None, disable_notification=None, timeout=None,
-        caption_entities=None, allow_sending_without_reply=None, protect_content=None):
+        caption_entities=None, allow_sending_without_reply=None, protect_content=None,
+        message_thread_id=None, has_spoiler=None):
     method_url = r'sendPhoto'
     payload = {'chat_id': chat_id}
     files = None
@@ -458,13 +481,17 @@ async def send_photo(
         payload['allow_sending_without_reply'] = allow_sending_without_reply
     if protect_content is not None:
         payload['protect_content'] = protect_content
+    if message_thread_id:
+        payload['message_thread_id'] = message_thread_id
+    if has_spoiler is not None:
+        payload['has_spoiler'] = has_spoiler
     return await _process_request(token, method_url, params=payload, files=files, method='post')
 
 
 async def send_media_group(
         token, chat_id, media,
         disable_notification=None, reply_to_message_id=None,
-        timeout=None, allow_sending_without_reply=None, protect_content=None):
+        timeout=None, allow_sending_without_reply=None, protect_content=None, message_thread_id=None):
     method_url = r'sendMediaGroup'
     media_json, files = await convert_input_media_array(media)
     payload = {'chat_id': chat_id, 'media': media_json}
@@ -478,6 +505,8 @@ async def send_media_group(
         payload['allow_sending_without_reply'] = allow_sending_without_reply
     if protect_content is not None:
         payload['protect_content'] = protect_content
+    if message_thread_id:
+        payload['message_thread_id'] = message_thread_id
     return await _process_request(
         token, method_url, params=payload,
         method='post' if files else 'get',
@@ -489,7 +518,7 @@ async def send_location(
         live_period=None, reply_to_message_id=None, 
         reply_markup=None, disable_notification=None, 
         timeout=None, horizontal_accuracy=None, heading=None,
-        proximity_alert_radius=None, allow_sending_without_reply=None, protect_content=None):
+        proximity_alert_radius=None, allow_sending_without_reply=None, protect_content=None, message_thread_id=None):
     method_url = r'sendLocation'
     payload = {'chat_id': chat_id, 'latitude': latitude, 'longitude': longitude}
     if live_period:
@@ -512,6 +541,8 @@ async def send_location(
         payload['timeout'] = timeout
     if protect_content is not None:
         payload['protect_content'] = protect_content
+    if message_thread_id:
+        payload['message_thread_id'] = message_thread_id
     return await _process_request(token, method_url, params=payload)
 
 
@@ -563,7 +594,7 @@ async def send_venue(
         foursquare_id=None, foursquare_type=None, disable_notification=None,
         reply_to_message_id=None, reply_markup=None, timeout=None,
         allow_sending_without_reply=None, google_place_id=None,
-        google_place_type=None, protect_content=None):
+        google_place_type=None, protect_content=None, message_thread_id=None):
     method_url = r'sendVenue'
     payload = {'chat_id': chat_id, 'latitude': latitude, 'longitude': longitude, 'title': title, 'address': address}
     if foursquare_id:
@@ -586,13 +617,15 @@ async def send_venue(
         payload['google_place_type'] = google_place_type
     if protect_content is not None:
         payload['protect_content'] = protect_content
+    if message_thread_id:
+        payload['message_thread_id'] = message_thread_id
     return await _process_request(token, method_url, params=payload)
 
 
 async def send_contact(
         token, chat_id, phone_number, first_name, last_name=None, vcard=None,
         disable_notification=None, reply_to_message_id=None, reply_markup=None, timeout=None,
-        allow_sending_without_reply=None, protect_content=None):
+        allow_sending_without_reply=None, protect_content=None, message_thread_id=None):
     method_url = r'sendContact'
     payload = {'chat_id': chat_id, 'phone_number': phone_number, 'first_name': first_name}
     if last_name:
@@ -611,21 +644,25 @@ async def send_contact(
         payload['allow_sending_without_reply'] = allow_sending_without_reply
     if protect_content is not None:
         payload['protect_content'] = protect_content
+    if message_thread_id:
+        payload['message_thread_id'] = message_thread_id
     return await _process_request(token, method_url, params=payload)
 
 
-async def send_chat_action(token, chat_id, action, timeout=None):
+async def send_chat_action(token, chat_id, action, timeout=None, message_thread_id=None):
     method_url = r'sendChatAction'
     payload = {'chat_id': chat_id, 'action': action}
     if timeout:
         payload['timeout'] = timeout
+    if message_thread_id:
+        payload['message_thread_id'] = message_thread_id
     return await _process_request(token, method_url, params=payload)
 
 
 async def send_video(token, chat_id, data, duration=None, caption=None, reply_to_message_id=None, reply_markup=None,
                parse_mode=None, supports_streaming=None, disable_notification=None, timeout=None, 
                thumb=None, width=None, height=None, caption_entities=None, allow_sending_without_reply=None,
-               protect_content=None):
+               protect_content=None, message_thread_id=None, has_spoiler=None):
     method_url = r'sendVideo'
     payload = {'chat_id': chat_id}
     files = None
@@ -667,13 +704,18 @@ async def send_video(token, chat_id, data, duration=None, caption=None, reply_to
         payload['allow_sending_without_reply'] = allow_sending_without_reply
     if protect_content is not None:
         payload['protect_content'] = protect_content
+    if message_thread_id:
+        payload['message_thread_id'] = message_thread_id
+    if has_spoiler is not None:
+        payload['has_spoiler'] = has_spoiler
     return await _process_request(token, method_url, params=payload, files=files, method='post')
 
 
 async def send_animation(
         token, chat_id, data, duration=None, caption=None, reply_to_message_id=None, reply_markup=None,
         parse_mode=None, disable_notification=None, timeout=None, thumb=None, caption_entities=None,
-        allow_sending_without_reply=None, width=None, height=None, protect_content=None):
+        allow_sending_without_reply=None, width=None, height=None, protect_content=None, message_thread_id=None,
+        has_spoiler=None):
     method_url = r'sendAnimation'
     payload = {'chat_id': chat_id}
     files = None
@@ -713,12 +755,16 @@ async def send_animation(
         payload['height'] = height
     if protect_content is not None:
         payload['protect_content'] = protect_content
+    if message_thread_id:
+        payload['message_thread_id'] = message_thread_id
+    if has_spoiler is not None:
+        payload['has_spoiler'] = has_spoiler
     return await _process_request(token, method_url, params=payload, files=files, method='post')
 
 
 async def send_voice(token, chat_id, voice, caption=None, duration=None, reply_to_message_id=None, reply_markup=None,
                parse_mode=None, disable_notification=None, timeout=None, caption_entities=None,
-               allow_sending_without_reply=None, protect_content=None):
+               allow_sending_without_reply=None, protect_content=None, message_thread_id=None):
     method_url = r'sendVoice'
     payload = {'chat_id': chat_id}
     files = None
@@ -746,11 +792,14 @@ async def send_voice(token, chat_id, voice, caption=None, duration=None, reply_t
         payload['allow_sending_without_reply'] = allow_sending_without_reply
     if protect_content is not None:
         payload['protect_content'] = protect_content
+    if message_thread_id:
+        payload['message_thread_id'] = message_thread_id
     return await _process_request(token, method_url, params=payload, files=files, method='post')
 
 
 async def send_video_note(token, chat_id, data, duration=None, length=None, reply_to_message_id=None, reply_markup=None,
-                    disable_notification=None, timeout=None, thumb=None, allow_sending_without_reply=None, protect_content=None):
+                    disable_notification=None, timeout=None, thumb=None, allow_sending_without_reply=None, protect_content=None,
+                    message_thread_id=None):
     method_url = r'sendVideoNote'
     payload = {'chat_id': chat_id}
     files = None
@@ -784,12 +833,14 @@ async def send_video_note(token, chat_id, data, duration=None, length=None, repl
         payload['allow_sending_without_reply'] = allow_sending_without_reply
     if protect_content is not None:
         payload['protect_content'] = protect_content
+    if message_thread_id:
+        payload['message_thread_id'] = message_thread_id
     return await _process_request(token, method_url, params=payload, files=files, method='post')
 
 
 async def send_audio(token, chat_id, audio, caption=None, duration=None, performer=None, title=None, reply_to_message_id=None,
                reply_markup=None, parse_mode=None, disable_notification=None, timeout=None, thumb=None,
-               caption_entities=None, allow_sending_without_reply=None, protect_content=None):
+               caption_entities=None, allow_sending_without_reply=None, protect_content=None, message_thread_id=None):
     method_url = r'sendAudio'
     payload = {'chat_id': chat_id}
     files = None
@@ -829,12 +880,15 @@ async def send_audio(token, chat_id, audio, caption=None, duration=None, perform
         payload['allow_sending_without_reply'] = allow_sending_without_reply
     if protect_content is not None:
         payload['protect_content'] = protect_content
+    if message_thread_id:
+        payload['message_thread_id'] = message_thread_id
     return await _process_request(token, method_url, params=payload, files=files, method='post')
 
 
 async def send_data(token, chat_id, data, data_type, reply_to_message_id=None, reply_markup=None, parse_mode=None,
               disable_notification=None, timeout=None, caption=None, thumb=None, caption_entities=None,
-              allow_sending_without_reply=None, disable_content_type_detection=None, visible_file_name=None, protect_content=None):
+              allow_sending_without_reply=None, disable_content_type_detection=None, visible_file_name=None, protect_content=None,
+              message_thread_id=None):
     method_url = await get_method_by_type(data_type)
     payload = {'chat_id': chat_id}
     files = None
@@ -873,6 +927,8 @@ async def send_data(token, chat_id, data, data_type, reply_to_message_id=None, r
         payload['protect_content'] = protect_content
     if method_url == 'sendDocument' and disable_content_type_detection is not None:
         payload['disable_content_type_detection'] = disable_content_type_detection
+    if message_thread_id:
+        payload['message_thread_id'] = message_thread_id
     return await _process_request(token, method_url, params=payload, files=files, method='post')
 
 
@@ -941,7 +997,7 @@ async def promote_chat_member(
         token, chat_id, user_id, can_change_info=None, can_post_messages=None,
         can_edit_messages=None, can_delete_messages=None, can_invite_users=None,
         can_restrict_members=None, can_pin_messages=None, can_promote_members=None,
-        is_anonymous=None, can_manage_chat=None, can_manage_voice_chats=None):
+        is_anonymous=None, can_manage_chat=None, can_manage_video_chats=None, can_manage_topics=None):
     method_url = 'promoteChatMember'
     payload = {'chat_id': chat_id, 'user_id': user_id}
     if can_change_info is not None:
@@ -964,8 +1020,10 @@ async def promote_chat_member(
         payload['is_anonymous'] = is_anonymous
     if can_manage_chat is not None:
         payload['can_manage_chat'] = can_manage_chat
-    if can_manage_voice_chats is not None:
-        payload['can_manage_voice_chats'] = can_manage_voice_chats
+    if can_manage_video_chats is not None:
+        payload['can_manage_video_chats'] = can_manage_video_chats
+    if can_manage_topics is not None:
+        payload['can_manage_topics'] = can_manage_topics
     return await _process_request(token, method_url, params=payload, method='post')
 
 
@@ -1106,6 +1164,42 @@ async def get_my_commands(token, scope=None, language_code=None):
         payload['language_code'] = language_code
     return await _process_request(token, method_url, params=payload)
 
+async def set_chat_menu_button(token, chat_id=None, menu_button=None):
+    method_url = r'setChatMenuButton'
+    payload = {}
+    if chat_id:
+        payload['chat_id'] = chat_id
+    if menu_button:
+        payload['menu_button'] = menu_button.to_json()
+
+    return await _process_request(token, method_url, params=payload, method='post')
+
+async def get_chat_menu_button(token, chat_id=None):
+    method_url = r'getChatMenuButton'
+    payload = {}
+    if chat_id:
+        payload['chat_id'] = chat_id
+
+    return await _process_request(token, method_url, params=payload, method='post')
+
+
+async def set_my_default_administrator_rights(token, rights=None, for_channels=None):
+    method_url = r'setMyDefaultAdministratorRights'
+    payload = {}
+    if rights:
+        payload['rights'] = rights.to_json()
+    if for_channels is not None:
+        payload['for_channels'] = for_channels
+
+    return await _process_request(token, method_url, params=payload, method='post')
+
+async def get_my_default_administrator_rights(token, for_channels=None):
+    method_url = r'getMyDefaultAdministratorRights'
+    payload = {}
+    if for_channels:
+        payload['for_channels'] = for_channels
+
+    return await _process_request(token, method_url, params=payload, method='post')
 
 async def set_my_commands(token, commands, scope=None, language_code=None):
     method_url = r'setMyCommands'
@@ -1241,7 +1335,7 @@ async def delete_message(token, chat_id, message_id, timeout=None):
 async def send_game(
         token, chat_id, game_short_name,
         disable_notification=None, reply_to_message_id=None, reply_markup=None, timeout=None,
-        allow_sending_without_reply=None, protect_content=None):
+        allow_sending_without_reply=None, protect_content=None, message_thread_id=None):
     method_url = r'sendGame'
     payload = {'chat_id': chat_id, 'game_short_name': game_short_name}
     if disable_notification is not None:
@@ -1256,6 +1350,8 @@ async def send_game(
         payload['allow_sending_without_reply'] = allow_sending_without_reply
     if protect_content is not None:
         payload['protect_content'] = protect_content
+    if message_thread_id:
+        payload['message_thread_id'] = message_thread_id
     return await _process_request(token, method_url, params=payload)
 
 
@@ -1320,7 +1416,8 @@ async def send_invoice(
         need_name=None, need_phone_number=None, need_email=None, need_shipping_address=None,
         send_phone_number_to_provider = None, send_email_to_provider = None, is_flexible=None,
         disable_notification=None, reply_to_message_id=None, reply_markup=None, provider_data=None,
-        timeout=None, allow_sending_without_reply=None, max_tip_amount=None, suggested_tip_amounts=None, protect_content=None):
+        timeout=None, allow_sending_without_reply=None, max_tip_amount=None, suggested_tip_amounts=None, protect_content=None,
+        message_thread_id=None):
     """
     Use this method to send invoices. On success, the sent Message is returned.
     :param token: Bot's token (you don't need to fill this)
@@ -1401,6 +1498,8 @@ async def send_invoice(
         payload['suggested_tip_amounts'] = json.dumps(suggested_tip_amounts)
     if protect_content is not None:
         payload['protect_content'] = protect_content
+    if message_thread_id:
+        payload['message_thread_id'] = message_thread_id
     return await _process_request(token, method_url, params=payload)
 
 
@@ -1488,6 +1587,9 @@ async def get_sticker_set(token, name):
     method_url = 'getStickerSet'
     return await _process_request(token, method_url, params={'name': name})
 
+async def get_custom_emoji_stickers(token, custom_emoji_ids):
+    method_url = r'getCustomEmojiStickers'
+    return await _process_request(token, method_url, params={'custom_emoji_ids': custom_emoji_ids})
 
 async def upload_sticker_file(token, user_id, png_sticker):
     method_url = 'uploadStickerFile'
@@ -1498,10 +1600,9 @@ async def upload_sticker_file(token, user_id, png_sticker):
 
 async def create_new_sticker_set(
         token, user_id, name, title, emojis, png_sticker, tgs_sticker,
-        contains_masks=None, mask_position=None, webm_sticker=None):
+        mask_position=None, webm_sticker=None, sticker_type=None):
     method_url = 'createNewStickerSet'
     payload = {'user_id': user_id, 'name': name, 'title': title, 'emojis': emojis}
-    stype = None
     if png_sticker:
         stype = 'png_sticker'
     elif webm_sticker:
@@ -1514,19 +1615,18 @@ async def create_new_sticker_set(
         files = {stype: sticker}
     else:
         payload[stype] = sticker
-    if contains_masks is not None:
-        payload['contains_masks'] = contains_masks
     if mask_position:
         payload['mask_position'] = mask_position.to_json()
     if webm_sticker:
         payload['webm_sticker'] = webm_sticker
+    if sticker_type:
+        payload['sticker_type'] = sticker_type
     return await _process_request(token, method_url, params=payload, files=files, method='post')
 
 
 async def add_sticker_to_set(token, user_id, name, emojis, png_sticker, tgs_sticker, mask_position, webm_sticker):
     method_url = 'addStickerToSet'
     payload = {'user_id': user_id, 'name': name, 'emojis': emojis}
-    stype = None
     if png_sticker:
         stype = 'png_sticker'
     elif webm_sticker:
@@ -1560,6 +1660,47 @@ async def delete_sticker_from_set(token, sticker):
     return await _process_request(token, method_url, params=payload, method='post')
 
 
+
+async def create_invoice_link(token, title, description, payload, provider_token,
+            currency, prices, max_tip_amount=None, suggested_tip_amounts=None, provider_data=None,
+            photo_url=None, photo_size=None, photo_width=None, photo_height=None, need_name=None, need_phone_number=None,
+            need_email=None, need_shipping_address=None, send_phone_number_to_provider=None,
+            send_email_to_provider=None, is_flexible=None):
+    method_url = r'createInvoiceLink'
+    payload = {'title': title, 'description': description, 'payload': payload, 'provider_token': provider_token,
+                'currency': currency, 'prices': await _convert_list_json_serializable(prices)}
+    if max_tip_amount:
+        payload['max_tip_amount'] = max_tip_amount
+    if suggested_tip_amounts:
+        payload['suggested_tip_amounts'] = json.dumps(suggested_tip_amounts)
+    if provider_data:
+        payload['provider_data'] = provider_data
+    if photo_url:
+        payload['photo_url'] = photo_url
+    if photo_size:
+        payload['photo_size'] = photo_size
+    if photo_width:
+        payload['photo_width'] = photo_width
+    if photo_height:
+        payload['photo_height'] = photo_height
+    if need_name is not None:
+        payload['need_name'] = need_name
+    if need_phone_number is not None:
+        payload['need_phone_number'] = need_phone_number
+    if need_email is not None:
+        payload['need_email'] = need_email
+    if need_shipping_address is not None:
+        payload['need_shipping_address'] = need_shipping_address
+    if send_phone_number_to_provider is not None:
+        payload['send_phone_number_to_provider'] = send_phone_number_to_provider
+    if send_email_to_provider is not None:
+        payload['send_email_to_provider'] = send_email_to_provider
+    if is_flexible is not None:
+        payload['is_flexible'] = is_flexible
+    return await _process_request(token, method_url, params=payload, method='post')
+
+
+
 # noinspection PyShadowingBuiltins
 async def send_poll(
         token, chat_id,
@@ -1567,7 +1708,7 @@ async def send_poll(
         is_anonymous = None, type = None, allows_multiple_answers = None, correct_option_id = None,
         explanation = None, explanation_parse_mode=None, open_period = None, close_date = None, is_closed = None,
         disable_notification=False, reply_to_message_id=None, allow_sending_without_reply=None,
-        reply_markup=None, timeout=None, explanation_entities=None, protect_content=None):
+        reply_markup=None, timeout=None, explanation_entities=None, protect_content=None, message_thread_id=None):
     method_url = r'sendPoll'
     payload = {
         'chat_id': str(chat_id),
@@ -1611,6 +1752,76 @@ async def send_poll(
             types.MessageEntity.to_list_of_dicts(explanation_entities))
     if protect_content:
         payload['protect_content'] = protect_content
+    if message_thread_id:
+        payload['message_thread_id'] = message_thread_id
+    return await _process_request(token, method_url, params=payload)
+
+
+async def create_forum_topic(token, chat_id, name, icon_color=None, icon_custom_emoji_id=None):
+    method_url = r'createForumTopic'
+    payload = {'chat_id': chat_id, 'name': name}
+    if icon_color:
+        payload['icon_color'] = icon_color
+    if icon_custom_emoji_id:
+        payload['icon_custom_emoji_id'] = icon_custom_emoji_id
+    return await _process_request(token, method_url, params=payload)
+
+async def edit_forum_topic(token, chat_id, message_thread_id, name=None, icon_custom_emoji_id=None):
+    method_url = r'editForumTopic'
+    payload = {'chat_id': chat_id, 'message_thread_id': message_thread_id}
+    if name is not None:
+        payload['name'] = name
+    if icon_custom_emoji_id is not None:
+        payload['icon_custom_emoji_id'] = icon_custom_emoji_id
+    return await _process_request(token, method_url, params=payload)
+
+async def close_forum_topic(token, chat_id, message_thread_id):
+    method_url = r'closeForumTopic'
+    payload = {'chat_id': chat_id, 'message_thread_id': message_thread_id}
+    return await _process_request(token, method_url, params=payload)
+
+async def reopen_forum_topic(token, chat_id, message_thread_id):
+    method_url = r'reopenForumTopic'
+    payload = {'chat_id': chat_id, 'message_thread_id': message_thread_id}
+    return await _process_request(token, method_url, params=payload)
+
+async def delete_forum_topic(token, chat_id, message_thread_id):
+    method_url = r'deleteForumTopic'
+    payload = {'chat_id': chat_id, 'message_thread_id': message_thread_id}
+    return await _process_request(token, method_url, params=payload)
+
+async def unpin_all_forum_topic_messages(token, chat_id, message_thread_id):
+    method_url = r'unpinAllForumTopicMessages'
+    payload = {'chat_id': chat_id, 'message_thread_id': message_thread_id}
+    return await _process_request(token, method_url, params=payload)
+
+async def get_forum_topic_icon_stickers(token):
+    method_url = r'getForumTopicIconStickers'
+    return await _process_request(token, method_url)
+
+async def edit_general_forum_topic(token, chat_id, name):
+    method_url = r'editGeneralForumTopic'
+    payload = {'chat_id': chat_id, 'name': name}
+    return await _process_request(token, method_url, params=payload)
+
+async def close_general_forum_topic(token, chat_id):
+    method_url = r'closeGeneralForumTopic'
+    payload = {'chat_id': chat_id}
+    return await _process_request(token, method_url, params=payload)
+
+async def reopen_general_forum_topic(token, chat_id):
+    method_url = r'reopenGeneralForumTopic'
+    payload = {'chat_id': chat_id}
+    return await _process_request(token, method_url, params=payload)
+
+async def hide_general_forum_topic(token, chat_id):
+    method_url = r'hideGeneralForumTopic'
+    payload = {'chat_id': chat_id}
+    return await _process_request(token, method_url, params=payload)
+
+async def unhide_general_forum_topic(token, chat_id):
+    method_url = r'unhideGeneralForumTopic'
+    payload = {'chat_id': chat_id}
     return await _process_request(token, method_url, params=payload)
 
 async def _convert_list_json_serializable(results):
@@ -1734,9 +1945,10 @@ class ApiTelegramException(ApiException):
             result)
         self.result_json = result_json
         self.error_code = result_json['error_code']
+        self.description = result_json['description']
 
 class RequestTimeout(Exception):
     """
     This class represents a request timeout.
     """
-    pass
+    pass

telebot/asyncio_storage/memory_storage.py

@@ -8,7 +8,7 @@ class StateMemoryStorage(StateStorageBase):
     
     
     async def set_state(self, chat_id, user_id, state):
-        if isinstance(state, object):
+        if hasattr(state, 'name'):
             state = state.name
         if chat_id in self.data:
             if user_id in self.data[chat_id]:

telebot/asyncio_storage/pickle_storage.py

@@ -1,7 +1,6 @@
 from telebot.asyncio_storage.base_storage import StateStorageBase, StateContext
 import os
 
-
 import pickle
 
 
@@ -47,14 +46,16 @@ class StatePickleStorage(StateStorageBase):
         file.close()
 
     async def set_state(self, chat_id, user_id, state):
-        if isinstance(state, object):
+        if hasattr(state, 'name'):
             state = state.name
         if chat_id in self.data:
             if user_id in self.data[chat_id]:
                 self.data[chat_id][user_id]['state'] = state
+                self.update_data()
                 return True
             else:
                 self.data[chat_id][user_id] = {'state': state, 'data': {}}
+                self.update_data()
                 return True
         self.data[chat_id] = {user_id: {'state': state, 'data': {}}}
         self.update_data()

telebot/asyncio_storage/redis_storage.py

@@ -1,11 +1,15 @@
 from telebot.asyncio_storage.base_storage import StateStorageBase, StateContext
 import json
 
+
 redis_installed = True
 try:
     import aioredis
-except:
-    redis_installed = False
+except ImportError:
+    try:
+        from redis import asyncio as aioredis
+    except ImportError:
+        redis_installed = False
 
 
 class StateRedisStorage(StateStorageBase):
@@ -34,7 +38,7 @@ class StateRedisStorage(StateStorageBase):
         """
         Function to get record from database.
         It has nothing to do with states.
-        Made for backend compatibility
+        Made for backward compatibility
         """
         result = await self.redis.get(self.prefix+str(key))
         if result: return json.loads(result)
@@ -44,7 +48,7 @@ class StateRedisStorage(StateStorageBase):
         """
         Function to set record to database.
         It has nothing to do with states.
-        Made for backend compatibility
+        Made for backward compatibility
         """
     
         await self.redis.set(self.prefix+str(key), json.dumps(value))
@@ -54,7 +58,7 @@ class StateRedisStorage(StateStorageBase):
         """
         Function to delete record from database.
         It has nothing to do with states.
-        Made for backend compatibility
+        Made for backward compatibility
         """
         await self.redis.delete(self.prefix+str(key))
         return True
@@ -65,7 +69,7 @@ class StateRedisStorage(StateStorageBase):
         """
         response = await self.get_record(chat_id)
         user_id = str(user_id)
-        if isinstance(state, object):
+        if hasattr(state, 'name'):
             state = state.name
         if response:
             if user_id in response:

telebot/callback_data.py

@@ -1,18 +1,55 @@
+"""
+Callback data factory's file.
+"""
+
+"""
+Copyright (c) 2017-2018 Alex Root Junior
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this
+software and associated documentation files (the "Software"), to deal in the Software
+without restriction, including without limitation the rights to use, copy, modify,
+merge, publish, distribute, sublicense, and/or sell copies of the Software,
+and to permit persons to whom the Software is furnished to do so, subject to the
+following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies
+or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
+PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
+BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
+OR OTHER DEALINGS IN THE SOFTWARE.
+
+
+This file was added during the pull request. The maintainers overlooked that it was copied
+"as is" from another project and they do not consider it as a right way to develop a project.
+However, due to backward compatibility we had to leave this file in the project with the above
+copyright added, as it is required by the original project license.
+"""
+
 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:
@@ -108,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
         """
 

telebot/custom_filters.py

@@ -12,8 +12,23 @@ 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
+
     def check(self, message):
         """
         Perform a check.
@@ -23,13 +38,27 @@ 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
+
     def check(self, message, text):
         """
         Perform a check.
@@ -42,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,
@@ -50,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')
@@ -81,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
@@ -134,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:
@@ -156,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):
@@ -178,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)
 
 
@@ -193,13 +274,21 @@ 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
 
 
@@ -207,29 +296,41 @@ 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):
-        return message.forward_from_chat is not None
+        """
+        :meta private:
+        """
+        return message.forward_date is not None
 
 
 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
 
 
@@ -237,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:
@@ -255,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'
@@ -265,6 +374,11 @@ 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']
 
 
@@ -272,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):
@@ -282,6 +399,9 @@ class StateFilter(AdvancedCustomFilter):
     key = 'state'
 
     def check(self, message, text):
+        """
+        :meta private:
+        """
         if text == '*': return True
         
         # needs to work with callbackquery
@@ -307,8 +427,8 @@ class StateFilter(AdvancedCustomFilter):
         elif isinstance(text, State):
             text = text.name
         
-        if message.chat.type == 'group':
-            group_state = self.bot.current_states.get_state(user_id, chat_id)
+        if message.chat.type in ['group', 'supergroup']:
+            group_state = self.bot.current_states.get_state(chat_id, user_id)
             if group_state == text:
                 return True
             elif type(text) is list and group_state in text:
@@ -316,7 +436,7 @@ class StateFilter(AdvancedCustomFilter):
 
 
         else:
-            user_state = self.bot.current_states.get_state(user_id, chat_id)
+            user_state = self.bot.current_states.get_state(chat_id, user_id)
             if user_state == text:
                 return True
             elif type(text) is list and user_state in text:
@@ -327,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()

telebot/ext/__init__.py

@@ -0,0 +1,3 @@
+"""
+A folder with asynchronous and synchronous extensions.
+"""

telebot/ext/aio/__init__.py

@@ -0,0 +1,10 @@
+"""
+A folder with all the async extensions.
+"""
+
+from .webhooks import AsyncWebhookListener
+
+
+__all__ = [
+    "AsyncWebhookListener"
+]

telebot/ext/aio/webhooks.py

@@ -0,0 +1,123 @@
+"""
+This file is used by AsyncTeleBot.run_webhooks() function.
+
+Fastapi and starlette(0.20.2+) libraries are required to run this script.
+"""
+
+# modules required for running this script
+fastapi_installed = True
+try:
+    import fastapi
+    from fastapi.responses import JSONResponse
+    from fastapi.requests import Request
+    from uvicorn import Server, Config
+except ImportError:
+    fastapi_installed = False
+
+import asyncio
+
+
+from telebot.types import Update
+
+
+from typing import Optional
+
+
+class AsyncWebhookListener:
+    def __init__(self, bot, 
+                secret_token: str,
+                host: Optional[str]="127.0.0.1", 
+                port: Optional[int]=443,
+                ssl_context: Optional[tuple]=None,
+                url_path: Optional[str]=None,
+                ) -> None:
+        """
+        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 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
+
+        :raises ImportError: If FastAPI or uvicorn is not installed.
+        :raises ImportError: If Starlette version is too old.
+
+        :return: None
+        """
+        self._check_dependencies()
+
+        self.app = fastapi.FastAPI()
+        self._secret_token = secret_token
+        self._bot = bot
+        self._port = port
+        self._host = host
+        self._ssl_context = ssl_context
+        self._url_path = url_path
+        self._prepare_endpoint_urls()
+
+
+    def _check_dependencies(self):
+        if not fastapi_installed:
+            raise ImportError('Fastapi or uvicorn is not installed. Please install it via pip.')
+            
+        import starlette
+        if starlette.__version__ < '0.20.2':
+            raise ImportError('Starlette version is too old. Please upgrade it: `pip3 install starlette -U`')
+        return
+
+    
+    def _prepare_endpoint_urls(self):
+        self.app.add_api_route(endpoint=self.process_update,path= self._url_path, methods=["POST"])
+
+
+    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:
+            # secret token didn't match
+            return JSONResponse(status_code=403, content={"error": "Forbidden"})
+        if request.headers.get('content-type') == 'application/json':
+            json_string = update
+            asyncio.create_task(self._bot.process_new_updates([Update.de_json(json_string)]))
+            return JSONResponse('', status_code=200)
+
+        return JSONResponse(status_code=403, content={"error": "Forbidden"})
+
+
+    async def run_app(self):
+        """
+        Run app with the given parameters to init.
+        Not supposed to be used manually by user.
+
+        :return: None
+        """
+
+        config = Config(app=self.app,
+            host=self._host,
+            port=self._port,
+            ssl_certfile=self._ssl_context[0],
+            ssl_keyfile=self._ssl_context[1]
+        )
+        server = Server(config)
+        await server.serve()
+        await self._bot.close_session()

telebot/ext/reloader.py

@@ -0,0 +1,31 @@
+
+from watchdog.events import FileSystemEventHandler
+from watchdog.events import FileSystemEvent
+import psutil
+import os
+import sys
+import logging
+
+logger = logging.getLogger('TeleBot')
+
+class EventHandler(FileSystemEventHandler):
+    def on_any_event(self, event: FileSystemEvent):
+        logger.info('* Detected changes in: %s, reloading', (event.src_path))
+        restart_file()
+
+def restart_file():
+    try:
+        p = psutil.Process(os.getpid())
+        for handler in p.open_files() + p.connections():
+            os.close(handler.fd)
+    except OSError:
+        pass
+    except Exception as e:
+        logger.error(e)
+
+    python = sys.executable
+    
+    if os.name == 'nt':
+        os.execv(sys.executable, ['python'] + sys.argv)
+    else:
+        os.execl(python, python, *sys.argv)

telebot/ext/sync/__init__.py

@@ -0,0 +1,10 @@
+"""
+A folder with all the sync extensions.
+"""
+
+from .webhooks import SyncWebhookListener
+
+
+__all__ = [
+    "SyncWebhookListener"
+]

telebot/ext/sync/webhooks.py

@@ -0,0 +1,116 @@
+"""
+This file is used by TeleBot.run_webhooks() function.
+Fastapi is required to run this script.
+"""
+
+# modules required for running this script
+fastapi_installed = True
+
+try:
+    import fastapi
+    from fastapi.responses import JSONResponse
+    from fastapi.requests import Request
+    import uvicorn
+except ImportError:
+    fastapi_installed = False
+
+from telebot.types import Update
+
+from typing import Optional
+
+
+class SyncWebhookListener:
+    def __init__(self, bot, 
+                secret_token: str,
+                host: Optional[str]="127.0.0.1", 
+                port: Optional[int]=443,
+                ssl_context: Optional[tuple]=None,
+                url_path: Optional[str]=None,
+                ) -> None:
+        """
+        Synchronous implementation of webhook listener
+        for synchronous version of telebot.
+        Not supposed to be used manually by user.
+        Use TeleBot.run_webhooks() instead.
+
+        :param bot: TeleBot instance.
+        :type bot: telebot.TeleBot
+
+        :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
+
+        :raises ImportError: If FastAPI or uvicorn is not installed.
+        :raises ImportError: If Starlette version is too old.
+
+        :return: None
+        """
+        self._check_dependencies()
+
+        self.app = fastapi.FastAPI()
+        self._secret_token = secret_token
+        self._bot = bot
+        self._port = port
+        self._host = host
+        self._ssl_context = ssl_context
+        self._url_path = url_path
+        self._prepare_endpoint_urls()
+
+
+    @staticmethod
+    def _check_dependencies():
+        if not fastapi_installed:
+            raise ImportError('Fastapi or uvicorn is not installed. Please install it via pip.')
+            
+        import starlette
+        if starlette.__version__ < '0.20.2':
+            raise ImportError('Starlette version is too old. Please upgrade it: `pip3 install starlette -U`')
+        return
+
+    
+    def _prepare_endpoint_urls(self):
+        self.app.add_api_route(endpoint=self.process_update,path= self._url_path, methods=["POST"])
+
+
+    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:
+            # secret token didn't match
+            return JSONResponse(status_code=403, content={"error": "Forbidden"})
+        if request.headers.get('content-type') == 'application/json':
+            self._bot.process_new_updates([Update.de_json(update)])
+            return JSONResponse('', status_code=200)
+
+        return JSONResponse(status_code=403, content={"error": "Forbidden"})
+
+
+    def run_app(self):
+        """
+        Run app with the given parameters to init.
+        Not supposed to be used manually by user.
+
+        :return: None
+        """
+
+        uvicorn.run(app=self.app,
+            host=self._host,
+            port=self._port,
+            ssl_certfile=self._ssl_context[0],
+            ssl_keyfile=self._ssl_context[1]
+        )

telebot/formatting.py

@@ -0,0 +1,326 @@
+"""
+Markdown & HTML formatting functions.
+
+.. versionadded:: 4.5.1
+"""
+
+import html
+
+import re
+
+from typing import Optional
+
+
+def format_text(*args, separator="\n"):
+    """
+    Formats a list of strings into a single string.
+
+    .. code:: python3
+
+        format_text( # just an example
+            mbold('Hello'),
+            mitalic('World')
+        )
+
+    :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)
+
+
+
+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)
+
+
+def escape_markdown(content: str) -> str:
+    """
+    Escapes Markdown characters in a string of Markdown.
+
+    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)
+    reparse = re.sub(r"\\\\([_*\[\]()~`>\#\+\-=|\.!\{\}])", r"\1", parse)
+    return reparse 
+
+
+def mbold(content: str, escape: Optional[bool]=True) -> str:
+    """
+    Returns a Markdown-formatted bold string.
+
+    :param content: The string to bold.
+    :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: Optional[bool]=True) -> str:
+    """
+    Returns an HTML-formatted bold string.
+
+    :param content: The string to bold.
+    :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 '<b>{}</b>'.format(escape_html(content) if escape else content)
+
+
+def mitalic(content: str, escape: Optional[bool]=True) -> str:
+    """
+    Returns a Markdown-formatted italic string.
+
+    :param content: The string to italicize.
+    :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: Optional[bool]=True) -> str:
+    """
+    Returns an HTML-formatted italic string.
+
+    :param content: The string to italicize.
+    :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 '<i>{}</i>'.format(escape_html(content) if escape else content)
+
+
+def munderline(content: str, escape: Optional[bool]=True) -> str:
+    """
+    Returns a Markdown-formatted underline string.
+
+    :param content: The string to underline.
+    :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: Optional[bool]=True) -> str:
+    """
+    Returns an HTML-formatted underline string.
+
+    :param content: The string to underline.
+    :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 '<u>{}</u>'.format(escape_html(content) if escape else content)
+
+
+def mstrikethrough(content: str, escape: Optional[bool]=True) -> str:
+    """
+    Returns a Markdown-formatted strikethrough string.
+
+    :param content: The string to strikethrough.
+    :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: Optional[bool]=True) -> str:
+    """
+    Returns an HTML-formatted strikethrough string.
+
+    :param content: The string to strikethrough.
+    :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 '<s>{}</s>'.format(escape_html(content) if escape else content)
+
+
+def mspoiler(content: str, escape: Optional[bool]=True) -> str:
+    """
+    Returns a Markdown-formatted spoiler string.
+
+    :param content: The string to spoiler.
+    :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: Optional[bool]=True) -> str:
+    """
+    Returns an HTML-formatted spoiler string.
+
+    :param content: The string to spoiler.
+    :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 '<tg-spoiler>{}</tg-spoiler>'.format(escape_html(content) if escape else content)
+
+
+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.
+    :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: 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.
+    :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 '<a href="{}">{}</a>'.format(escape_html(url), escape_html(content) if escape else content)
+
+
+def mcode(content: str, language: str="", escape: Optional[bool]=True) -> str:
+    """
+    Returns a Markdown-formatted code string.
+
+    :param content: The string to code.
+    :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: Optional[bool]=True) -> str:
+    """
+    Returns an HTML-formatted code string.
+
+    :param content: The string to code.
+    :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 '<code>{}</code>'.format(escape_html(content) if escape else content)
+
+
+def hpre(content: str, escape: Optional[bool]=True, language: str="") -> str:
+    """
+    Returns an HTML-formatted preformatted string.
+
+    :param content: The string to preformatted.
+    :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 '<pre><code class="{}">{}</code></pre>'.format(language, escape_html(content) if escape else content)
+
+
+def hide_link(url: str) -> str:
+    """
+    Hide url of an image.
+
+    :param url: The url of the image.
+    :type url: :obj:`str`
+    
+    :return: The hidden url.
+    :rtype: :obj:`str`
+    """
+    return f'<a href="{url}">&#8288;</a>'

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,27 +161,76 @@ 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:
         return self.name
 
-    
 
 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):
                 # change value of that variable
                 value.name = ':'.join((cls.__name__, name))
+                value.group = cls
 
     
 class BaseMiddleware:
     """
     Base class for middleware.
     Your middlewares should be inherited from this class.
+
+    Set update_sensitive=True if you want to get different updates on
+    different functions. For example, if you want to handle pre_process for
+    message update, then you will have to create pre_process_message function, and
+    so on. Same applies to post_process.
+
+    .. 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
+                self.update_types = ['message', 'edited_message']
+            
+            def pre_process_message(self, message, data):
+                # only message update here
+                pass
+
+            def post_process_message(self, message, data, exception):
+                pass # only message update here for post_process
+
+            def pre_process_edited_message(self, message, data):
+                # only edited_message update here
+                pass
+
+            def post_process_edited_message(self, message, data, exception):
+                pass # only edited_message update here for post_process
     """
 
+    update_sensitive: bool = False
+
     def __init__(self):
         pass
 
@@ -189,10 +249,10 @@ class SkipHandler:
     Update will go to post_process,
     but will skip execution of handler.
     """
-
     def __init__(self) -> None:
         pass
 
+
 class CancelUpdate:
     """
     Class for canceling updates.
@@ -201,6 +261,28 @@ class CancelUpdate:
     Update will skip handler and execution
     of post_process in middlewares.
     """
-
     def __init__(self) -> None:
-        pass
+        pass
+
+
+class ContinueHandling:
+    """
+    Class for continue updates in handlers.
+    Just return instance of this class 
+    in handlers to continue process.
+    
+    .. code-block:: python3
+        :caption: Example of using ContinueHandling
+
+        @bot.message_handler(commands=['start'])
+        def start(message):
+            bot.send_message(message.chat.id, 'Hello World!')
+            return ContinueHandling()
+        
+        @bot.message_handler(commands=['start'])
+        def start2(message):
+            bot.send_message(message.chat.id, 'Hello World2!')
+    
+    """
+    def __init__(self) -> None:
+        pass

telebot/storage/base_storage.py

@@ -41,7 +41,10 @@ class StateStorageBase:
     
     def get_state(self, chat_id, user_id):
         raise NotImplementedError
-        
+
+    def get_interactive_data(self, chat_id, user_id):
+        raise NotImplementedError
+
     def save(self, chat_id, user_id, data):
         raise NotImplementedError
 

telebot/storage/memory_storage.py

@@ -1,14 +1,16 @@
 from telebot.storage.base_storage import StateStorageBase, StateContext
 
+
 class StateMemoryStorage(StateStorageBase):
     def __init__(self) -> None:
+        super().__init__()
         self.data = {}
         #
         # {chat_id: {user_id: {'state': None, 'data': {}}, ...}, ...}
     
     
     def set_state(self, chat_id, user_id, state):
-        if isinstance(state, object):
+        if hasattr(state, 'name'):
             state = state.name
         if chat_id in self.data:
             if user_id in self.data[chat_id]:

telebot/storage/pickle_storage.py

@@ -1,13 +1,12 @@
 from telebot.storage.base_storage import StateStorageBase, StateContext
 import os
 
-
 import pickle
 
 
 class StatePickleStorage(StateStorageBase):
-    # noinspection PyMissingConstructor
     def __init__(self, file_path="./.state-save/states.pkl") -> None:
+        super().__init__()
         self.file_path = file_path
         self.create_dir()
         self.data = self.read()
@@ -53,14 +52,16 @@ class StatePickleStorage(StateStorageBase):
         file.close()
 
     def set_state(self, chat_id, user_id, state):
-        if isinstance(state, object):
+        if hasattr(state, 'name'):
             state = state.name
         if chat_id in self.data:
             if user_id in self.data[chat_id]:
                 self.data[chat_id][user_id]['state'] = state
+                self.update_data()
                 return True
             else:
                 self.data[chat_id][user_id] = {'state': state, 'data': {}}
+                self.update_data()
                 return True
         self.data[chat_id] = {user_id: {'state': state, 'data': {}}}
         self.update_data()

telebot/storage/redis_storage.py

@@ -1,4 +1,3 @@
-from pyclbr import Class
 from telebot.storage.base_storage import StateStorageBase, StateContext
 import json
 
@@ -17,6 +16,7 @@ class StateRedisStorage(StateStorageBase):
     TeleBot(storage=StateRedisStorage())
     """
     def __init__(self, host='localhost', port=6379, db=0, password=None, prefix='telebot_'):
+        super().__init__()
         self.redis = ConnectionPool(host=host, port=port, db=db, password=password)
         #self.con = Redis(connection_pool=self.redis) -> use this when necessary
         #
@@ -29,7 +29,7 @@ class StateRedisStorage(StateStorageBase):
         """
         Function to get record from database.
         It has nothing to do with states.
-        Made for backend compatibility
+        Made for backward compatibility
         """
         connection = Redis(connection_pool=self.redis)
         result = connection.get(self.prefix+str(key))
@@ -41,7 +41,7 @@ class StateRedisStorage(StateStorageBase):
         """
         Function to set record to database.
         It has nothing to do with states.
-        Made for backend compatibility
+        Made for backward compatibility
         """
         connection = Redis(connection_pool=self.redis)
         connection.set(self.prefix+str(key), json.dumps(value))
@@ -52,7 +52,7 @@ class StateRedisStorage(StateStorageBase):
         """
         Function to delete record from database.
         It has nothing to do with states.
-        Made for backend compatibility
+        Made for backward compatibility
         """
         connection = Redis(connection_pool=self.redis)
         connection.delete(self.prefix+str(key))
@@ -65,7 +65,7 @@ class StateRedisStorage(StateStorageBase):
         """
         response = self.get_record(chat_id)
         user_id = str(user_id)
-        if isinstance(state, object):
+        if hasattr(state, 'name'):
             state = state.name
 
         if response:
@@ -177,4 +177,4 @@ class StateRedisStorage(StateStorageBase):
                 response[user_id]['data'] = dict(data, **response[user_id]['data'])
                 self.set_record(chat_id, response)
                 return True
-    
+