python-telegram-bot · Bibo-Joshi · Oct 9, 2021 · Jul 14, 2021 · Aug 11, 2021 · Aug 11, 2021
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -14,7 +14,7 @@ repos:
     hooks:
     -   id: flake8
 -   repo: https://github.com/PyCQA/pylint
-    rev: v2.8.3
+    rev: v2.10.2
     hooks:
     -   id: pylint
         files: ^(telegram|examples)/.*\.py$
@@ -27,12 +27,17 @@ repos:
           - cachetools==4.2.2
           - . # this basically does `pip install -e .`
 -   repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v0.812
+    rev: v0.910
     hooks:
     -   id: mypy
         name: mypy-ptb
         files: ^telegram/.*\.py$
         additional_dependencies:
+          - types-ujson
+          - types-pytz
+          - types-cryptography
+          - types-certifi
+          - types-cachetools
           - certifi
           - tornado>=6.1
           - APScheduler==3.6.3
@@ -51,7 +56,7 @@ repos:
           - cachetools==4.2.2
           - . # this basically does `pip install -e .`
 -   repo: https://github.com/asottile/pyupgrade
-    rev: v2.19.1
+    rev: v2.24.0
     hooks:
     -   id: pyupgrade
         files: ^(telegram|examples|tests)/.*\.py$

diff --git a/docs/source/telegram.ext.dispatcherbuilder.rst b/docs/source/telegram.ext.dispatcherbuilder.rst
@@ -0,0 +1,7 @@
+:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/builders.py
+
+telegram.ext.DispatcherBuilder
+==============================
+
+.. autoclass:: telegram.ext.DispatcherBuilder
+    :members:
diff --git a/docs/source/telegram.ext.rst b/docs/source/telegram.ext.rst
@@ -4,7 +4,9 @@ telegram.ext package
 .. toctree::
 
     telegram.ext.extbot
+    telegram.ext.updaterbuilder
     telegram.ext.updater
+    telegram.ext.dispatcherbuilder
     telegram.ext.dispatcher
     telegram.ext.dispatcherhandlerstop
     telegram.ext.callbackcontext
@@ -60,4 +62,5 @@ utils
 .. toctree::
 
     telegram.ext.utils.promise
+    telegram.ext.utils.stack
     telegram.ext.utils.types
diff --git a/docs/source/telegram.ext.updaterbuilder.rst b/docs/source/telegram.ext.updaterbuilder.rst
@@ -0,0 +1,7 @@
+:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/builders.py
+
+telegram.ext.UpdaterBuilder
+===========================
+
+.. autoclass:: telegram.ext.UpdaterBuilder
+    :members:
diff --git a/docs/source/telegram.ext.utils.stack.rst b/docs/source/telegram.ext.utils.stack.rst
@@ -0,0 +1,8 @@
+:github_url: https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/utils/stack.py
+
+telegram.ext.utils.stack Module
+================================
+
+.. automodule:: telegram.ext.utils.stack
+    :members:
+    :show-inheritance:
diff --git a/examples/arbitrarycallbackdatabot.py b/examples/arbitrarycallbackdatabot.py
@@ -11,38 +11,40 @@
 
 from telegram import InlineKeyboardButton, InlineKeyboardMarkup, Update
 from telegram.ext import (
-    Updater,
     CommandHandler,
     CallbackQueryHandler,
-    CallbackContext,
     InvalidCallbackData,
     PicklePersistence,
+    Updater,
+    CallbackContext,
 )
 
+
+# Enable logging
 logging.basicConfig(
     format='%(asctime)s - %(name)s - %(levelname)s - %(message)s', level=logging.INFO
 )
 logger = logging.getLogger(__name__)
 
 
-def start(update: Update, context: CallbackContext) -> None:
+def start(update: Update, context: CallbackContext.DEFAULT_TYPE) -> None:
     """Sends a message with 5 inline buttons attached."""
     number_list: List[int] = []
     update.message.reply_text('Please choose:', reply_markup=build_keyboard(number_list))
 
 
-def help_command(update: Update, context: CallbackContext) -> None:
+def help_command(update: Update, context: CallbackContext.DEFAULT_TYPE) -> None:
     """Displays info on how to use the bot."""
     update.message.reply_text(
         "Use /start to test this bot. Use /clear to clear the stored data so that you can see "
         "what happens, if the button data is not available. "
     )
 
 
-def clear(update: Update, context: CallbackContext) -> None:
+def clear(update: Update, context: CallbackContext.DEFAULT_TYPE) -> None:
     """Clears the callback data cache"""
-    context.bot.callback_data_cache.clear_callback_data()  # type: ignore[attr-defined]
-    context.bot.callback_data_cache.clear_callback_queries()  # type: ignore[attr-defined]
+    context.bot.callback_data_cache.clear_callback_data()
+    context.bot.callback_data_cache.clear_callback_queries()
     update.effective_message.reply_text('All clear!')
 
 
