Bump Version to v20.5

python-telegram-bot · Sep 3, 2023 · 82c98b6 · 82c98b6
1 parent f9ccf56
commit 82c98b6
Show file tree

Hide file tree

Showing 33 changed files with 112 additions and 61 deletions.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -4,6 +4,57 @@
 Changelog
 =========
 
+Version 20.5
+============
+*Released 2023-09-03*
+
+This is the technical changelog for version 20.5. More elaborate release notes can be found in the news channel `@pythontelegrambotchannel <https://t.me/pythontelegrambotchannel>`__.
+
+Major Changes
+-------------
+
+-  API 6.8 (:pr:`3853`)
+-  Remove Functionality Deprecated Since Bot API 6.5, 6.6 or 6.7 (:pr:`3858`)
+
+New Features
+------------
+
+-  Extend Allowed Values for HTTP Version (:pr:`3823` closes :issue:`3821`)
+-  Add ``has_args`` Parameter to ``CommandHandler`` (:pr:`3854` by `@thatguylah <https://github.com/thatguylah>`__ closes :issue:`3798`)
+-  Add ``Application.stop_running()`` and Improve Marking Updates as Read on ``Updater.stop()`` (:pr:`3804`)
+
+Minor Changes
+-------------
+
+-  Type Hinting Fixes for ``WebhookInfo`` (:pr:`3871`)
+-  Test and Document ``Exception.__cause__`` on ``NetworkError`` (:pr:`3792` closes :issue:`3778`)
+-  Add Support for Python 3.12 RC (:pr:`3847`)
+
+Documentation Improvements
+--------------------------
+
+-  Remove Version Check from Examples (:pr:`3846`)
+-  Documentation Improvements (:pr:`3803`, :pr:`3797`, :pr:`3816` by `@trim21 <https://github.com/trim21>`__, :pr:`3829` by `@aelkheir <https://github.com/aelkheir>`__)
+-  Provide Versions of ``customwebhookbot.py`` with Different Frameworks (:pr:`3820` closes :issue:`3717`)
+
+Dependency Updates
+------------------
+
+-  ``pre-commit`` autoupdate (:pr:`3824`)
+-  Bump ``srvaroa/labeler`` from 1.6.0 to 1.6.1 (:pr:`3870`)
+-  Bump ``sphinx`` from 7.0.1 to 7.1.1 (:pr:`3818`)
+-  Bump ``sphinx`` from 7.2.3 to 7.2.5 (:pr:`3869`)
+-  Bump ``furo`` from 2023.5.20 to 2023.7.26 (:pr:`3817`)
+-  Update ``apscheduler`` requirement from ~=3.10.3 to ~=3.10.4 (:pr:`3862`)
+-  Bump ``sphinx`` from 7.2.2 to 7.2.3 (:pr:`3861`)
+-  Bump ``pytest-asyncio`` from 0.21.0 to 0.21.1 (:pr:`3801`)
+-  Bump ``sphinx-paramlinks`` from 0.5.4 to 0.6.0 (:pr:`3840`)
+-  Update ``apscheduler`` requirement from ~=3.10.1 to ~=3.10.3 (:pr:`3851`)
+-  Bump ``furo`` from 2023.7.26 to 2023.8.19 (:pr:`3850`)
+-  Bump ``sphinx`` from 7.1.2 to 7.2.2 (:pr:`3852`)
+-  Bump ``sphinx`` from 7.1.1 to 7.1.2 (:pr:`3827`)
+
+
 Version 20.4
 ============
 

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -21,9 +21,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = "20.4"  # telegram.__version__[:3]
+version = "20.5"  # telegram.__version__[:3]
 # The full version, including alpha/beta/rc tags.
-release = "20.4"  # telegram.__version__
+release = "20.5"  # telegram.__version__
 
 # If your documentation needs a minimal Sphinx version, state it here.
 needs_sphinx = "6.1.3"

