python-telegram-bot · Bibo-Joshi · Mar 2, 2024 · Feb 11, 2024 · Feb 11, 2024 · Feb 12, 2024
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -1,13 +1,12 @@
 name: Test Documentation Build
 on:
   pull_request:
-    branches:
-      - master
-      - doc-fixes
+    paths:
+      - telegram/**
+      - docs/**
   push:
     branches:
       - master
-      - doc-fixes
 
 jobs:
   test-sphinx-build:

diff --git a/.github/workflows/test_official.yml b/.github/workflows/test_official.yml
@@ -1,8 +1,9 @@
 name: Bot API Tests
 on:
   pull_request:
-    branches:
-      - master
+    paths:
+      - telegram/**
+      - tests/**
   push:
     branches:
       - master

diff --git a/.github/workflows/type_completeness.yml b/.github/workflows/type_completeness.yml
@@ -1,8 +1,8 @@
 name: Check Type Completeness
 on:
   pull_request:
-    branches:
-      - master
+    paths:
+      - telegram/**
   push:
     branches:
       - master

diff --git a/.github/workflows/unit_tests.yml b/.github/workflows/unit_tests.yml
@@ -1,13 +1,12 @@
 name: Unit Tests
 on:
   pull_request:
-    branches:
-      - master
-
+    paths:
+      - telegram/**
+      - tests/**
   push:
     branches:
       - master
-
   schedule:
     # Run monday and friday morning at 03:07 - odd time to spread load on GitHub Actions
     - cron: '7 3 * * 1,5'

diff --git a/README.rst b/README.rst
@@ -14,7 +14,7 @@
    :target: https://pypi.org/project/python-telegram-bot/
    :alt: Supported Python versions
 
-.. image:: https://img.shields.io/badge/Bot%20API-7.0-blue?logo=telegram
+.. image:: https://img.shields.io/badge/Bot%20API-7.1-blue?logo=telegram
    :target: https://core.telegram.org/bots/api-changelog
    :alt: Supported Bot API versions
 
@@ -93,7 +93,7 @@ Installing both ``python-telegram-bot`` and ``python-telegram-bot-raw`` in conju
 Telegram API support
 ====================
 
-All types and methods of the Telegram Bot API **7.0** are supported.
+All types and methods of the Telegram Bot API **7.1** are supported.
 
 Installing
 ==========

diff --git a/README_RAW.rst b/README_RAW.rst
@@ -14,7 +14,7 @@
    :target: https://pypi.org/project/python-telegram-bot-raw/
    :alt: Supported Python versions
 
-.. image:: https://img.shields.io/badge/Bot%20API-7.0-blue?logo=telegram
+.. image:: https://img.shields.io/badge/Bot%20API-7.1-blue?logo=telegram
    :target: https://core.telegram.org/bots/api-changelog
    :alt: Supported Bot API versions
 
@@ -89,7 +89,7 @@ Installing both ``python-telegram-bot`` and ``python-telegram-bot-raw`` in conju
 Telegram API support
 ====================
 
-All types and methods of the Telegram Bot API **7.0** are supported.
+All types and methods of the Telegram Bot API **7.1** are supported.
 
 Installing
 ==========

diff --git a/docs/source/telegram.at-tree.rst b/docs/source/telegram.at-tree.rst
@@ -22,6 +22,7 @@ Available Types
     telegram.chat
     telegram.chatadministratorrights
     telegram.chatboost
+    telegram.chatboostadded
     telegram.chatboostremoved
     telegram.chatboostsource
     telegram.chatboostsourcegiftcode

diff --git a/docs/source/telegram.chatboostadded.rst b/docs/source/telegram.chatboostadded.rst
@@ -0,0 +1,6 @@
+ChatBoostAdded
+==============
+
+.. autoclass:: telegram.ChatBoostAdded
+    :members:
+    :show-inheritance:
diff --git a/docs/substitutions/global.rst b/docs/substitutions/global.rst
@@ -77,3 +77,5 @@
 .. |reply_quote| replace:: If set to :obj:`True`, the reply is sent as an actual reply to this message. If ``reply_to_message_id`` is passed, this parameter will be ignored. Default: :obj:`True` in group chats and :obj:`False` in private chats.
 
 .. |do_quote| replace:: If set to :obj:`True`, the replied message is quoted. For a dict, it must be the output of :meth:`~telegram.Message.build_reply_arguments` to specify exact ``reply_parameters``. If ``reply_to_message_id`` or ``reply_parameters`` are passed, this parameter will be ignored. Default: :obj:`True` in group chats and :obj:`False` in private chats.
+
+.. |non_optional_story_argument| replace:: As of this version, this argument is now required. In accordance with our `stability policy <https://docs.python-telegram-bot.org/en/stable/stability_policy.html>`__, the signature will be kept as optional for now, though they are mandatory and an error will be raised if you don't pass it.
diff --git a/telegram/__init__.py b/telegram/__init__.py
@@ -40,6 +40,7 @@
     "Chat",
     "ChatAdministratorRights",
     "ChatBoost",
+    "ChatBoostAdded",
     "ChatBoostRemoved",
     "ChatBoostSource",
     "ChatBoostSourceGiftCode",
@@ -242,6 +243,7 @@
 from ._chatadministratorrights import ChatAdministratorRights
 from ._chatboost import (
     ChatBoost,
+    ChatBoostAdded,
     ChatBoostRemoved,
     ChatBoostSource,
     ChatBoostSourceGiftCode,

diff --git a/telegram/_bot.py b/telegram/_bot.py
@@ -5250,10 +5250,10 @@ async def promote_chat_member(
             user_id (:obj:`int`): Unique identifier of the target user.
             is_anonymous (:obj:`bool`, optional): Pass :obj:`True`, if the administrator's presence
                 in the chat is hidden.
-            can_manage_chat (:obj:`bool`, optional): Pass  :obj:`True`, if the administrator can
-                access the chat event log, chat statistics, boost list in channels, see channel
-                members, report spam messages, see anonymous administrators in supergroups and
-                ignore slow mode. Implied by any other administrator privilege.
+            can_manage_chat (:obj:`bool`, optional): Pass :obj:`True`, if the administrator can
+                access the chat event log, get boost list, see hidden supergroup and channel
+                members, report spam messages and ignore slow mode. Implied by any other
+                administrator privilege.
 
                 .. versionadded:: 13.4
 
@@ -5285,15 +5285,15 @@ async def promote_chat_member(
 
                 .. versionadded:: 20.0
             can_post_stories (:obj:`bool`, optional): Pass :obj:`True`, if the administrator can
-                post stories in the channel; channels only.
+                post stories to the chat.
 
                 .. versionadded:: 20.6
             can_edit_stories (:obj:`bool`, optional): Pass :obj:`True`, if the administrator can
-                edit stories posted by other users; channels only.
+                edit stories posted by other users.
 
                 .. versionadded:: 20.6
             can_delete_stories (:obj:`bool`, optional): Pass :obj:`True`, if the administrator can
-                delete stories posted by other users; channels only.
+                delete stories posted by other users.
 
                 .. versionadded:: 20.6
 

diff --git a/telegram/_chat.py b/telegram/_chat.py
@@ -219,6 +219,16 @@ class Chat(TelegramObject):
             :meth:`telegram.Bot.get_chat`.
 
             .. versionadded:: 20.0
+        unrestrict_boost_count (:obj:`int`, optional): For supergroups, the minimum number of
+            boosts that a non-administrator user needs to add in order to ignore slow mode and chat
+            permissions. Returned only in :meth:`telegram.Bot.get_chat`.
+
+            .. versionadded:: NEXT.VERSION
+        custom_emoji_sticker_set_name (:obj:`str`, optional): For supergroups, the name of the
+            group's custom emoji sticker set. Custom emoji from this set can be used by all users
+            and bots in the group. Returned only in :meth:`telegram.Bot.get_chat`.
+
+            .. versionadded:: NEXT.VERSION
 
     Attributes:
         id (:obj:`int`): Unique identifier for this chat. This number may be greater than 32 bits
@@ -352,6 +362,16 @@ class Chat(TelegramObject):
             :meth:`telegram.Bot.get_chat`.
 
             .. versionadded:: 20.0
+        unrestrict_boost_count (:obj:`int`): Optional. For supergroups, the minimum number of
+            boosts that a non-administrator user needs to add in order to ignore slow mode and chat
+            permissions. Returned only in :meth:`telegram.Bot.get_chat`.
+
+            .. versionadded:: NEXT.VERSION
+        custom_emoji_sticker_set_name (:obj:`str`): Optional. For supergroups, the name of the
+            group's custom emoji sticker set. Custom emoji from this set can be used by all users
+            and bots in the group. Returned only in :meth:`telegram.Bot.get_chat`.
+
+            .. versionadded:: NEXT.VERSION
 
     .. _topics: https://telegram.org/blog/topics-in-groups-collectible-usernames#topics-in-groups
     .. _accent colors: https://core.telegram.org/bots/api#accent-colors
@@ -364,6 +384,7 @@ class Chat(TelegramObject):
         "background_custom_emoji_id",
         "bio",
         "can_set_sticker_set",
+        "custom_emoji_sticker_set_name",
         "description",
         "emoji_status_custom_emoji_id",
         "emoji_status_expiration_date",
@@ -392,6 +413,7 @@ class Chat(TelegramObject):
         "sticker_set_name",
         "title",
         "type",
+        "unrestrict_boost_count",
         "username",
     )
 
@@ -446,6 +468,8 @@ def __init__(
         profile_accent_color_id: Optional[int] = None,
         profile_background_custom_emoji_id: Optional[str] = None,
         has_visible_history: Optional[bool] = None,
+        unrestrict_boost_count: Optional[int] = None,
+        custom_emoji_sticker_set_name: Optional[str] = None,
         *,
         api_kwargs: Optional[JSONDict] = None,
     ):
@@ -493,6 +517,8 @@ def __init__(
         self.background_custom_emoji_id: Optional[str] = background_custom_emoji_id
         self.profile_accent_color_id: Optional[int] = profile_accent_color_id
         self.profile_background_custom_emoji_id: Optional[str] = profile_background_custom_emoji_id
+        self.unrestrict_boost_count: Optional[int] = unrestrict_boost_count
+        self.custom_emoji_sticker_set_name: Optional[str] = custom_emoji_sticker_set_name
 
         self._id_attrs = (self.id,)
 

diff --git a/telegram/_chatadministratorrights.py b/telegram/_chatadministratorrights.py
@@ -47,9 +47,8 @@ class ChatAdministratorRights(TelegramObject):
     Args:
         is_anonymous (:obj:`bool`): :obj:`True`, if the user's presence in the chat is hidden.
         can_manage_chat (:obj:`bool`): :obj:`True`, if the administrator can access the chat event
-            log, chat statistics, boost list in channels, see channel members, report spam
-            messages, see anonymous administrators in supergroups and ignore slow mode.
-            Implied by any other administrator privilege.
+            log, get boost list, see hidden supergroup and channel members, report spam messages
+            and ignore slow mode. Implied by any other administrator privilege.
         can_delete_messages (:obj:`bool`): :obj:`True`, if the administrator can delete messages of
             other users.
         can_manage_video_chats (:obj:`bool`): :obj:`True`, if the administrator can manage video
@@ -70,18 +69,24 @@ class ChatAdministratorRights(TelegramObject):
             messages of other users.
         can_pin_messages (:obj:`bool`, optional): :obj:`True`, if the user is allowed to pin
             messages; groups and supergroups only.
-        can_post_stories (:obj:`bool`, optional): :obj:`True`, if the administrator can post
-            stories in the channel; channels only.
+        can_post_stories (:obj:`bool`): :obj:`True`, if the administrator can post
+            stories to the chat.
 
             .. versionadded:: 20.6
-        can_edit_stories (:obj:`bool`, optional): :obj:`True`, if the administrator can edit
-            stories posted by other users; channels only.
+            .. versionchanged:: NEXT.VERSION
+                |non_optional_story_argument|
+        can_edit_stories (:obj:`bool`): :obj:`True`, if the administrator can edit
+            stories posted by other users.
 
             .. versionadded:: 20.6
-        can_delete_stories (:obj:`bool`, optional): :obj:`True`, if the administrator can delete
-            stories posted by other users; channels only.
+            .. versionchanged:: NEXT.VERSION
+                |non_optional_story_argument|
+        can_delete_stories (:obj:`bool`): :obj:`True`, if the administrator can delete
+            stories posted by other users.
 
             .. versionadded:: 20.6
+            .. versionchanged:: NEXT.VERSION
+                |non_optional_story_argument|
         can_manage_topics (:obj:`bool`, optional): :obj:`True`, if the user is allowed
             to create, rename, close, and reopen forum topics; supergroups only.
 
@@ -90,9 +95,8 @@ class ChatAdministratorRights(TelegramObject):
     Attributes:
         is_anonymous (:obj:`bool`): :obj:`True`, if the user's presence in the chat is hidden.
         can_manage_chat (:obj:`bool`): :obj:`True`, if the administrator can access the chat event
-            log, chat statistics, boost list in channels, see channel members, report spam
-            messages, see anonymous administrators in supergroups and ignore slow mode.
-            Implied by any other administrator privilege.
+            log, get boost list, see hidden supergroup and channel members, report spam messages
+            and ignore slow mode. Implied by any other administrator privilege.
         can_delete_messages (:obj:`bool`): :obj:`True`, if the administrator can delete messages of
             other users.
         can_manage_video_chats (:obj:`bool`): :obj:`True`, if the administrator can manage video
@@ -113,18 +117,24 @@ class ChatAdministratorRights(TelegramObject):
             messages of other users.
         can_pin_messages (:obj:`bool`): Optional. :obj:`True`, if the user is allowed to pin
             messages; groups and supergroups only.
-        can_post_stories (:obj:`bool`): Optional. :obj:`True`, if the administrator can post
-            stories in the channel; channels only.
+        can_post_stories (:obj:`bool`): :obj:`True`, if the administrator can post
+            stories to the chat.
 
             .. versionadded:: 20.6
-        can_edit_stories (:obj:`bool`): Optional. :obj:`True`, if the administrator can edit
-            stories posted by other users; channels only.
+            .. versionchanged:: NEXT.VERSION
+                |non_optional_story_argument|
+        can_edit_stories (:obj:`bool`): :obj:`True`, if the administrator can edit
+            stories posted by other users.
 
             .. versionadded:: 20.6
-        can_delete_stories (:obj:`bool`): Optional. :obj:`True`, if the administrator can delete
-            stories posted by other users; channels only.
+            .. versionchanged:: NEXT.VERSION
+                |non_optional_story_argument|
+        can_delete_stories (:obj:`bool`): :obj:`True`, if the administrator can delete
+            stories posted by other users.
 
             .. versionadded:: 20.6
+            .. versionchanged:: NEXT.VERSION
+                |non_optional_story_argument|
         can_manage_topics (:obj:`bool`): Optional. :obj:`True`, if the user is allowed
             to create, rename, close, and reopen forum topics; supergroups only.
 
@@ -179,13 +189,19 @@ def __init__(
         self.can_promote_members: bool = can_promote_members
         self.can_change_info: bool = can_change_info
         self.can_invite_users: bool = can_invite_users
+        # Not actually optionals but because of backwards compatability we pretend they are
+        if can_post_stories is None or can_edit_stories is None or can_delete_stories is None:
+            raise TypeError(
+                "As of vNEXT.VERSION can_post_stories, can_edit_stories and can_delete_stories"
+                " must be set in order to create this object."
+            )
+        self.can_post_stories: bool = can_post_stories
+        self.can_edit_stories: bool = can_edit_stories
+        self.can_delete_stories: bool = can_delete_stories
         # Optionals
         self.can_post_messages: Optional[bool] = can_post_messages
         self.can_edit_messages: Optional[bool] = can_edit_messages
         self.can_pin_messages: Optional[bool] = can_pin_messages
-        self.can_post_stories: Optional[bool] = can_post_stories
-        self.can_edit_stories: Optional[bool] = can_edit_stories
-        self.can_delete_stories: Optional[bool] = can_delete_stories
         self.can_manage_topics: Optional[bool] = can_manage_topics
 
         self._id_attrs = (

diff --git a/telegram/_chatboost.py b/telegram/_chatboost.py
@@ -34,6 +34,39 @@
     from telegram import Bot
 
 
+class ChatBoostAdded(TelegramObject):
+    """
+    This object represents a service message about a user boosting a chat.
+
+    Objects of this class are comparable in terms of equality.
+    Two objects of this class are considered equal, if their
+    :attr:`boost_count` are equal.
+
+    .. versionadded:: NEXT.VERSION
+
+    Args:
+        boost_count (:obj:`int`): Number of boosts added by the user.
+
+    Attributes:
+        boost_count (:obj:`int`): Number of boosts added by the user.
+
+    """
+
+    __slots__ = ("boost_count",)
+
+    def __init__(
+        self,
+        boost_count: int,
+        *,
+        api_kwargs: Optional[JSONDict] = None,
+    ) -> None:
+        super().__init__(api_kwargs=api_kwargs)
+        self.boost_count: int = boost_count
+        self._id_attrs = (self.boost_count,)
+
+        self._freeze()
+
+
 class ChatBoostSource(TelegramObject):
     """
     Base class for Telegram ChatBoostSource objects. It can be one of:
Original file line number	Diff line number	Diff line change
Expand Up		@@ -77,3 +77,5 @@
		.. \|reply_quote\| replace:: If set to :obj:`True`, the reply is sent as an actual reply to this message. If ``reply_to_message_id`` is passed, this parameter will be ignored. Default: :obj:`True` in group chats and :obj:`False` in private chats.

		.. \|do_quote\| replace:: If set to :obj:`True`, the replied message is quoted. For a dict, it must be the output of :meth:`~telegram.Message.build_reply_arguments` to specify exact ``reply_parameters``. If ``reply_to_message_id`` or ``reply_parameters`` are passed, this parameter will be ignored. Default: :obj:`True` in group chats and :obj:`False` in private chats.

		.. \|non_optional_story_argument\| replace:: As of this version, this argument is now required. In accordance with our `stability policy <https://docs.python-telegram-bot.org/en/stable/stability_policy.html>`__, the signature will be kept as optional for now, though they are mandatory and an error will be raised if you don't pass it.