@@ -53,7 +55,7 @@ def build_keyboard(current_list: List[int]) -> InlineKeyboardMarkup:
     )
 
 
-def list_button(update: Update, context: CallbackContext) -> None:
+def list_button(update: Update, context: CallbackContext.DEFAULT_TYPE) -> None:
     """Parses the CallbackQuery and updates the message text."""
     query = update.callback_query
     query.answer()
@@ -73,7 +75,7 @@ def list_button(update: Update, context: CallbackContext) -> None:
     context.drop_callback_data(query)
 
 
-def handle_invalid_button(update: Update, context: CallbackContext) -> None:
+def handle_invalid_button(update: Update, context: CallbackContext.DEFAULT_TYPE) -> None:
     """Informs the user that the button is no longer available."""
     update.callback_query.answer()
     update.effective_message.edit_text(
@@ -86,7 +88,13 @@ def main() -> None:
     # We use persistence to demonstrate how buttons can still work after the bot was restarted
     persistence = PicklePersistence(filepath='arbitrarycallbackdatabot')
     # Create the Updater and pass it your bot's token.
-    updater = Updater("TOKEN", persistence=persistence, arbitrary_callback_data=True)
+    updater = (
+        Updater.builder()
+        .token("TOKEN")
+        .persistence(persistence)
+        .arbitrary_callback_data(True)
+        .build()
+    )
 
     updater.dispatcher.add_handler(CommandHandler('start', start))
     updater.dispatcher.add_handler(CommandHandler('help', help_command))

diff --git a/examples/chatmemberbot.py b/examples/chatmemberbot.py
@@ -16,13 +16,14 @@
 
 from telegram import Update, Chat, ChatMember, ParseMode, ChatMemberUpdated
 from telegram.ext import (
-    Updater,
     CommandHandler,
-    CallbackContext,
     ChatMemberHandler,
+    Updater,
+    CallbackContext,
 )
 
 # Enable logging
+
 logging.basicConfig(
     format="%(asctime)s - %(name)s - %(levelname)s - %(message)s", level=logging.INFO
 )
@@ -66,7 +67,7 @@ def extract_status_change(
     return was_member, is_member
 
 
-def track_chats(update: Update, context: CallbackContext) -> None:
+def track_chats(update: Update, context: CallbackContext.DEFAULT_TYPE) -> None:
     """Tracks the chats the bot is in."""
     result = extract_status_change(update.my_chat_member)
     if result is None:
@@ -101,7 +102,7 @@ def track_chats(update: Update, context: CallbackContext) -> None:
             context.bot_data.setdefault("channel_ids", set()).discard(chat.id)
 
 
-def show_chats(update: Update, context: CallbackContext) -> None:
+def show_chats(update: Update, context: CallbackContext.DEFAULT_TYPE) -> None:
     """Shows which chats the bot is in"""
     user_ids = ", ".join(str(uid) for uid in context.bot_data.setdefault("user_ids", set()))
     group_ids = ", ".join(str(gid) for gid in context.bot_data.setdefault("group_ids", set()))
@@ -114,7 +115,7 @@ def show_chats(update: Update, context: CallbackContext) -> None:
     update.effective_message.reply_text(text)
 
 
-def greet_chat_members(update: Update, context: CallbackContext) -> None:
+def greet_chat_members(update: Update, context: CallbackContext.DEFAULT_TYPE) -> None:
     """Greets new users in chats and announces when someone leaves"""
     result = extract_status_change(update.chat_member)
     if result is None:
@@ -139,7 +140,7 @@ def greet_chat_members(update: Update, context: CallbackContext) -> None:
 def main() -> None:
     """Start the bot."""
     # Create the Updater and pass it your bot's token.
-    updater = Updater("TOKEN")
+    updater = Updater.builder().token("TOKEN").build()
 
     # Get the dispatcher to register handlers
     dispatcher = updater.dispatcher

diff --git a/examples/contexttypesbot.py b/examples/contexttypesbot.py
@@ -15,13 +15,14 @@
 
 from telegram import Update, InlineKeyboardButton, InlineKeyboardMarkup, ParseMode
 from telegram.ext import (
-    Updater,
     CommandHandler,
     CallbackContext,
     ContextTypes,
     CallbackQueryHandler,
     TypeHandler,
     Dispatcher,
+    ExtBot,
+    Updater,
 )
 
 
@@ -32,8 +33,8 @@ def __init__(self) -> None:
         self.clicks_per_message: DefaultDict[int, int] = defaultdict(int)
 
 
-# The [dict, ChatData, dict] is for type checkers like mypy
-class CustomContext(CallbackContext[dict, ChatData, dict]):
+# The [ExtBot, dict, ChatData, dict] is for type checkers like mypy
+class CustomContext(CallbackContext[ExtBot, dict, ChatData, dict]):
     """Custom class for context."""
 
     def __init__(self, dispatcher: Dispatcher):
@@ -113,7 +114,7 @@ def track_users(update: Update, context: CustomContext) -> None:
 def main() -> None:
     """Run the bot."""
     context_types = ContextTypes(context=CustomContext, chat_data=ChatData)
-    updater = Updater("TOKEN", context_types=context_types)
+    updater = Updater.builder().token("TOKEN").context_types(context_types).build()
 
     dispatcher = updater.dispatcher
     # run track_users in its own group to not interfere with the user handlers

diff --git a/examples/conversationbot.py b/examples/conversationbot.py
@@ -18,25 +18,25 @@
 
 from telegram import ReplyKeyboardMarkup, ReplyKeyboardRemove, Update
 from telegram.ext import (
-    Updater,
     CommandHandler,
     MessageHandler,
     Filters,
     ConversationHandler,
+    Updater,
     CallbackContext,
 )
 
+
 # Enable logging
 logging.basicConfig(
     format='%(asctime)s - %(name)s - %(levelname)s - %(message)s', level=logging.INFO
 )
-
 logger = logging.getLogger(__name__)
 
 GENDER, PHOTO, LOCATION, BIO = range(4)
 
 
-def start(update: Update, context: CallbackContext) -> int:
+def start(update: Update, context: CallbackContext.DEFAULT_TYPE) -> int:
     """Starts the conversation and asks the user about their gender."""
     reply_keyboard = [['Boy', 'Girl', 'Other']]
 
@@ -52,7 +52,7 @@ def start(update: Update, context: CallbackContext) -> int:
     return GENDER
 
 
-def gender(update: Update, context: CallbackContext) -> int:
+def gender(update: Update, context: CallbackContext.DEFAULT_TYPE) -> int:
     """Stores the selected gender and asks for a photo."""
     user = update.message.from_user
     logger.info("Gender of %s: %s", user.first_name, update.message.text)
@@ -65,7 +65,7 @@ def gender(update: Update, context: CallbackContext) -> int:
     return PHOTO
 
 
-def photo(update: Update, context: CallbackContext) -> int:
+def photo(update: Update, context: CallbackContext.DEFAULT_TYPE) -> int:
     """Stores the photo and asks for a location."""
     user = update.message.from_user
     photo_file = update.message.photo[-1].get_file()
@@ -78,7 +78,7 @@ def photo(update: Update, context: CallbackContext) -> int:
     return LOCATION
 
 
-def skip_photo(update: Update, context: CallbackContext) -> int:
+def skip_photo(update: Update, context: CallbackContext.DEFAULT_TYPE) -> int:
     """Skips the photo and asks for a location."""
     user = update.message.from_user
     logger.info("User %s did not send a photo.", user.first_name)
@@ -89,7 +89,7 @@ def skip_photo(update: Update, context: CallbackContext) -> int:
     return LOCATION
 
 
-def location(update: Update, context: CallbackContext) -> int:
+def location(update: Update, context: CallbackContext.DEFAULT_TYPE) -> int:
     """Stores the location and asks for some info about the user."""
     user = update.message.from_user
     user_location = update.message.location
@@ -103,7 +103,7 @@ def location(update: Update, context: CallbackContext) -> int:
     return BIO
 
 
-def skip_location(update: Update, context: CallbackContext) -> int:
+def skip_location(update: Update, context: CallbackContext.DEFAULT_TYPE) -> int:
     """Skips the location and asks for info about the user."""
     user = update.message.from_user
     logger.info("User %s did not send a location.", user.first_name)
@@ -114,7 +114,7 @@ def skip_location(update: Update, context: CallbackContext) -> int:
     return BIO
 
 
-def bio(update: Update, context: CallbackContext) -> int:
+def bio(update: Update, context: CallbackContext.DEFAULT_TYPE) -> int:
     """Stores the info about the user and ends the conversation."""
     user = update.message.from_user
     logger.info("Bio of %s: %s", user.first_name, update.message.text)
@@ -123,7 +123,7 @@ def bio(update: Update, context: CallbackContext) -> int:
     return ConversationHandler.END
 
 
-def cancel(update: Update, context: CallbackContext) -> int:
+def cancel(update: Update, context: CallbackContext.DEFAULT_TYPE) -> int:
     """Cancels and ends the conversation."""
     user = update.message.from_user
     logger.info("User %s canceled the conversation.", user.first_name)
@@ -137,7 +137,7 @@ def cancel(update: Update, context: CallbackContext) -> int:
 def main() -> None:
     """Run the bot."""
     # Create the Updater and pass it your bot's token.
-    updater = Updater("TOKEN")
+    updater = Updater.builder().token("TOKEN").build()
 
     # Get the dispatcher to register handlers
     dispatcher = updater.dispatcher