diff --git a/telegram/_bot.py b/telegram/_bot.py
@@ -187,7 +187,7 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
           the file path will be passed in the
           `file URI scheme <https://en.wikipedia.org/wiki/File_URI_scheme>`_.
 
-    .. versionchanged:: NEXT.VERSION
+    .. versionchanged:: 20.5
         Removed deprecated methods ``set_sticker_set_thumb`` and ``setStickerSetThumb``.
         Use :meth:`set_sticker_set_thumbnail` and :meth:`setStickerSetThumbnail` instead.
 
@@ -1109,7 +1109,7 @@ async def send_audio(
 
         .. seealso:: :wiki:`Working with Files and Media <Working-with-Files-and-Media>`
 
-        .. versionchanged:: NEXT.VERSION
+        .. versionchanged:: 20.5
             |removed_thumb_arg|
 
         Args:
@@ -1231,7 +1231,7 @@ async def send_document(
 
         .. seealso:: :wiki:`Working with Files and Media <Working-with-Files-and-Media>`
 
-        .. versionchanged:: NEXT.VERSION
+        .. versionchanged:: 20.5
             |removed_thumb_arg|
 
         Args:
@@ -1446,7 +1446,7 @@ async def send_video(
 
         .. seealso:: :wiki:`Working with Files and Media <Working-with-Files-and-Media>`
 
-        .. versionchanged:: NEXT.VERSION
+        .. versionchanged:: 20.5
             |removed_thumb_arg|
 
         Args:
@@ -1576,7 +1576,7 @@ async def send_video_note(
 
         .. seealso:: :wiki:`Working with Files and Media <Working-with-Files-and-Media>`
 
-        .. versionchanged:: NEXT.VERSION
+        .. versionchanged:: 20.5
             |removed_thumb_arg|
 
         Args:
@@ -1695,7 +1695,7 @@ async def send_animation(
 
         .. seealso:: :wiki:`Working with Files and Media <Working-with-Files-and-Media>`
 
-        .. versionchanged:: NEXT.VERSION
+        .. versionchanged:: 20.5
             |removed_thumb_arg|
 
         Args:
@@ -2757,7 +2757,7 @@ async def answer_inline_query(
         .. seealso:: :wiki:`Working with Files and Media <Working-with-Files-and-Media>`
 
 
-        .. versionchanged:: NEXT.VERSION
+        .. versionchanged:: 20.5
            Removed deprecated arguments ``switch_pm_text`` and ``switch_pm_parameter``.
 
         Args:
@@ -5493,7 +5493,7 @@ async def upload_sticker_file(
         :meth:`create_new_sticker_set` and :meth:`add_sticker_to_set` methods (can be used multiple
         times).
 
-        .. versionchanged:: NEXT.VERSION
+        .. versionchanged:: 20.5
            Removed deprecated parameter ``png_sticker``.
 
         Args:
@@ -5561,7 +5561,7 @@ async def add_sticker_to_set(
             Since Bot API 6.6, the parameter :paramref:`sticker` replace the parameters
             ``png_sticker``, ``tgs_sticker``, ``webm_sticker``, ``emojis``, and ``mask_position``.
 
-        .. versionchanged:: NEXT.VERSION
+        .. versionchanged:: 20.5
            Removed deprecated parameters ``png_sticker``, ``tgs_sticker``, ``webm_sticker``,
            ``emojis``, and ``mask_position``.
 
@@ -5663,7 +5663,7 @@ async def create_new_sticker_set(
             replace the parameters ``png_sticker``, ``tgs_sticker``,``webm_sticker``, ``emojis``,
             and ``mask_position``.
 
-        .. versionchanged:: NEXT.VERSION
+        .. versionchanged:: 20.5
             Removed the deprecated parameters mentioned above and adjusted the order of the
             parameters.
 
@@ -7346,7 +7346,7 @@ async def unpin_all_general_forum_topic_messages(
         :paramref:`~telegram.ChatAdministratorRights.can_pin_messages` administrator rights in the
         supergroup.
 
-        .. versionadded:: NEXT.VERSION
+        .. versionadded:: 20.5
 
         Args:
             chat_id (:obj:`int` | :obj:`str`): |chat_id_group|

diff --git a/telegram/_chat.py b/telegram/_chat.py
@@ -178,7 +178,7 @@ class Chat(TelegramObject):
             :meth:`telegram.Bot.get_chat`.
             |datetime_localization|
 
-            .. versionadded:: NEXT.VERSION
+            .. versionadded:: 20.5
         has_aggressive_anti_spam_enabled (:obj:`bool`, optional): :obj:`True`, if aggressive
             anti-spam checks are enabled in the supergroup. The field is only available to chat
             administrators. Returned only in :meth:`telegram.Bot.get_chat`.
@@ -277,7 +277,7 @@ class Chat(TelegramObject):
             :meth:`telegram.Bot.get_chat`.
             |datetime_localization|
 
-            .. versionadded:: NEXT.VERSION
+            .. versionadded:: 20.5
         has_aggressive_anti_spam_enabled (:obj:`bool`): Optional. :obj:`True`, if aggressive
             anti-spam checks are enabled in the supergroup. The field is only available to chat
             administrators. Returned only in :meth:`telegram.Bot.get_chat`.
@@ -2934,7 +2934,7 @@ async def unpin_all_general_forum_topic_messages(
         For the documentation of the arguments, please see
         :meth:`telegram.Bot.unpin_all_general_forum_topic_messages`.
 
-        .. versionadded:: NEXT.VERSION
+        .. versionadded:: 20.5
 
         Returns:
             :obj:`bool`: On success, :obj:`True` is returned.

diff --git a/telegram/_chatmember.py b/telegram/_chatmember.py
@@ -366,7 +366,7 @@ class ChatMemberRestricted(ChatMember):
        All arguments were made positional and their order was changed.
        The argument can_manage_topics was added.
 
-    .. versionchanged:: NEXT.VERSION
+    .. versionchanged:: 20.5
       Removed deprecated argument and attribute ``can_send_media_messages``.
 
     Args:

diff --git a/telegram/_chatpermissions.py b/telegram/_chatpermissions.py
@@ -40,7 +40,7 @@ class ChatPermissions(TelegramObject):
     .. versionchanged:: 20.0
         :attr:`can_manage_topics` is considered as well when comparing objects of
         this type in terms of equality.
-    .. versionchanged:: NEXT.VERSION
+    .. versionchanged:: 20.5
 
         * :attr:`can_send_audios`, :attr:`can_send_documents`, :attr:`can_send_photos`,
           :attr:`can_send_videos`, :attr:`can_send_video_notes` and :attr:`can_send_voice_notes`

diff --git a/telegram/_files/animation.py b/telegram/_files/animation.py
@@ -30,7 +30,7 @@ class Animation(_BaseThumbedMedium):
     Objects of this class are comparable in terms of equality. Two objects of this class are
     considered equal, if their :attr:`file_unique_id` is equal.
 
-    .. versionchanged:: NEXT.VERSION
+    .. versionchanged:: 20.5
       |removed_thumb_note|
 
     Args:

diff --git a/telegram/_files/audio.py b/telegram/_files/audio.py
@@ -30,7 +30,7 @@ class Audio(_BaseThumbedMedium):
     Objects of this class are comparable in terms of equality. Two objects of this class are
     considered equal, if their :attr:`file_unique_id` is equal.
 
-    .. versionchanged:: NEXT.VERSION
+    .. versionchanged:: 20.5
       |removed_thumb_note|
 
 

diff --git a/telegram/_files/document.py b/telegram/_files/document.py
@@ -31,7 +31,7 @@ class Document(_BaseThumbedMedium):
     Objects of this class are comparable in terms of equality. Two objects of this class are
     considered equal, if their :attr:`file_unique_id` is equal.
 
-    .. versionchanged:: NEXT.VERSION
+    .. versionchanged:: 20.5
       |removed_thumb_note|
 
     Args:

diff --git a/telegram/_files/inputmedia.py b/telegram/_files/inputmedia.py
@@ -123,7 +123,7 @@ class InputMediaAnimation(InputMedia):
 
     .. seealso:: :wiki:`Working with Files and Media <Working-with-Files-and-Media>`
 
-    .. versionchanged:: NEXT.VERSION
+    .. versionchanged:: 20.5
       |removed_thumb_note|
 
     Args:
@@ -320,7 +320,7 @@ class InputMediaVideo(InputMedia):
             easily generate thumbnails. However, this behaviour is undocumented and might be
             changed by Telegram.
 
-    .. versionchanged:: NEXT.VERSION
+    .. versionchanged:: 20.5
       |removed_thumb_note|
 
     Args:
@@ -449,7 +449,7 @@ class InputMediaAudio(InputMedia):
         duration, performer and title from that video, unless otherwise specified with the
         optional arguments.
 
-    .. versionchanged:: NEXT.VERSION
+    .. versionchanged:: 20.5
       |removed_thumb_note|
 
     Args:
@@ -553,7 +553,7 @@ class InputMediaDocument(InputMedia):
 
     .. seealso:: :wiki:`Working with Files and Media <Working-with-Files-and-Media>`
 
-    .. versionchanged:: NEXT.VERSION
+    .. versionchanged:: 20.5
       |removed_thumb_note|
 
     Args:

diff --git a/telegram/_files/sticker.py b/telegram/_files/sticker.py
@@ -42,7 +42,7 @@ class Sticker(_BaseThumbedMedium):
         arguments had to be changed. Use keyword arguments to make sure that the arguments are
         passed correctly.
 
-    .. versionchanged:: NEXT.VERSION
+    .. versionchanged:: 20.5
       |removed_thumb_note|
 
     Args:
@@ -226,7 +226,7 @@ class StickerSet(TelegramObject):
     .. versionchanged:: 20.0
         The parameter ``contains_masks`` has been removed. Use :paramref:`sticker_type` instead.
 
-    .. versionchanged:: NEXT.VERSION
+    .. versionchanged:: 20.5
        |removed_thumb_note|
 
     Args:

diff --git a/telegram/_files/video.py b/telegram/_files/video.py
@@ -30,7 +30,7 @@ class Video(_BaseThumbedMedium):
     Objects of this class are comparable in terms of equality. Two objects of this class are
     considered equal, if their :attr:`file_unique_id` is equal.
 
-    .. versionchanged:: NEXT.VERSION
+    .. versionchanged:: 20.5
       |removed_thumb_note|
 
     Args:

diff --git a/telegram/_files/videonote.py b/telegram/_files/videonote.py
@@ -31,7 +31,7 @@ class VideoNote(_BaseThumbedMedium):
     Objects of this class are comparable in terms of equality. Two objects of this class are
     considered equal, if their :attr:`file_unique_id` is equal.
 
-    .. versionchanged:: NEXT.VERSION
+    .. versionchanged:: 20.5
       |removed_thumb_note|
 
     Args:

diff --git a/telegram/_inline/inlinequeryresultarticle.py b/telegram/_inline/inlinequeryresultarticle.py
@@ -35,7 +35,7 @@ class InlineQueryResultArticle(InlineQueryResult):
     Examples:
         :any:`Inline Bot <examples.inlinebot>`
 
-    .. versionchanged:: NEXT.VERSION
+    .. versionchanged:: 20.5
       Removed the deprecated arguments and attributes ``thumb_*``.
 
     Args:

diff --git a/telegram/_inline/inlinequeryresultcontact.py b/telegram/_inline/inlinequeryresultcontact.py
@@ -35,7 +35,7 @@ class InlineQueryResultContact(InlineQueryResult):
     Alternatively, you can use :attr:`input_message_content` to send a message with the specified
     content instead of the contact.
 
-    .. versionchanged:: NEXT.VERSION
+    .. versionchanged:: 20.5
         |removed_thumb_wildcard_note|
 
     Args:

diff --git a/telegram/_inline/inlinequeryresultdocument.py b/telegram/_inline/inlinequeryresultdocument.py
@@ -40,7 +40,7 @@ class InlineQueryResultDocument(InlineQueryResult):
 
     .. seealso:: :wiki:`Working with Files and Media <Working-with-Files-and-Media>`
 
-    .. versionchanged:: NEXT.VERSION
+    .. versionchanged:: 20.5
         |removed_thumb_wildcard_note|
 
     Args:

diff --git a/telegram/_inline/inlinequeryresultgif.py b/telegram/_inline/inlinequeryresultgif.py
@@ -39,7 +39,7 @@ class InlineQueryResultGif(InlineQueryResult):
 
     .. seealso:: :wiki:`Working with Files and Media <Working-with-Files-and-Media>`
 
-    .. versionchanged:: NEXT.VERSION
+    .. versionchanged:: 20.5
       |removed_thumb_wildcard_note|
 
     Args:

diff --git a/telegram/_inline/inlinequeryresultlocation.py b/telegram/_inline/inlinequeryresultlocation.py
@@ -35,7 +35,7 @@ class InlineQueryResultLocation(InlineQueryResult):
     Alternatively, you can use :attr:`input_message_content` to send a message with the specified
     content instead of the location.
 
-    .. versionchanged:: NEXT.VERSION
+    .. versionchanged:: 20.5
         |removed_thumb_wildcard_note|
 
     Args:

diff --git a/telegram/_inline/inlinequeryresultmpeg4gif.py b/telegram/_inline/inlinequeryresultmpeg4gif.py
@@ -40,7 +40,7 @@ class InlineQueryResultMpeg4Gif(InlineQueryResult):
 
     .. seealso:: :wiki:`Working with Files and Media <Working-with-Files-and-Media>`
 
-    .. versionchanged:: NEXT.VERSION
+    .. versionchanged:: 20.5
         |removed_thumb_wildcard_note|
 
     Args:

diff --git a/telegram/_inline/inlinequeryresultphoto.py b/telegram/_inline/inlinequeryresultphoto.py
@@ -39,7 +39,7 @@ class InlineQueryResultPhoto(InlineQueryResult):
 
     .. seealso:: :wiki:`Working with Files and Media <Working-with-Files-and-Media>`
 
-    .. versionchanged:: NEXT.VERSION
+    .. versionchanged:: 20.5
       |removed_thumb_url_note|
 
     Args:

diff --git a/telegram/_inline/inlinequeryresultvenue.py b/telegram/_inline/inlinequeryresultvenue.py
@@ -39,7 +39,7 @@ class InlineQueryResultVenue(InlineQueryResult):
       Foursquare details and Google Pace details are mutually exclusive. However, this
       behaviour is undocumented and might be changed by Telegram.
 
-    .. versionchanged:: NEXT.VERSION
+    .. versionchanged:: 20.5
         |removed_thumb_wildcard_note|
 
     Args:

diff --git a/telegram/_inline/inlinequeryresultvideo.py b/telegram/_inline/inlinequeryresultvideo.py
@@ -44,7 +44,7 @@ class InlineQueryResultVideo(InlineQueryResult):
 
     .. seealso:: :wiki:`Working with Files and Media <Working-with-Files-and-Media>`
 
-    .. versionchanged:: NEXT.VERSION
+    .. versionchanged:: 20.5
         |removed_thumb_url_note|
 
     Args: