From 28d19c3b9a65e7dd5f68c1172e35acdcac20fd78 Mon Sep 17 00:00:00 2001 From: Bibo-Joshi <22366557+Bibo-Joshi@users.noreply.github.com> Date: Sat, 21 Sep 2024 11:33:52 +0200 Subject: [PATCH 01/25] Introduce `conftest.py` for File Related Tests (#4488) Co-authored-by: Harshil <37377066+harshil21@users.noreply.github.com> --- tests/_files/conftest.py | 189 ++++++++++++++++++++++++++++++ tests/_files/test_animation.py | 14 --- tests/_files/test_audio.py | 12 -- tests/_files/test_document.py | 12 -- tests/_files/test_inputmedia.py | 88 ++++++-------- tests/_files/test_inputsticker.py | 3 +- tests/_files/test_photo.py | 28 ----- tests/_files/test_sticker.py | 102 ++-------------- tests/_files/test_video.py | 12 -- tests/_files/test_videonote.py | 2 +- tests/auxil/constants.py | 4 + tests/conftest.py | 26 +++- tests/test_bot.py | 5 +- tests/test_forum.py | 29 +---- 14 files changed, 263 insertions(+), 263 deletions(-) create mode 100644 tests/_files/conftest.py diff --git a/tests/_files/conftest.py b/tests/_files/conftest.py new file mode 100644 index 00000000000..f2ae1d3abd5 --- /dev/null +++ b/tests/_files/conftest.py @@ -0,0 +1,189 @@ +#!/usr/bin/env python +# +# A library that provides a Python interface to the Telegram Bot API +# Copyright (C) 2015-2024 +# Leandro Toledo de Souza +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Lesser Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Lesser Public License for more details. +# +# You should have received a copy of the GNU Lesser Public License +# along with this program. If not, see [http://www.gnu.org/licenses/]. +"""Module to provide fixtures most of which are used in test_inputmedia.py.""" +import pytest + +from telegram.error import BadRequest +from tests.auxil.files import data_file +from tests.auxil.networking import expect_bad_request + + +@pytest.fixture(scope="session") +async def animation(bot, chat_id): + with data_file("game.gif").open("rb") as f, data_file("thumb.jpg").open("rb") as thumb: + return ( + await bot.send_animation(chat_id, animation=f, read_timeout=50, thumbnail=thumb) + ).animation + + +@pytest.fixture +def animation_file(): + with data_file("game.gif").open("rb") as f: + yield f + + +@pytest.fixture(scope="module") +async def animated_sticker(bot, chat_id): + with data_file("telegram_animated_sticker.tgs").open("rb") as f: + return (await bot.send_sticker(chat_id, sticker=f, read_timeout=50)).sticker + + +@pytest.fixture +def animated_sticker_file(): + with data_file("telegram_animated_sticker.tgs").open("rb") as f: + yield f + + +@pytest.fixture +async def animated_sticker_set(bot): + ss = await bot.get_sticker_set(f"animated_test_by_{bot.username}") + if len(ss.stickers) > 100: + try: + for i in range(1, 50): + await bot.delete_sticker_from_set(ss.stickers[-i].file_id) + except BadRequest as e: + if e.message == "Stickerset_not_modified": + return ss + raise Exception("stickerset is growing too large.") from None + return ss + + +@pytest.fixture(scope="session") +async def audio(bot, chat_id): + with data_file("telegram.mp3").open("rb") as f, data_file("thumb.jpg").open("rb") as thumb: + return (await bot.send_audio(chat_id, audio=f, read_timeout=50, thumbnail=thumb)).audio + + +@pytest.fixture +def audio_file(): + with data_file("telegram.mp3").open("rb") as f: + yield f + + +@pytest.fixture(scope="session") +async def document(bot, chat_id): + with data_file("telegram.png").open("rb") as f: + return (await bot.send_document(chat_id, document=f, read_timeout=50)).document + + +@pytest.fixture +def document_file(): + with data_file("telegram.png").open("rb") as f: + yield f + + +@pytest.fixture(scope="session") +def photo(photolist): + return photolist[-1] + + +@pytest.fixture +def photo_file(): + with data_file("telegram.jpg").open("rb") as f: + yield f + + +@pytest.fixture(scope="session") +async def photolist(bot, chat_id): + async def func(): + with data_file("telegram.jpg").open("rb") as f: + return (await bot.send_photo(chat_id, photo=f, read_timeout=50)).photo + + return await expect_bad_request( + func, "Type of file mismatch", "Telegram did not accept the file." + ) + + +@pytest.fixture(scope="module") +async def sticker(bot, chat_id): + with data_file("telegram.webp").open("rb") as f: + sticker = (await bot.send_sticker(chat_id, sticker=f, read_timeout=50)).sticker + # necessary to properly test needs_repainting + with sticker._unfrozen(): + sticker.needs_repainting = True + return sticker + + +@pytest.fixture +def sticker_file(): + with data_file("telegram.webp").open("rb") as file: + yield file + + +@pytest.fixture +async def sticker_set(bot): + ss = await bot.get_sticker_set(f"test_by_{bot.username}") + if len(ss.stickers) > 100: + try: + for i in range(1, 50): + await bot.delete_sticker_from_set(ss.stickers[-i].file_id) + except BadRequest as e: + if e.message == "Stickerset_not_modified": + return ss + raise Exception("stickerset is growing too large.") from None + return ss + + +@pytest.fixture +def sticker_set_thumb_file(): + with data_file("sticker_set_thumb.png").open("rb") as file: + yield file + + +@pytest.fixture(scope="session") +def thumb(photolist): + return photolist[0] + + +@pytest.fixture(scope="session") +async def video(bot, chat_id): + with data_file("telegram.mp4").open("rb") as f: + return (await bot.send_video(chat_id, video=f, read_timeout=50)).video + + +@pytest.fixture +def video_file(): + with data_file("telegram.mp4").open("rb") as f: + yield f + + +@pytest.fixture +def video_sticker_file(): + with data_file("telegram_video_sticker.webm").open("rb") as f: + yield f + + +@pytest.fixture(scope="module") +def video_sticker(bot, chat_id): + with data_file("telegram_video_sticker.webm").open("rb") as f: + return bot.send_sticker(chat_id, sticker=f, timeout=50).sticker + + +@pytest.fixture +async def video_sticker_set(bot): + ss = await bot.get_sticker_set(f"video_test_by_{bot.username}") + if len(ss.stickers) > 100: + try: + for i in range(1, 50): + await bot.delete_sticker_from_set(ss.stickers[-i].file_id) + except BadRequest as e: + if e.message == "Stickerset_not_modified": + return ss + raise Exception("stickerset is growing too large.") from None + return ss diff --git a/tests/_files/test_animation.py b/tests/_files/test_animation.py index 55c2076e23f..a312d3575cd 100644 --- a/tests/_files/test_animation.py +++ b/tests/_files/test_animation.py @@ -37,20 +37,6 @@ from tests.auxil.slots import mro_slots -@pytest.fixture -def animation_file(): - with data_file("game.gif").open("rb") as f: - yield f - - -@pytest.fixture(scope="module") -async def animation(bot, chat_id): - with data_file("game.gif").open("rb") as f, data_file("thumb.jpg").open("rb") as thumb: - return ( - await bot.send_animation(chat_id, animation=f, read_timeout=50, thumbnail=thumb) - ).animation - - class AnimationTestBase: animation_file_id = "CgADAQADngIAAuyVeEez0xRovKi9VAI" animation_file_unique_id = "adc3145fd2e84d95b64d68eaa22aa33e" diff --git a/tests/_files/test_audio.py b/tests/_files/test_audio.py index ed0d74d4d72..08e598cb267 100644 --- a/tests/_files/test_audio.py +++ b/tests/_files/test_audio.py @@ -37,18 +37,6 @@ from tests.auxil.slots import mro_slots -@pytest.fixture -def audio_file(): - with data_file("telegram.mp3").open("rb") as f: - yield f - - -@pytest.fixture(scope="module") -async def audio(bot, chat_id): - with data_file("telegram.mp3").open("rb") as f, data_file("thumb.jpg").open("rb") as thumb: - return (await bot.send_audio(chat_id, audio=f, read_timeout=50, thumbnail=thumb)).audio - - class AudioTestBase: caption = "Test *audio*" performer = "Leandro Toledo" diff --git a/tests/_files/test_document.py b/tests/_files/test_document.py index 90b6bdf1121..e6037403408 100644 --- a/tests/_files/test_document.py +++ b/tests/_files/test_document.py @@ -37,18 +37,6 @@ from tests.auxil.slots import mro_slots -@pytest.fixture -def document_file(): - with data_file("telegram.png").open("rb") as f: - yield f - - -@pytest.fixture(scope="module") -async def document(bot, chat_id): - with data_file("telegram.png").open("rb") as f: - return (await bot.send_document(chat_id, document=f, read_timeout=50)).document - - class DocumentTestBase: caption = "DocumentTest - *Caption*" document_file_url = "https://python-telegram-bot.org/static/testfiles/telegram.gif" diff --git a/tests/_files/test_inputmedia.py b/tests/_files/test_inputmedia.py index 6b54e4d196a..e75a5adb60f 100644 --- a/tests/_files/test_inputmedia.py +++ b/tests/_files/test_inputmedia.py @@ -38,32 +38,14 @@ ReplyParameters, ) from telegram.constants import InputMediaType, ParseMode - -# noinspection PyUnresolvedReferences from telegram.error import BadRequest from telegram.request import RequestData -from tests._files.test_animation import animation, animation_file # noqa: F401 from tests.auxil.files import data_file from tests.auxil.networking import expect_bad_request from tests.auxil.slots import mro_slots -# noinspection PyUnresolvedReferences -from tests.test_forum import emoji_id, real_topic # noqa: F401 - from ..auxil.build_messages import make_message -# noinspection PyUnresolvedReferences -from .test_audio import audio, audio_file # noqa: F401 - -# noinspection PyUnresolvedReferences -from .test_document import document, document_file # noqa: F401 - -# noinspection PyUnresolvedReferences -from .test_photo import photo, photo_file, photolist, thumb # noqa: F401 - -# noinspection PyUnresolvedReferences -from .test_video import video, video_file # noqa: F401 - @pytest.fixture(scope="module") def input_media_video(class_thumb_file): @@ -213,7 +195,7 @@ def test_to_dict(self, input_media_video): == input_media_video.show_caption_above_media ) - def test_with_video(self, video): # noqa: F811 + def test_with_video(self, video): # fixture found in test_video input_media_video = InputMediaVideo(video, caption="test 3") assert input_media_video.type == self.type_ @@ -223,7 +205,7 @@ def test_with_video(self, video): # noqa: F811 assert input_media_video.duration == video.duration assert input_media_video.caption == "test 3" - def test_with_video_file(self, video_file): # noqa: F811 + def test_with_video_file(self, video_file): # fixture found in test_video input_media_video = InputMediaVideo(video_file, caption="test 3") assert input_media_video.type == self.type_ @@ -303,14 +285,14 @@ def test_to_dict(self, input_media_photo): == input_media_photo.show_caption_above_media ) - def test_with_photo(self, photo): # noqa: F811 + def test_with_photo(self, photo): # fixture found in test_photo input_media_photo = InputMediaPhoto(photo, caption="test 2") assert input_media_photo.type == self.type_ assert input_media_photo.media == photo.file_id assert input_media_photo.caption == "test 2" - def test_with_photo_file(self, photo_file): # noqa: F811 + def test_with_photo_file(self, photo_file): # fixture found in test_photo input_media_photo = InputMediaPhoto(photo_file, caption="test 2") assert input_media_photo.type == self.type_ @@ -374,14 +356,14 @@ def test_to_dict(self, input_media_animation): == input_media_animation.show_caption_above_media ) - def test_with_animation(self, animation): # noqa: F811 + def test_with_animation(self, animation): # fixture found in test_animation input_media_animation = InputMediaAnimation(animation, caption="test 2") assert input_media_animation.type == self.type_ assert input_media_animation.media == animation.file_id assert input_media_animation.caption == "test 2" - def test_with_animation_file(self, animation_file): # noqa: F811 + def test_with_animation_file(self, animation_file): # fixture found in test_animation input_media_animation = InputMediaAnimation(animation_file, caption="test 2") assert input_media_animation.type == self.type_ @@ -442,7 +424,7 @@ def test_to_dict(self, input_media_audio): ce.to_dict() for ce in input_media_audio.caption_entities ] - def test_with_audio(self, audio): # noqa: F811 + def test_with_audio(self, audio): # fixture found in test_audio input_media_audio = InputMediaAudio(audio, caption="test 3") assert input_media_audio.type == self.type_ @@ -452,7 +434,7 @@ def test_with_audio(self, audio): # noqa: F811 assert input_media_audio.title == audio.title assert input_media_audio.caption == "test 3" - def test_with_audio_file(self, audio_file): # noqa: F811 + def test_with_audio_file(self, audio_file): # fixture found in test_audio input_media_audio = InputMediaAudio(audio_file, caption="test 3") assert input_media_audio.type == self.type_ @@ -513,14 +495,14 @@ def test_to_dict(self, input_media_document): == input_media_document.disable_content_type_detection ) - def test_with_document(self, document): # noqa: F811 + def test_with_document(self, document): # fixture found in test_document input_media_document = InputMediaDocument(document, caption="test 3") assert input_media_document.type == self.type_ assert input_media_document.media == document.file_id assert input_media_document.caption == "test 3" - def test_with_document_file(self, document_file): # noqa: F811 + def test_with_document_file(self, document_file): # fixture found in test_document input_media_document = InputMediaDocument(document_file, caption="test 3") assert input_media_document.type == self.type_ @@ -551,13 +533,13 @@ def test_to_dict(self, input_paid_media_photo): assert input_paid_media_photo_dict["type"] == input_paid_media_photo.type assert input_paid_media_photo_dict["media"] == input_paid_media_photo.media - def test_with_photo(self, photo): # noqa: F811 + def test_with_photo(self, photo): # fixture found in test_photo input_paid_media_photo = InputPaidMediaPhoto(photo) assert input_paid_media_photo.type == self.type_ assert input_paid_media_photo.media == photo.file_id - def test_with_photo_file(self, photo_file): # noqa: F811 + def test_with_photo_file(self, photo_file): # fixture found in test_photo input_paid_media_photo = InputPaidMediaPhoto(photo_file) assert input_paid_media_photo.type == self.type_ @@ -597,7 +579,7 @@ def test_to_dict(self, input_paid_media_video): ) assert input_paid_media_video_dict["thumbnail"] == input_paid_media_video.thumbnail - def test_with_video(self, video): # noqa: F811 + def test_with_video(self, video): # fixture found in test_video input_paid_media_video = InputPaidMediaVideo(video) assert input_paid_media_video.type == self.type_ @@ -606,7 +588,7 @@ def test_with_video(self, video): # noqa: F811 assert input_paid_media_video.height == video.height assert input_paid_media_video.duration == video.duration - def test_with_video_file(self, video_file): # noqa: F811 + def test_with_video_file(self, video_file): # fixture found in test_video input_paid_media_video = InputPaidMediaVideo(video_file) assert input_paid_media_video.type == self.type_ @@ -621,7 +603,7 @@ def test_with_local_files(self): @pytest.fixture(scope="module") -def media_group(photo, thumb): # noqa: F811 +def media_group(photo, thumb): return [ InputMediaPhoto(photo, caption="*photo* 1", parse_mode="Markdown"), InputMediaPhoto(thumb, caption="photo 2", parse_mode="HTML"), @@ -632,12 +614,12 @@ def media_group(photo, thumb): # noqa: F811 @pytest.fixture(scope="module") -def media_group_no_caption_args(photo, thumb): # noqa: F811 +def media_group_no_caption_args(photo, thumb): return [InputMediaPhoto(photo), InputMediaPhoto(thumb), InputMediaPhoto(photo)] @pytest.fixture(scope="module") -def media_group_no_caption_only_caption_entities(photo, thumb): # noqa: F811 +def media_group_no_caption_only_caption_entities(photo, thumb): return [ InputMediaPhoto(photo, caption_entities=[MessageEntity(MessageEntity.BOLD, 0, 5)]), InputMediaPhoto(photo, caption_entities=[MessageEntity(MessageEntity.BOLD, 0, 5)]), @@ -645,7 +627,7 @@ def media_group_no_caption_only_caption_entities(photo, thumb): # noqa: F811 @pytest.fixture(scope="module") -def media_group_no_caption_only_parse_mode(photo, thumb): # noqa: F811 +def media_group_no_caption_only_parse_mode(photo, thumb): return [ InputMediaPhoto(photo, parse_mode="Markdown"), InputMediaPhoto(thumb, parse_mode="HTML"), @@ -676,10 +658,10 @@ async def test_send_media_group_custom_filename( self, offline_bot, chat_id, - photo_file, # noqa: F811 - animation_file, # noqa: F811 - audio_file, # noqa: F811 - video_file, # noqa: F811 + photo_file, + animation_file, + audio_file, + video_file, monkeypatch, ): async def make_assertion(url, request_data: RequestData, *args, **kwargs): @@ -703,7 +685,7 @@ async def make_assertion(url, request_data: RequestData, *args, **kwargs): await offline_bot.send_media_group(chat_id, media) async def test_send_media_group_with_thumbs( - self, offline_bot, chat_id, video_file, photo_file, monkeypatch # noqa: F811 + self, offline_bot, chat_id, video_file, photo_file, monkeypatch ): async def make_assertion(method, url, request_data: RequestData, *args, **kwargs): nonlocal input_video @@ -721,7 +703,7 @@ async def make_assertion(method, url, request_data: RequestData, *args, **kwargs await offline_bot.send_media_group(chat_id, [input_video, input_video]) async def test_edit_message_media_with_thumb( - self, offline_bot, chat_id, video_file, photo_file, monkeypatch # noqa: F811 + self, offline_bot, chat_id, video_file, photo_file, monkeypatch ): async def make_assertion( method: str, url: str, request_data: Optional[RequestData] = None, *args, **kwargs @@ -792,9 +774,7 @@ async def test_send_media_group_photo(self, bot, chat_id, media_group): mes.caption_entities == (MessageEntity(MessageEntity.BOLD, 0, 5),) for mes in messages ) - async def test_send_media_group_new_files( - self, bot, chat_id, video_file, photo_file # noqa: F811 - ): + async def test_send_media_group_new_files(self, bot, chat_id, video_file, photo_file): async def func(): return await bot.send_media_group( chat_id, @@ -830,7 +810,7 @@ async def test_send_media_group_different_sequences( assert all(mes.media_group_id == messages[0].media_group_id for mes in messages) async def test_send_media_group_with_message_thread_id( - self, bot, real_topic, forum_group_id, media_group # noqa: F811 + self, bot, real_topic, forum_group_id, media_group ): messages = await bot.send_media_group( forum_group_id, @@ -929,9 +909,7 @@ async def test_send_media_group_all_args(self, bot, raw_bot, chat_id, media_grou ) assert all(mes.has_protected_content for mes in messages) - async def test_send_media_group_with_spoiler( - self, bot, chat_id, photo_file, video_file # noqa: F811 - ): + async def test_send_media_group_with_spoiler(self, bot, chat_id, photo_file, video_file): # Media groups can't contain Animations, so that is tested in test_animation.py media = [ InputMediaPhoto(photo_file, has_spoiler=True), @@ -1074,11 +1052,11 @@ async def test_edit_message_media_default_parse_mode( chat_id, default_bot, media_type, - animation, # noqa: F811 - document, # noqa: F811 - audio, # noqa: F811 - photo, # noqa: F811 - video, # noqa: F811 + animation, + document, + audio, + photo, + video, ): html_caption = "bold italic code" markdown_caption = "*bold* _italic_ `code`" @@ -1153,7 +1131,7 @@ def build_media(parse_mode, med_type): # make sure that the media was not modified assert media.parse_mode == copied_media.parse_mode - async def test_send_paid_media(self, bot, channel_id, photo_file, video_file): # noqa: F811 + async def test_send_paid_media(self, bot, channel_id, photo_file, video_file): msg = await bot.send_paid_media( chat_id=channel_id, star_count=20, diff --git a/tests/_files/test_inputsticker.py b/tests/_files/test_inputsticker.py index bd45bbdea59..cfbe20560ef 100644 --- a/tests/_files/test_inputsticker.py +++ b/tests/_files/test_inputsticker.py @@ -21,7 +21,6 @@ from telegram import InputSticker, MaskPosition from telegram._files.inputfile import InputFile -from tests._files.test_sticker import video_sticker_file # noqa: F401 from tests.auxil.files import data_file from tests.auxil.slots import mro_slots @@ -77,7 +76,7 @@ def test_to_dict(self, input_sticker): assert input_sticker_dict["keywords"] == list(input_sticker.keywords) assert input_sticker_dict["format"] == input_sticker.format - def test_with_sticker_input_types(self, video_sticker_file): # noqa: F811 + def test_with_sticker_input_types(self, video_sticker_file): sticker = InputSticker(sticker=video_sticker_file, emoji_list=["👍"], format="video") assert isinstance(sticker.sticker, InputFile) sticker = InputSticker(data_file("telegram_video_sticker.webm"), ["👍"], "video") diff --git a/tests/_files/test_photo.py b/tests/_files/test_photo.py index 919c3155bcb..bdf34f72b4a 100644 --- a/tests/_files/test_photo.py +++ b/tests/_files/test_photo.py @@ -34,37 +34,9 @@ ) from tests.auxil.build_messages import make_message from tests.auxil.files import data_file -from tests.auxil.networking import expect_bad_request from tests.auxil.slots import mro_slots -@pytest.fixture -def photo_file(): - with data_file("telegram.jpg").open("rb") as f: - yield f - - -@pytest.fixture(scope="module") -async def photolist(bot, chat_id): - async def func(): - with data_file("telegram.jpg").open("rb") as f: - return (await bot.send_photo(chat_id, photo=f, read_timeout=50)).photo - - return await expect_bad_request( - func, "Type of file mismatch", "Telegram did not accept the file." - ) - - -@pytest.fixture(scope="module") -def thumb(photolist): - return photolist[0] - - -@pytest.fixture(scope="module") -def photo(photolist): - return photolist[-1] - - class PhotoTestBase: width = 800 height = 800 diff --git a/tests/_files/test_sticker.py b/tests/_files/test_sticker.py index 3fa608e3a4d..d77f93ac776 100644 --- a/tests/_files/test_sticker.py +++ b/tests/_files/test_sticker.py @@ -49,46 +49,6 @@ from tests.auxil.slots import mro_slots -@pytest.fixture -def sticker_file(): - with data_file("telegram.webp").open("rb") as file: - yield file - - -@pytest.fixture(scope="module") -async def sticker(bot, chat_id): - with data_file("telegram.webp").open("rb") as f: - sticker = (await bot.send_sticker(chat_id, sticker=f, read_timeout=50)).sticker - # necessary to properly test needs_repainting - with sticker._unfrozen(): - sticker.needs_repainting = StickerTestBase.needs_repainting - return sticker - - -@pytest.fixture -def animated_sticker_file(): - with data_file("telegram_animated_sticker.tgs").open("rb") as f: - yield f - - -@pytest.fixture(scope="module") -async def animated_sticker(bot, chat_id): - with data_file("telegram_animated_sticker.tgs").open("rb") as f: - return (await bot.send_sticker(chat_id, sticker=f, read_timeout=50)).sticker - - -@pytest.fixture -def video_sticker_file(): - with data_file("telegram_video_sticker.webm").open("rb") as f: - yield f - - -@pytest.fixture(scope="module") -def video_sticker(bot, chat_id): - with data_file("telegram_video_sticker.webm").open("rb") as f: - return bot.send_sticker(chat_id, sticker=f, timeout=50).sticker - - class StickerTestBase: # sticker_file_url = 'https://python-telegram-bot.org/static/testfiles/telegram.webp' # Serving sticker from gh since our server sends wrong content_type @@ -524,54 +484,6 @@ async def test_error_send_empty_file_id(self, bot, chat_id): await bot.send_sticker(chat_id, "") -@pytest.fixture -async def sticker_set(bot): - ss = await bot.get_sticker_set(f"test_by_{bot.username}") - if len(ss.stickers) > 100: - try: - for i in range(1, 50): - await bot.delete_sticker_from_set(ss.stickers[-i].file_id) - except BadRequest as e: - if e.message == "Stickerset_not_modified": - return ss - raise Exception("stickerset is growing too large.") from None - return ss - - -@pytest.fixture -async def animated_sticker_set(bot): - ss = await bot.get_sticker_set(f"animated_test_by_{bot.username}") - if len(ss.stickers) > 100: - try: - for i in range(1, 50): - await bot.delete_sticker_from_set(ss.stickers[-i].file_id) - except BadRequest as e: - if e.message == "Stickerset_not_modified": - return ss - raise Exception("stickerset is growing too large.") from None - return ss - - -@pytest.fixture -async def video_sticker_set(bot): - ss = await bot.get_sticker_set(f"video_test_by_{bot.username}") - if len(ss.stickers) > 100: - try: - for i in range(1, 50): - await bot.delete_sticker_from_set(ss.stickers[-i].file_id) - except BadRequest as e: - if e.message == "Stickerset_not_modified": - return ss - raise Exception("stickerset is growing too large.") from None - return ss - - -@pytest.fixture -def sticker_set_thumb_file(): - with data_file("sticker_set_thumb.png").open("rb") as file: - yield file - - class StickerSetTestBase: title = "Test stickers" stickers = [Sticker("file_id", "file_un_id", 512, 512, True, True, Sticker.REGULAR)] @@ -1067,6 +979,13 @@ async def test_bot_methods_8_png(self, bot, sticker_set, sticker_file): ) +class MaskPositionTestBase: + point = MaskPosition.EYES + x_shift = -1 + y_shift = 1 + scale = 2 + + @pytest.fixture(scope="module") def mask_position(): return MaskPosition( @@ -1077,13 +996,6 @@ def mask_position(): ) -class MaskPositionTestBase: - point = MaskPosition.EYES - x_shift = -1 - y_shift = 1 - scale = 2 - - class TestMaskPositionWithoutRequest(MaskPositionTestBase): def test_slot_behaviour(self, mask_position): inst = mask_position diff --git a/tests/_files/test_video.py b/tests/_files/test_video.py index d4ace54e3e5..66230389f7e 100644 --- a/tests/_files/test_video.py +++ b/tests/_files/test_video.py @@ -37,18 +37,6 @@ from tests.auxil.slots import mro_slots -@pytest.fixture -def video_file(): - with data_file("telegram.mp4").open("rb") as f: - yield f - - -@pytest.fixture(scope="module") -async def video(bot, chat_id): - with data_file("telegram.mp4").open("rb") as f: - return (await bot.send_video(chat_id, video=f, read_timeout=50)).video - - class VideoTestBase: width = 360 height = 640 diff --git a/tests/_files/test_videonote.py b/tests/_files/test_videonote.py index d85de9fb4b0..ce69fa8f850 100644 --- a/tests/_files/test_videonote.py +++ b/tests/_files/test_videonote.py @@ -248,7 +248,7 @@ async def test_send_all_args(self, bot, chat_id, video_note_file, video_note, th assert message.video_note.thumbnail.height == self.thumb_height assert message.has_protected_content - async def test_get_and_download(self, bot, video_note, chat_id, tmp_file): + async def test_get_and_download(self, bot, video_note, tmp_file): new_file = await bot.get_file(video_note.file_id) assert new_file.file_size == self.file_size diff --git a/tests/auxil/constants.py b/tests/auxil/constants.py index 8ec314bfbe5..5c90824ba4c 100644 --- a/tests/auxil/constants.py +++ b/tests/auxil/constants.py @@ -20,3 +20,7 @@ # THIS KEY IS OBVIOUSLY COMPROMISED # DO NOT USE IN PRODUCTION! PRIVATE_KEY = b"-----BEGIN RSA PRIVATE KEY-----\r\nMIIEowIBAAKCAQEA0AvEbNaOnfIL3GjB8VI4M5IaWe+GcK8eSPHkLkXREIsaddum\r\nwPBm/+w8lFYdnY+O06OEJrsaDtwGdU//8cbGJ/H/9cJH3dh0tNbfszP7nTrQD+88\r\nydlcYHzClaG8G+oTe9uEZSVdDXj5IUqR0y6rDXXb9tC9l+oSz+ShYg6+C4grAb3E\r\nSTv5khZ9Zsi/JEPWStqNdpoNuRh7qEYc3t4B/a5BH7bsQENyJSc8AWrfv+drPAEe\r\njQ8xm1ygzWvJp8yZPwOIYuL+obtANcoVT2G2150Wy6qLC0bD88Bm40GqLbSazueC\r\nRHZRug0B9rMUKvKc4FhG4AlNzBCaKgIcCWEqKwIDAQABAoIBACcIjin9d3Sa3S7V\r\nWM32JyVF3DvTfN3XfU8iUzV7U+ZOswA53eeFM04A/Ly4C4ZsUNfUbg72O8Vd8rg/\r\n8j1ilfsYpHVvphwxaHQlfIMa1bKCPlc/A6C7b2GLBtccKTbzjARJA2YWxIaqk9Nz\r\nMjj1IJK98i80qt29xRnMQ5sqOO3gn2SxTErvNchtBiwOH8NirqERXig8VCY6fr3n\r\nz7ZImPU3G/4qpD0+9ULrt9x/VkjqVvNdK1l7CyAuve3D7ha3jPMfVHFtVH5gqbyp\r\nKotyIHAyD+Ex3FQ1JV+H7DkP0cPctQiss7OiO9Zd9C1G2OrfQz9el7ewAPqOmZtC\r\nKjB3hUECgYEA/4MfKa1cvaCqzd3yUprp1JhvssVkhM1HyucIxB5xmBcVLX2/Kdhn\r\nhiDApZXARK0O9IRpFF6QVeMEX7TzFwB6dfkyIePsGxputA5SPbtBlHOvjZa8omMl\r\nEYfNa8x/mJkvSEpzvkWPascuHJWv1cEypqphu/70DxubWB5UKo/8o6cCgYEA0HFy\r\ncgwPMB//nltHGrmaQZPFT7/Qgl9ErZT3G9S8teWY4o4CXnkdU75tBoKAaJnpSfX3\r\nq8VuRerF45AFhqCKhlG4l51oW7TUH50qE3GM+4ivaH5YZB3biwQ9Wqw+QyNLAh/Q\r\nnS4/Wwb8qC9QuyEgcCju5lsCaPEXZiZqtPVxZd0CgYEAshBG31yZjO0zG1TZUwfy\r\nfN3euc8mRgZpSdXIHiS5NSyg7Zr8ZcUSID8jAkJiQ3n3OiAsuq1MGQ6kNa582kLT\r\nFPQdI9Ea8ahyDbkNR0gAY9xbM2kg/Gnro1PorH9PTKE0ekSodKk1UUyNrg4DBAwn\r\nqE6E3ebHXt/2WmqIbUD653ECgYBQCC8EAQNX3AFegPd1GGxU33Lz4tchJ4kMCNU0\r\nN2NZh9VCr3nTYjdTbxsXU8YP44CCKFG2/zAO4kymyiaFAWEOn5P7irGF/JExrjt4\r\nibGy5lFLEq/HiPtBjhgsl1O0nXlwUFzd7OLghXc+8CPUJaz5w42unqT3PBJa40c3\r\nQcIPdQKBgBnSb7BcDAAQ/Qx9juo/RKpvhyeqlnp0GzPSQjvtWi9dQRIu9Pe7luHc\r\nm1Img1EO1OyE3dis/rLaDsAa2AKu1Yx6h85EmNjavBqP9wqmFa0NIQQH8fvzKY3/\r\nP8IHY6009aoamLqYaexvrkHVq7fFKiI6k8myMJ6qblVNFv14+KXU\r\n-----END RSA PRIVATE KEY-----" # noqa: E501 + +TEST_MSG_TEXT = "Topics are forever" +TEST_TOPIC_ICON_COLOR = 0x6FB9F0 +TEST_TOPIC_NAME = "Sad bot true: real stories" diff --git a/tests/conftest.py b/tests/conftest.py index b637f89573c..02f83b47555 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -40,7 +40,7 @@ from telegram.ext import Defaults from tests.auxil.build_messages import DATE from tests.auxil.ci_bots import BOT_INFO_PROVIDER, JOB_INDEX -from tests.auxil.constants import PRIVATE_KEY +from tests.auxil.constants import PRIVATE_KEY, TEST_TOPIC_ICON_COLOR, TEST_TOPIC_NAME from tests.auxil.envvars import GITHUB_ACTION, RUN_TEST_OFFICIAL, TEST_WITH_OPT_DEPS from tests.auxil.files import data_file from tests.auxil.networking import NonchalantHttpxRequest @@ -264,6 +264,30 @@ def class_thumb_file(): yield f +@pytest.fixture(scope="session") +async def emoji_id(bot): + emoji_sticker_list = await bot.get_forum_topic_icon_stickers() + first_sticker = emoji_sticker_list[0] + return first_sticker.custom_emoji_id + + +@pytest.fixture +async def real_topic(bot, emoji_id, forum_group_id): + result = await bot.create_forum_topic( + chat_id=forum_group_id, + name=TEST_TOPIC_NAME, + icon_color=TEST_TOPIC_ICON_COLOR, + icon_custom_emoji_id=emoji_id, + ) + + yield result + + result = await bot.delete_forum_topic( + chat_id=forum_group_id, message_thread_id=result.message_thread_id + ) + assert result is True, "Topic was not deleted" + + def _get_false_update_fixture_decorator_params(): message = Message(1, DATE, Chat(1, ""), from_user=User(1, "", False), text="test") params = [ diff --git a/tests/test_bot.py b/tests/test_bot.py index fa723093f37..00f65385871 100644 --- a/tests/test_bot.py +++ b/tests/test_bot.py @@ -103,11 +103,10 @@ from tests.auxil.pytest_classes import PytestBot, PytestExtBot, make_bot from tests.auxil.slots import mro_slots -from ._files.test_photo import photo_file from .auxil.build_messages import make_message -@pytest.fixture +@pytest.fixture(scope="module") async def message(bot, chat_id): # mostly used in tests for edit_message out = await bot.send_message( chat_id, "Text", disable_web_page_preview=True, disable_notification=True @@ -1128,7 +1127,7 @@ async def test_rtm_aswr_mutually_exclusive_reply_parameters(self, offline_bot, c ) # Test with send media group - media = InputMediaPhoto(photo_file) + media = InputMediaPhoto("") with pytest.raises(ValueError, match="`reply_to_message_id` and"): await offline_bot.send_media_group( chat_id, media, reply_to_message_id=1, reply_parameters=True diff --git a/tests/test_forum.py b/tests/test_forum.py index 4fd65c5d8dd..70bca8a028a 100644 --- a/tests/test_forum.py +++ b/tests/test_forum.py @@ -32,19 +32,9 @@ Sticker, ) from telegram.error import BadRequest +from tests.auxil.constants import TEST_MSG_TEXT, TEST_TOPIC_ICON_COLOR, TEST_TOPIC_NAME from tests.auxil.slots import mro_slots -TEST_MSG_TEXT = "Topics are forever" -TEST_TOPIC_ICON_COLOR = 0x6FB9F0 -TEST_TOPIC_NAME = "Sad bot true: real stories" - - -@pytest.fixture(scope="module") -async def emoji_id(bot): - emoji_sticker_list = await bot.get_forum_topic_icon_stickers() - first_sticker = emoji_sticker_list[0] - return first_sticker.custom_emoji_id - @pytest.fixture(scope="module") async def forum_topic_object(forum_group_id, emoji_id): @@ -56,23 +46,6 @@ async def forum_topic_object(forum_group_id, emoji_id): ) -@pytest.fixture -async def real_topic(bot, emoji_id, forum_group_id): - result = await bot.create_forum_topic( - chat_id=forum_group_id, - name=TEST_TOPIC_NAME, - icon_color=TEST_TOPIC_ICON_COLOR, - icon_custom_emoji_id=emoji_id, - ) - - yield result - - result = await bot.delete_forum_topic( - chat_id=forum_group_id, message_thread_id=result.message_thread_id - ) - assert result is True, "Topic was not deleted" - - class TestForumTopicWithoutRequest: def test_slot_behaviour(self, forum_topic_object): inst = forum_topic_object From 2eae2830f3aa53ca5c381455121e6fdcddba06f1 Mon Sep 17 00:00:00 2001 From: Bibo-Joshi <22366557+Bibo-Joshi@users.noreply.github.com> Date: Sat, 21 Sep 2024 11:34:25 +0200 Subject: [PATCH 02/25] Maintenance Work on `Bot` Tests (#4489) Co-authored-by: Harshil <37377066+harshil21@users.noreply.github.com> --- tests/test_bot.py | 32 ++++++++++++++------------------ 1 file changed, 14 insertions(+), 18 deletions(-) diff --git a/tests/test_bot.py b/tests/test_bot.py index 00f65385871..54fa28f11cb 100644 --- a/tests/test_bot.py +++ b/tests/test_bot.py @@ -90,7 +90,7 @@ ParseMode, ReactionEmoji, ) -from telegram.error import BadRequest, EndPointNotFound, InvalidToken, NetworkError +from telegram.error import BadRequest, EndPointNotFound, InvalidToken from telegram.ext import ExtBot, InvalidCallbackData from telegram.helpers import escape_markdown from telegram.request import BaseRequest, HTTPXRequest, RequestData @@ -2264,6 +2264,19 @@ async def do_request(*args, **kwargs): obj = await offline_bot.get_business_connection(business_connection_id=bci) assert isinstance(obj, BusinessConnection) + async def test_send_chat_action_all_args(self, bot, chat_id, monkeypatch): + async def make_assertion(*args, **_): + kwargs = args[1] + return ( + kwargs["chat_id"] == chat_id + and kwargs["action"] == "action" + and kwargs["message_thread_id"] == 1 + and kwargs["business_connection_id"] == 3 + ) + + monkeypatch.setattr(bot, "_post", make_assertion) + assert await bot.send_chat_action(chat_id, "action", 1, 3) + async def test_refund_star_payment(self, offline_bot, monkeypatch): # can't make actual request so we just test that the correct data is passed async def make_assertion(url, request_data: RequestData, *args, **kwargs): @@ -2395,8 +2408,6 @@ async def test_forward_messages(self, bot, chat_id): async def test_delete_message(self, bot, chat_id): message = await bot.send_message(chat_id, text="will be deleted") - await asyncio.sleep(2) - assert await bot.delete_message(chat_id=chat_id, message_id=message.message_id) is True async def test_delete_message_old_message(self, bot, chat_id): @@ -2488,18 +2499,6 @@ async def test_send_contact(self, bot, chat_id): assert message.contact.last_name == last_name assert message.has_protected_content - async def test_send_chat_action_all_args(self, bot, chat_id, monkeypatch): - async def make_assertion(*args, **_): - kwargs = args[1] - return ( - kwargs["chat_id"] == chat_id - and kwargs["action"] == "action" - and kwargs["message_thread_id"] == 1 - ) - - monkeypatch.setattr(bot, "_post", make_assertion) - assert await bot.send_chat_action(chat_id, "action", 1) - # TODO: Add bot to group to test polls too @pytest.mark.parametrize( "reply_markup", @@ -3108,9 +3107,6 @@ async def test_leave_chat(self, bot): with pytest.raises(BadRequest, match="Chat not found"): await bot.leave_chat(-123456) - with pytest.raises(NetworkError, match="Chat not found"): - await bot.leave_chat(-123456) - async def test_get_chat(self, bot, super_group_id): cfi = await bot.get_chat(super_group_id) assert cfi.type == "supergroup" From 3409f511075bcdacd39984ad645950cf9f22253b Mon Sep 17 00:00:00 2001 From: Bibo-Joshi <22366557+Bibo-Joshi@users.noreply.github.com> Date: Sat, 21 Sep 2024 17:15:22 +0200 Subject: [PATCH 03/25] Introduce Codecov's Test Analysis (#4487) --- .github/workflows/unit_tests.yml | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/.github/workflows/unit_tests.yml b/.github/workflows/unit_tests.yml index fc9925c0806..a8acc04a8a2 100644 --- a/.github/workflows/unit_tests.yml +++ b/.github/workflows/unit_tests.yml @@ -57,11 +57,8 @@ jobs: # - without socks support # - without http2 support TO_TEST="test_no_passport.py or test_datetime.py or test_defaults.py or test_jobqueue.py or test_applicationbuilder.py or test_ratelimiter.py or test_updater.py or test_callbackdatacache.py or test_request.py" - pytest -v --cov -k "${TO_TEST}" - # Rerun only failed tests (--lf), and don't run any tests if none failed (--lfnf=none) - pytest -v --cov --cov-append -k "${TO_TEST}" --lf --lfnf=none --junit-xml=.test_report_no_optionals.xml - # No tests were selected, convert returned status code to 0 - opt_dep_status=$(( $? == 5 ? 0 : $? )) + pytest -v --cov -k "${TO_TEST}" --junit-xml=.test_report_no_optionals_junit.xml + opt_dep_status=$? # Test the rest export TEST_WITH_OPT_DEPS='true' @@ -69,9 +66,8 @@ jobs: # `-n auto --dist loadfile` uses pytest-xdist to run each test file on a different CPU # worker. Increasing number of workers has little effect on test duration, but it seems # to increase flakyness, specially on python 3.7 with --dist=loadgroup. - pytest -v --cov --cov-append -n auto --dist loadfile - pytest -v --cov --cov-append -n auto --dist loadfile --lf --lfnf=none --junit-xml=.test_report_optionals.xml - main_status=$(( $? == 5 ? 0 : $? )) + pytest -v --cov --cov-append -n auto --dist loadfile --junit-xml=.test_report_optionals_junit.xml + main_status=$? # exit with non-zero status if any of the two pytest runs failed exit $(( ${opt_dep_status} || ${main_status} )) env: @@ -87,8 +83,8 @@ jobs: if: always() # always run, even if tests fail with: paths: | - .test_report_no_optionals.xml - .test_report_optionals.xml + .test_report_no_optionals_junit.xml + .test_report_optionals_junit.xml - name: Submit coverage uses: codecov/codecov-action@v4 @@ -97,3 +93,9 @@ jobs: name: ${{ matrix.os }}-${{ matrix.python-version }} fail_ci_if_error: true token: ${{ secrets.CODECOV_TOKEN }} + - name: Upload test results to Codecov + uses: codecov/test-results-action@v1 + if: ${{ !cancelled() }} + with: + files: .test_report_no_optionals_junit.xml,.test_report_optionals_junit.xml + token: ${{ secrets.CODECOV_TOKEN }} From 9709c03b35c6125e432d36d4739b839ae592c6d4 Mon Sep 17 00:00:00 2001 From: Bibo-Joshi <22366557+Bibo-Joshi@users.noreply.github.com> Date: Sat, 21 Sep 2024 18:49:33 +0200 Subject: [PATCH 04/25] Fix Failing Tests by Making Them Independent (#4494) --- tests/test_bot.py | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/tests/test_bot.py b/tests/test_bot.py index 54fa28f11cb..b8cdf5f17f1 100644 --- a/tests/test_bot.py +++ b/tests/test_bot.py @@ -2863,10 +2863,13 @@ async def test_edit_message_text_entities(self, bot, message): assert message.entities == tuple(entities) @pytest.mark.parametrize("default_bot", [{"parse_mode": "Markdown"}], indirect=True) - async def test_edit_message_text_default_parse_mode(self, default_bot, message): + async def test_edit_message_text_default_parse_mode(self, default_bot, chat_id): test_string = "Italic Bold Code" test_markdown_string = "_Italic_ *Bold* `Code`" + # can't use `message` fixture as that would change its value + message = await default_bot.send_message(chat_id, "dummy text") + message = await default_bot.edit_message_text( text=test_markdown_string, chat_id=message.chat_id, @@ -2937,10 +2940,16 @@ async def test_edit_message_caption_entities(self, bot, media_message): # edit_message_media is tested in test_inputmedia @pytest.mark.parametrize("default_bot", [{"parse_mode": "Markdown"}], indirect=True) - async def test_edit_message_caption_default_parse_mode(self, default_bot, media_message): + async def test_edit_message_caption_default_parse_mode(self, default_bot, chat_id): test_string = "Italic Bold Code" test_markdown_string = "_Italic_ *Bold* `Code`" + # can't use `media_message` fixture as that would change its value + with data_file("telegram.ogg").open("rb") as f: + media_message = await default_bot.send_voice( + chat_id, voice=f, caption="my caption", read_timeout=10 + ) + message = await default_bot.edit_message_caption( caption=test_markdown_string, chat_id=media_message.chat_id, From bd3cdbcdbd807275dcdd01819f595da6bc882f31 Mon Sep 17 00:00:00 2001 From: Bibo-Joshi <22366557+Bibo-Joshi@users.noreply.github.com> Date: Sun, 22 Sep 2024 19:49:48 +0200 Subject: [PATCH 05/25] Update `pytest-xdist` Usage (#4491) --- .github/workflows/unit_tests.yml | 10 +++++----- tests/test_bot.py | 21 +-------------------- 2 files changed, 6 insertions(+), 25 deletions(-) diff --git a/.github/workflows/unit_tests.yml b/.github/workflows/unit_tests.yml index a8acc04a8a2..67a0bb80cf1 100644 --- a/.github/workflows/unit_tests.yml +++ b/.github/workflows/unit_tests.yml @@ -37,7 +37,7 @@ jobs: python -W ignore -m pip install -U pytest-cov python -W ignore -m pip install . python -W ignore -m pip install -r requirements-unit-tests.txt - python -W ignore -m pip install pytest-xdist[psutil] + python -W ignore -m pip install pytest-xdist - name: Test with pytest # We run 4 different suites here @@ -63,10 +63,10 @@ jobs: # Test the rest export TEST_WITH_OPT_DEPS='true' pip install .[all] - # `-n auto --dist loadfile` uses pytest-xdist to run each test file on a different CPU - # worker. Increasing number of workers has little effect on test duration, but it seems - # to increase flakyness, specially on python 3.7 with --dist=loadgroup. - pytest -v --cov --cov-append -n auto --dist loadfile --junit-xml=.test_report_optionals_junit.xml + # `-n auto --dist worksteal` uses pytest-xdist to run tests on multiple CPU + # workers. Increasing number of workers has little effect on test duration, but it seems + # to increase flakyness. + pytest -v --cov --cov-append -n auto --dist worksteal --junit-xml=.test_report_optionals_junit.xml main_status=$? # exit with non-zero status if any of the two pytest runs failed exit $(( ${opt_dep_status} || ${main_status} )) diff --git a/tests/test_bot.py b/tests/test_bot.py index b8cdf5f17f1..12745827e81 100644 --- a/tests/test_bot.py +++ b/tests/test_bot.py @@ -3007,7 +3007,6 @@ async def test_edit_reply_markup(self, bot, message): async def test_edit_reply_markup_inline(self): pass - @pytest.mark.xdist_group("getUpdates_and_webhook") # TODO: Actually send updates to the test bot so this can be tested properly async def test_get_updates(self, bot): await bot.delete_webhook() # make sure there is no webhook set if webhook tests failed @@ -3074,7 +3073,6 @@ async def catch_timeouts(*args, **kwargs): await bot.get_updates(read_timeout=read_timeout, timeout=timeout) assert caught_read_timeout == expected - @pytest.mark.xdist_group("getUpdates_and_webhook") @pytest.mark.parametrize("use_ip", [True, False]) # local file path as file_input is tested below in test_set_webhook_params @pytest.mark.parametrize("file_input", ["bytes", "file_handle"]) @@ -3209,10 +3207,8 @@ async def test_send_game_default_protect_content(self, default_bot, chat_id, val protected = await default_bot.send_game(chat_id, "test_game", protect_content=val) assert protected.has_protected_content is val - @pytest.mark.xdist_group("game") @xfail - async def test_set_game_score_1(self, bot, chat_id): - # NOTE: numbering of methods assures proper order between test_set_game_scoreX methods + async def test_set_game_score_and_high_scores(self, bot, chat_id): # First, test setting a score. game_short_name = "test_game" game = await bot.send_game(chat_id, game_short_name) @@ -3229,10 +3225,6 @@ async def test_set_game_score_1(self, bot, chat_id): assert message.game.animation.file_unique_id == game.game.animation.file_unique_id assert message.game.text != game.game.text - @pytest.mark.xdist_group("game") - @xfail - async def test_set_game_score_2(self, bot, chat_id): - # NOTE: numbering of methods assures proper order between test_set_game_scoreX methods # Test setting a score higher than previous game_short_name = "test_game" game = await bot.send_game(chat_id, game_short_name) @@ -3252,10 +3244,6 @@ async def test_set_game_score_2(self, bot, chat_id): assert message.game.animation.file_unique_id == game.game.animation.file_unique_id assert message.game.text == game.game.text - @pytest.mark.xdist_group("game") - @xfail - async def test_set_game_score_3(self, bot, chat_id): - # NOTE: numbering of methods assures proper order between test_set_game_scoreX methods # Test setting a score lower than previous (should raise error) game_short_name = "test_game" game = await bot.send_game(chat_id, game_short_name) @@ -3267,10 +3255,6 @@ async def test_set_game_score_3(self, bot, chat_id): user_id=chat_id, score=score, chat_id=game.chat_id, message_id=game.message_id ) - @pytest.mark.xdist_group("game") - @xfail - async def test_set_game_score_4(self, bot, chat_id): - # NOTE: numbering of methods assures proper order between test_set_game_scoreX methods # Test force setting a lower score game_short_name = "test_game" game = await bot.send_game(chat_id, game_short_name) @@ -3295,9 +3279,6 @@ async def test_set_game_score_4(self, bot, chat_id): game2 = await bot.send_game(chat_id, game_short_name) assert str(score) in game2.game.text - @pytest.mark.xdist_group("game") - @xfail - async def test_get_game_high_scores(self, bot, chat_id): # We need a game to get the scores for game_short_name = "test_game" game = await bot.send_game(chat_id, game_short_name) From 79e589b39ebb2a71a8113087eac7d06b68d5fd6d Mon Sep 17 00:00:00 2001 From: Bibo-Joshi <22366557+Bibo-Joshi@users.noreply.github.com> Date: Wed, 25 Sep 2024 17:17:55 +0200 Subject: [PATCH 06/25] Reduce Creation of HTTP Clients in Tests (#4493) --- tests/auxil/build_messages.py | 5 +++-- tests/auxil/pytest_classes.py | 2 +- tests/conftest.py | 10 +++++----- tests/ext/test_basepersistence.py | 15 +++++++++++---- tests/ext/test_callbackcontext.py | 2 +- tests/test_bot.py | 10 +++++----- 6 files changed, 26 insertions(+), 18 deletions(-) diff --git a/tests/auxil/build_messages.py b/tests/auxil/build_messages.py index 69370977efb..8664317d229 100644 --- a/tests/auxil/build_messages.py +++ b/tests/auxil/build_messages.py @@ -27,16 +27,17 @@ DATE = datetime.datetime.now() -def make_message(text, **kwargs): +def make_message(text: str, offline: bool = True, **kwargs): """ Testing utility factory to create a fake ``telegram.Message`` with reasonable defaults for mimicking a real message. :param text: (str) message text + :param offline: (bool) whether the bot should be offline :return: a (fake) ``telegram.Message`` """ bot = kwargs.pop("bot", None) if bot is None: - bot = make_bot(BOT_INFO_PROVIDER.get_info()) + bot = make_bot(BOT_INFO_PROVIDER.get_info(), offline=offline) message = Message( message_id=1, from_user=kwargs.pop("user", User(id=1, first_name="", is_bot=False)), diff --git a/tests/auxil/pytest_classes.py b/tests/auxil/pytest_classes.py index b80945b6704..f85e12ac23c 100644 --- a/tests/auxil/pytest_classes.py +++ b/tests/auxil/pytest_classes.py @@ -93,7 +93,7 @@ class PytestUpdater(Updater): pass -def make_bot(bot_info=None, offline: bool = False, **kwargs): +def make_bot(bot_info=None, offline: bool = True, **kwargs): """ Tests are executed on tg.ext.ExtBot, as that class only extends the functionality of tg.bot """ diff --git a/tests/conftest.py b/tests/conftest.py index 02f83b47555..69c8ce96037 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -152,7 +152,7 @@ def bot_info() -> Dict[str, str]: @pytest.fixture(scope="session") async def bot(bot_info): """Makes an ExtBot instance with the given bot_info""" - async with make_bot(bot_info) as _bot: + async with make_bot(bot_info, offline=False) as _bot: yield _bot @@ -168,13 +168,13 @@ async def offline_bot(bot_info): @pytest.fixture def one_time_bot(bot_info): """A function scoped bot since the session bot would shutdown when `async with app` finishes""" - return make_bot(bot_info) + return make_bot(bot_info, offline=False) @pytest.fixture(scope="session") async def cdc_bot(bot_info): """Makes an ExtBot instance with the given bot_info that uses arbitrary callback_data""" - async with make_bot(bot_info, arbitrary_callback_data=True) as _bot: + async with make_bot(bot_info, arbitrary_callback_data=True, offline=False) as _bot: yield _bot @@ -204,7 +204,7 @@ async def default_bot(request, bot_info): # If the bot is already created, return it. Else make a new one. default_bot = _default_bots.get(defaults) if default_bot is None: - default_bot = make_bot(bot_info, defaults=defaults) + default_bot = make_bot(bot_info, defaults=defaults, offline=False) await default_bot.initialize() _default_bots[defaults] = default_bot # Defaults object is hashable return default_bot @@ -216,7 +216,7 @@ async def tz_bot(timezone, bot_info): try: # If the bot is already created, return it. Saves time since get_me is not called again. return _default_bots[defaults] except KeyError: - default_bot = make_bot(bot_info, defaults=defaults) + default_bot = make_bot(bot_info, defaults=defaults, offline=False) await default_bot.initialize() _default_bots[defaults] = default_bot return default_bot diff --git a/tests/ext/test_basepersistence.py b/tests/ext/test_basepersistence.py index d3c2ef771b9..c04a5d16826 100644 --- a/tests/ext/test_basepersistence.py +++ b/tests/ext/test_basepersistence.py @@ -24,6 +24,7 @@ import logging import sys import time +from http import HTTPStatus from pathlib import Path from typing import NamedTuple, Optional @@ -43,8 +44,9 @@ PersistenceInput, filters, ) +from telegram.request import HTTPXRequest from telegram.warnings import PTBUserWarning -from tests.auxil.build_messages import make_message_update +from tests.auxil.build_messages import make_message, make_message_update from tests.auxil.pytest_classes import PytestApplication, make_bot from tests.auxil.slots import mro_slots @@ -245,9 +247,9 @@ def build_papp( persistence = TrackingPersistence(store_data=store_data, fill_data=fill_data) if bot_info is not None: - bot = make_bot(bot_info, arbitrary_callback_data=True) + bot = make_bot(bot_info, arbitrary_callback_data=True, offline=False) else: - bot = make_bot(token=token, arbitrary_callback_data=True) + bot = make_bot(token=token, arbitrary_callback_data=True, offline=False) return ( ApplicationBuilder() .bot(bot) @@ -262,7 +264,7 @@ def build_conversation_handler(name: str, persistent: bool = True) -> BaseHandle @pytest.fixture -def papp(request, bot_info) -> Application: +def papp(request, bot_info, monkeypatch) -> Application: papp_input = request.param store_data = {} if papp_input.bot_data is not None: @@ -274,6 +276,11 @@ def papp(request, bot_info) -> Application: if papp_input.callback_data is not None: store_data["callback_data"] = papp_input.callback_data + async def do_request(*args, **kwargs): + return HTTPStatus.OK, make_message(text="text") + + monkeypatch.setattr(HTTPXRequest, "do_request", do_request) + app = build_papp( bot_info=bot_info, store_data=store_data, diff --git a/tests/ext/test_callbackcontext.py b/tests/ext/test_callbackcontext.py index 9a5f64e6f21..429d28a6ff6 100644 --- a/tests/ext/test_callbackcontext.py +++ b/tests/ext/test_callbackcontext.py @@ -211,7 +211,7 @@ def test_drop_callback_data_exception(self, bot, app, raw_bot): app.bot = bot async def test_drop_callback_data(self, bot, chat_id): - new_bot = make_bot(token=bot.token, arbitrary_callback_data=True) + new_bot = make_bot(token=bot.token, arbitrary_callback_data=True, offline=False) app = ApplicationBuilder().bot(new_bot).build() update = Update( diff --git a/tests/test_bot.py b/tests/test_bot.py index 12745827e81..379addbd859 100644 --- a/tests/test_bot.py +++ b/tests/test_bot.py @@ -361,13 +361,13 @@ async def test_equality(self): "link", ], ) - async def test_get_me_and_properties_not_initialized(self, offline_bot: Bot, attribute): - offline_bot = Bot(token=offline_bot.token) + async def test_get_me_and_properties_not_initialized(self, attribute): + bot = make_bot(offline=True, token="randomtoken") try: with pytest.raises(RuntimeError, match="not properly initialized"): - offline_bot[attribute] + bot[attribute] finally: - await offline_bot.shutdown() + await bot.shutdown() async def test_get_me_and_properties(self, offline_bot): get_me_bot = await ExtBot(offline_bot.token).get_me() @@ -1564,7 +1564,7 @@ async def post(url, request_data: RequestData, *args, **kwargs): [(True, 1024), (False, 1024), (0, 0), (None, None)], ) async def test_callback_data_maxsize(self, bot_info, acd_in, maxsize): - async with make_bot(bot_info, arbitrary_callback_data=acd_in) as acd_bot: + async with make_bot(bot_info, arbitrary_callback_data=acd_in, offline=True) as acd_bot: if acd_in is not False: assert acd_bot.callback_data_cache.maxsize == maxsize else: From 2bc65560ebbf77e1f301fac5472e1bafa1fd565e Mon Sep 17 00:00:00 2001 From: Bibo-Joshi <22366557+Bibo-Joshi@users.noreply.github.com> Date: Wed, 25 Sep 2024 18:53:26 +0200 Subject: [PATCH 07/25] Stabilize Some Flaky Tests (#4500) --- tests/_files/test_animation.py | 3 ++- tests/test_bot.py | 31 +++++++++++++++---------------- 2 files changed, 17 insertions(+), 17 deletions(-) diff --git a/tests/_files/test_animation.py b/tests/_files/test_animation.py index a312d3575cd..0f581259db9 100644 --- a/tests/_files/test_animation.py +++ b/tests/_files/test_animation.py @@ -233,7 +233,8 @@ async def test_send_all_args(self, bot, chat_id, animation_file, animation, thum assert message.animation.file_unique_id assert message.animation.file_name == animation.file_name assert message.animation.mime_type == animation.mime_type - assert message.animation.file_size == animation.file_size + # TGs reported file size is not reliable + assert isinstance(message.animation.file_size, int) assert message.animation.thumbnail.width == self.width assert message.animation.thumbnail.height == self.height assert message.has_protected_content diff --git a/tests/test_bot.py b/tests/test_bot.py index 379addbd859..426b5aa6637 100644 --- a/tests/test_bot.py +++ b/tests/test_bot.py @@ -2372,15 +2372,12 @@ async def test_forward_protected_message(self, bot, chat_id): assert all("can't be forwarded" in str(exc) for exc in result) async def test_forward_messages(self, bot, chat_id): - tasks = asyncio.gather( - bot.send_message(chat_id, text="will be forwarded"), - bot.send_message(chat_id, text="will be forwarded"), - ) - - msg1, msg2 = await tasks + # not using gather here to have deteriminically ordered message_ids + msg1 = await bot.send_message(chat_id, text="will be forwarded") + msg2 = await bot.send_message(chat_id, text="will be forwarded") forward_messages = await bot.forward_messages( - chat_id, from_chat_id=chat_id, message_ids=sorted((msg1.message_id, msg2.message_id)) + chat_id, from_chat_id=chat_id, message_ids=(msg1.message_id, msg2.message_id) ) assert isinstance(forward_messages, tuple) @@ -3939,14 +3936,12 @@ async def test_copy_message_with_default(self, default_bot, chat_id, media_messa assert len(message.caption_entities) == 0 async def test_copy_messages(self, bot, chat_id): - tasks = asyncio.gather( - bot.send_message(chat_id, text="will be copied 1"), - bot.send_message(chat_id, text="will be copied 2"), - ) - msg1, msg2 = await tasks + # not using gather here to have deterministically ordered message_ids + msg1 = await bot.send_message(chat_id, text="will be copied 1") + msg2 = await bot.send_message(chat_id, text="will be copied 2") copy_messages = await bot.copy_messages( - chat_id, from_chat_id=chat_id, message_ids=sorted((msg1.message_id, msg2.message_id)) + chat_id, from_chat_id=chat_id, message_ids=(msg1.message_id, msg2.message_id) ) assert isinstance(copy_messages, tuple) @@ -4059,7 +4054,7 @@ async def test_replace_callback_data_copy_message(self, cdc_bot, chat_id): bot.callback_data_cache.clear_callback_data() bot.callback_data_cache.clear_callback_queries() - async def test_get_chat_arbitrary_callback_data(self, channel_id, cdc_bot): + async def test_get_chat_arbitrary_callback_data(self, chat_id, cdc_bot): bot = cdc_bot try: @@ -4068,7 +4063,7 @@ async def test_get_chat_arbitrary_callback_data(self, channel_id, cdc_bot): ) message = await bot.send_message( - channel_id, text="get_chat_arbitrary_callback_data", reply_markup=reply_markup + chat_id, text="get_chat_arbitrary_callback_data", reply_markup=reply_markup ) await message.pin() @@ -4078,7 +4073,11 @@ async def test_get_chat_arbitrary_callback_data(self, channel_id, cdc_bot): ) assert data == "callback_data" - cfi = await bot.get_chat(channel_id) + cfi = await bot.get_chat(chat_id) + + if not cfi.pinned_message: + pytest.xfail("Pinning messages is not always reliable on TG") + assert cfi.pinned_message == message assert cfi.pinned_message.reply_markup == reply_markup assert await message.unpin() # (not placed in finally block since msg can be unbound) From 2f0690251842c82cd63088433722f3f4646d0c59 Mon Sep 17 00:00:00 2001 From: Bibo-Joshi <22366557+Bibo-Joshi@users.noreply.github.com> Date: Tue, 1 Oct 2024 07:16:29 +0200 Subject: [PATCH 08/25] Improve Test Instability Caused by `Message` Fixtures (#4507) --- tests/test_bot.py | 87 +++++++++++++++++++++++------------------------ 1 file changed, 42 insertions(+), 45 deletions(-) diff --git a/tests/test_bot.py b/tests/test_bot.py index 426b5aa6637..1c8671c97bd 100644 --- a/tests/test_bot.py +++ b/tests/test_bot.py @@ -106,17 +106,26 @@ from .auxil.build_messages import make_message -@pytest.fixture(scope="module") -async def message(bot, chat_id): # mostly used in tests for edit_message - out = await bot.send_message( +@pytest.fixture +async def one_time_message(bot, chat_id): + # mostly used in tests for edit_message and hence can't be reused + return await bot.send_message( chat_id, "Text", disable_web_page_preview=True, disable_notification=True ) - out._unfreeze() - return out @pytest.fixture(scope="module") +async def static_message(bot, chat_id): + # must not be edited to keep tests independent! We only use bot.send_message so that + # we have a valid message_id to e.g. reply to + return await bot.send_message( + chat_id, "Text", disable_web_page_preview=True, disable_notification=True + ) + + +@pytest.fixture async def media_message(bot, chat_id): + # mostly used in tests for edit_message and hence can't be reused with data_file("telegram.ogg").open("rb") as f: return await bot.send_voice(chat_id, voice=f, caption="my caption", read_timeout=10) @@ -1971,7 +1980,7 @@ async def post(url, request_data: RequestData, *args, **kwargs): indirect=["default_bot"], ) async def test_send_message_default_quote_parse_mode( - self, default_bot, chat_id, message, custom, monkeypatch + self, default_bot, chat_id, custom, monkeypatch ): async def make_assertion(url, request_data: RequestData, *args, **kwargs): assert request_data.parameters["reply_parameters"].get("quote_parse_mode") == ( @@ -1984,9 +1993,7 @@ async def make_assertion(url, request_data: RequestData, *args, **kwargs): kwargs["quote_parse_mode"] = custom monkeypatch.setattr(default_bot.request, "post", make_assertion) - await default_bot.send_message( - chat_id, message, reply_parameters=ReplyParameters(**kwargs) - ) + await default_bot.send_message(chat_id, "test", reply_parameters=ReplyParameters(**kwargs)) @pytest.mark.parametrize( ("default_bot", "custom"), @@ -2339,13 +2346,13 @@ async def test_multiple_init_cycles(self, bot): async with test_bot: await test_bot.get_me() - async def test_forward_message(self, bot, chat_id, message): + async def test_forward_message(self, bot, chat_id, static_message): forward_message = await bot.forward_message( - chat_id, from_chat_id=chat_id, message_id=message.message_id + chat_id, from_chat_id=chat_id, message_id=static_message.message_id ) - assert forward_message.text == message.text - assert forward_message.forward_origin.sender_user == message.from_user + assert forward_message.text == static_message.text + assert forward_message.forward_origin.sender_user == static_message.from_user assert isinstance(forward_message.forward_origin.date, dtm.datetime) async def test_forward_protected_message(self, bot, chat_id): @@ -2831,18 +2838,18 @@ async def test_get_one_user_profile_photo(self, bot, chat_id): assert user_profile_photos.total_count == 1 assert user_profile_photos.photos[0][0].file_size == 5403 - async def test_edit_message_text(self, bot, message): + async def test_edit_message_text(self, bot, one_time_message): message = await bot.edit_message_text( text="new_text", - chat_id=message.chat_id, - message_id=message.message_id, + chat_id=one_time_message.chat_id, + message_id=one_time_message.message_id, parse_mode="HTML", disable_web_page_preview=True, ) assert message.text == "new_text" - async def test_edit_message_text_entities(self, bot, message): + async def test_edit_message_text_entities(self, bot, one_time_message): test_string = "Italic Bold Code" entities = [ MessageEntity(MessageEntity.ITALIC, 0, 6), @@ -2851,8 +2858,8 @@ async def test_edit_message_text_entities(self, bot, message): ] message = await bot.edit_message_text( text=test_string, - chat_id=message.chat_id, - message_id=message.message_id, + chat_id=one_time_message.chat_id, + message_id=one_time_message.message_id, entities=entities, ) @@ -2860,17 +2867,16 @@ async def test_edit_message_text_entities(self, bot, message): assert message.entities == tuple(entities) @pytest.mark.parametrize("default_bot", [{"parse_mode": "Markdown"}], indirect=True) - async def test_edit_message_text_default_parse_mode(self, default_bot, chat_id): + async def test_edit_message_text_default_parse_mode( + self, default_bot, chat_id, one_time_message + ): test_string = "Italic Bold Code" test_markdown_string = "_Italic_ *Bold* `Code`" - # can't use `message` fixture as that would change its value - message = await default_bot.send_message(chat_id, "dummy text") - message = await default_bot.edit_message_text( text=test_markdown_string, - chat_id=message.chat_id, - message_id=message.message_id, + chat_id=one_time_message.chat_id, + message_id=one_time_message.message_id, disable_web_page_preview=True, ) assert message.text_markdown == test_markdown_string @@ -2886,21 +2892,16 @@ async def test_edit_message_text_default_parse_mode(self, default_bot, chat_id): assert message.text == test_markdown_string assert message.text_markdown == escape_markdown(test_markdown_string) + suffix = " edited" message = await default_bot.edit_message_text( - text=test_markdown_string, - chat_id=message.chat_id, - message_id=message.message_id, - disable_web_page_preview=True, - ) - message = await default_bot.edit_message_text( - text=test_markdown_string, + text=test_markdown_string + suffix, chat_id=message.chat_id, message_id=message.message_id, parse_mode="HTML", disable_web_page_preview=True, ) - assert message.text == test_markdown_string - assert message.text_markdown == escape_markdown(test_markdown_string) + assert message.text == test_markdown_string + suffix + assert message.text_markdown == escape_markdown(test_markdown_string) + suffix @pytest.mark.skip(reason="need reference to an inline message") async def test_edit_message_text_inline(self): @@ -2937,16 +2938,10 @@ async def test_edit_message_caption_entities(self, bot, media_message): # edit_message_media is tested in test_inputmedia @pytest.mark.parametrize("default_bot", [{"parse_mode": "Markdown"}], indirect=True) - async def test_edit_message_caption_default_parse_mode(self, default_bot, chat_id): + async def test_edit_message_caption_default_parse_mode(self, default_bot, media_message): test_string = "Italic Bold Code" test_markdown_string = "_Italic_ *Bold* `Code`" - # can't use `media_message` fixture as that would change its value - with data_file("telegram.ogg").open("rb") as f: - media_message = await default_bot.send_voice( - chat_id, voice=f, caption="my caption", read_timeout=10 - ) - message = await default_bot.edit_message_caption( caption=test_markdown_string, chat_id=media_message.chat_id, @@ -2992,10 +2987,12 @@ async def test_edit_message_caption_with_parse_mode(self, bot, media_message): async def test_edit_message_caption_inline(self): pass - async def test_edit_reply_markup(self, bot, message): + async def test_edit_reply_markup(self, bot, one_time_message): new_markup = InlineKeyboardMarkup([[InlineKeyboardButton(text="test", callback_data="1")]]) message = await bot.edit_message_reply_markup( - chat_id=message.chat_id, message_id=message.message_id, reply_markup=new_markup + chat_id=one_time_message.chat_id, + message_id=one_time_message.message_id, + reply_markup=new_markup, ) assert message is not True @@ -4181,9 +4178,9 @@ async def test_set_get_my_short_description(self, bot): bot.get_my_short_description("de"), ) == 3 * [BotShortDescription("")] - async def test_set_message_reaction(self, bot, chat_id, message): + async def test_set_message_reaction(self, bot, chat_id, static_message): assert await bot.set_message_reaction( - chat_id, message.message_id, ReactionEmoji.THUMBS_DOWN, True + chat_id, static_message.message_id, ReactionEmoji.THUMBS_DOWN, True ) @pytest.mark.parametrize("bot_class", [Bot, ExtBot]) From 9a8b208ef702930462061a57d5dee44123240963 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 2 Oct 2024 02:57:34 +0200 Subject: [PATCH 09/25] Bump `Bibo-Joshi/pyright-type-completeness` from 1.0.0 to 1.0.1 (#4510) Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .github/workflows/type_completeness.yml | 2 +- .github/workflows/type_completeness_monthly.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/type_completeness.yml b/.github/workflows/type_completeness.yml index 17dc249c81f..afa120e0793 100644 --- a/.github/workflows/type_completeness.yml +++ b/.github/workflows/type_completeness.yml @@ -14,7 +14,7 @@ jobs: name: test-type-completeness runs-on: ubuntu-latest steps: - - uses: Bibo-Joshi/pyright-type-completeness@1.0.0 + - uses: Bibo-Joshi/pyright-type-completeness@1.0.1 with: package-name: telegram python-version: 3.12 diff --git a/.github/workflows/type_completeness_monthly.yml b/.github/workflows/type_completeness_monthly.yml index a5492f9030c..64771d349d0 100644 --- a/.github/workflows/type_completeness_monthly.yml +++ b/.github/workflows/type_completeness_monthly.yml @@ -9,7 +9,7 @@ jobs: name: test-type-completeness runs-on: ubuntu-latest steps: - - uses: Bibo-Joshi/pyright-type-completeness@1.0.0 + - uses: Bibo-Joshi/pyright-type-completeness@1.0.1 id: pyright-type-completeness with: package-name: telegram From 06854633ab00d81fa5592adc17d92896fbda662c Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 2 Oct 2024 03:00:45 +0200 Subject: [PATCH 10/25] Bump `srvaroa/labeler` from 1.10.1 to 1.11.0 (#4509) Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: dependabot[bot] Co-authored-by: Bibo-Joshi <22366557+Bibo-Joshi@users.noreply.github.com> --- .github/workflows/labelling.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/labelling.yml b/.github/workflows/labelling.yml index 12cd1b4bea7..fa497fc41ce 100644 --- a/.github/workflows/labelling.yml +++ b/.github/workflows/labelling.yml @@ -11,7 +11,7 @@ jobs: pull-requests: write # for srvaroa/labeler to add labels in PR runs-on: ubuntu-latest steps: - - uses: srvaroa/labeler@v1.10.1 + - uses: srvaroa/labeler@v1.11.0 # Config file at .github/labeler.yml env: GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}" From a39a59ee9b03174a44d675db261895ceabe0ec6f Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 21 Oct 2024 19:12:44 +0200 Subject: [PATCH 11/25] Bump `sphinxcontrib-mermaid` from 0.9.2 to 1.0.0 (#4529) Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- docs/requirements-docs.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt index 7c3a4239807..0f97a0ac374 100644 --- a/docs/requirements-docs.txt +++ b/docs/requirements-docs.txt @@ -2,6 +2,6 @@ sphinx==8.0.2 furo==2024.8.6 furo-sphinx-search @ git+https://github.com/harshil21/furo-sphinx-search@v0.2.0.1 sphinx-paramlinks==0.6.0 -sphinxcontrib-mermaid==0.9.2 +sphinxcontrib-mermaid==1.0.0 sphinx-copybutton==0.5.2 sphinx-inline-tabs==2023.4.21 \ No newline at end of file From 2ce687c8f18cfc9733508bc2a3e525d66cae7a81 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 21 Oct 2024 19:40:12 +0200 Subject: [PATCH 12/25] Bump `sphinx` from 8.0.2 to 8.1.3 (#4532) Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: dependabot[bot] --- docs/requirements-docs.txt | 2 +- docs/source/conf.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt index 0f97a0ac374..1ae17a68faf 100644 --- a/docs/requirements-docs.txt +++ b/docs/requirements-docs.txt @@ -1,4 +1,4 @@ -sphinx==8.0.2 +sphinx==8.1.3 furo==2024.8.6 furo-sphinx-search @ git+https://github.com/harshil21/furo-sphinx-search@v0.2.0.1 sphinx-paramlinks==0.6.0 diff --git a/docs/source/conf.py b/docs/source/conf.py index abad78812c6..caac474d34c 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -30,7 +30,7 @@ release = telegram.__version__ # If your documentation needs a minimal Sphinx version, state it here. -needs_sphinx = "8.0.2" +needs_sphinx = "8.1.3" # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom From efacc3dd1b1eba102a0be982eec92c0f3ba85c4a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Silo=C3=A9=20Garcez?= <51986786+roast-lord@users.noreply.github.com> Date: Wed, 23 Oct 2024 17:14:03 -0300 Subject: [PATCH 13/25] Allow `Sequence` in `Application.add_handlers` (#4531) --- AUTHORS.rst | 1 + telegram/ext/_application.py | 23 +++++++++++++++-------- 2 files changed, 16 insertions(+), 8 deletions(-) diff --git a/AUTHORS.rst b/AUTHORS.rst index e95a2b7a3f9..8f2024e4404 100644 --- a/AUTHORS.rst +++ b/AUTHORS.rst @@ -115,6 +115,7 @@ The following wonderful people contributed directly or indirectly to this projec - `Sascha `_ - `Shelomentsev D `_ - `Shivam Saini `_ +- `Siloé Garcez `_ - `Simon Schürrle `_ - `sooyhwang `_ - `syntx `_ diff --git a/telegram/ext/_application.py b/telegram/ext/_application.py index 86e38b1de9f..904119c18da 100644 --- a/telegram/ext/_application.py +++ b/telegram/ext/_application.py @@ -17,6 +17,7 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains the Application class.""" + import asyncio import contextlib import inspect @@ -45,7 +46,6 @@ Optional, Sequence, Set, - Tuple, Type, TypeVar, Union, @@ -1420,8 +1420,8 @@ def add_handler(self, handler: BaseHandler[Any, CCT, Any], group: int = DEFAULT_ def add_handlers( self, handlers: Union[ - Union[List[BaseHandler[Any, CCT, Any]], Tuple[BaseHandler[Any, CCT, Any]]], - Dict[int, Union[List[BaseHandler[Any, CCT, Any]], Tuple[BaseHandler[Any, CCT, Any]]]], + Sequence[BaseHandler[Any, CCT, Any]], + Dict[int, Sequence[BaseHandler[Any, CCT, Any]]], ], group: Union[int, DefaultValue[int]] = _DEFAULT_0, ) -> None: @@ -1431,10 +1431,15 @@ def add_handlers( .. versionadded:: 20.0 Args: - handlers (List[:class:`telegram.ext.BaseHandler`] | \ - Dict[int, List[:class:`telegram.ext.BaseHandler`]]): \ + handlers (Sequence[:class:`telegram.ext.BaseHandler`] | \ + Dict[int, Sequence[:class:`telegram.ext.BaseHandler`]]): Specify a sequence of handlers *or* a dictionary where the keys are groups and values are handlers. + + .. versionchanged:: NEXT.VERSION + Accepts any :class:`collections.abc.Sequence` as input instead of just a list + or tuple. + group (:obj:`int`, optional): Specify which group the sequence of :paramref:`handlers` should be added to. Defaults to ``0``. @@ -1453,13 +1458,15 @@ def add_handlers( if isinstance(handlers, dict): for handler_group, grp_handlers in handlers.items(): - if not isinstance(grp_handlers, (list, tuple)): - raise TypeError(f"Handlers for group {handler_group} must be a list or tuple") + if not isinstance(grp_handlers, Sequence): + raise TypeError( + f"Handlers for group {handler_group} must be a sequence of handlers." + ) for handler in grp_handlers: self.add_handler(handler, handler_group) - elif isinstance(handlers, (list, tuple)): + elif isinstance(handlers, Sequence): for handler in handlers: self.add_handler(handler, DefaultValue.get_value(group)) From 847b97f86e83fb4c19bd5083ab93f8071df938ba Mon Sep 17 00:00:00 2001 From: Bibo-Joshi <22366557+Bibo-Joshi@users.noreply.github.com> Date: Thu, 24 Oct 2024 20:03:16 +0200 Subject: [PATCH 14/25] Use Stable Python 3.13 Release in Test Suite (#4535) --- .github/workflows/unit_tests.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/unit_tests.yml b/.github/workflows/unit_tests.yml index 67a0bb80cf1..9c59cb8ee07 100644 --- a/.github/workflows/unit_tests.yml +++ b/.github/workflows/unit_tests.yml @@ -20,7 +20,7 @@ jobs: runs-on: ${{matrix.os}} strategy: matrix: - python-version: ['3.8', '3.9', '3.10', '3.11', '3.12', '3.13.0-rc.2'] + python-version: ['3.8', '3.9', '3.10', '3.11', '3.12', '3.13'] os: [ubuntu-latest, windows-latest, macos-latest] fail-fast: False steps: From 5ab82a9c2b09286b66777ad0345b1abf3dedf131 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pablo=20Mart=C3=ADnez?= <58857054+elpekenin@users.noreply.github.com> Date: Thu, 24 Oct 2024 20:48:49 +0200 Subject: [PATCH 15/25] Drop Support for Python 3.8 (#4398) Co-authored-by: poolitzer Co-authored-by: Hinrich Mahler <22366557+Bibo-Joshi@users.noreply.github.com> --- .github/workflows/unit_tests.yml | 2 +- .pre-commit-config.yaml | 2 +- README.rst | 2 +- docs/auxil/admonition_inserter.py | 3 +- docs/auxil/kwargs_insertion.py | 3 +- docs/auxil/link_code.py | 3 +- examples/arbitrarycallbackdatabot.py | 8 +- examples/chatmemberbot.py | 4 +- examples/contexttypesbot.py | 6 +- examples/conversationbot2.py | 3 +- examples/nestedconversationbot.py | 6 +- examples/persistentconversationbot.py | 3 +- pyproject.toml | 5 +- telegram/_bot.py | 74 ++++++++---------- telegram/_botcommandscope.py | 6 +- telegram/_business.py | 21 ++--- telegram/_callbackquery.py | 7 +- telegram/_chat.py | 27 +++---- telegram/_chatbackground.py | 9 ++- telegram/_chatboost.py | 9 ++- telegram/_chatfullinfo.py | 11 +-- telegram/_chatmember.py | 4 +- telegram/_chatmemberupdated.py | 10 +-- telegram/_dice.py | 6 +- telegram/_files/_basethumbedmedium.py | 4 +- telegram/_files/inputfile.py | 2 +- telegram/_files/inputmedia.py | 17 ++-- telegram/_files/inputsticker.py | 11 +-- telegram/_files/sticker.py | 7 +- telegram/_games/game.py | 17 ++-- telegram/_giveaway.py | 15 ++-- telegram/_inline/inlinekeyboardmarkup.py | 7 +- telegram/_inline/inlinequery.py | 3 +- telegram/_inline/inlinequeryresultaudio.py | 7 +- .../_inline/inlinequeryresultcachedaudio.py | 7 +- .../inlinequeryresultcacheddocument.py | 7 +- .../_inline/inlinequeryresultcachedgif.py | 7 +- .../inlinequeryresultcachedmpeg4gif.py | 7 +- .../_inline/inlinequeryresultcachedphoto.py | 7 +- .../_inline/inlinequeryresultcachedvideo.py | 7 +- .../_inline/inlinequeryresultcachedvoice.py | 7 +- telegram/_inline/inlinequeryresultdocument.py | 7 +- telegram/_inline/inlinequeryresultgif.py | 7 +- telegram/_inline/inlinequeryresultmpeg4gif.py | 7 +- telegram/_inline/inlinequeryresultphoto.py | 7 +- telegram/_inline/inlinequeryresultvideo.py | 7 +- telegram/_inline/inlinequeryresultvoice.py | 7 +- .../_inline/inputinvoicemessagecontent.py | 11 +-- telegram/_inline/inputtextmessagecontent.py | 7 +- telegram/_menubutton.py | 6 +- telegram/_message.py | 57 +++++++------- telegram/_messageentity.py | 21 ++--- telegram/_messageorigin.py | 4 +- telegram/_messagereactionupdated.py | 15 ++-- telegram/_paidmedia.py | 15 ++-- telegram/_passport/credentials.py | 15 ++-- .../_passport/encryptedpassportelement.py | 13 ++-- telegram/_passport/passportdata.py | 13 ++-- telegram/_passport/passportelementerrors.py | 18 ++--- telegram/_passport/passportfile.py | 14 ++-- telegram/_payment/shippingoption.py | 7 +- telegram/_payment/shippingquery.py | 3 +- telegram/_payment/stars.py | 19 ++--- telegram/_poll.py | 47 +++++------ telegram/_reaction.py | 4 +- telegram/_reply.py | 15 ++-- telegram/_replykeyboardmarkup.py | 7 +- telegram/_shared.py | 15 ++-- telegram/_telegramobject.py | 55 +++++-------- telegram/_update.py | 6 +- telegram/_user.py | 23 +++--- telegram/_userprofilephotos.py | 7 +- telegram/_utils/argumentparsing.py | 5 +- telegram/_utils/entities.py | 11 +-- telegram/_utils/enum.py | 4 +- telegram/_utils/files.py | 10 +-- telegram/_utils/types.py | 26 ++----- telegram/_utils/warnings.py | 6 +- telegram/_utils/warnings_transition.py | 4 +- telegram/_videochat.py | 7 +- telegram/_webhookinfo.py | 7 +- telegram/constants.py | 18 ++--- telegram/error.py | 31 +++----- telegram/ext/_aioratelimiter.py | 19 ++--- telegram/ext/_application.py | 68 +++++++--------- telegram/ext/_applicationbuilder.py | 31 +++----- telegram/ext/_basepersistence.py | 20 ++--- telegram/ext/_baseratelimiter.py | 19 ++--- telegram/ext/_baseupdateprocessor.py | 10 ++- telegram/ext/_callbackcontext.py | 37 ++++----- telegram/ext/_callbackdatacache.py | 25 +++--- telegram/ext/_contexttypes.py | 78 +++++++++---------- telegram/ext/_defaults.py | 4 +- telegram/ext/_dictpersistence.py | 54 ++++++------- telegram/ext/_extbot.py | 36 ++++----- .../ext/_handlers/callbackqueryhandler.py | 3 +- .../_handlers/choseninlineresulthandler.py | 3 +- telegram/ext/_handlers/commandhandler.py | 12 +-- telegram/ext/_handlers/conversationhandler.py | 67 +++++++--------- telegram/ext/_handlers/inlinequeryhandler.py | 11 +-- telegram/ext/_handlers/messagehandler.py | 6 +- .../ext/_handlers/precheckoutqueryhandler.py | 3 +- telegram/ext/_handlers/prefixhandler.py | 10 +-- .../ext/_handlers/stringcommandhandler.py | 8 +- telegram/ext/_handlers/stringregexhandler.py | 3 +- telegram/ext/_handlers/typehandler.py | 9 ++- telegram/ext/_jobqueue.py | 16 ++-- telegram/ext/_picklepersistence.py | 34 ++++---- telegram/ext/_updater.py | 32 +++----- telegram/ext/_utils/_update_parsing.py | 10 +-- telegram/ext/_utils/trackingdict.py | 11 +-- telegram/ext/_utils/types.py | 26 ++----- telegram/ext/_utils/webhookhandler.py | 4 +- telegram/ext/filters.py | 55 +++++-------- telegram/request/_baserequest.py | 13 ++-- telegram/request/_httpxrequest.py | 9 ++- telegram/request/_requestdata.py | 22 +++--- telegram/request/_requestparameter.py | 11 +-- tests/auxil/bot_method_checks.py | 13 ++-- tests/auxil/networking.py | 4 +- tests/conftest.py | 5 +- tests/docs/admonition_inserter.py | 2 +- tests/ext/test_application.py | 16 ++-- tests/ext/test_filters.py | 2 +- tests/ext/test_picklepersistence.py | 9 ++- tests/request/test_request.py | 12 +-- tests/request/test_requestdata.py | 16 ++-- tests/request/test_requestparameter.py | 2 +- tests/test_bot.py | 12 +-- tests/test_messageentity.py | 3 +- tests/test_official/arg_type_checker.py | 3 +- tests/test_official/exceptions.py | 2 +- tests/test_official/helpers.py | 3 +- 133 files changed, 894 insertions(+), 950 deletions(-) diff --git a/.github/workflows/unit_tests.yml b/.github/workflows/unit_tests.yml index 9c59cb8ee07..c1fd3df2b49 100644 --- a/.github/workflows/unit_tests.yml +++ b/.github/workflows/unit_tests.yml @@ -20,7 +20,7 @@ jobs: runs-on: ${{matrix.os}} strategy: matrix: - python-version: ['3.8', '3.9', '3.10', '3.11', '3.12', '3.13'] + python-version: ['3.9', '3.10', '3.11', '3.12', '3.13'] os: [ubuntu-latest, windows-latest, macos-latest] fail-fast: False steps: diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 0da0cea1381..99e1312da01 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -72,7 +72,7 @@ repos: hooks: - id: pyupgrade args: - - --py38-plus + - --py39-plus - repo: https://github.com/pycqa/isort rev: 5.13.2 hooks: diff --git a/README.rst b/README.rst index 4c7cba54347..035180a3ce0 100644 --- a/README.rst +++ b/README.rst @@ -70,7 +70,7 @@ Introduction This library provides a pure Python, asynchronous interface for the `Telegram Bot API `_. -It's compatible with Python versions **3.8+**. +It's compatible with Python versions **3.9+**. In addition to the pure API implementation, this library features several convenience methods and shortcuts as well as a number of high-level classes to make the development of bots easy and straightforward. These classes are contained in the diff --git a/docs/auxil/admonition_inserter.py b/docs/auxil/admonition_inserter.py index 9455025331a..268b8e7e7b4 100644 --- a/docs/auxil/admonition_inserter.py +++ b/docs/auxil/admonition_inserter.py @@ -20,7 +20,8 @@ import re import typing from collections import defaultdict -from typing import Any, Iterator, Union +from collections.abc import Iterator +from typing import Any, Union import telegram import telegram.ext diff --git a/docs/auxil/kwargs_insertion.py b/docs/auxil/kwargs_insertion.py index ffb2ada137a..7bc4a9e0110 100644 --- a/docs/auxil/kwargs_insertion.py +++ b/docs/auxil/kwargs_insertion.py @@ -16,7 +16,6 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. import inspect -from typing import List keyword_args = [ "Keyword Arguments:", @@ -85,7 +84,7 @@ ] -def find_insert_pos_for_kwargs(lines: List[str]) -> int: +def find_insert_pos_for_kwargs(lines: list[str]) -> int: """Finds the correct position to insert the keyword arguments and returns the index.""" for idx, value in reversed(list(enumerate(lines))): # reversed since :returns: is at the end if value.startswith("Returns"): diff --git a/docs/auxil/link_code.py b/docs/auxil/link_code.py index 8c20f34b4af..f451dc50281 100644 --- a/docs/auxil/link_code.py +++ b/docs/auxil/link_code.py @@ -21,7 +21,6 @@ """ import subprocess from pathlib import Path -from typing import Dict, Tuple from sphinx.util import logging @@ -32,7 +31,7 @@ # must be a module-level variable so that it can be written to by the `autodoc-process-docstring` # event handler in `sphinx_hooks.py` -LINE_NUMBERS: Dict[str, Tuple[Path, int, int]] = {} +LINE_NUMBERS: dict[str, tuple[Path, int, int]] = {} def _git_branch() -> str: diff --git a/examples/arbitrarycallbackdatabot.py b/examples/arbitrarycallbackdatabot.py index cf3d46fa91b..e11620c1670 100644 --- a/examples/arbitrarycallbackdatabot.py +++ b/examples/arbitrarycallbackdatabot.py @@ -12,7 +12,7 @@ `pip install "python-telegram-bot[callback-data]"` """ import logging -from typing import List, Tuple, cast +from typing import cast from telegram import InlineKeyboardButton, InlineKeyboardMarkup, Update from telegram.ext import ( @@ -36,7 +36,7 @@ async def start(update: Update, context: ContextTypes.DEFAULT_TYPE) -> None: """Sends a message with 5 inline buttons attached.""" - number_list: List[int] = [] + number_list: list[int] = [] await update.message.reply_text("Please choose:", reply_markup=build_keyboard(number_list)) @@ -55,7 +55,7 @@ async def clear(update: Update, context: ContextTypes.DEFAULT_TYPE) -> None: await update.effective_message.reply_text("All clear!") -def build_keyboard(current_list: List[int]) -> InlineKeyboardMarkup: +def build_keyboard(current_list: list[int]) -> InlineKeyboardMarkup: """Helper function to build the next inline keyboard.""" return InlineKeyboardMarkup.from_column( [InlineKeyboardButton(str(i), callback_data=(i, current_list)) for i in range(1, 6)] @@ -69,7 +69,7 @@ async def list_button(update: Update, context: ContextTypes.DEFAULT_TYPE) -> Non # Get the data from the callback_data. # If you're using a type checker like MyPy, you'll have to use typing.cast # to make the checker get the expected type of the callback_data - number, number_list = cast(Tuple[int, List[int]], query.data) + number, number_list = cast(tuple[int, list[int]], query.data) # append the number to the list number_list.append(number) diff --git a/examples/chatmemberbot.py b/examples/chatmemberbot.py index dd299b73acf..34dad2a8385 100644 --- a/examples/chatmemberbot.py +++ b/examples/chatmemberbot.py @@ -12,7 +12,7 @@ """ import logging -from typing import Optional, Tuple +from typing import Optional from telegram import Chat, ChatMember, ChatMemberUpdated, Update from telegram.constants import ParseMode @@ -37,7 +37,7 @@ logger = logging.getLogger(__name__) -def extract_status_change(chat_member_update: ChatMemberUpdated) -> Optional[Tuple[bool, bool]]: +def extract_status_change(chat_member_update: ChatMemberUpdated) -> Optional[tuple[bool, bool]]: """Takes a ChatMemberUpdated instance and extracts whether the 'old_chat_member' was a member of the chat and whether the 'new_chat_member' is a member of the chat. Returns None, if the status didn't change. diff --git a/examples/contexttypesbot.py b/examples/contexttypesbot.py index 9c361772cdb..b89d8ffc7d7 100644 --- a/examples/contexttypesbot.py +++ b/examples/contexttypesbot.py @@ -12,7 +12,7 @@ import logging from collections import defaultdict -from typing import DefaultDict, Optional, Set +from typing import Optional from telegram import InlineKeyboardButton, InlineKeyboardMarkup, Update from telegram.constants import ParseMode @@ -40,7 +40,7 @@ class ChatData: """Custom class for chat_data. Here we store data per message.""" def __init__(self) -> None: - self.clicks_per_message: DefaultDict[int, int] = defaultdict(int) + self.clicks_per_message: defaultdict[int, int] = defaultdict(int) # The [ExtBot, dict, ChatData, dict] is for type checkers like mypy @@ -57,7 +57,7 @@ def __init__( self._message_id: Optional[int] = None @property - def bot_user_ids(self) -> Set[int]: + def bot_user_ids(self) -> set[int]: """Custom shortcut to access a value stored in the bot_data dict""" return self.bot_data.setdefault("user_ids", set()) diff --git a/examples/conversationbot2.py b/examples/conversationbot2.py index 6a5e54a8e5b..af29e0198e9 100644 --- a/examples/conversationbot2.py +++ b/examples/conversationbot2.py @@ -15,7 +15,6 @@ """ import logging -from typing import Dict from telegram import ReplyKeyboardMarkup, ReplyKeyboardRemove, Update from telegram.ext import ( @@ -46,7 +45,7 @@ markup = ReplyKeyboardMarkup(reply_keyboard, one_time_keyboard=True) -def facts_to_str(user_data: Dict[str, str]) -> str: +def facts_to_str(user_data: dict[str, str]) -> str: """Helper function for formatting the gathered user info.""" facts = [f"{key} - {value}" for key, value in user_data.items()] return "\n".join(facts).join(["\n", "\n"]) diff --git a/examples/nestedconversationbot.py b/examples/nestedconversationbot.py index fdc49de2b7f..bc940f4cd45 100644 --- a/examples/nestedconversationbot.py +++ b/examples/nestedconversationbot.py @@ -15,7 +15,7 @@ """ import logging -from typing import Any, Dict, Tuple +from typing import Any from telegram import InlineKeyboardButton, InlineKeyboardMarkup, Update from telegram.ext import ( @@ -66,7 +66,7 @@ # Helper -def _name_switcher(level: str) -> Tuple[str, str]: +def _name_switcher(level: str) -> tuple[str, str]: if level == PARENTS: return "Father", "Mother" return "Brother", "Sister" @@ -122,7 +122,7 @@ async def adding_self(update: Update, context: ContextTypes.DEFAULT_TYPE) -> str async def show_data(update: Update, context: ContextTypes.DEFAULT_TYPE) -> str: """Pretty print gathered data.""" - def pretty_print(data: Dict[str, Any], level: str) -> str: + def pretty_print(data: dict[str, Any], level: str) -> str: people = data.get(level) if not people: return "\nNo information yet." diff --git a/examples/persistentconversationbot.py b/examples/persistentconversationbot.py index 19be96f562f..4c5322456bb 100644 --- a/examples/persistentconversationbot.py +++ b/examples/persistentconversationbot.py @@ -15,7 +15,6 @@ """ import logging -from typing import Dict from telegram import ReplyKeyboardMarkup, ReplyKeyboardRemove, Update from telegram.ext import ( @@ -47,7 +46,7 @@ markup = ReplyKeyboardMarkup(reply_keyboard, one_time_keyboard=True) -def facts_to_str(user_data: Dict[str, str]) -> str: +def facts_to_str(user_data: dict[str, str]) -> str: """Helper function for formatting the gathered user info.""" facts = [f"{key} - {value}" for key, value in user_data.items()] return "\n".join(facts).join(["\n", "\n"]) diff --git a/pyproject.toml b/pyproject.toml index 80edfde44f8..cb98f0057aa 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -8,7 +8,7 @@ dynamic = ["version"] name = "python-telegram-bot" description = "We have made you a wrapper you can't refuse" readme = "README.rst" -requires-python = ">=3.8" +requires-python = ">=3.9" license = "LGPL-3.0-only" license-files = { paths = ["LICENSE", "LICENSE.dual", "LICENSE.lesser"] } authors = [ @@ -31,7 +31,6 @@ classifiers = [ "Topic :: Internet", "Programming Language :: Python", "Programming Language :: Python :: 3", - "Programming Language :: Python :: 3.8", "Programming Language :: Python :: 3.9", "Programming Language :: Python :: 3.10", "Programming Language :: Python :: 3.11", @@ -192,7 +191,7 @@ disallow_untyped_defs = true disallow_incomplete_defs = true disallow_untyped_decorators = true show_error_codes = true -python_version = "3.8" +python_version = "3.9" # For some files, it's easier to just disable strict-optional all together instead of # cluttering the code with `# type: ignore`s or stuff like diff --git a/telegram/_bot.py b/telegram/_bot.py index 513e43d1698..345dac4ed13 100644 --- a/telegram/_bot.py +++ b/telegram/_bot.py @@ -23,21 +23,15 @@ import contextlib import copy import pickle +from collections.abc import Sequence from datetime import datetime from types import TracebackType from typing import ( TYPE_CHECKING, Any, - AsyncContextManager, Callable, - Dict, - List, NoReturn, Optional, - Sequence, - Set, - Tuple, - Type, TypeVar, Union, cast, @@ -130,7 +124,7 @@ BT = TypeVar("BT", bound="Bot") -class Bot(TelegramObject, AsyncContextManager["Bot"]): +class Bot(TelegramObject, contextlib.AbstractAsyncContextManager["Bot"]): """This object represents a Telegram Bot. Instances of this class can be used as asyncio context managers, where @@ -263,7 +257,7 @@ def __init__( self._private_key: Optional[bytes] = None self._initialized: bool = False - self._request: Tuple[BaseRequest, BaseRequest] = ( + self._request: tuple[BaseRequest, BaseRequest] = ( HTTPXRequest() if get_updates_request is None else get_updates_request, HTTPXRequest() if request is None else request, ) @@ -332,7 +326,7 @@ async def __aenter__(self: BT) -> BT: async def __aexit__( self, - exc_type: Optional[Type[BaseException]], + exc_type: Optional[type[BaseException]], exc_val: Optional[BaseException], exc_tb: Optional[TracebackType], ) -> None: @@ -352,7 +346,7 @@ def __reduce__(self) -> NoReturn: """ raise pickle.PicklingError("Bot objects cannot be pickled!") - def __deepcopy__(self, memodict: Dict[int, object]) -> NoReturn: + def __deepcopy__(self, memodict: dict[int, object]) -> NoReturn: """Customizes how :func:`copy.deepcopy` processes objects of this type. Bots can not be deepcopied and this method will always raise an exception. @@ -528,7 +522,7 @@ def name(self) -> str: def _warn( cls, message: Union[str, PTBUserWarning], - category: Type[Warning] = PTBUserWarning, + category: type[Warning] = PTBUserWarning, stacklevel: int = 0, ) -> None: """Convenience method to issue a warning. This method is here mostly to make it easier @@ -539,7 +533,7 @@ def _warn( def _parse_file_input( self, file_input: Union[FileInput, "TelegramObject"], - tg_type: Optional[Type["TelegramObject"]] = None, + tg_type: Optional[type["TelegramObject"]] = None, filename: Optional[str] = None, attach: bool = False, ) -> Union[str, "InputFile", Any]: @@ -551,7 +545,7 @@ def _parse_file_input( local_mode=self._local_mode, ) - def _insert_defaults(self, data: Dict[str, object]) -> None: + def _insert_defaults(self, data: dict[str, object]) -> None: """This method is here to make ext.Defaults work. Because we need to be able to tell e.g. `send_message(chat_id, text)` from `send_message(chat_id, text, parse_mode=None)`, the default values for `parse_mode` etc are not `None` but `DEFAULT_NONE`. While this *could* @@ -605,7 +599,7 @@ async def _post( pool_timeout: ODVInput[float] = DEFAULT_NONE, api_kwargs: Optional[JSONDict] = None, ) -> Any: - # We know that the return type is Union[bool, JSONDict, List[JSONDict]], but it's hard + # We know that the return type is Union[bool, JSONDict, list[JSONDict]], but it's hard # to tell mypy which methods expects which of these return values and `Any` saves us a # lot of `type: ignore` comments if data is None: @@ -638,7 +632,7 @@ async def _do_post( write_timeout: ODVInput[float] = DEFAULT_NONE, connect_timeout: ODVInput[float] = DEFAULT_NONE, pool_timeout: ODVInput[float] = DEFAULT_NONE, - ) -> Union[bool, JSONDict, List[JSONDict]]: + ) -> Union[bool, JSONDict, list[JSONDict]]: # This also converts datetimes into timestamps. # We don't do this earlier so that _insert_defaults (see above) has a chance to convert # to the default timezone in case this is called by ExtBot @@ -798,7 +792,7 @@ async def do_api_request( self, endpoint: str, api_kwargs: Optional[JSONDict] = None, - return_type: Optional[Type[TelegramObject]] = None, + return_type: Optional[type[TelegramObject]] = None, *, read_timeout: ODVInput[float] = DEFAULT_NONE, write_timeout: ODVInput[float] = DEFAULT_NONE, @@ -1226,7 +1220,7 @@ async def forward_messages( connect_timeout: ODVInput[float] = DEFAULT_NONE, pool_timeout: ODVInput[float] = DEFAULT_NONE, api_kwargs: Optional[JSONDict] = None, - ) -> Tuple[MessageId, ...]: + ) -> tuple[MessageId, ...]: """ Use this method to forward messages of any kind. If some of the specified messages can't be found or forwarded, they are skipped. Service messages and messages with protected content @@ -1248,7 +1242,7 @@ async def forward_messages( message_thread_id (:obj:`int`, optional): |message_thread_id_arg| Returns: - Tuple[:class:`telegram.Message`]: On success, a tuple of ``MessageId`` of sent messages + tuple[:class:`telegram.Message`]: On success, a tuple of ``MessageId`` of sent messages is returned. Raises: @@ -2499,7 +2493,7 @@ async def send_media_group( caption: Optional[str] = None, parse_mode: ODVInput[str] = DEFAULT_NONE, caption_entities: Optional[Sequence["MessageEntity"]] = None, - ) -> Tuple[Message, ...]: + ) -> tuple[Message, ...]: """Use this method to send a group of photos, videos, documents or audios as an album. Documents and audio files can be only grouped in an album with messages of the same type. @@ -2581,7 +2575,7 @@ async def send_media_group( .. versionadded:: 20.0 Returns: - Tuple[:class:`telegram.Message`]: An array of the sent Messages. + tuple[:class:`telegram.Message`]: An array of the sent Messages. Raises: :class:`telegram.error.TelegramError` @@ -3403,7 +3397,7 @@ def _effective_inline_results( ], next_offset: Optional[str] = None, current_offset: Optional[str] = None, - ) -> Tuple[Sequence["InlineQueryResult"], Optional[str]]: + ) -> tuple[Sequence["InlineQueryResult"], Optional[str]]: """ Builds the effective results from the results input. We make this a stand-alone method so tg.ext.ExtBot can wrap it. @@ -3526,7 +3520,7 @@ async def answer_inline_query( Args: inline_query_id (:obj:`str`): Unique identifier for the answered query. - results (List[:class:`telegram.InlineQueryResult`] | Callable): A list of results for + results (list[:class:`telegram.InlineQueryResult`] | Callable): A list of results for the inline query. In case :paramref:`current_offset` is passed, :paramref:`results` may also be a callable that accepts the current page index starting from 0. It must return @@ -4280,7 +4274,7 @@ async def get_updates( connect_timeout: ODVInput[float] = DEFAULT_NONE, pool_timeout: ODVInput[float] = DEFAULT_NONE, api_kwargs: Optional[JSONDict] = None, - ) -> Tuple[Update, ...]: + ) -> tuple[Update, ...]: """Use this method to receive incoming updates using long polling. Note: @@ -4325,7 +4319,7 @@ async def get_updates( |sequenceargs| Returns: - Tuple[:class:`telegram.Update`] + tuple[:class:`telegram.Update`] Raises: :class:`telegram.error.TelegramError` @@ -4362,7 +4356,7 @@ async def get_updates( # waiting for the server to return and there's no way of knowing the connection had been # dropped in real time. result = cast( - List[JSONDict], + list[JSONDict], await self._post( "getUpdates", data, @@ -4626,7 +4620,7 @@ async def get_chat_administrators( connect_timeout: ODVInput[float] = DEFAULT_NONE, pool_timeout: ODVInput[float] = DEFAULT_NONE, api_kwargs: Optional[JSONDict] = None, - ) -> Tuple[ChatMember, ...]: + ) -> tuple[ChatMember, ...]: """ Use this method to get a list of administrators in a chat. @@ -4637,7 +4631,7 @@ async def get_chat_administrators( chat_id (:obj:`int` | :obj:`str`): |chat_id_channel| Returns: - Tuple[:class:`telegram.ChatMember`]: On success, returns a tuple of ``ChatMember`` + tuple[:class:`telegram.ChatMember`]: On success, returns a tuple of ``ChatMember`` objects that contains information about all chat administrators except other bots. If the chat is a group or a supergroup and no administrators were appointed, only the creator will be returned. @@ -4901,7 +4895,7 @@ async def get_game_high_scores( connect_timeout: ODVInput[float] = DEFAULT_NONE, pool_timeout: ODVInput[float] = DEFAULT_NONE, api_kwargs: Optional[JSONDict] = None, - ) -> Tuple[GameHighScore, ...]: + ) -> tuple[GameHighScore, ...]: """ Use this method to get data for high score tables. Will return the score of the specified user and several of their neighbors in a game. @@ -4924,7 +4918,7 @@ async def get_game_high_scores( :paramref:`message_id` are not specified. Identifier of the inline message. Returns: - Tuple[:class:`telegram.GameHighScore`] + tuple[:class:`telegram.GameHighScore`] Raises: :class:`telegram.error.TelegramError` @@ -6304,7 +6298,7 @@ async def get_custom_emoji_stickers( connect_timeout: ODVInput[float] = DEFAULT_NONE, pool_timeout: ODVInput[float] = DEFAULT_NONE, api_kwargs: Optional[JSONDict] = None, - ) -> Tuple[Sticker, ...]: + ) -> tuple[Sticker, ...]: """ Use this method to get information about emoji stickers by their identifiers. @@ -6320,7 +6314,7 @@ async def get_custom_emoji_stickers( |sequenceargs| Returns: - Tuple[:class:`telegram.Sticker`] + tuple[:class:`telegram.Sticker`] Raises: :class:`telegram.error.TelegramError` @@ -7427,7 +7421,7 @@ async def get_my_commands( connect_timeout: ODVInput[float] = DEFAULT_NONE, pool_timeout: ODVInput[float] = DEFAULT_NONE, api_kwargs: Optional[JSONDict] = None, - ) -> Tuple[BotCommand, ...]: + ) -> tuple[BotCommand, ...]: """ Use this method to get the current list of the bot's commands for the given scope and user language. @@ -7449,7 +7443,7 @@ async def get_my_commands( .. versionadded:: 13.7 Returns: - Tuple[:class:`telegram.BotCommand`]: On success, the commands set for the bot. An empty + tuple[:class:`telegram.BotCommand`]: On success, the commands set for the bot. An empty tuple is returned if commands are not set. Raises: @@ -7472,7 +7466,7 @@ async def get_my_commands( async def set_my_commands( self, - commands: Sequence[Union[BotCommand, Tuple[str, str]]], + commands: Sequence[Union[BotCommand, tuple[str, str]]], scope: Optional[BotCommandScope] = None, language_code: Optional[str] = None, *, @@ -7791,7 +7785,7 @@ async def copy_messages( connect_timeout: ODVInput[float] = DEFAULT_NONE, pool_timeout: ODVInput[float] = DEFAULT_NONE, api_kwargs: Optional[JSONDict] = None, - ) -> Tuple["MessageId", ...]: + ) -> tuple["MessageId", ...]: """ Use this method to copy messages of any kind. If some of the specified messages can't be found or copied, they are skipped. Service messages, paid media messages, giveaway @@ -7819,7 +7813,7 @@ async def copy_messages( their captions. Returns: - Tuple[:class:`telegram.MessageId`]: On success, a tuple of :class:`~telegram.MessageId` + tuple[:class:`telegram.MessageId`]: On success, a tuple of :class:`~telegram.MessageId` of the sent messages is returned. Raises: @@ -8072,14 +8066,14 @@ async def get_forum_topic_icon_stickers( connect_timeout: ODVInput[float] = DEFAULT_NONE, pool_timeout: ODVInput[float] = DEFAULT_NONE, api_kwargs: Optional[JSONDict] = None, - ) -> Tuple[Sticker, ...]: + ) -> tuple[Sticker, ...]: """Use this method to get custom emoji stickers, which can be used as a forum topic icon by any user. Requires no parameters. .. versionadded:: 20.0 Returns: - Tuple[:class:`telegram.Sticker`] + tuple[:class:`telegram.Sticker`] Raises: :class:`telegram.error.TelegramError` @@ -8968,7 +8962,7 @@ async def set_message_reaction( Raises: :class:`telegram.error.TelegramError` """ - allowed_reactions: Set[str] = set(ReactionEmoji) + allowed_reactions: set[str] = set(ReactionEmoji) parsed_reaction = ( [ ( diff --git a/telegram/_botcommandscope.py b/telegram/_botcommandscope.py index 73cafd17599..8d068802ca0 100644 --- a/telegram/_botcommandscope.py +++ b/telegram/_botcommandscope.py @@ -18,7 +18,7 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. # pylint: disable=redefined-builtin """This module contains objects representing Telegram bot command scopes.""" -from typing import TYPE_CHECKING, Dict, Final, Optional, Type, Union +from typing import TYPE_CHECKING, Final, Optional, Union from telegram import constants from telegram._telegramobject import TelegramObject @@ -91,7 +91,7 @@ def de_json( care of selecting the correct subclass. Args: - data (Dict[:obj:`str`, ...]): The JSON data. + data (dict[:obj:`str`, ...]): The JSON data. bot (:class:`telegram.Bot`, optional): The bot associated with this object. Defaults to :obj:`None`, in which case shortcut methods will not be available. @@ -107,7 +107,7 @@ def de_json( if not data: return None - _class_mapping: Dict[str, Type[BotCommandScope]] = { + _class_mapping: dict[str, type[BotCommandScope]] = { cls.DEFAULT: BotCommandScopeDefault, cls.ALL_PRIVATE_CHATS: BotCommandScopeAllPrivateChats, cls.ALL_GROUP_CHATS: BotCommandScopeAllGroupChats, diff --git a/telegram/_business.py b/telegram/_business.py index 22c89e024b4..15512e63d0f 100644 --- a/telegram/_business.py +++ b/telegram/_business.py @@ -19,8 +19,9 @@ # along with this program. If not, see [http://www.gnu.org/licenses/] """This module contains the Telegram Business related classes.""" +from collections.abc import Sequence from datetime import datetime -from typing import TYPE_CHECKING, Optional, Sequence, Tuple +from typing import TYPE_CHECKING, Optional from telegram._chat import Chat from telegram._files.location import Location @@ -145,7 +146,7 @@ class BusinessMessagesDeleted(TelegramObject): business_connection_id (:obj:`str`): Unique identifier of the business connection. chat (:class:`telegram.Chat`): Information about a chat in the business account. The bot may not have access to the chat or the corresponding user. - message_ids (Tuple[:obj:`int`]): A list of identifiers of the deleted messages in the + message_ids (tuple[:obj:`int`]): A list of identifiers of the deleted messages in the chat of the business account. """ @@ -166,7 +167,7 @@ def __init__( super().__init__(api_kwargs=api_kwargs) self.business_connection_id: str = business_connection_id self.chat: Chat = chat - self.message_ids: Tuple[int, ...] = parse_sequence_arg(message_ids) + self.message_ids: tuple[int, ...] = parse_sequence_arg(message_ids) self._id_attrs = ( self.business_connection_id, @@ -359,37 +360,37 @@ def __init__( self.opening_minute: int = opening_minute self.closing_minute: int = closing_minute - self._opening_time: Optional[Tuple[int, int, int]] = None - self._closing_time: Optional[Tuple[int, int, int]] = None + self._opening_time: Optional[tuple[int, int, int]] = None + self._closing_time: Optional[tuple[int, int, int]] = None self._id_attrs = (self.opening_minute, self.closing_minute) self._freeze() - def _parse_minute(self, minute: int) -> Tuple[int, int, int]: + def _parse_minute(self, minute: int) -> tuple[int, int, int]: return (minute // 1440, minute % 1440 // 60, minute % 1440 % 60) @property - def opening_time(self) -> Tuple[int, int, int]: + def opening_time(self) -> tuple[int, int, int]: """Convenience attribute. A :obj:`tuple` parsed from :attr:`opening_minute`. It contains the `weekday`, `hour` and `minute` in the same ranges as :attr:`datetime.datetime.weekday`, :attr:`datetime.datetime.hour` and :attr:`datetime.datetime.minute` Returns: - Tuple[:obj:`int`, :obj:`int`, :obj:`int`]: + tuple[:obj:`int`, :obj:`int`, :obj:`int`]: """ if self._opening_time is None: self._opening_time = self._parse_minute(self.opening_minute) return self._opening_time @property - def closing_time(self) -> Tuple[int, int, int]: + def closing_time(self) -> tuple[int, int, int]: """Convenience attribute. A :obj:`tuple` parsed from :attr:`closing_minute`. It contains the `weekday`, `hour` and `minute` in the same ranges as :attr:`datetime.datetime.weekday`, :attr:`datetime.datetime.hour` and :attr:`datetime.datetime.minute` Returns: - Tuple[:obj:`int`, :obj:`int`, :obj:`int`]: + tuple[:obj:`int`, :obj:`int`, :obj:`int`]: """ if self._closing_time is None: self._closing_time = self._parse_minute(self.closing_minute) diff --git a/telegram/_callbackquery.py b/telegram/_callbackquery.py index bdfa569dbfd..af44a3243c3 100644 --- a/telegram/_callbackquery.py +++ b/telegram/_callbackquery.py @@ -18,7 +18,8 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. # pylint: disable=redefined-builtin """This module contains an object that represents a Telegram CallbackQuery""" -from typing import TYPE_CHECKING, Final, Optional, Sequence, Tuple, Union +from collections.abc import Sequence +from typing import TYPE_CHECKING, Final, Optional, Union from telegram import constants from telegram._files.location import Location @@ -676,7 +677,7 @@ async def get_game_high_scores( connect_timeout: ODVInput[float] = DEFAULT_NONE, pool_timeout: ODVInput[float] = DEFAULT_NONE, api_kwargs: Optional[JSONDict] = None, - ) -> Tuple["GameHighScore", ...]: + ) -> tuple["GameHighScore", ...]: """Shortcut for either:: await update.callback_query.message.get_game_high_score(*args, **kwargs) @@ -695,7 +696,7 @@ async def get_game_high_scores( Raises :exc:`TypeError` if :attr:`message` is not accessible. Returns: - Tuple[:class:`telegram.GameHighScore`] + tuple[:class:`telegram.GameHighScore`] Raises: :exc:`TypeError` if :attr:`message` is not accessible. diff --git a/telegram/_chat.py b/telegram/_chat.py index 8c5f705248e..7e5dc0ad89c 100644 --- a/telegram/_chat.py +++ b/telegram/_chat.py @@ -18,9 +18,10 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains an object that represents a Telegram Chat.""" +from collections.abc import Sequence from datetime import datetime from html import escape -from typing import TYPE_CHECKING, Final, Optional, Sequence, Tuple, Union +from typing import TYPE_CHECKING, Final, Optional, Union from telegram import constants from telegram._chatpermissions import ChatPermissions @@ -296,7 +297,7 @@ async def get_administrators( connect_timeout: ODVInput[float] = DEFAULT_NONE, pool_timeout: ODVInput[float] = DEFAULT_NONE, api_kwargs: Optional[JSONDict] = None, - ) -> Tuple["ChatMember", ...]: + ) -> tuple["ChatMember", ...]: """Shortcut for:: await bot.get_chat_administrators(update.effective_chat.id, *args, **kwargs) @@ -305,7 +306,7 @@ async def get_administrators( :meth:`telegram.Bot.get_chat_administrators`. Returns: - Tuple[:class:`telegram.ChatMember`]: A tuple of administrators in a chat. An Array of + tuple[:class:`telegram.ChatMember`]: A tuple of administrators in a chat. An Array of :class:`telegram.ChatMember` objects that contains information about all chat administrators except other bots. If the chat is a group or a supergroup and no administrators were appointed, only the creator will be returned. @@ -1140,7 +1141,7 @@ async def send_media_group( caption: Optional[str] = None, parse_mode: ODVInput[str] = DEFAULT_NONE, caption_entities: Optional[Sequence["MessageEntity"]] = None, - ) -> Tuple["Message", ...]: + ) -> tuple["Message", ...]: """Shortcut for:: await bot.send_media_group(update.effective_chat.id, *args, **kwargs) @@ -1148,7 +1149,7 @@ async def send_media_group( For the documentation of the arguments, please see :meth:`telegram.Bot.send_media_group`. Returns: - Tuple[:class:`telegram.Message`]: On success, a tuple of :class:`~telegram.Message` + tuple[:class:`telegram.Message`]: On success, a tuple of :class:`~telegram.Message` instances that were sent is returned. """ @@ -2268,7 +2269,7 @@ async def send_copies( connect_timeout: ODVInput[float] = DEFAULT_NONE, pool_timeout: ODVInput[float] = DEFAULT_NONE, api_kwargs: Optional[JSONDict] = None, - ) -> Tuple["MessageId", ...]: + ) -> tuple["MessageId", ...]: """Shortcut for:: await bot.copy_messages(chat_id=update.effective_chat.id, *args, **kwargs) @@ -2280,7 +2281,7 @@ async def send_copies( .. versionadded:: 20.8 Returns: - Tuple[:class:`telegram.MessageId`]: On success, a tuple of :class:`~telegram.MessageId` + tuple[:class:`telegram.MessageId`]: On success, a tuple of :class:`~telegram.MessageId` of the sent messages is returned. """ @@ -2313,7 +2314,7 @@ async def copy_messages( connect_timeout: ODVInput[float] = DEFAULT_NONE, pool_timeout: ODVInput[float] = DEFAULT_NONE, api_kwargs: Optional[JSONDict] = None, - ) -> Tuple["MessageId", ...]: + ) -> tuple["MessageId", ...]: """Shortcut for:: await bot.copy_messages(from_chat_id=update.effective_chat.id, *args, **kwargs) @@ -2325,7 +2326,7 @@ async def copy_messages( .. versionadded:: 20.8 Returns: - Tuple[:class:`telegram.MessageId`]: On success, a tuple of :class:`~telegram.MessageId` + tuple[:class:`telegram.MessageId`]: On success, a tuple of :class:`~telegram.MessageId` of the sent messages is returned. """ @@ -2442,7 +2443,7 @@ async def forward_messages_from( connect_timeout: ODVInput[float] = DEFAULT_NONE, pool_timeout: ODVInput[float] = DEFAULT_NONE, api_kwargs: Optional[JSONDict] = None, - ) -> Tuple["MessageId", ...]: + ) -> tuple["MessageId", ...]: """Shortcut for:: await bot.forward_messages(chat_id=update.effective_chat.id, *args, **kwargs) @@ -2454,7 +2455,7 @@ async def forward_messages_from( .. versionadded:: 20.8 Returns: - Tuple[:class:`telegram.MessageId`]: On success, a tuple of :class:`~telegram.MessageId` + tuple[:class:`telegram.MessageId`]: On success, a tuple of :class:`~telegram.MessageId` of sent messages is returned. """ @@ -2485,7 +2486,7 @@ async def forward_messages_to( connect_timeout: ODVInput[float] = DEFAULT_NONE, pool_timeout: ODVInput[float] = DEFAULT_NONE, api_kwargs: Optional[JSONDict] = None, - ) -> Tuple["MessageId", ...]: + ) -> tuple["MessageId", ...]: """Shortcut for:: await bot.forward_messages(from_chat_id=update.effective_chat.id, *args, **kwargs) @@ -2497,7 +2498,7 @@ async def forward_messages_to( .. versionadded:: 20.8 Returns: - Tuple[:class:`telegram.MessageId`]: On success, a tuple of :class:`~telegram.MessageId` + tuple[:class:`telegram.MessageId`]: On success, a tuple of :class:`~telegram.MessageId` of sent messages is returned. """ diff --git a/telegram/_chatbackground.py b/telegram/_chatbackground.py index b33fd4d91ae..148c628039d 100644 --- a/telegram/_chatbackground.py +++ b/telegram/_chatbackground.py @@ -17,7 +17,8 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains objects related to chat backgrounds.""" -from typing import TYPE_CHECKING, Dict, Final, Optional, Sequence, Tuple, Type +from collections.abc import Sequence +from typing import TYPE_CHECKING, Final, Optional from telegram import constants from telegram._files.document import Document @@ -87,7 +88,7 @@ def de_json( if not data: return None - _class_mapping: Dict[str, Type[BackgroundFill]] = { + _class_mapping: dict[str, type[BackgroundFill]] = { cls.SOLID: BackgroundFillSolid, cls.GRADIENT: BackgroundFillGradient, cls.FREEFORM_GRADIENT: BackgroundFillFreeformGradient, @@ -212,7 +213,7 @@ def __init__( super().__init__(type=self.FREEFORM_GRADIENT, api_kwargs=api_kwargs) with self._unfrozen(): - self.colors: Tuple[int, ...] = parse_sequence_arg(colors) + self.colors: tuple[int, ...] = parse_sequence_arg(colors) self._id_attrs = (self.colors,) @@ -278,7 +279,7 @@ def de_json( if not data: return None - _class_mapping: Dict[str, Type[BackgroundType]] = { + _class_mapping: dict[str, type[BackgroundType]] = { cls.FILL: BackgroundTypeFill, cls.WALLPAPER: BackgroundTypeWallpaper, cls.PATTERN: BackgroundTypePattern, diff --git a/telegram/_chatboost.py b/telegram/_chatboost.py index e5e26d2f472..fee5fff9e51 100644 --- a/telegram/_chatboost.py +++ b/telegram/_chatboost.py @@ -18,8 +18,9 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains the classes that represent Telegram ChatBoosts.""" +from collections.abc import Sequence from datetime import datetime -from typing import TYPE_CHECKING, Dict, Final, Optional, Sequence, Tuple, Type +from typing import TYPE_CHECKING, Final, Optional from telegram import constants from telegram._chat import Chat @@ -119,7 +120,7 @@ def de_json( if not data: return None - _class_mapping: Dict[str, Type[ChatBoostSource]] = { + _class_mapping: dict[str, type[ChatBoostSource]] = { cls.PREMIUM: ChatBoostSourcePremium, cls.GIFT_CODE: ChatBoostSourceGiftCode, cls.GIVEAWAY: ChatBoostSourceGiveaway, @@ -431,7 +432,7 @@ class UserChatBoosts(TelegramObject): user. Attributes: - boosts (Tuple[:class:`telegram.ChatBoost`]): List of boosts added to the chat by the user. + boosts (tuple[:class:`telegram.ChatBoost`]): List of boosts added to the chat by the user. """ __slots__ = ("boosts",) @@ -444,7 +445,7 @@ def __init__( ): super().__init__(api_kwargs=api_kwargs) - self.boosts: Tuple[ChatBoost, ...] = parse_sequence_arg(boosts) + self.boosts: tuple[ChatBoost, ...] = parse_sequence_arg(boosts) self._id_attrs = (self.boosts,) self._freeze() diff --git a/telegram/_chatfullinfo.py b/telegram/_chatfullinfo.py index de26101f33c..6778cfae711 100644 --- a/telegram/_chatfullinfo.py +++ b/telegram/_chatfullinfo.py @@ -18,8 +18,9 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains an object that represents a Telegram ChatFullInfo.""" +from collections.abc import Sequence from datetime import datetime -from typing import TYPE_CHECKING, Optional, Sequence, Tuple +from typing import TYPE_CHECKING, Optional from telegram._birthdate import Birthdate from telegram._chat import Chat, _ChatBase @@ -224,7 +225,7 @@ class ChatFullInfo(_ChatBase): .. versionadded:: 20.0 photo (:class:`telegram.ChatPhoto`): Optional. Chat photo. - active_usernames (Tuple[:obj:`str`]): Optional. If set, the list of all `active chat + active_usernames (tuple[:obj:`str`]): Optional. If set, the list of all `active chat usernames `_; for private chats, supergroups and channels. @@ -252,7 +253,7 @@ class ChatFullInfo(_ChatBase): of the user. .. versionadded:: 21.1 - available_reactions (Tuple[:class:`telegram.ReactionType`]): Optional. List of available + available_reactions (tuple[:class:`telegram.ReactionType`]): Optional. List of available reactions allowed in the chat. If omitted, then all of :const:`telegram.constants.ReactionEmoji` are allowed. @@ -483,14 +484,14 @@ def __init__( self.has_restricted_voice_and_video_messages: Optional[bool] = ( has_restricted_voice_and_video_messages ) - self.active_usernames: Tuple[str, ...] = parse_sequence_arg(active_usernames) + self.active_usernames: tuple[str, ...] = parse_sequence_arg(active_usernames) self.emoji_status_custom_emoji_id: Optional[str] = emoji_status_custom_emoji_id self.emoji_status_expiration_date: Optional[datetime] = emoji_status_expiration_date self.has_aggressive_anti_spam_enabled: Optional[bool] = ( has_aggressive_anti_spam_enabled ) self.has_hidden_members: Optional[bool] = has_hidden_members - self.available_reactions: Optional[Tuple[ReactionType, ...]] = parse_sequence_arg( + self.available_reactions: Optional[tuple[ReactionType, ...]] = parse_sequence_arg( available_reactions ) self.accent_color_id: Optional[int] = accent_color_id diff --git a/telegram/_chatmember.py b/telegram/_chatmember.py index da84516b165..99c87dfb09d 100644 --- a/telegram/_chatmember.py +++ b/telegram/_chatmember.py @@ -19,7 +19,7 @@ """This module contains an object that represents a Telegram ChatMember.""" import datetime -from typing import TYPE_CHECKING, Dict, Final, Optional, Type +from typing import TYPE_CHECKING, Final, Optional from telegram import constants from telegram._telegramobject import TelegramObject @@ -114,7 +114,7 @@ def de_json( if not data: return None - _class_mapping: Dict[str, Type[ChatMember]] = { + _class_mapping: dict[str, type[ChatMember]] = { cls.OWNER: ChatMemberOwner, cls.ADMINISTRATOR: ChatMemberAdministrator, cls.MEMBER: ChatMemberMember, diff --git a/telegram/_chatmemberupdated.py b/telegram/_chatmemberupdated.py index 1aacb218533..82f86ef880e 100644 --- a/telegram/_chatmemberupdated.py +++ b/telegram/_chatmemberupdated.py @@ -18,7 +18,7 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains an object that represents a Telegram ChatMemberUpdated.""" import datetime -from typing import TYPE_CHECKING, Dict, Optional, Tuple, Union +from typing import TYPE_CHECKING, Optional, Union from telegram._chat import Chat from telegram._chatinvitelink import ChatInviteLink @@ -162,7 +162,7 @@ def de_json( return super().de_json(data=data, bot=bot) - def _get_attribute_difference(self, attribute: str) -> Tuple[object, object]: + def _get_attribute_difference(self, attribute: str) -> tuple[object, object]: try: old = self.old_chat_member[attribute] except KeyError: @@ -177,9 +177,9 @@ def _get_attribute_difference(self, attribute: str) -> Tuple[object, object]: def difference( self, - ) -> Dict[ + ) -> dict[ str, - Tuple[ + tuple[ Union[str, bool, datetime.datetime, User], Union[str, bool, datetime.datetime, User] ], ]: @@ -198,7 +198,7 @@ def difference( .. versionadded:: 13.5 Returns: - Dict[:obj:`str`, Tuple[:class:`object`, :class:`object`]]: A dictionary mapping + dict[:obj:`str`, tuple[:class:`object`, :class:`object`]]: A dictionary mapping attribute names to tuples of the form ``(old_value, new_value)`` """ # we first get the names of the attributes that have changed diff --git a/telegram/_dice.py b/telegram/_dice.py index 621e4b13f98..f0e752fdaa2 100644 --- a/telegram/_dice.py +++ b/telegram/_dice.py @@ -17,7 +17,7 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains an object that represents a Telegram Dice.""" -from typing import Final, List, Optional +from typing import Final, Optional from telegram import constants from telegram._telegramobject import TelegramObject @@ -114,8 +114,8 @@ def __init__(self, value: int, emoji: str, *, api_kwargs: Optional[JSONDict] = N .. versionadded:: 13.4 """ - ALL_EMOJI: Final[List[str]] = list(constants.DiceEmoji) - """List[:obj:`str`]: A list of all available dice emoji.""" + ALL_EMOJI: Final[list[str]] = list(constants.DiceEmoji) + """list[:obj:`str`]: A list of all available dice emoji.""" MIN_VALUE: Final[int] = constants.DiceLimit.MIN_VALUE """:const:`telegram.constants.DiceLimit.MIN_VALUE` diff --git a/telegram/_files/_basethumbedmedium.py b/telegram/_files/_basethumbedmedium.py index 20ff82eab5e..d0b66f35c20 100644 --- a/telegram/_files/_basethumbedmedium.py +++ b/telegram/_files/_basethumbedmedium.py @@ -17,7 +17,7 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. """Common base class for media objects with thumbnails""" -from typing import TYPE_CHECKING, Optional, Type, TypeVar +from typing import TYPE_CHECKING, Optional, TypeVar from telegram._files._basemedium import _BaseMedium from telegram._files.photosize import PhotoSize @@ -82,7 +82,7 @@ def __init__( @classmethod def de_json( - cls: Type[ThumbedMT_co], data: Optional[JSONDict], bot: Optional["Bot"] = None + cls: type[ThumbedMT_co], data: Optional[JSONDict], bot: Optional["Bot"] = None ) -> Optional[ThumbedMT_co]: """See :meth:`telegram.TelegramObject.de_json`.""" data = cls._parse_data(data) diff --git a/telegram/_files/inputfile.py b/telegram/_files/inputfile.py index e7c9cc6c64b..d376d16a106 100644 --- a/telegram/_files/inputfile.py +++ b/telegram/_files/inputfile.py @@ -130,7 +130,7 @@ def field_tuple(self) -> FieldTuple: Content may now be a file handle. Returns: - Tuple[:obj:`str`, :obj:`bytes` | :class:`IO`, :obj:`str`]: + tuple[:obj:`str`, :obj:`bytes` | :class:`IO`, :obj:`str`]: """ return self.filename, self.input_file_content, self.mimetype diff --git a/telegram/_files/inputmedia.py b/telegram/_files/inputmedia.py index c33a87a2d44..6dcf9d57809 100644 --- a/telegram/_files/inputmedia.py +++ b/telegram/_files/inputmedia.py @@ -17,7 +17,8 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. """Base class for Telegram InputMedia Objects.""" -from typing import Final, Optional, Sequence, Tuple, Union +from collections.abc import Sequence +from typing import Final, Optional, Union from telegram import constants from telegram._files.animation import Animation @@ -74,7 +75,7 @@ class InputMedia(TelegramObject): 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. parse_mode (:obj:`str`): Optional. |parse_mode| - caption_entities (Tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| + caption_entities (tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| .. versionchanged:: 20.0 @@ -99,7 +100,7 @@ def __init__( self.type: str = enum.get_member(constants.InputMediaType, media_type, media_type) self.media: Union[str, InputFile, Animation, Audio, Document, PhotoSize, Video] = media self.caption: Optional[str] = caption - self.caption_entities: Tuple[MessageEntity, ...] = parse_sequence_arg(caption_entities) + self.caption_entities: tuple[MessageEntity, ...] = parse_sequence_arg(caption_entities) self.parse_mode: ODVInput[str] = parse_mode self._freeze() @@ -321,7 +322,7 @@ class InputMediaAnimation(InputMedia): 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. parse_mode (:obj:`str`): Optional. The parse mode to use for text formatting. - caption_entities (Tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| + caption_entities (tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| .. versionchanged:: 20.0 @@ -436,7 +437,7 @@ class InputMediaPhoto(InputMedia): 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. parse_mode (:obj:`str`): Optional. |parse_mode| - caption_entities (Tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| + caption_entities (tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| .. versionchanged:: 20.0 @@ -546,7 +547,7 @@ class InputMediaVideo(InputMedia): 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. parse_mode (:obj:`str`): Optional. |parse_mode| - caption_entities (Tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| + caption_entities (tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| .. versionchanged:: 20.0 @@ -676,7 +677,7 @@ class InputMediaAudio(InputMedia): 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. parse_mode (:obj:`str`): Optional. |parse_mode| - caption_entities (Tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| + caption_entities (tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| .. versionchanged:: 20.0 @@ -779,7 +780,7 @@ class InputMediaDocument(InputMedia): 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. parse_mode (:obj:`str`): Optional. |parse_mode| - caption_entities (Tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| + caption_entities (tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| .. versionchanged:: 20.0 diff --git a/telegram/_files/inputsticker.py b/telegram/_files/inputsticker.py index 8fc8b8461c6..59b8e8ba96d 100644 --- a/telegram/_files/inputsticker.py +++ b/telegram/_files/inputsticker.py @@ -18,7 +18,8 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains an object that represents a Telegram InputSticker.""" -from typing import TYPE_CHECKING, Optional, Sequence, Tuple, Union +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional, Union from telegram._files.sticker import MaskPosition from telegram._telegramobject import TelegramObject @@ -67,13 +68,13 @@ class InputSticker(TelegramObject): Attributes: sticker (:obj:`str` | :class:`telegram.InputFile`): The added sticker. - emoji_list (Tuple[:obj:`str`]): Tuple of + emoji_list (tuple[:obj:`str`]): Tuple of :tg-const:`telegram.constants.StickerLimit.MIN_STICKER_EMOJI` - :tg-const:`telegram.constants.StickerLimit.MAX_STICKER_EMOJI` emoji associated with the sticker. mask_position (:class:`telegram.MaskPosition`): Optional. Position where the mask should be placed on faces. For ":tg-const:`telegram.constants.StickerType.MASK`" stickers only. - keywords (Tuple[:obj:`str`]): Optional. Tuple of + keywords (tuple[:obj:`str`]): Optional. Tuple of 0-:tg-const:`telegram.constants.StickerLimit.MAX_SEARCH_KEYWORDS` search keywords for the sticker with the total length of up to :tg-const:`telegram.constants.StickerLimit.MAX_KEYWORD_LENGTH` characters. For @@ -110,9 +111,9 @@ def __init__( local_mode=True, attach=True, ) - self.emoji_list: Tuple[str, ...] = parse_sequence_arg(emoji_list) + self.emoji_list: tuple[str, ...] = parse_sequence_arg(emoji_list) self.format: str = format self.mask_position: Optional[MaskPosition] = mask_position - self.keywords: Tuple[str, ...] = parse_sequence_arg(keywords) + self.keywords: tuple[str, ...] = parse_sequence_arg(keywords) self._freeze() diff --git a/telegram/_files/sticker.py b/telegram/_files/sticker.py index 3c3c1cd7e72..01ebf37e6ff 100644 --- a/telegram/_files/sticker.py +++ b/telegram/_files/sticker.py @@ -17,7 +17,8 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains objects that represent stickers.""" -from typing import TYPE_CHECKING, Final, Optional, Sequence, Tuple +from collections.abc import Sequence +from typing import TYPE_CHECKING, Final, Optional from telegram import constants from telegram._files._basethumbedmedium import _BaseThumbedMedium @@ -259,7 +260,7 @@ class StickerSet(TelegramObject): Attributes: name (:obj:`str`): Sticker set name. title (:obj:`str`): Sticker set title. - stickers (Tuple[:class:`telegram.Sticker`]): List of all set stickers. + stickers (tuple[:class:`telegram.Sticker`]): List of all set stickers. .. versionchanged:: 20.0 |tupleclassattrs| @@ -296,7 +297,7 @@ def __init__( super().__init__(api_kwargs=api_kwargs) self.name: str = name self.title: str = title - self.stickers: Tuple[Sticker, ...] = parse_sequence_arg(stickers) + self.stickers: tuple[Sticker, ...] = parse_sequence_arg(stickers) self.sticker_type: str = sticker_type # Optional self.thumbnail: Optional[PhotoSize] = thumbnail diff --git a/telegram/_games/game.py b/telegram/_games/game.py index 1a25d1ad538..efe30ea7f25 100644 --- a/telegram/_games/game.py +++ b/telegram/_games/game.py @@ -17,7 +17,8 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains an object that represents a Telegram Game.""" -from typing import TYPE_CHECKING, Dict, List, Optional, Sequence, Tuple +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional from telegram._files.animation import Animation from telegram._files.photosize import PhotoSize @@ -65,7 +66,7 @@ class Game(TelegramObject): Attributes: title (:obj:`str`): Title of the game. description (:obj:`str`): Description of the game. - photo (Tuple[:class:`telegram.PhotoSize`]): Photo that will be displayed in the game + photo (tuple[:class:`telegram.PhotoSize`]): Photo that will be displayed in the game message in chats. .. versionchanged:: 20.0 @@ -76,7 +77,7 @@ class Game(TelegramObject): when the bot calls :meth:`telegram.Bot.set_game_score`, or manually edited using :meth:`telegram.Bot.edit_message_text`. 0-:tg-const:`telegram.constants.MessageLimit.MAX_TEXT_LENGTH` characters. - text_entities (Tuple[:class:`telegram.MessageEntity`]): Optional. Special entities that + text_entities (tuple[:class:`telegram.MessageEntity`]): Optional. Special entities that appear in text, such as usernames, URLs, bot commands, etc. This tuple is empty if the message does not contain text entities. @@ -112,10 +113,10 @@ def __init__( # Required self.title: str = title self.description: str = description - self.photo: Tuple[PhotoSize, ...] = parse_sequence_arg(photo) + self.photo: tuple[PhotoSize, ...] = parse_sequence_arg(photo) # Optionals self.text: Optional[str] = text - self.text_entities: Tuple[MessageEntity, ...] = parse_sequence_arg(text_entities) + self.text_entities: tuple[MessageEntity, ...] = parse_sequence_arg(text_entities) self.animation: Optional[Animation] = animation self._id_attrs = (self.title, self.description, self.photo) @@ -163,7 +164,7 @@ def parse_text_entity(self, entity: MessageEntity) -> str: return entity_text.decode(TextEncoding.UTF_16_LE) - def parse_text_entities(self, types: Optional[List[str]] = None) -> Dict[MessageEntity, str]: + def parse_text_entities(self, types: Optional[list[str]] = None) -> dict[MessageEntity, str]: """ Returns a :obj:`dict` that maps :class:`telegram.MessageEntity` to :obj:`str`. It contains entities from this message filtered by their @@ -176,13 +177,13 @@ def parse_text_entities(self, types: Optional[List[str]] = None) -> Dict[Message See :attr:`parse_text_entity` for more info. Args: - types (List[:obj:`str`], optional): List of :class:`telegram.MessageEntity` types as + types (list[:obj:`str`], optional): List of :class:`telegram.MessageEntity` types as strings. If the :attr:`~telegram.MessageEntity.type` attribute of an entity is contained in this list, it will be returned. Defaults to :attr:`telegram.MessageEntity.ALL_TYPES`. Returns: - Dict[:class:`telegram.MessageEntity`, :obj:`str`]: A dictionary of entities mapped to + dict[:class:`telegram.MessageEntity`, :obj:`str`]: A dictionary of entities mapped to the text that belongs to them, calculated based on UTF-16 codepoints. """ diff --git a/telegram/_giveaway.py b/telegram/_giveaway.py index 1e258b477f1..b3af8ec99d6 100644 --- a/telegram/_giveaway.py +++ b/telegram/_giveaway.py @@ -18,7 +18,8 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains an objects that are related to Telegram giveaways.""" import datetime -from typing import TYPE_CHECKING, Optional, Sequence, Tuple +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional from telegram._chat import Chat from telegram._telegramobject import TelegramObject @@ -41,7 +42,7 @@ class Giveaway(TelegramObject): .. versionadded:: 20.8 Args: - chats (Tuple[:class:`telegram.Chat`]): The list of chats which the user must join to + chats (tuple[:class:`telegram.Chat`]): The list of chats which the user must join to participate in the giveaway. winners_selection_date (:class:`datetime.datetime`): The date when the giveaway winner will be selected. |datetime_localization| @@ -76,7 +77,7 @@ class Giveaway(TelegramObject): has_public_winners (:obj:`True`): Optional. :obj:`True`, if the list of giveaway winners will be visible to everyone prize_description (:obj:`str`): Optional. Description of additional giveaway prize - country_codes (Tuple[:obj:`str`]): Optional. A tuple of two-letter ISO 3166-1 alpha-2 + country_codes (tuple[:obj:`str`]): Optional. A tuple of two-letter ISO 3166-1 alpha-2 country codes indicating the countries from which eligible users for the giveaway must come. If empty, then all users can participate in the giveaway. Users with a phone number that was bought on Fragment can always participate in giveaways. @@ -117,13 +118,13 @@ def __init__( ): super().__init__(api_kwargs=api_kwargs) - self.chats: Tuple[Chat, ...] = tuple(chats) + self.chats: tuple[Chat, ...] = tuple(chats) self.winners_selection_date: datetime.datetime = winners_selection_date self.winner_count: int = winner_count self.only_new_members: Optional[bool] = only_new_members self.has_public_winners: Optional[bool] = has_public_winners self.prize_description: Optional[str] = prize_description - self.country_codes: Tuple[str, ...] = parse_sequence_arg(country_codes) + self.country_codes: tuple[str, ...] = parse_sequence_arg(country_codes) self.premium_subscription_month_count: Optional[int] = premium_subscription_month_count self.prize_star_count: Optional[int] = prize_star_count @@ -222,7 +223,7 @@ class GiveawayWinners(TelegramObject): winners_selection_date (:class:`datetime.datetime`): Point in time when winners of the giveaway were selected. |datetime_localization| winner_count (:obj:`int`): Total number of winners in the giveaway - winners (Tuple[:class:`telegram.User`]): tuple of up to + winners (tuple[:class:`telegram.User`]): tuple of up to :tg-const:`telegram.constants.GiveawayLimit.MAX_WINNERS` winners of the giveaway additional_chat_count (:obj:`int`): Optional. The number of other chats the user had to join in order to be eligible for the giveaway @@ -278,7 +279,7 @@ def __init__( self.giveaway_message_id: int = giveaway_message_id self.winners_selection_date: datetime.datetime = winners_selection_date self.winner_count: int = winner_count - self.winners: Tuple[User, ...] = tuple(winners) + self.winners: tuple[User, ...] = tuple(winners) self.additional_chat_count: Optional[int] = additional_chat_count self.premium_subscription_month_count: Optional[int] = premium_subscription_month_count self.unclaimed_prize_count: Optional[int] = unclaimed_prize_count diff --git a/telegram/_inline/inlinekeyboardmarkup.py b/telegram/_inline/inlinekeyboardmarkup.py index 6857e4d8e3a..406688f2d2f 100644 --- a/telegram/_inline/inlinekeyboardmarkup.py +++ b/telegram/_inline/inlinekeyboardmarkup.py @@ -17,7 +17,8 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains an object that represents a Telegram InlineKeyboardMarkup.""" -from typing import TYPE_CHECKING, Optional, Sequence, Tuple +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional from telegram._inline.inlinekeyboardbutton import InlineKeyboardButton from telegram._telegramobject import TelegramObject @@ -57,7 +58,7 @@ class InlineKeyboardMarkup(TelegramObject): |sequenceclassargs| Attributes: - inline_keyboard (Tuple[Tuple[:class:`telegram.InlineKeyboardButton`]]): Tuple of + inline_keyboard (tuple[tuple[:class:`telegram.InlineKeyboardButton`]]): Tuple of button rows, each represented by a tuple of :class:`~telegram.InlineKeyboardButton` objects. @@ -81,7 +82,7 @@ def __init__( "InlineKeyboardButtons" ) # Required - self.inline_keyboard: Tuple[Tuple[InlineKeyboardButton, ...], ...] = tuple( + self.inline_keyboard: tuple[tuple[InlineKeyboardButton, ...], ...] = tuple( tuple(row) for row in inline_keyboard ) diff --git a/telegram/_inline/inlinequery.py b/telegram/_inline/inlinequery.py index ba29a8646fe..f6a94e8f47e 100644 --- a/telegram/_inline/inlinequery.py +++ b/telegram/_inline/inlinequery.py @@ -19,7 +19,8 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains an object that represents a Telegram InlineQuery.""" -from typing import TYPE_CHECKING, Callable, Final, Optional, Sequence, Union +from collections.abc import Sequence +from typing import TYPE_CHECKING, Callable, Final, Optional, Union from telegram import constants from telegram._files.location import Location diff --git a/telegram/_inline/inlinequeryresultaudio.py b/telegram/_inline/inlinequeryresultaudio.py index 69353967adc..0b2b822b60e 100644 --- a/telegram/_inline/inlinequeryresultaudio.py +++ b/telegram/_inline/inlinequeryresultaudio.py @@ -17,7 +17,8 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains the classes that represent Telegram InlineQueryResultAudio.""" -from typing import TYPE_CHECKING, Optional, Sequence, Tuple +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional from telegram._inline.inlinekeyboardmarkup import InlineKeyboardMarkup from telegram._inline.inlinequeryresult import InlineQueryResult @@ -73,7 +74,7 @@ class InlineQueryResultAudio(InlineQueryResult): 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. parse_mode (:obj:`str`): Optional. |parse_mode| - caption_entities (Tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| + caption_entities (tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| .. versionchanged:: 20.0 @@ -124,6 +125,6 @@ def __init__( self.audio_duration: Optional[int] = audio_duration self.caption: Optional[str] = caption self.parse_mode: ODVInput[str] = parse_mode - self.caption_entities: Tuple[MessageEntity, ...] = parse_sequence_arg(caption_entities) + self.caption_entities: tuple[MessageEntity, ...] = parse_sequence_arg(caption_entities) self.reply_markup: Optional[InlineKeyboardMarkup] = reply_markup self.input_message_content: Optional[InputMessageContent] = input_message_content diff --git a/telegram/_inline/inlinequeryresultcachedaudio.py b/telegram/_inline/inlinequeryresultcachedaudio.py index 2fb7cdbb54d..933a2b85bce 100644 --- a/telegram/_inline/inlinequeryresultcachedaudio.py +++ b/telegram/_inline/inlinequeryresultcachedaudio.py @@ -17,7 +17,8 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains the classes that represent Telegram InlineQueryResultCachedAudio.""" -from typing import TYPE_CHECKING, Optional, Sequence, Tuple +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional from telegram._inline.inlinekeyboardmarkup import InlineKeyboardMarkup from telegram._inline.inlinequeryresult import InlineQueryResult @@ -68,7 +69,7 @@ class InlineQueryResultCachedAudio(InlineQueryResult): 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. parse_mode (:obj:`str`): Optional. |parse_mode| - caption_entities (Tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| + caption_entities (tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| .. versionchanged:: 20.0 @@ -110,6 +111,6 @@ def __init__( # Optionals self.caption: Optional[str] = caption self.parse_mode: ODVInput[str] = parse_mode - self.caption_entities: Tuple[MessageEntity, ...] = parse_sequence_arg(caption_entities) + self.caption_entities: tuple[MessageEntity, ...] = parse_sequence_arg(caption_entities) self.reply_markup: Optional[InlineKeyboardMarkup] = reply_markup self.input_message_content: Optional[InputMessageContent] = input_message_content diff --git a/telegram/_inline/inlinequeryresultcacheddocument.py b/telegram/_inline/inlinequeryresultcacheddocument.py index b5416c2748c..0ef4e199338 100644 --- a/telegram/_inline/inlinequeryresultcacheddocument.py +++ b/telegram/_inline/inlinequeryresultcacheddocument.py @@ -17,7 +17,8 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains the classes that represent Telegram InlineQueryResultCachedDocument.""" -from typing import TYPE_CHECKING, Optional, Sequence, Tuple +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional from telegram._inline.inlinekeyboardmarkup import InlineKeyboardMarkup from telegram._inline.inlinequeryresult import InlineQueryResult @@ -72,7 +73,7 @@ class InlineQueryResultCachedDocument(InlineQueryResult): 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. parse_mode (:obj:`str`): Optional. |parse_mode| - caption_entities (Tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| + caption_entities (tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| .. versionchanged:: 20.0 @@ -120,6 +121,6 @@ def __init__( self.description: Optional[str] = description self.caption: Optional[str] = caption self.parse_mode: ODVInput[str] = parse_mode - self.caption_entities: Tuple[MessageEntity, ...] = parse_sequence_arg(caption_entities) + self.caption_entities: tuple[MessageEntity, ...] = parse_sequence_arg(caption_entities) self.reply_markup: Optional[InlineKeyboardMarkup] = reply_markup self.input_message_content: Optional[InputMessageContent] = input_message_content diff --git a/telegram/_inline/inlinequeryresultcachedgif.py b/telegram/_inline/inlinequeryresultcachedgif.py index 9f52347a05c..c621a814e51 100644 --- a/telegram/_inline/inlinequeryresultcachedgif.py +++ b/telegram/_inline/inlinequeryresultcachedgif.py @@ -17,7 +17,8 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains the classes that represent Telegram InlineQueryResultCachedGif.""" -from typing import TYPE_CHECKING, Optional, Sequence, Tuple +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional from telegram._inline.inlinekeyboardmarkup import InlineKeyboardMarkup from telegram._inline.inlinequeryresult import InlineQueryResult @@ -74,7 +75,7 @@ class InlineQueryResultCachedGif(InlineQueryResult): 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. parse_mode (:obj:`str`): Optional. |parse_mode| - caption_entities (Tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| + caption_entities (tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| .. versionchanged:: 20.0 @@ -124,7 +125,7 @@ def __init__( self.title: Optional[str] = title self.caption: Optional[str] = caption self.parse_mode: ODVInput[str] = parse_mode - self.caption_entities: Tuple[MessageEntity, ...] = parse_sequence_arg(caption_entities) + self.caption_entities: tuple[MessageEntity, ...] = parse_sequence_arg(caption_entities) self.reply_markup: Optional[InlineKeyboardMarkup] = reply_markup self.input_message_content: Optional[InputMessageContent] = input_message_content self.show_caption_above_media: Optional[bool] = show_caption_above_media diff --git a/telegram/_inline/inlinequeryresultcachedmpeg4gif.py b/telegram/_inline/inlinequeryresultcachedmpeg4gif.py index f750f4df8fd..fa5be748441 100644 --- a/telegram/_inline/inlinequeryresultcachedmpeg4gif.py +++ b/telegram/_inline/inlinequeryresultcachedmpeg4gif.py @@ -17,7 +17,8 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains the classes that represent Telegram InlineQueryResultMpeg4Gif.""" -from typing import TYPE_CHECKING, Optional, Sequence, Tuple +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional from telegram._inline.inlinekeyboardmarkup import InlineKeyboardMarkup from telegram._inline.inlinequeryresult import InlineQueryResult @@ -74,7 +75,7 @@ class InlineQueryResultCachedMpeg4Gif(InlineQueryResult): 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. parse_mode (:obj:`str`): Optional. |parse_mode| - caption_entities (Tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| + caption_entities (tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| .. versionchanged:: 20.0 @@ -124,7 +125,7 @@ def __init__( self.title: Optional[str] = title self.caption: Optional[str] = caption self.parse_mode: ODVInput[str] = parse_mode - self.caption_entities: Tuple[MessageEntity, ...] = parse_sequence_arg(caption_entities) + self.caption_entities: tuple[MessageEntity, ...] = parse_sequence_arg(caption_entities) self.reply_markup: Optional[InlineKeyboardMarkup] = reply_markup self.input_message_content: Optional[InputMessageContent] = input_message_content self.show_caption_above_media: Optional[bool] = show_caption_above_media diff --git a/telegram/_inline/inlinequeryresultcachedphoto.py b/telegram/_inline/inlinequeryresultcachedphoto.py index 75f292d2e32..06914934ff7 100644 --- a/telegram/_inline/inlinequeryresultcachedphoto.py +++ b/telegram/_inline/inlinequeryresultcachedphoto.py @@ -17,7 +17,8 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains the classes that represent Telegram InlineQueryResultPhoto""" -from typing import TYPE_CHECKING, Optional, Sequence, Tuple +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional from telegram._inline.inlinekeyboardmarkup import InlineKeyboardMarkup from telegram._inline.inlinequeryresult import InlineQueryResult @@ -76,7 +77,7 @@ class InlineQueryResultCachedPhoto(InlineQueryResult): 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. parse_mode (:obj:`str`): Optional. |parse_mode| - caption_entities (Tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| + caption_entities (tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| .. versionchanged:: 20.0 @@ -129,7 +130,7 @@ def __init__( self.description: Optional[str] = description self.caption: Optional[str] = caption self.parse_mode: ODVInput[str] = parse_mode - self.caption_entities: Tuple[MessageEntity, ...] = parse_sequence_arg(caption_entities) + self.caption_entities: tuple[MessageEntity, ...] = parse_sequence_arg(caption_entities) self.reply_markup: Optional[InlineKeyboardMarkup] = reply_markup self.input_message_content: Optional[InputMessageContent] = input_message_content self.show_caption_above_media: Optional[bool] = show_caption_above_media diff --git a/telegram/_inline/inlinequeryresultcachedvideo.py b/telegram/_inline/inlinequeryresultcachedvideo.py index 99a58eebbe5..a341114d7a7 100644 --- a/telegram/_inline/inlinequeryresultcachedvideo.py +++ b/telegram/_inline/inlinequeryresultcachedvideo.py @@ -17,7 +17,8 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains the classes that represent Telegram InlineQueryResultCachedVideo.""" -from typing import TYPE_CHECKING, Optional, Sequence, Tuple +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional from telegram._inline.inlinekeyboardmarkup import InlineKeyboardMarkup from telegram._inline.inlinequeryresult import InlineQueryResult @@ -72,7 +73,7 @@ class InlineQueryResultCachedVideo(InlineQueryResult): 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. parse_mode (:obj:`str`): Optional. |parse_mode| - caption_entities (Tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| + caption_entities (tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| .. versionchanged:: 20.0 @@ -125,7 +126,7 @@ def __init__( self.description: Optional[str] = description self.caption: Optional[str] = caption self.parse_mode: ODVInput[str] = parse_mode - self.caption_entities: Tuple[MessageEntity, ...] = parse_sequence_arg(caption_entities) + self.caption_entities: tuple[MessageEntity, ...] = parse_sequence_arg(caption_entities) self.reply_markup: Optional[InlineKeyboardMarkup] = reply_markup self.input_message_content: Optional[InputMessageContent] = input_message_content self.show_caption_above_media: Optional[bool] = show_caption_above_media diff --git a/telegram/_inline/inlinequeryresultcachedvoice.py b/telegram/_inline/inlinequeryresultcachedvoice.py index dc8bd2ad3a6..c830264edef 100644 --- a/telegram/_inline/inlinequeryresultcachedvoice.py +++ b/telegram/_inline/inlinequeryresultcachedvoice.py @@ -17,7 +17,8 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains the classes that represent Telegram InlineQueryResultCachedVoice.""" -from typing import TYPE_CHECKING, Optional, Sequence, Tuple +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional from telegram._inline.inlinekeyboardmarkup import InlineKeyboardMarkup from telegram._inline.inlinequeryresult import InlineQueryResult @@ -70,7 +71,7 @@ class InlineQueryResultCachedVoice(InlineQueryResult): 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. parse_mode (:obj:`str`): Optional. |parse_mode| - caption_entities (Tuple[:class:`telegram.MessageEntity`]): Optional. |caption_entities| + caption_entities (tuple[:class:`telegram.MessageEntity`]): Optional. |caption_entities| .. versionchanged:: 20.0 @@ -115,6 +116,6 @@ def __init__( # Optionals self.caption: Optional[str] = caption self.parse_mode: ODVInput[str] = parse_mode - self.caption_entities: Tuple[MessageEntity, ...] = parse_sequence_arg(caption_entities) + self.caption_entities: tuple[MessageEntity, ...] = parse_sequence_arg(caption_entities) self.reply_markup: Optional[InlineKeyboardMarkup] = reply_markup self.input_message_content: Optional[InputMessageContent] = input_message_content diff --git a/telegram/_inline/inlinequeryresultdocument.py b/telegram/_inline/inlinequeryresultdocument.py index e0380440b20..aef409ca0c4 100644 --- a/telegram/_inline/inlinequeryresultdocument.py +++ b/telegram/_inline/inlinequeryresultdocument.py @@ -17,7 +17,8 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains the classes that represent Telegram InlineQueryResultDocument""" -from typing import TYPE_CHECKING, Optional, Sequence, Tuple +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional from telegram._inline.inlinekeyboardmarkup import InlineKeyboardMarkup from telegram._inline.inlinequeryresult import InlineQueryResult @@ -86,7 +87,7 @@ class InlineQueryResultDocument(InlineQueryResult): 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. parse_mode (:obj:`str`): Optional. |parse_mode| - caption_entities (Tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| + caption_entities (tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| .. versionchanged:: 20.0 @@ -155,7 +156,7 @@ def __init__( # Optionals self.caption: Optional[str] = caption self.parse_mode: ODVInput[str] = parse_mode - self.caption_entities: Tuple[MessageEntity, ...] = parse_sequence_arg(caption_entities) + self.caption_entities: tuple[MessageEntity, ...] = parse_sequence_arg(caption_entities) self.description: Optional[str] = description self.reply_markup: Optional[InlineKeyboardMarkup] = reply_markup self.input_message_content: Optional[InputMessageContent] = input_message_content diff --git a/telegram/_inline/inlinequeryresultgif.py b/telegram/_inline/inlinequeryresultgif.py index e5694e4f856..f95aec09cba 100644 --- a/telegram/_inline/inlinequeryresultgif.py +++ b/telegram/_inline/inlinequeryresultgif.py @@ -17,7 +17,8 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains the classes that represent Telegram InlineQueryResultGif.""" -from typing import TYPE_CHECKING, Optional, Sequence, Tuple +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional from telegram._inline.inlinekeyboardmarkup import InlineKeyboardMarkup from telegram._inline.inlinequeryresult import InlineQueryResult @@ -102,7 +103,7 @@ class InlineQueryResultGif(InlineQueryResult): 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. parse_mode (:obj:`str`): Optional. |parse_mode| - caption_entities (Tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| + caption_entities (tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| .. versionchanged:: 20.0 @@ -166,7 +167,7 @@ def __init__( self.title: Optional[str] = title self.caption: Optional[str] = caption self.parse_mode: ODVInput[str] = parse_mode - self.caption_entities: Tuple[MessageEntity, ...] = parse_sequence_arg(caption_entities) + self.caption_entities: tuple[MessageEntity, ...] = parse_sequence_arg(caption_entities) self.reply_markup: Optional[InlineKeyboardMarkup] = reply_markup self.input_message_content: Optional[InputMessageContent] = input_message_content self.thumbnail_mime_type: Optional[str] = thumbnail_mime_type diff --git a/telegram/_inline/inlinequeryresultmpeg4gif.py b/telegram/_inline/inlinequeryresultmpeg4gif.py index 9e27ab949df..43b8ae161a0 100644 --- a/telegram/_inline/inlinequeryresultmpeg4gif.py +++ b/telegram/_inline/inlinequeryresultmpeg4gif.py @@ -17,7 +17,8 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains the classes that represent Telegram InlineQueryResultMpeg4Gif.""" -from typing import TYPE_CHECKING, Optional, Sequence, Tuple +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional from telegram._inline.inlinekeyboardmarkup import InlineKeyboardMarkup from telegram._inline.inlinequeryresult import InlineQueryResult @@ -104,7 +105,7 @@ class InlineQueryResultMpeg4Gif(InlineQueryResult): 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. parse_mode (:obj:`str`): Optional. |parse_mode| - caption_entities (Tuple[:class:`telegram.MessageEntity`]): Optional. |caption_entities| + caption_entities (tuple[:class:`telegram.MessageEntity`]): Optional. |caption_entities| .. versionchanged:: 20.0 @@ -168,7 +169,7 @@ def __init__( self.title: Optional[str] = title self.caption: Optional[str] = caption self.parse_mode: ODVInput[str] = parse_mode - self.caption_entities: Tuple[MessageEntity, ...] = parse_sequence_arg(caption_entities) + self.caption_entities: tuple[MessageEntity, ...] = parse_sequence_arg(caption_entities) self.reply_markup: Optional[InlineKeyboardMarkup] = reply_markup self.input_message_content: Optional[InputMessageContent] = input_message_content self.thumbnail_mime_type: Optional[str] = thumbnail_mime_type diff --git a/telegram/_inline/inlinequeryresultphoto.py b/telegram/_inline/inlinequeryresultphoto.py index b74adf218e3..ce5a9ab867e 100644 --- a/telegram/_inline/inlinequeryresultphoto.py +++ b/telegram/_inline/inlinequeryresultphoto.py @@ -17,7 +17,8 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains the classes that represent Telegram InlineQueryResultPhoto.""" -from typing import TYPE_CHECKING, Optional, Sequence, Tuple +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional from telegram._inline.inlinekeyboardmarkup import InlineKeyboardMarkup from telegram._inline.inlinequeryresult import InlineQueryResult @@ -92,7 +93,7 @@ class InlineQueryResultPhoto(InlineQueryResult): 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. parse_mode (:obj:`str`): Optional. |parse_mode| - caption_entities (Tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| + caption_entities (tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| .. versionchanged:: 20.0 @@ -154,7 +155,7 @@ def __init__( self.description: Optional[str] = description self.caption: Optional[str] = caption self.parse_mode: ODVInput[str] = parse_mode - self.caption_entities: Tuple[MessageEntity, ...] = parse_sequence_arg(caption_entities) + self.caption_entities: tuple[MessageEntity, ...] = parse_sequence_arg(caption_entities) self.reply_markup: Optional[InlineKeyboardMarkup] = reply_markup self.input_message_content: Optional[InputMessageContent] = input_message_content self.show_caption_above_media: Optional[bool] = show_caption_above_media diff --git a/telegram/_inline/inlinequeryresultvideo.py b/telegram/_inline/inlinequeryresultvideo.py index bb01c1ac1bd..ce21da45549 100644 --- a/telegram/_inline/inlinequeryresultvideo.py +++ b/telegram/_inline/inlinequeryresultvideo.py @@ -17,7 +17,8 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains the classes that represent Telegram InlineQueryResultVideo.""" -from typing import TYPE_CHECKING, Optional, Sequence, Tuple +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional from telegram._inline.inlinekeyboardmarkup import InlineKeyboardMarkup from telegram._inline.inlinequeryresult import InlineQueryResult @@ -99,7 +100,7 @@ class InlineQueryResultVideo(InlineQueryResult): 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. parse_mode (:obj:`str`): Optional. |parse_mode| - caption_entities (Tuple[:class:`telegram.MessageEntity`]): Optional. + caption_entities (tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| .. versionchanged:: 20.0 @@ -171,7 +172,7 @@ def __init__( # Optional self.caption: Optional[str] = caption self.parse_mode: ODVInput[str] = parse_mode - self.caption_entities: Tuple[MessageEntity, ...] = parse_sequence_arg(caption_entities) + self.caption_entities: tuple[MessageEntity, ...] = parse_sequence_arg(caption_entities) self.video_width: Optional[int] = video_width self.video_height: Optional[int] = video_height self.video_duration: Optional[int] = video_duration diff --git a/telegram/_inline/inlinequeryresultvoice.py b/telegram/_inline/inlinequeryresultvoice.py index d33f31b34d8..de196498fb4 100644 --- a/telegram/_inline/inlinequeryresultvoice.py +++ b/telegram/_inline/inlinequeryresultvoice.py @@ -17,7 +17,8 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains the classes that represent Telegram InlineQueryResultVoice.""" -from typing import TYPE_CHECKING, Optional, Sequence, Tuple +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional from telegram._inline.inlinekeyboardmarkup import InlineKeyboardMarkup from telegram._inline.inlinequeryresult import InlineQueryResult @@ -72,7 +73,7 @@ class InlineQueryResultVoice(InlineQueryResult): 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. parse_mode (:obj:`str`): Optional. |parse_mode| - caption_entities (Tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| + caption_entities (tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| .. versionchanged:: 20.0 @@ -121,6 +122,6 @@ def __init__( self.voice_duration: Optional[int] = voice_duration self.caption: Optional[str] = caption self.parse_mode: ODVInput[str] = parse_mode - self.caption_entities: Tuple[MessageEntity, ...] = parse_sequence_arg(caption_entities) + self.caption_entities: tuple[MessageEntity, ...] = parse_sequence_arg(caption_entities) self.reply_markup: Optional[InlineKeyboardMarkup] = reply_markup self.input_message_content: Optional[InputMessageContent] = input_message_content diff --git a/telegram/_inline/inputinvoicemessagecontent.py b/telegram/_inline/inputinvoicemessagecontent.py index 101e0184b57..2ab896c8a5c 100644 --- a/telegram/_inline/inputinvoicemessagecontent.py +++ b/telegram/_inline/inputinvoicemessagecontent.py @@ -17,7 +17,8 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains a class that represents a Telegram InputInvoiceMessageContent.""" -from typing import TYPE_CHECKING, Optional, Sequence, Tuple +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional from telegram._inline.inputmessagecontent import InputMessageContent from telegram._payment.labeledprice import LabeledPrice @@ -122,7 +123,7 @@ class InputInvoiceMessageContent(InputMessageContent): currency (:obj:`str`): Three-letter ISO 4217 currency code, see more on `currencies `_. Pass ``XTR`` for payments in |tg_stars|. - prices (Tuple[:class:`telegram.LabeledPrice`]): Price breakdown, a list of + prices (tuple[:class:`telegram.LabeledPrice`]): Price breakdown, a list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in |tg_stars|. @@ -135,7 +136,7 @@ class InputInvoiceMessageContent(InputMessageContent): `currencies.json `_, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to ``0``. Not supported for payments in |tg_stars|. - suggested_tip_amounts (Tuple[:obj:`int`]): Optional. An array of suggested + suggested_tip_amounts (tuple[:obj:`int`]): Optional. An array of suggested amounts of tip in the *smallest units* of the currency (integer, **not** float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed @@ -226,10 +227,10 @@ def __init__( self.payload: str = payload self.provider_token: Optional[str] = provider_token self.currency: str = currency - self.prices: Tuple[LabeledPrice, ...] = parse_sequence_arg(prices) + self.prices: tuple[LabeledPrice, ...] = parse_sequence_arg(prices) # Optionals self.max_tip_amount: Optional[int] = max_tip_amount - self.suggested_tip_amounts: Tuple[int, ...] = parse_sequence_arg(suggested_tip_amounts) + self.suggested_tip_amounts: tuple[int, ...] = parse_sequence_arg(suggested_tip_amounts) self.provider_data: Optional[str] = provider_data self.photo_url: Optional[str] = photo_url self.photo_size: Optional[int] = photo_size diff --git a/telegram/_inline/inputtextmessagecontent.py b/telegram/_inline/inputtextmessagecontent.py index 475f9c5bb28..09d5e597b13 100644 --- a/telegram/_inline/inputtextmessagecontent.py +++ b/telegram/_inline/inputtextmessagecontent.py @@ -17,7 +17,8 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains the classes that represent Telegram InputTextMessageContent.""" -from typing import TYPE_CHECKING, Optional, Sequence, Tuple +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional from telegram._inline.inputmessagecontent import InputMessageContent from telegram._messageentity import MessageEntity @@ -75,7 +76,7 @@ class InputTextMessageContent(InputMessageContent): :tg-const:`telegram.constants.MessageLimit.MAX_TEXT_LENGTH` characters after entities parsing. parse_mode (:obj:`str`): Optional. |parse_mode| - entities (Tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| + entities (tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| .. versionchanged:: 20.0 @@ -107,7 +108,7 @@ def __init__( self.message_text: str = message_text # Optionals self.parse_mode: ODVInput[str] = parse_mode - self.entities: Tuple[MessageEntity, ...] = parse_sequence_arg(entities) + self.entities: tuple[MessageEntity, ...] = parse_sequence_arg(entities) self.link_preview_options: ODVInput[LinkPreviewOptions] = parse_lpo_and_dwpp( disable_web_page_preview, link_preview_options ) diff --git a/telegram/_menubutton.py b/telegram/_menubutton.py index 50b6511b08d..3df50fd3f8b 100644 --- a/telegram/_menubutton.py +++ b/telegram/_menubutton.py @@ -17,7 +17,7 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains objects related to Telegram menu buttons.""" -from typing import TYPE_CHECKING, Dict, Final, Optional, Type +from typing import TYPE_CHECKING, Final, Optional from telegram import constants from telegram._telegramobject import TelegramObject @@ -76,7 +76,7 @@ def de_json( care of selecting the correct subclass. Args: - data (Dict[:obj:`str`, ...]): The JSON data. + data (dict[:obj:`str`, ...]): The JSON data. bot (:class:`telegram.Bot`, optional): The bot associated with this object. Defaults to :obj:`None`, in which case shortcut methods will not be available. @@ -95,7 +95,7 @@ def de_json( if not data and cls is MenuButton: return None - _class_mapping: Dict[str, Type[MenuButton]] = { + _class_mapping: dict[str, type[MenuButton]] = { cls.COMMANDS: MenuButtonCommands, cls.WEB_APP: MenuButtonWebApp, cls.DEFAULT: MenuButtonDefault, diff --git a/telegram/_message.py b/telegram/_message.py index 11bee572493..44490482b29 100644 --- a/telegram/_message.py +++ b/telegram/_message.py @@ -21,8 +21,9 @@ import datetime import re +from collections.abc import Sequence from html import escape -from typing import TYPE_CHECKING, Dict, List, Optional, Sequence, Tuple, TypedDict, Union +from typing import TYPE_CHECKING, Optional, TypedDict, Union from telegram._chat import Chat from telegram._chatbackground import ChatBackground @@ -629,7 +630,7 @@ class Message(MaybeInaccessibleMessage): message belongs to. text (:obj:`str`): Optional. For text messages, the actual UTF-8 text of the message, 0-:tg-const:`telegram.constants.MessageLimit.MAX_TEXT_LENGTH` characters. - entities (Tuple[:class:`telegram.MessageEntity`]): Optional. For text messages, special + entities (tuple[:class:`telegram.MessageEntity`]): Optional. For text messages, special entities like usernames, URLs, bot commands, etc. that appear in the text. See :attr:`parse_entity` and :attr:`parse_entities` methods for how to use properly. This list is empty if the message does not contain entities. @@ -648,7 +649,7 @@ class Message(MaybeInaccessibleMessage): ..versionadded:: 21.3 - caption_entities (Tuple[:class:`telegram.MessageEntity`]): Optional. For messages with a + caption_entities (tuple[:class:`telegram.MessageEntity`]): Optional. For messages with a Caption. Special entities like usernames, URLs, bot commands, etc. that appear in the caption. See :attr:`Message.parse_caption_entity` and :attr:`parse_caption_entities` methods for how to use properly. This list is empty if the message does not contain @@ -675,7 +676,7 @@ class Message(MaybeInaccessibleMessage): .. seealso:: :wiki:`Working with Files and Media ` game (:class:`telegram.Game`): Optional. Message is a game, information about the game. :ref:`More about games >> `. - photo (Tuple[:class:`telegram.PhotoSize`]): Optional. Message is a photo, available + photo (tuple[:class:`telegram.PhotoSize`]): Optional. Message is a photo, available sizes of the photo. This list is empty if the message does not contain a photo. .. seealso:: :wiki:`Working with Files and Media ` @@ -703,7 +704,7 @@ class Message(MaybeInaccessibleMessage): about the video message. .. seealso:: :wiki:`Working with Files and Media ` - new_chat_members (Tuple[:class:`telegram.User`]): Optional. New members that were added + new_chat_members (tuple[:class:`telegram.User`]): Optional. New members that were added to the group or supergroup and information about them (the bot itself may be one of these members). This list is empty if the message does not contain new chat members. @@ -722,7 +723,7 @@ class Message(MaybeInaccessibleMessage): left_chat_member (:class:`telegram.User`): Optional. A member was removed from the group, information about them (this member may be the bot itself). new_chat_title (:obj:`str`): Optional. A chat title was changed to this value. - new_chat_photo (Tuple[:class:`telegram.PhotoSize`]): A chat photo was changed to + new_chat_photo (tuple[:class:`telegram.PhotoSize`]): A chat photo was changed to this value. This list is empty if the message does not contain a new chat photo. .. versionchanged:: 20.0 @@ -1118,12 +1119,12 @@ def __init__( self.edit_date: Optional[datetime.datetime] = edit_date self.has_protected_content: Optional[bool] = has_protected_content self.text: Optional[str] = text - self.entities: Tuple[MessageEntity, ...] = parse_sequence_arg(entities) - self.caption_entities: Tuple[MessageEntity, ...] = parse_sequence_arg(caption_entities) + self.entities: tuple[MessageEntity, ...] = parse_sequence_arg(entities) + self.caption_entities: tuple[MessageEntity, ...] = parse_sequence_arg(caption_entities) self.audio: Optional[Audio] = audio self.game: Optional[Game] = game self.document: Optional[Document] = document - self.photo: Tuple[PhotoSize, ...] = parse_sequence_arg(photo) + self.photo: tuple[PhotoSize, ...] = parse_sequence_arg(photo) self.sticker: Optional[Sticker] = sticker self.video: Optional[Video] = video self.voice: Optional[Voice] = voice @@ -1132,10 +1133,10 @@ def __init__( self.contact: Optional[Contact] = contact self.location: Optional[Location] = location self.venue: Optional[Venue] = venue - self.new_chat_members: Tuple[User, ...] = parse_sequence_arg(new_chat_members) + self.new_chat_members: tuple[User, ...] = parse_sequence_arg(new_chat_members) self.left_chat_member: Optional[User] = left_chat_member self.new_chat_title: Optional[str] = new_chat_title - self.new_chat_photo: Tuple[PhotoSize, ...] = parse_sequence_arg(new_chat_photo) + self.new_chat_photo: tuple[PhotoSize, ...] = parse_sequence_arg(new_chat_photo) self.delete_chat_photo: Optional[bool] = bool(delete_chat_photo) self.group_chat_created: Optional[bool] = bool(group_chat_created) self.supergroup_chat_created: Optional[bool] = bool(supergroup_chat_created) @@ -1406,7 +1407,7 @@ def effective_attachment( * :class:`telegram.Invoice` * :class:`telegram.Location` * :class:`telegram.PassportData` - * List[:class:`telegram.PhotoSize`] + * list[:class:`telegram.PhotoSize`] * :class:`telegram.PaidMediaInfo` * :class:`telegram.Poll` * :class:`telegram.Sticker` @@ -1478,7 +1479,7 @@ def _quote( def compute_quote_position_and_entities( self, quote: str, index: Optional[int] = None - ) -> Tuple[int, Optional[Tuple[MessageEntity, ...]]]: + ) -> tuple[int, Optional[tuple[MessageEntity, ...]]]: """ Use this function to compute position and entities of a quote in the message text or caption. Useful for filling the parameters @@ -1504,7 +1505,7 @@ def compute_quote_position_and_entities( message. If not specified, the first occurrence is used. Returns: - Tuple[:obj:`int`, :obj:`None` | Tuple[:class:`~telegram.MessageEntity`, ...]]: On + tuple[:obj:`int`, :obj:`None` | tuple[:class:`~telegram.MessageEntity`, ...]]: On success, a tuple containing information about quote position and entities is returned. Raises: @@ -1647,7 +1648,7 @@ async def _parse_quote_arguments( quote: Optional[bool], reply_to_message_id: Optional[int], reply_parameters: Optional["ReplyParameters"], - ) -> Tuple[Union[str, int], ReplyParameters]: + ) -> tuple[Union[str, int], ReplyParameters]: if quote and do_quote: raise ValueError("The arguments `quote` and `do_quote` are mutually exclusive") @@ -2048,7 +2049,7 @@ async def reply_media_group( caption: Optional[str] = None, parse_mode: ODVInput[str] = DEFAULT_NONE, caption_entities: Optional[Sequence["MessageEntity"]] = None, - ) -> Tuple["Message", ...]: + ) -> tuple["Message", ...]: """Shortcut for:: await bot.send_media_group( @@ -2075,7 +2076,7 @@ async def reply_media_group( .. versionadded:: 20.8 Returns: - Tuple[:class:`telegram.Message`]: An array of the sent Messages. + tuple[:class:`telegram.Message`]: An array of the sent Messages. Raises: :class:`telegram.error.TelegramError` @@ -3989,7 +3990,7 @@ async def get_game_high_scores( connect_timeout: ODVInput[float] = DEFAULT_NONE, pool_timeout: ODVInput[float] = DEFAULT_NONE, api_kwargs: Optional[JSONDict] = None, - ) -> Tuple["GameHighScore", ...]: + ) -> tuple["GameHighScore", ...]: """Shortcut for:: await bot.get_game_high_scores( @@ -4005,7 +4006,7 @@ async def get_game_high_scores( behaviour is undocumented and might be changed by Telegram. Returns: - Tuple[:class:`telegram.GameHighScore`] + tuple[:class:`telegram.GameHighScore`] """ return await self.get_bot().get_game_high_scores( chat_id=self.chat_id, @@ -4431,7 +4432,7 @@ def parse_caption_entity(self, entity: MessageEntity) -> str: return parse_message_entity(self.caption, entity) - def parse_entities(self, types: Optional[List[str]] = None) -> Dict[MessageEntity, str]: + def parse_entities(self, types: Optional[list[str]] = None) -> dict[MessageEntity, str]: """ Returns a :obj:`dict` that maps :class:`telegram.MessageEntity` to :obj:`str`. It contains entities from this message filtered by their @@ -4444,21 +4445,21 @@ def parse_entities(self, types: Optional[List[str]] = None) -> Dict[MessageEntit See :attr:`parse_entity` for more info. Args: - types (List[:obj:`str`], optional): List of :class:`telegram.MessageEntity` types as + types (list[:obj:`str`], optional): List of :class:`telegram.MessageEntity` types as strings. If the ``type`` attribute of an entity is contained in this list, it will be returned. Defaults to a list of all types. All types can be found as constants in :class:`telegram.MessageEntity`. Returns: - Dict[:class:`telegram.MessageEntity`, :obj:`str`]: A dictionary of entities mapped to + dict[:class:`telegram.MessageEntity`, :obj:`str`]: A dictionary of entities mapped to the text that belongs to them, calculated based on UTF-16 codepoints. """ return parse_message_entities(self.text, self.entities, types=types) def parse_caption_entities( - self, types: Optional[List[str]] = None - ) -> Dict[MessageEntity, str]: + self, types: Optional[list[str]] = None + ) -> dict[MessageEntity, str]: """ Returns a :obj:`dict` that maps :class:`telegram.MessageEntity` to :obj:`str`. It contains entities from this message's caption filtered by their @@ -4471,13 +4472,13 @@ def parse_caption_entities( codepoints. See :attr:`parse_entity` for more info. Args: - types (List[:obj:`str`], optional): List of :class:`telegram.MessageEntity` types as + types (list[:obj:`str`], optional): List of :class:`telegram.MessageEntity` types as strings. If the ``type`` attribute of an entity is contained in this list, it will be returned. Defaults to a list of all types. All types can be found as constants in :class:`telegram.MessageEntity`. Returns: - Dict[:class:`telegram.MessageEntity`, :obj:`str`]: A dictionary of entities mapped to + dict[:class:`telegram.MessageEntity`, :obj:`str`]: A dictionary of entities mapped to the text that belongs to them, calculated based on UTF-16 codepoints. """ @@ -4487,7 +4488,7 @@ def parse_caption_entities( def _parse_html( cls, message_text: Optional[str], - entities: Dict[MessageEntity, str], + entities: dict[MessageEntity, str], urled: bool = False, offset: int = 0, ) -> Optional[str]: @@ -4676,7 +4677,7 @@ def caption_html_urled(self) -> str: def _parse_markdown( cls, message_text: Optional[str], - entities: Dict[MessageEntity, str], + entities: dict[MessageEntity, str], urled: bool = False, version: MarkdownVersion = 1, offset: int = 0, diff --git a/telegram/_messageentity.py b/telegram/_messageentity.py index ae675e8e9fd..4b076d5e540 100644 --- a/telegram/_messageentity.py +++ b/telegram/_messageentity.py @@ -20,7 +20,8 @@ import copy import itertools -from typing import TYPE_CHECKING, Dict, Final, List, Optional, Sequence, Tuple, Union +from collections.abc import Sequence +from typing import TYPE_CHECKING, Final, Optional, Union from telegram import constants from telegram._telegramobject import TelegramObject @@ -200,7 +201,7 @@ def adjust_message_entities_to_utf_16(text: str, entities: _SEM) -> _SEM: accumulated_length = 0 # calculate the length of each slice text[:position] in utf-16 accordingly, # store the position translations - position_translation: Dict[int, int] = {} + position_translation: dict[int, int] = {} for i, position in enumerate(positions): last_position = positions[i - 1] if i > 0 else 0 text_slice = text[last_position:position] @@ -286,8 +287,8 @@ def shift_entities(by: Union[str, int], entities: _SEM) -> _SEM: @classmethod def concatenate( cls, - *args: Union[Tuple[str, _SEM], Tuple[str, _SEM, bool]], - ) -> Tuple[str, _SEM]: + *args: Union[tuple[str, _SEM], tuple[str, _SEM, bool]], + ) -> tuple[str, _SEM]: """Utility functionality for concatenating two text along with their formatting entities. Tip: @@ -332,8 +333,8 @@ async def prefix_message(update: Update, context: ContextTypes.DEFAULT_TYPE): .. versionadded:: 21.5 Args: - *args (Tuple[:obj:`str`, Sequence[:class:`telegram.MessageEntity`]] | \ - Tuple[:obj:`str`, Sequence[:class:`telegram.MessageEntity`], :obj:`bool`]): + *args (tuple[:obj:`str`, Sequence[:class:`telegram.MessageEntity`]] | \ + tuple[:obj:`str`, Sequence[:class:`telegram.MessageEntity`], :obj:`bool`]): Arbitrary number of tuples containing the text and its entities to concatenate. If the last element of the tuple is a :obj:`bool`, it is used to determine whether to adjust the entities to UTF-16 via @@ -341,11 +342,11 @@ async def prefix_message(update: Update, context: ContextTypes.DEFAULT_TYPE): default. Returns: - Tuple[:obj:`str`, Sequence[:class:`telegram.MessageEntity`]]: The concatenated text + tuple[:obj:`str`, Sequence[:class:`telegram.MessageEntity`]]: The concatenated text and its entities """ output_text = "" - output_entities: List[MessageEntity] = [] + output_entities: list[MessageEntity] = [] for arg in args: text, entities = arg[0], arg[1] @@ -357,8 +358,8 @@ async def prefix_message(update: Update, context: ContextTypes.DEFAULT_TYPE): return output_text, output_entities - ALL_TYPES: Final[List[str]] = list(constants.MessageEntityType) - """List[:obj:`str`]: A list of all available message entity types.""" + ALL_TYPES: Final[list[str]] = list(constants.MessageEntityType) + """list[:obj:`str`]: A list of all available message entity types.""" BLOCKQUOTE: Final[str] = constants.MessageEntityType.BLOCKQUOTE """:const:`telegram.constants.MessageEntityType.BLOCKQUOTE` diff --git a/telegram/_messageorigin.py b/telegram/_messageorigin.py index 534583adb8b..37d80be4194 100644 --- a/telegram/_messageorigin.py +++ b/telegram/_messageorigin.py @@ -18,7 +18,7 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains the classes that represent Telegram MessageOigin.""" import datetime -from typing import TYPE_CHECKING, Dict, Final, Optional, Type +from typing import TYPE_CHECKING, Final, Optional from telegram import constants from telegram._chat import Chat @@ -105,7 +105,7 @@ def de_json( if not data: return None - _class_mapping: Dict[str, Type[MessageOrigin]] = { + _class_mapping: dict[str, type[MessageOrigin]] = { cls.USER: MessageOriginUser, cls.HIDDEN_USER: MessageOriginHiddenUser, cls.CHAT: MessageOriginChat, diff --git a/telegram/_messagereactionupdated.py b/telegram/_messagereactionupdated.py index d4d4033a647..a1e28c2bc8d 100644 --- a/telegram/_messagereactionupdated.py +++ b/telegram/_messagereactionupdated.py @@ -17,8 +17,9 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains an object that represents a Telegram MessageReaction Update.""" +from collections.abc import Sequence from datetime import datetime -from typing import TYPE_CHECKING, Optional, Sequence, Tuple +from typing import TYPE_CHECKING, Optional from telegram._chat import Chat from telegram._reaction import ReactionCount, ReactionType @@ -54,7 +55,7 @@ class MessageReactionCountUpdated(TelegramObject): message_id (:obj:`int`): Unique message identifier inside the chat. date (:class:`datetime.datetime`): Date of the change in Unix time |datetime_localization| - reactions (Tuple[:class:`telegram.ReactionCount`]): List of reactions that are present on + reactions (tuple[:class:`telegram.ReactionCount`]): List of reactions that are present on the message """ @@ -79,7 +80,7 @@ def __init__( self.chat: Chat = chat self.message_id: int = message_id self.date: datetime = date - self.reactions: Tuple[ReactionCount, ...] = parse_sequence_arg(reactions) + self.reactions: tuple[ReactionCount, ...] = parse_sequence_arg(reactions) self._id_attrs = (self.chat, self.message_id, self.date, self.reactions) self._freeze() @@ -132,9 +133,9 @@ class MessageReactionUpdated(TelegramObject): message_id (:obj:`int`): Unique message identifier inside the chat. date (:class:`datetime.datetime`): Date of the change in Unix time. |datetime_localization| - old_reaction (Tuple[:class:`telegram.ReactionType`]): Previous list of reaction types + old_reaction (tuple[:class:`telegram.ReactionType`]): Previous list of reaction types that were set by the user. - new_reaction (Tuple[:class:`telegram.ReactionType`]): New list of reaction types that + new_reaction (tuple[:class:`telegram.ReactionType`]): New list of reaction types that were set by the user. user (:class:`telegram.User`): Optional. The user that changed the reaction, if the user isn't anonymous. @@ -169,8 +170,8 @@ def __init__( self.chat: Chat = chat self.message_id: int = message_id self.date: datetime = date - self.old_reaction: Tuple[ReactionType, ...] = parse_sequence_arg(old_reaction) - self.new_reaction: Tuple[ReactionType, ...] = parse_sequence_arg(new_reaction) + self.old_reaction: tuple[ReactionType, ...] = parse_sequence_arg(old_reaction) + self.new_reaction: tuple[ReactionType, ...] = parse_sequence_arg(new_reaction) # Optional self.user: Optional[User] = user diff --git a/telegram/_paidmedia.py b/telegram/_paidmedia.py index 1c2cc409191..c3ab1e22eaf 100644 --- a/telegram/_paidmedia.py +++ b/telegram/_paidmedia.py @@ -18,7 +18,8 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains objects that represent paid media in Telegram.""" -from typing import TYPE_CHECKING, Dict, Final, Optional, Sequence, Tuple, Type +from collections.abc import Sequence +from typing import TYPE_CHECKING, Final, Optional from telegram import constants from telegram._files.photosize import PhotoSize @@ -81,7 +82,7 @@ def de_json( care of selecting the correct subclass. Args: - data (Dict[:obj:`str`, ...]): The JSON data. + data (dict[:obj:`str`, ...]): The JSON data. bot (:class:`telegram.Bot`, optional): The bot associated with this object. Returns: @@ -96,7 +97,7 @@ def de_json( if not data and cls is PaidMedia: return None - _class_mapping: Dict[str, Type[PaidMedia]] = { + _class_mapping: dict[str, type[PaidMedia]] = { cls.PREVIEW: PaidMediaPreview, cls.PHOTO: PaidMediaPhoto, cls.VIDEO: PaidMediaVideo, @@ -165,7 +166,7 @@ class PaidMediaPhoto(PaidMedia): Attributes: type (:obj:`str`): Type of the paid media, always :tg-const:`telegram.PaidMedia.PHOTO`. - photo (Tuple[:class:`telegram.PhotoSize`]): The photo. + photo (tuple[:class:`telegram.PhotoSize`]): The photo. """ __slots__ = ("photo",) @@ -179,7 +180,7 @@ def __init__( super().__init__(type=PaidMedia.PHOTO, api_kwargs=api_kwargs) with self._unfrozen(): - self.photo: Tuple[PhotoSize, ...] = parse_sequence_arg(photo) + self.photo: tuple[PhotoSize, ...] = parse_sequence_arg(photo) self._id_attrs = (self.type, self.photo) @@ -259,7 +260,7 @@ class PaidMediaInfo(TelegramObject): Attributes: star_count (:obj:`int`): The number of Telegram Stars that must be paid to buy access to the media. - paid_media (Tuple[:class:`telegram.PaidMedia`]): Information about the paid media. + paid_media (tuple[:class:`telegram.PaidMedia`]): Information about the paid media. """ __slots__ = ("paid_media", "star_count") @@ -273,7 +274,7 @@ def __init__( ) -> None: super().__init__(api_kwargs=api_kwargs) self.star_count: int = star_count - self.paid_media: Tuple[PaidMedia, ...] = parse_sequence_arg(paid_media) + self.paid_media: tuple[PaidMedia, ...] = parse_sequence_arg(paid_media) self._id_attrs = (self.star_count, self.paid_media) self._freeze() diff --git a/telegram/_passport/credentials.py b/telegram/_passport/credentials.py index 7345991a5ac..17e44595abc 100644 --- a/telegram/_passport/credentials.py +++ b/telegram/_passport/credentials.py @@ -19,7 +19,8 @@ # pylint: disable=missing-module-docstring, redefined-builtin import json from base64 import b64decode -from typing import TYPE_CHECKING, Optional, Sequence, Tuple, no_type_check +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional, no_type_check try: from cryptography.hazmat.backends import default_backend @@ -390,11 +391,11 @@ class SecureValue(TelegramObject): selfie (:class:`telegram.FileCredentials`, optional): Credentials for encrypted selfie of the user with a document. Can be available for "passport", "driver_license", "identity_card" and "internal_passport". - translation (List[:class:`telegram.FileCredentials`], optional): Credentials for an + translation (list[:class:`telegram.FileCredentials`], optional): Credentials for an encrypted translation of the document. Available for "passport", "driver_license", "identity_card", "internal_passport", "utility_bill", "bank_statement", "rental_agreement", "passport_registration" and "temporary_registration". - files (List[:class:`telegram.FileCredentials`], optional): Credentials for encrypted + files (list[:class:`telegram.FileCredentials`], optional): Credentials for encrypted files. Available for "utility_bill", "bank_statement", "rental_agreement", "passport_registration" and "temporary_registration" types. @@ -410,7 +411,7 @@ class SecureValue(TelegramObject): selfie (:class:`telegram.FileCredentials`): Optional. Credentials for encrypted selfie of the user with a document. Can be available for "passport", "driver_license", "identity_card" and "internal_passport". - translation (Tuple[:class:`telegram.FileCredentials`]): Optional. Credentials for an + translation (tuple[:class:`telegram.FileCredentials`]): Optional. Credentials for an encrypted translation of the document. Available for "passport", "driver_license", "identity_card", "internal_passport", "utility_bill", "bank_statement", "rental_agreement", "passport_registration" and "temporary_registration". @@ -418,7 +419,7 @@ class SecureValue(TelegramObject): .. versionchanged:: 20.0 |tupleclassattrs| - files (Tuple[:class:`telegram.FileCredentials`]): Optional. Credentials for encrypted + files (tuple[:class:`telegram.FileCredentials`]): Optional. Credentials for encrypted files. Available for "utility_bill", "bank_statement", "rental_agreement", "passport_registration" and "temporary_registration" types. @@ -447,8 +448,8 @@ def __init__( self.front_side: Optional[FileCredentials] = front_side self.reverse_side: Optional[FileCredentials] = reverse_side self.selfie: Optional[FileCredentials] = selfie - self.files: Tuple[FileCredentials, ...] = parse_sequence_arg(files) - self.translation: Tuple[FileCredentials, ...] = parse_sequence_arg(translation) + self.files: tuple[FileCredentials, ...] = parse_sequence_arg(files) + self.translation: tuple[FileCredentials, ...] = parse_sequence_arg(translation) self._freeze() diff --git a/telegram/_passport/encryptedpassportelement.py b/telegram/_passport/encryptedpassportelement.py index 9f16d81e0f2..5bb764c9fc1 100644 --- a/telegram/_passport/encryptedpassportelement.py +++ b/telegram/_passport/encryptedpassportelement.py @@ -18,7 +18,8 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains an object that represents a Telegram EncryptedPassportElement.""" from base64 import b64decode -from typing import TYPE_CHECKING, Optional, Sequence, Tuple, Union +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional, Union from telegram._passport.credentials import decrypt_json from telegram._passport.data import IdDocumentData, PersonalDetails, ResidentialAddress @@ -100,7 +101,7 @@ class EncryptedPassportElement(TelegramObject): "phone_number" type. email (:obj:`str`): Optional. User's verified email address; available only for "email" type. - files (Tuple[:class:`telegram.PassportFile`]): Optional. Array of encrypted/decrypted + files (tuple[:class:`telegram.PassportFile`]): Optional. Array of encrypted/decrypted files with documents provided by the user; available only for "utility_bill", "bank_statement", "rental_agreement", "passport_registration" and "temporary_registration" types. @@ -119,7 +120,7 @@ class EncryptedPassportElement(TelegramObject): selfie (:class:`telegram.PassportFile`): Optional. Encrypted/decrypted file with the selfie of the user holding a document, provided by the user; available if requested for "passport", "driver_license", "identity_card" and "internal_passport". - translation (Tuple[:class:`telegram.PassportFile`]): Optional. Array of + translation (tuple[:class:`telegram.PassportFile`]): Optional. Array of encrypted/decrypted files with translated versions of documents provided by the user; available if requested for "passport", "driver_license", "identity_card", "internal_passport", "utility_bill", "bank_statement", "rental_agreement", @@ -172,11 +173,11 @@ def __init__( self.data: Optional[Union[PersonalDetails, IdDocumentData, ResidentialAddress]] = data self.phone_number: Optional[str] = phone_number self.email: Optional[str] = email - self.files: Tuple[PassportFile, ...] = parse_sequence_arg(files) + self.files: tuple[PassportFile, ...] = parse_sequence_arg(files) self.front_side: Optional[PassportFile] = front_side self.reverse_side: Optional[PassportFile] = reverse_side self.selfie: Optional[PassportFile] = selfie - self.translation: Tuple[PassportFile, ...] = parse_sequence_arg(translation) + self.translation: tuple[PassportFile, ...] = parse_sequence_arg(translation) self.hash: str = hash self._id_attrs = ( @@ -218,7 +219,7 @@ def de_json_decrypted( passport credentials. Args: - data (Dict[:obj:`str`, ...]): The JSON data. + data (dict[:obj:`str`, ...]): The JSON data. bot (:class:`telegram.Bot` | :obj:`None`): The bot associated with these object. May be :obj:`None`, in which case shortcut methods will not be available. diff --git a/telegram/_passport/passportdata.py b/telegram/_passport/passportdata.py index 32e3879bc4d..8b4db028a05 100644 --- a/telegram/_passport/passportdata.py +++ b/telegram/_passport/passportdata.py @@ -17,7 +17,8 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. """Contains information about Telegram Passport data shared with the bot by the user.""" -from typing import TYPE_CHECKING, Optional, Sequence, Tuple +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional from telegram._passport.credentials import EncryptedCredentials from telegram._passport.encryptedpassportelement import EncryptedPassportElement @@ -49,7 +50,7 @@ class PassportData(TelegramObject): credentials (:class:`telegram.EncryptedCredentials`)): Encrypted credentials. Attributes: - data (Tuple[:class:`telegram.EncryptedPassportElement`]): Array with encrypted + data (tuple[:class:`telegram.EncryptedPassportElement`]): Array with encrypted information about documents and other Telegram Passport elements that was shared with the bot. @@ -72,10 +73,10 @@ def __init__( ): super().__init__(api_kwargs=api_kwargs) - self.data: Tuple[EncryptedPassportElement, ...] = parse_sequence_arg(data) + self.data: tuple[EncryptedPassportElement, ...] = parse_sequence_arg(data) self.credentials: EncryptedCredentials = credentials - self._decrypted_data: Optional[Tuple[EncryptedPassportElement]] = None + self._decrypted_data: Optional[tuple[EncryptedPassportElement]] = None self._id_attrs = tuple([x.type for x in data] + [credentials.hash]) self._freeze() @@ -96,9 +97,9 @@ def de_json( return super().de_json(data=data, bot=bot) @property - def decrypted_data(self) -> Tuple[EncryptedPassportElement, ...]: + def decrypted_data(self) -> tuple[EncryptedPassportElement, ...]: """ - Tuple[:class:`telegram.EncryptedPassportElement`]: Lazily decrypt and return information + tuple[:class:`telegram.EncryptedPassportElement`]: Lazily decrypt and return information about documents and other Telegram Passport elements which were shared with the bot. .. versionchanged:: 20.0 diff --git a/telegram/_passport/passportelementerrors.py b/telegram/_passport/passportelementerrors.py index 8d6911439c7..097d6085688 100644 --- a/telegram/_passport/passportelementerrors.py +++ b/telegram/_passport/passportelementerrors.py @@ -19,7 +19,7 @@ # pylint: disable=redefined-builtin """This module contains the classes that represent Telegram PassportElementError.""" -from typing import List, Optional +from typing import Optional from telegram._telegramobject import TelegramObject from telegram._utils.types import JSONDict @@ -168,7 +168,7 @@ class PassportElementErrorFiles(PassportElementError): type (:obj:`str`): The section of the user's Telegram Passport which has the issue, one of ``"utility_bill"``, ``"bank_statement"``, ``"rental_agreement"``, ``"passport_registration"``, ``"temporary_registration"``. - file_hashes (List[:obj:`str`]): List of base64-encoded file hashes. + file_hashes (list[:obj:`str`]): List of base64-encoded file hashes. message (:obj:`str`): Error message. Attributes: @@ -184,7 +184,7 @@ class PassportElementErrorFiles(PassportElementError): def __init__( self, type: str, - file_hashes: List[str], + file_hashes: list[str], message: str, *, api_kwargs: Optional[JSONDict] = None, @@ -192,7 +192,7 @@ def __init__( # Required super().__init__("files", type, message, api_kwargs=api_kwargs) with self._unfrozen(): - self._file_hashes: List[str] = file_hashes + self._file_hashes: list[str] = file_hashes self._id_attrs = (self.source, self.type, self.message, *tuple(file_hashes)) @@ -203,7 +203,7 @@ def to_dict(self, recursive: bool = True) -> JSONDict: return data @property - def file_hashes(self) -> List[str]: + def file_hashes(self) -> list[str]: """List of base64-encoded file hashes. .. deprecated:: 20.6 @@ -386,7 +386,7 @@ class PassportElementErrorTranslationFiles(PassportElementError): one of ``"passport"``, ``"driver_license"``, ``"identity_card"``, ``"internal_passport"``, ``"utility_bill"``, ``"bank_statement"``, ``"rental_agreement"``, ``"passport_registration"``, ``"temporary_registration"``. - file_hashes (List[:obj:`str`]): List of base64-encoded file hashes. + file_hashes (list[:obj:`str`]): List of base64-encoded file hashes. message (:obj:`str`): Error message. Attributes: @@ -403,7 +403,7 @@ class PassportElementErrorTranslationFiles(PassportElementError): def __init__( self, type: str, - file_hashes: List[str], + file_hashes: list[str], message: str, *, api_kwargs: Optional[JSONDict] = None, @@ -411,7 +411,7 @@ def __init__( # Required super().__init__("translation_files", type, message, api_kwargs=api_kwargs) with self._unfrozen(): - self._file_hashes: List[str] = file_hashes + self._file_hashes: list[str] = file_hashes self._id_attrs = (self.source, self.type, self.message, *tuple(file_hashes)) @@ -422,7 +422,7 @@ def to_dict(self, recursive: bool = True) -> JSONDict: return data @property - def file_hashes(self) -> List[str]: + def file_hashes(self) -> list[str]: """List of base64-encoded file hashes. .. deprecated:: 20.6 diff --git a/telegram/_passport/passportfile.py b/telegram/_passport/passportfile.py index 84a1ce201ed..e023457f670 100644 --- a/telegram/_passport/passportfile.py +++ b/telegram/_passport/passportfile.py @@ -18,7 +18,7 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains an object that represents a Encrypted PassportFile.""" -from typing import TYPE_CHECKING, List, Optional, Tuple +from typing import TYPE_CHECKING, Optional from telegram._telegramobject import TelegramObject from telegram._utils.defaultvalue import DEFAULT_NONE @@ -124,7 +124,7 @@ def de_json_decrypted( passport credentials. Args: - data (Dict[:obj:`str`, ...]): The JSON data. + data (dict[:obj:`str`, ...]): The JSON data. bot (:class:`telegram.Bot` | :obj:`None`): The bot associated with these object. May be :obj:`None`, in which case shortcut methods will not be available. @@ -151,10 +151,10 @@ def de_json_decrypted( @classmethod def de_list_decrypted( cls, - data: Optional[List[JSONDict]], + data: Optional[list[JSONDict]], bot: Optional["Bot"], - credentials: List["FileCredentials"], - ) -> Tuple[Optional["PassportFile"], ...]: + credentials: list["FileCredentials"], + ) -> tuple[Optional["PassportFile"], ...]: """Variant of :meth:`telegram.TelegramObject.de_list` that also takes into account passport credentials. @@ -164,7 +164,7 @@ def de_list_decrypted( * Filters out any :obj:`None` values Args: - data (List[Dict[:obj:`str`, ...]]): The JSON data. + data (list[dict[:obj:`str`, ...]]): The JSON data. bot (:class:`telegram.Bot` | :obj:`None`): The bot associated with these object. May be :obj:`None`, in which case shortcut methods will not be available. @@ -176,7 +176,7 @@ def de_list_decrypted( credentials (:class:`telegram.FileCredentials`): The credentials Returns: - Tuple[:class:`telegram.PassportFile`]: + tuple[:class:`telegram.PassportFile`]: """ if not data: diff --git a/telegram/_payment/shippingoption.py b/telegram/_payment/shippingoption.py index 15047a00b1f..b41af98793d 100644 --- a/telegram/_payment/shippingoption.py +++ b/telegram/_payment/shippingoption.py @@ -17,7 +17,8 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains an object that represents a Telegram ShippingOption.""" -from typing import TYPE_CHECKING, Optional, Sequence, Tuple +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional from telegram._telegramobject import TelegramObject from telegram._utils.argumentparsing import parse_sequence_arg @@ -47,7 +48,7 @@ class ShippingOption(TelegramObject): Attributes: id (:obj:`str`): Shipping option identifier. title (:obj:`str`): Option title. - prices (Tuple[:class:`telegram.LabeledPrice`]): List of price portions. + prices (tuple[:class:`telegram.LabeledPrice`]): List of price portions. .. versionchanged:: 20.0 |tupleclassattrs| @@ -68,7 +69,7 @@ def __init__( self.id: str = id self.title: str = title - self.prices: Tuple[LabeledPrice, ...] = parse_sequence_arg(prices) + self.prices: tuple[LabeledPrice, ...] = parse_sequence_arg(prices) self._id_attrs = (self.id,) diff --git a/telegram/_payment/shippingquery.py b/telegram/_payment/shippingquery.py index cf81b4ecfa6..24b4e0a662f 100644 --- a/telegram/_payment/shippingquery.py +++ b/telegram/_payment/shippingquery.py @@ -18,7 +18,8 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains an object that represents a Telegram ShippingQuery.""" -from typing import TYPE_CHECKING, Optional, Sequence +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional from telegram._payment.shippingaddress import ShippingAddress from telegram._telegramobject import TelegramObject diff --git a/telegram/_payment/stars.py b/telegram/_payment/stars.py index dfeb832e223..32678915a45 100644 --- a/telegram/_payment/stars.py +++ b/telegram/_payment/stars.py @@ -19,8 +19,9 @@ # pylint: disable=redefined-builtin """This module contains the classes for Telegram Stars transactions.""" +from collections.abc import Sequence from datetime import datetime -from typing import TYPE_CHECKING, Dict, Final, Optional, Sequence, Tuple, Type +from typing import TYPE_CHECKING, Final, Optional from telegram import constants from telegram._paidmedia import PaidMedia @@ -79,7 +80,7 @@ def de_json( care of selecting the correct subclass. Args: - data (Dict[:obj:`str`, ...]): The JSON data. + data (dict[:obj:`str`, ...]): The JSON data. bot (:class:`telegram.Bot`): The bot associated with this object. Returns: @@ -91,7 +92,7 @@ def de_json( if not data: return None - _class_mapping: Dict[str, Type[RevenueWithdrawalState]] = { + _class_mapping: dict[str, type[RevenueWithdrawalState]] = { cls.PENDING: RevenueWithdrawalStatePending, cls.SUCCEEDED: RevenueWithdrawalStateSucceeded, cls.FAILED: RevenueWithdrawalStateFailed, @@ -239,7 +240,7 @@ def de_json( care of selecting the correct subclass. Args: - data (Dict[:obj:`str`, ...]): The JSON data. + data (dict[:obj:`str`, ...]): The JSON data. bot (:class:`telegram.Bot`): The bot associated with this object. Returns: @@ -254,7 +255,7 @@ def de_json( if not data and cls is TransactionPartner: return None - _class_mapping: Dict[str, Type[TransactionPartner]] = { + _class_mapping: dict[str, type[TransactionPartner]] = { cls.FRAGMENT: TransactionPartnerFragment, cls.USER: TransactionPartnerUser, cls.OTHER: TransactionPartnerOther, @@ -337,7 +338,7 @@ class TransactionPartnerUser(TransactionPartner): always :tg-const:`telegram.TransactionPartner.USER`. user (:class:`telegram.User`): Information about the user. invoice_payload (:obj:`str`): Optional. Bot-specified invoice payload. - paid_media (Tuple[:class:`telegram.PaidMedia`]): Optional. Information about the paid + paid_media (tuple[:class:`telegram.PaidMedia`]): Optional. Information about the paid media bought by the user. .. versionadded:: 21.5 @@ -363,7 +364,7 @@ def __init__( with self._unfrozen(): self.user: User = user self.invoice_payload: Optional[str] = invoice_payload - self.paid_media: Optional[Tuple[PaidMedia, ...]] = parse_sequence_arg(paid_media) + self.paid_media: Optional[tuple[PaidMedia, ...]] = parse_sequence_arg(paid_media) self.paid_media_payload: Optional[str] = paid_media_payload self._id_attrs = ( self.type, @@ -516,7 +517,7 @@ class StarTransactions(TelegramObject): transactions (Sequence[:class:`telegram.StarTransaction`]): The list of transactions. Attributes: - transactions (Tuple[:class:`telegram.StarTransaction`]): The list of transactions. + transactions (tuple[:class:`telegram.StarTransaction`]): The list of transactions. """ __slots__ = ("transactions",) @@ -525,7 +526,7 @@ def __init__( self, transactions: Sequence[StarTransaction], *, api_kwargs: Optional[JSONDict] = None ): super().__init__(api_kwargs=api_kwargs) - self.transactions: Tuple[StarTransaction, ...] = parse_sequence_arg(transactions) + self.transactions: tuple[StarTransaction, ...] = parse_sequence_arg(transactions) self._id_attrs = (self.transactions,) self._freeze() diff --git a/telegram/_poll.py b/telegram/_poll.py index 8ea387a0950..59b4032fb91 100644 --- a/telegram/_poll.py +++ b/telegram/_poll.py @@ -18,7 +18,8 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains an object that represents a Telegram Poll.""" import datetime -from typing import TYPE_CHECKING, Dict, Final, List, Optional, Sequence, Tuple +from collections.abc import Sequence +from typing import TYPE_CHECKING, Final, Optional from telegram import constants from telegram._chat import Chat @@ -83,7 +84,7 @@ def __init__( super().__init__(api_kwargs=api_kwargs) self.text: str = text self.text_parse_mode: ODVInput[str] = text_parse_mode - self.text_entities: Tuple[MessageEntity, ...] = parse_sequence_arg(text_entities) + self.text_entities: tuple[MessageEntity, ...] = parse_sequence_arg(text_entities) self._id_attrs = (self.text,) @@ -127,7 +128,7 @@ class PollOption(TelegramObject): :tg-const:`telegram.PollOption.MIN_LENGTH`-:tg-const:`telegram.PollOption.MAX_LENGTH` characters. voter_count (:obj:`int`): Number of users that voted for this option. - text_entities (Tuple[:class:`telegram.MessageEntity`]): Special entities + text_entities (tuple[:class:`telegram.MessageEntity`]): Special entities that appear in the option text. Currently, only custom emoji entities are allowed in poll option texts. This list is empty if the question does not contain entities. @@ -149,7 +150,7 @@ def __init__( super().__init__(api_kwargs=api_kwargs) self.text: str = text self.voter_count: int = voter_count - self.text_entities: Tuple[MessageEntity, ...] = parse_sequence_arg(text_entities) + self.text_entities: tuple[MessageEntity, ...] = parse_sequence_arg(text_entities) self._id_attrs = (self.text, self.voter_count) @@ -189,7 +190,7 @@ def parse_entity(self, entity: MessageEntity) -> str: """ return parse_message_entity(self.text, entity) - def parse_entities(self, types: Optional[List[str]] = None) -> Dict[MessageEntity, str]: + def parse_entities(self, types: Optional[list[str]] = None) -> dict[MessageEntity, str]: """ Returns a :obj:`dict` that maps :class:`telegram.MessageEntity` to :obj:`str`. It contains entities from this polls question filtered by their ``type`` attribute as @@ -203,12 +204,12 @@ def parse_entities(self, types: Optional[List[str]] = None) -> Dict[MessageEntit .. versionadded:: 21.2 Args: - types (List[:obj:`str`], optional): List of ``MessageEntity`` types as strings. If the + types (list[:obj:`str`], optional): List of ``MessageEntity`` types as strings. If the ``type`` attribute of an entity is contained in this list, it will be returned. Defaults to :attr:`telegram.MessageEntity.ALL_TYPES`. Returns: - Dict[:class:`telegram.MessageEntity`, :obj:`str`]: A dictionary of entities mapped to + dict[:class:`telegram.MessageEntity`, :obj:`str`]: A dictionary of entities mapped to the text that belongs to them, calculated based on UTF-16 codepoints. """ return parse_message_entities(self.text, self.text_entities, types) @@ -260,7 +261,7 @@ class PollAnswer(TelegramObject): Attributes: poll_id (:obj:`str`): Unique poll identifier. - option_ids (Tuple[:obj:`int`]): Identifiers of answer options, chosen by the user. May + option_ids (tuple[:obj:`int`]): Identifiers of answer options, chosen by the user. May be empty if the user retracted their vote. .. versionchanged:: 20.0 @@ -292,7 +293,7 @@ def __init__( super().__init__(api_kwargs=api_kwargs) self.poll_id: str = poll_id self.voter_chat: Optional[Chat] = voter_chat - self.option_ids: Tuple[int, ...] = parse_sequence_arg(option_ids) + self.option_ids: tuple[int, ...] = parse_sequence_arg(option_ids) self.user: Optional[User] = user self._id_attrs = ( @@ -374,7 +375,7 @@ class Poll(TelegramObject): id (:obj:`str`): Unique poll identifier. question (:obj:`str`): Poll question, :tg-const:`telegram.Poll.MIN_QUESTION_LENGTH`- :tg-const:`telegram.Poll.MAX_QUESTION_LENGTH` characters. - options (Tuple[:class:`~telegram.PollOption`]): List of poll options. + options (tuple[:class:`~telegram.PollOption`]): List of poll options. .. versionchanged:: 20.0 |tupleclassattrs| @@ -389,7 +390,7 @@ class Poll(TelegramObject): explanation (:obj:`str`): Optional. Text that is shown when a user chooses an incorrect answer or taps on the lamp icon in a quiz-style poll, 0-:tg-const:`telegram.Poll.MAX_EXPLANATION_LENGTH` characters. - explanation_entities (Tuple[:class:`telegram.MessageEntity`]): Special entities + explanation_entities (tuple[:class:`telegram.MessageEntity`]): Special entities like usernames, URLs, bot commands, etc. that appear in the :attr:`explanation`. This list is empty if the message does not contain explanation entities. @@ -405,7 +406,7 @@ class Poll(TelegramObject): .. versionchanged:: 20.3 |datetime_localization| - question_entities (Tuple[:class:`telegram.MessageEntity`]): Special entities + question_entities (tuple[:class:`telegram.MessageEntity`]): Special entities that appear in the :attr:`question`. Currently, only custom emoji entities are allowed in poll questions. This list is empty if the question does not contain entities. @@ -453,7 +454,7 @@ def __init__( super().__init__(api_kwargs=api_kwargs) self.id: str = id self.question: str = question - self.options: Tuple[PollOption, ...] = parse_sequence_arg(options) + self.options: tuple[PollOption, ...] = parse_sequence_arg(options) self.total_voter_count: int = total_voter_count self.is_closed: bool = is_closed self.is_anonymous: bool = is_anonymous @@ -461,12 +462,12 @@ def __init__( self.allows_multiple_answers: bool = allows_multiple_answers self.correct_option_id: Optional[int] = correct_option_id self.explanation: Optional[str] = explanation - self.explanation_entities: Tuple[MessageEntity, ...] = parse_sequence_arg( + self.explanation_entities: tuple[MessageEntity, ...] = parse_sequence_arg( explanation_entities ) self.open_period: Optional[int] = open_period self.close_date: Optional[datetime.datetime] = close_date - self.question_entities: Tuple[MessageEntity, ...] = parse_sequence_arg(question_entities) + self.question_entities: tuple[MessageEntity, ...] = parse_sequence_arg(question_entities) self._id_attrs = (self.id,) @@ -516,8 +517,8 @@ def parse_explanation_entity(self, entity: MessageEntity) -> str: return parse_message_entity(self.explanation, entity) def parse_explanation_entities( - self, types: Optional[List[str]] = None - ) -> Dict[MessageEntity, str]: + self, types: Optional[list[str]] = None + ) -> dict[MessageEntity, str]: """ Returns a :obj:`dict` that maps :class:`telegram.MessageEntity` to :obj:`str`. It contains entities from this polls explanation filtered by their ``type`` attribute as @@ -529,12 +530,12 @@ def parse_explanation_entities( UTF-16 codepoints. See :attr:`parse_explanation_entity` for more info. Args: - types (List[:obj:`str`], optional): List of ``MessageEntity`` types as strings. If the + types (list[:obj:`str`], optional): List of ``MessageEntity`` types as strings. If the ``type`` attribute of an entity is contained in this list, it will be returned. Defaults to :attr:`telegram.MessageEntity.ALL_TYPES`. Returns: - Dict[:class:`telegram.MessageEntity`, :obj:`str`]: A dictionary of entities mapped to + dict[:class:`telegram.MessageEntity`, :obj:`str`]: A dictionary of entities mapped to the text that belongs to them, calculated based on UTF-16 codepoints. Raises: @@ -567,8 +568,8 @@ def parse_question_entity(self, entity: MessageEntity) -> str: return parse_message_entity(self.question, entity) def parse_question_entities( - self, types: Optional[List[str]] = None - ) -> Dict[MessageEntity, str]: + self, types: Optional[list[str]] = None + ) -> dict[MessageEntity, str]: """ Returns a :obj:`dict` that maps :class:`telegram.MessageEntity` to :obj:`str`. It contains entities from this polls question filtered by their ``type`` attribute as @@ -582,12 +583,12 @@ def parse_question_entities( UTF-16 codepoints. See :attr:`parse_question_entity` for more info. Args: - types (List[:obj:`str`], optional): List of ``MessageEntity`` types as strings. If the + types (list[:obj:`str`], optional): List of ``MessageEntity`` types as strings. If the ``type`` attribute of an entity is contained in this list, it will be returned. Defaults to :attr:`telegram.MessageEntity.ALL_TYPES`. Returns: - Dict[:class:`telegram.MessageEntity`, :obj:`str`]: A dictionary of entities mapped to + dict[:class:`telegram.MessageEntity`, :obj:`str`]: A dictionary of entities mapped to the text that belongs to them, calculated based on UTF-16 codepoints. """ diff --git a/telegram/_reaction.py b/telegram/_reaction.py index 90de7823d79..ca0f37fb0cc 100644 --- a/telegram/_reaction.py +++ b/telegram/_reaction.py @@ -18,7 +18,7 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains objects that represents a Telegram ReactionType.""" -from typing import TYPE_CHECKING, Dict, Final, Literal, Optional, Type, Union +from typing import TYPE_CHECKING, Final, Literal, Optional, Union from telegram import constants from telegram._telegramobject import TelegramObject @@ -89,7 +89,7 @@ def de_json( if not data and cls is ReactionType: return None - _class_mapping: Dict[str, Type[ReactionType]] = { + _class_mapping: dict[str, type[ReactionType]] = { cls.EMOJI: ReactionTypeEmoji, cls.CUSTOM_EMOJI: ReactionTypeCustomEmoji, cls.PAID: ReactionTypePaid, diff --git a/telegram/_reply.py b/telegram/_reply.py index 65e42665718..afaa379ca38 100644 --- a/telegram/_reply.py +++ b/telegram/_reply.py @@ -17,7 +17,8 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. """This modules contains objects that represents Telegram Replies""" -from typing import TYPE_CHECKING, Optional, Sequence, Tuple, Union +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional, Union from telegram._chat import Chat from telegram._dice import Dice @@ -124,7 +125,7 @@ class ExternalReplyInfo(TelegramObject): file. document (:class:`telegram.Document`): Optional. Message is a general file, information about the file. - photo (Tuple[:class:`telegram.PhotoSize`]): Optional. Message is a photo, available sizes + photo (tuple[:class:`telegram.PhotoSize`]): Optional. Message is a photo, available sizes of the photo. sticker (:class:`telegram.Sticker`): Optional. Message is a sticker, information about the sticker. @@ -224,7 +225,7 @@ def __init__( self.animation: Optional[Animation] = animation self.audio: Optional[Audio] = audio self.document: Optional[Document] = document - self.photo: Optional[Tuple[PhotoSize, ...]] = parse_sequence_arg(photo) + self.photo: Optional[tuple[PhotoSize, ...]] = parse_sequence_arg(photo) self.sticker: Optional[Sticker] = sticker self.story: Optional[Story] = story self.video: Optional[Video] = video @@ -311,7 +312,7 @@ class TextQuote(TelegramObject): message. position (:obj:`int`): Approximate quote position in the original message in UTF-16 code units as specified by the sender. - entities (Tuple[:class:`telegram.MessageEntity`]): Optional. Special entities that appear + entities (tuple[:class:`telegram.MessageEntity`]): Optional. Special entities that appear in the quote. Currently, only bold, italic, underline, strikethrough, spoiler, and custom_emoji entities are kept in quotes. is_manual (:obj:`bool`): Optional. :obj:`True`, if the quote was chosen manually by the @@ -338,7 +339,7 @@ def __init__( self.text: str = text self.position: int = position - self.entities: Optional[Tuple[MessageEntity, ...]] = parse_sequence_arg(entities) + self.entities: Optional[tuple[MessageEntity, ...]] = parse_sequence_arg(entities) self.is_manual: Optional[bool] = is_manual self._id_attrs = ( @@ -411,7 +412,7 @@ class ReplyParameters(TelegramObject): quote_parse_mode (:obj:`str`): Optional. Mode for parsing entities in the quote. See :wiki:`formatting options ` for more details. - quote_entities (Tuple[:class:`telegram.MessageEntity`]): Optional. A JSON-serialized list + quote_entities (tuple[:class:`telegram.MessageEntity`]): Optional. A JSON-serialized list of special entities that appear in the quote. It can be specified instead of :paramref:`quote_parse_mode`. quote_position (:obj:`int`): Optional. Position of the quote in the original message in @@ -447,7 +448,7 @@ def __init__( self.allow_sending_without_reply: ODVInput[bool] = allow_sending_without_reply self.quote: Optional[str] = quote self.quote_parse_mode: ODVInput[str] = quote_parse_mode - self.quote_entities: Optional[Tuple[MessageEntity, ...]] = parse_sequence_arg( + self.quote_entities: Optional[tuple[MessageEntity, ...]] = parse_sequence_arg( quote_entities ) self.quote_position: Optional[int] = quote_position diff --git a/telegram/_replykeyboardmarkup.py b/telegram/_replykeyboardmarkup.py index 1b410ebc709..3abecc5863c 100644 --- a/telegram/_replykeyboardmarkup.py +++ b/telegram/_replykeyboardmarkup.py @@ -18,7 +18,8 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains an object that represents a Telegram ReplyKeyboardMarkup.""" -from typing import Final, Optional, Sequence, Tuple, Union +from collections.abc import Sequence +from typing import Final, Optional, Union from telegram import constants from telegram._keyboardbutton import KeyboardButton @@ -85,7 +86,7 @@ class ReplyKeyboardMarkup(TelegramObject): .. versionadded:: 20.0 Attributes: - keyboard (Tuple[Tuple[:class:`telegram.KeyboardButton`]]): Array of button rows, + keyboard (tuple[tuple[:class:`telegram.KeyboardButton`]]): Array of button rows, each represented by an Array of :class:`telegram.KeyboardButton` objects. resize_keyboard (:obj:`bool`): Optional. Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if there are just two rows of @@ -148,7 +149,7 @@ def __init__( ) # Required - self.keyboard: Tuple[Tuple[KeyboardButton, ...], ...] = tuple( + self.keyboard: tuple[tuple[KeyboardButton, ...], ...] = tuple( tuple(KeyboardButton(button) if isinstance(button, str) else button for button in row) for row in keyboard ) diff --git a/telegram/_shared.py b/telegram/_shared.py index b4ce2c4d5a0..60d8ef3b961 100644 --- a/telegram/_shared.py +++ b/telegram/_shared.py @@ -17,7 +17,8 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains two objects used for request chats/users service messages.""" -from typing import TYPE_CHECKING, Optional, Sequence, Tuple +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional from telegram._files.photosize import PhotoSize from telegram._telegramobject import TelegramObject @@ -59,7 +60,7 @@ class UsersShared(TelegramObject): Attributes: request_id (:obj:`int`): Identifier of the request. - users (Tuple[:class:`telegram.SharedUser`]): Information about users shared with the + users (tuple[:class:`telegram.SharedUser`]): Information about users shared with the bot. .. versionadded:: 21.1 @@ -76,7 +77,7 @@ def __init__( ): super().__init__(api_kwargs=api_kwargs) self.request_id: int = request_id - self.users: Tuple[SharedUser, ...] = parse_sequence_arg(users) + self.users: tuple[SharedUser, ...] = parse_sequence_arg(users) self._id_attrs = (self.request_id, self.users) @@ -144,7 +145,7 @@ class ChatShared(TelegramObject): the bot and available. .. versionadded:: 21.1 - photo (Tuple[:class:`telegram.PhotoSize`]): Optional. Available sizes of the chat photo, + photo (tuple[:class:`telegram.PhotoSize`]): Optional. Available sizes of the chat photo, if the photo was requested by the bot .. versionadded:: 21.1 @@ -167,7 +168,7 @@ def __init__( self.chat_id: int = chat_id self.title: Optional[str] = title self.username: Optional[str] = username - self.photo: Optional[Tuple[PhotoSize, ...]] = parse_sequence_arg(photo) + self.photo: Optional[tuple[PhotoSize, ...]] = parse_sequence_arg(photo) self._id_attrs = (self.request_id, self.chat_id) @@ -226,7 +227,7 @@ class SharedUser(TelegramObject): bot. username (:obj:`str`): Optional. Username of the user, if the username was requested by the bot. - photo (Tuple[:class:`telegram.PhotoSize`]): Available sizes of the chat photo, if + photo (tuple[:class:`telegram.PhotoSize`]): Available sizes of the chat photo, if the photo was requested by the bot. This list is empty if the photo was not requsted. """ @@ -247,7 +248,7 @@ def __init__( self.first_name: Optional[str] = first_name self.last_name: Optional[str] = last_name self.username: Optional[str] = username - self.photo: Optional[Tuple[PhotoSize, ...]] = parse_sequence_arg(photo) + self.photo: Optional[tuple[PhotoSize, ...]] = parse_sequence_arg(photo) self._id_attrs = (self.user_id,) diff --git a/telegram/_telegramobject.py b/telegram/_telegramobject.py index 50407553226..6f5038da44b 100644 --- a/telegram/_telegramobject.py +++ b/telegram/_telegramobject.py @@ -21,27 +21,12 @@ import datetime import inspect import json -from collections.abc import Sized +from collections.abc import Iterator, Mapping, Sized from contextlib import contextmanager from copy import deepcopy from itertools import chain from types import MappingProxyType -from typing import ( - TYPE_CHECKING, - Any, - ClassVar, - Dict, - Iterator, - List, - Mapping, - Optional, - Set, - Tuple, - Type, - TypeVar, - Union, - cast, -) +from typing import TYPE_CHECKING, Any, ClassVar, Optional, TypeVar, Union, cast from telegram._utils.datetime import to_timestamp from telegram._utils.defaultvalue import DefaultValue @@ -80,7 +65,7 @@ class TelegramObject: :obj:`list` are now of type :obj:`tuple`. Arguments: - api_kwargs (Dict[:obj:`str`, any], optional): |toapikwargsarg| + api_kwargs (dict[:obj:`str`, any], optional): |toapikwargsarg| .. versionadded:: 20.0 @@ -95,11 +80,11 @@ class TelegramObject: # Used to cache the names of the parameters of the __init__ method of the class # Must be a private attribute to avoid name clashes between subclasses - __INIT_PARAMS: ClassVar[Set[str]] = set() + __INIT_PARAMS: ClassVar[set[str]] = set() # Used to check if __INIT_PARAMS has been set for the current class. Unfortunately, we can't # just check if `__INIT_PARAMS is None`, since subclasses use the parent class' __INIT_PARAMS # unless it's overridden - __INIT_PARAMS_CHECK: Optional[Type["TelegramObject"]] = None + __INIT_PARAMS_CHECK: Optional[type["TelegramObject"]] = None def __init__(self, *, api_kwargs: Optional[JSONDict] = None) -> None: # Setting _frozen to `False` here means that classes without arguments still need to @@ -107,7 +92,7 @@ def __init__(self, *, api_kwargs: Optional[JSONDict] = None) -> None: # `with self._unfrozen()` in the `__init__` of subclasses and we have fewer empty # classes than classes with arguments. self._frozen: bool = False - self._id_attrs: Tuple[object, ...] = () + self._id_attrs: tuple[object, ...] = () self._bot: Optional[Bot] = None # We don't do anything with api_kwargs here - see docstring of _apply_api_kwargs self.api_kwargs: Mapping[str, Any] = MappingProxyType(api_kwargs or {}) @@ -263,7 +248,7 @@ def __getitem__(self, item: str) -> object: f"`{item}`." ) from exc - def __getstate__(self) -> Dict[str, Union[str, object]]: + def __getstate__(self) -> dict[str, Union[str, object]]: """ Overrides :meth:`object.__getstate__` to customize the pickling process of objects of this type. @@ -271,7 +256,7 @@ def __getstate__(self) -> Dict[str, Union[str, object]]: :meth:`set_bot` (if any), as it can't be pickled. Returns: - state (Dict[:obj:`str`, :obj:`object`]): The state of the object. + state (dict[:obj:`str`, :obj:`object`]): The state of the object. """ out = self._get_attrs( include_private=True, recursive=False, remove_bot=True, convert_default_vault=False @@ -281,7 +266,7 @@ def __getstate__(self) -> Dict[str, Union[str, object]]: out["api_kwargs"] = dict(self.api_kwargs) return out - def __setstate__(self, state: Dict[str, object]) -> None: + def __setstate__(self, state: dict[str, object]) -> None: """ Overrides :meth:`object.__setstate__` to customize the unpickling process of objects of this type. Modifies the object in-place. @@ -305,7 +290,7 @@ def __setstate__(self, state: Dict[str, object]) -> None: self._bot = None # get api_kwargs first because we may need to add entries to it (see try-except below) - api_kwargs = cast(Dict[str, object], state.pop("api_kwargs", {})) + api_kwargs = cast(dict[str, object], state.pop("api_kwargs", {})) # get _frozen before the loop to avoid setting it to True in the loop frozen = state.pop("_frozen", False) @@ -341,7 +326,7 @@ def __setstate__(self, state: Dict[str, object]) -> None: if frozen: self._freeze() - def __deepcopy__(self: Tele_co, memodict: Dict[int, object]) -> Tele_co: + def __deepcopy__(self: Tele_co, memodict: dict[int, object]) -> Tele_co: """ Customizes how :func:`copy.deepcopy` processes objects of this type. The only difference to the default implementation is that the :class:`telegram.Bot` @@ -401,7 +386,7 @@ def _parse_data(data: Optional[JSONDict]) -> Optional[JSONDict]: @classmethod def _de_json( - cls: Type[Tele_co], + cls: type[Tele_co], data: Optional[JSONDict], bot: Optional["Bot"], api_kwargs: Optional[JSONDict] = None, @@ -433,12 +418,12 @@ def _de_json( @classmethod def de_json( - cls: Type[Tele_co], data: Optional[JSONDict], bot: Optional["Bot"] = None + cls: type[Tele_co], data: Optional[JSONDict], bot: Optional["Bot"] = None ) -> Optional[Tele_co]: """Converts JSON data to a Telegram object. Args: - data (Dict[:obj:`str`, ...]): The JSON data. + data (dict[:obj:`str`, ...]): The JSON data. bot (:class:`telegram.Bot`, optional): The bot associated with this object. Defaults to :obj:`None`, in which case shortcut methods will not be available. @@ -453,8 +438,8 @@ def de_json( @classmethod def de_list( - cls: Type[Tele_co], data: Optional[List[JSONDict]], bot: Optional["Bot"] = None - ) -> Tuple[Tele_co, ...]: + cls: type[Tele_co], data: Optional[list[JSONDict]], bot: Optional["Bot"] = None + ) -> tuple[Tele_co, ...]: """Converts a list of JSON objects to a tuple of Telegram objects. .. versionchanged:: 20.0 @@ -463,7 +448,7 @@ def de_list( * Filters out any :obj:`None` values. Args: - data (List[Dict[:obj:`str`, ...]]): The JSON data. + data (list[dict[:obj:`str`, ...]]): The JSON data. bot (:class:`telegram.Bot`, optional): The bot associated with these object. Defaults to :obj:`None`, in which case shortcut methods will not be available. @@ -552,7 +537,7 @@ def _get_attrs( recursive: bool = False, remove_bot: bool = False, convert_default_vault: bool = True, - ) -> Dict[str, Union[str, object]]: + ) -> dict[str, Union[str, object]]: """This method is used for obtaining the attributes of the object. Args: @@ -625,7 +610,7 @@ def to_dict(self, recursive: bool = True) -> JSONDict: # Now we should convert TGObjects to dicts inside objects such as sequences, and convert # datetimes to timestamps. This mostly eliminates the need for subclasses to override # `to_dict` - pop_keys: Set[str] = set() + pop_keys: set[str] = set() for key, value in out.items(): if isinstance(value, (tuple, list)): if not value: @@ -637,7 +622,7 @@ def to_dict(self, recursive: bool = True) -> JSONDict: for item in value: if hasattr(item, "to_dict"): val.append(item.to_dict(recursive=recursive)) - # This branch is useful for e.g. Tuple[Tuple[PhotoSize|KeyboardButton]] + # This branch is useful for e.g. tuple[tuple[PhotoSize|KeyboardButton]] elif isinstance(item, (tuple, list)): val.append( [ diff --git a/telegram/_update.py b/telegram/_update.py index 5db7b9a5584..abacce72c5f 100644 --- a/telegram/_update.py +++ b/telegram/_update.py @@ -18,7 +18,7 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains an object that represents a Telegram Update.""" -from typing import TYPE_CHECKING, Final, List, Optional, Union +from typing import TYPE_CHECKING, Final, Optional, Union from telegram import constants from telegram._business import BusinessConnection, BusinessMessagesDeleted @@ -402,8 +402,8 @@ class Update(TelegramObject): .. versionadded:: 21.6 """ - ALL_TYPES: Final[List[str]] = list(constants.UpdateType) - """List[:obj:`str`]: A list of all available update types. + ALL_TYPES: Final[list[str]] = list(constants.UpdateType) + """list[:obj:`str`]: A list of all available update types. .. versionadded:: 13.5""" diff --git a/telegram/_user.py b/telegram/_user.py index 075c4f12861..9e8e1f0ea1f 100644 --- a/telegram/_user.py +++ b/telegram/_user.py @@ -18,8 +18,9 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains an object that represents a Telegram User.""" +from collections.abc import Sequence from datetime import datetime -from typing import TYPE_CHECKING, Optional, Sequence, Tuple, Union +from typing import TYPE_CHECKING, Optional, Union from telegram._inline.inlinekeyboardbutton import InlineKeyboardButton from telegram._menubutton import MenuButton @@ -621,7 +622,7 @@ async def send_media_group( caption: Optional[str] = None, parse_mode: ODVInput[str] = DEFAULT_NONE, caption_entities: Optional[Sequence["MessageEntity"]] = None, - ) -> Tuple["Message", ...]: + ) -> tuple["Message", ...]: """Shortcut for:: await bot.send_media_group(update.effective_user.id, *args, **kwargs) @@ -632,7 +633,7 @@ async def send_media_group( |user_chat_id_note| Returns: - Tuple[:class:`telegram.Message`:] On success, a tuple of :class:`~telegram.Message` + tuple[:class:`telegram.Message`:] On success, a tuple of :class:`~telegram.Message` instances that were sent is returned. """ @@ -1739,7 +1740,7 @@ async def send_copies( connect_timeout: ODVInput[float] = DEFAULT_NONE, pool_timeout: ODVInput[float] = DEFAULT_NONE, api_kwargs: Optional[JSONDict] = None, - ) -> Tuple["MessageId", ...]: + ) -> tuple["MessageId", ...]: """Shortcut for:: await bot.copy_messages(chat_id=update.effective_user.id, *argss, **kwargs) @@ -1751,7 +1752,7 @@ async def send_copies( .. versionadded:: 20.8 Returns: - Tuple[:class:`telegram.MessageId`]: On success, a tuple of :class:`~telegram.MessageId` + tuple[:class:`telegram.MessageId`]: On success, a tuple of :class:`~telegram.MessageId` of the sent messages is returned. """ @@ -1784,7 +1785,7 @@ async def copy_messages( connect_timeout: ODVInput[float] = DEFAULT_NONE, pool_timeout: ODVInput[float] = DEFAULT_NONE, api_kwargs: Optional[JSONDict] = None, - ) -> Tuple["MessageId", ...]: + ) -> tuple["MessageId", ...]: """Shortcut for:: await bot.copy_messages(from_chat_id=update.effective_user.id, *argss, **kwargs) @@ -1796,7 +1797,7 @@ async def copy_messages( .. versionadded:: 20.8 Returns: - Tuple[:class:`telegram.MessageId`]: On success, a tuple of :class:`~telegram.MessageId` + tuple[:class:`telegram.MessageId`]: On success, a tuple of :class:`~telegram.MessageId` of the sent messages is returned. """ @@ -1913,7 +1914,7 @@ async def forward_messages_from( connect_timeout: ODVInput[float] = DEFAULT_NONE, pool_timeout: ODVInput[float] = DEFAULT_NONE, api_kwargs: Optional[JSONDict] = None, - ) -> Tuple["MessageId", ...]: + ) -> tuple["MessageId", ...]: """Shortcut for:: await bot.forward_messages(chat_id=update.effective_user.id, *argss, **kwargs) @@ -1925,7 +1926,7 @@ async def forward_messages_from( .. versionadded:: 20.8 Returns: - Tuple[:class:`telegram.MessageId`]: On success, a tuple of :class:`~telegram.MessageId` + tuple[:class:`telegram.MessageId`]: On success, a tuple of :class:`~telegram.MessageId` of sent messages is returned. """ @@ -1956,7 +1957,7 @@ async def forward_messages_to( connect_timeout: ODVInput[float] = DEFAULT_NONE, pool_timeout: ODVInput[float] = DEFAULT_NONE, api_kwargs: Optional[JSONDict] = None, - ) -> Tuple["MessageId", ...]: + ) -> tuple["MessageId", ...]: """Shortcut for:: await bot.forward_messages(from_chat_id=update.effective_user.id, *argss, **kwargs) @@ -1968,7 +1969,7 @@ async def forward_messages_to( .. versionadded:: 20.8 Returns: - Tuple[:class:`telegram.MessageId`]: On success, a tuple of :class:`~telegram.MessageId` + tuple[:class:`telegram.MessageId`]: On success, a tuple of :class:`~telegram.MessageId` of sent messages is returned. """ diff --git a/telegram/_userprofilephotos.py b/telegram/_userprofilephotos.py index 9a5e4a066ef..c7355bb8723 100644 --- a/telegram/_userprofilephotos.py +++ b/telegram/_userprofilephotos.py @@ -17,7 +17,8 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains an object that represents a Telegram UserProfilePhotos.""" -from typing import TYPE_CHECKING, Optional, Sequence, Tuple +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional from telegram._files.photosize import PhotoSize from telegram._telegramobject import TelegramObject @@ -43,7 +44,7 @@ class UserProfilePhotos(TelegramObject): Attributes: total_count (:obj:`int`): Total number of profile pictures. - photos (Tuple[Tuple[:class:`telegram.PhotoSize`]]): Requested profile pictures (in up to 4 + photos (tuple[tuple[:class:`telegram.PhotoSize`]]): Requested profile pictures (in up to 4 sizes each). .. versionchanged:: 20.0 @@ -63,7 +64,7 @@ def __init__( super().__init__(api_kwargs=api_kwargs) # Required self.total_count: int = total_count - self.photos: Tuple[Tuple[PhotoSize, ...], ...] = tuple(tuple(sizes) for sizes in photos) + self.photos: tuple[tuple[PhotoSize, ...], ...] = tuple(tuple(sizes) for sizes in photos) self._id_attrs = (self.total_count, self.photos) diff --git a/telegram/_utils/argumentparsing.py b/telegram/_utils/argumentparsing.py index c3613ecdd9c..22485512ff4 100644 --- a/telegram/_utils/argumentparsing.py +++ b/telegram/_utils/argumentparsing.py @@ -23,7 +23,8 @@ user. Changes to this module are not considered breaking changes and may not be documented in the changelog. """ -from typing import Optional, Sequence, Tuple, TypeVar +from collections.abc import Sequence +from typing import Optional, TypeVar from telegram._linkpreviewoptions import LinkPreviewOptions from telegram._utils.types import ODVInput @@ -31,7 +32,7 @@ T = TypeVar("T") -def parse_sequence_arg(arg: Optional[Sequence[T]]) -> Tuple[T, ...]: +def parse_sequence_arg(arg: Optional[Sequence[T]]) -> tuple[T, ...]: """Parses an optional sequence into a tuple Args: diff --git a/telegram/_utils/entities.py b/telegram/_utils/entities.py index 34901c3d6f7..c97560e8f5a 100644 --- a/telegram/_utils/entities.py +++ b/telegram/_utils/entities.py @@ -23,7 +23,8 @@ user. Changes to this module are not considered breaking changes and may not be documented in the changelog. """ -from typing import Dict, Optional, Sequence +from collections.abc import Sequence +from typing import Optional from telegram._messageentity import MessageEntity from telegram._utils.strings import TextEncoding @@ -47,7 +48,7 @@ def parse_message_entity(text: str, entity: MessageEntity) -> str: def parse_message_entities( text: str, entities: Sequence[MessageEntity], types: Optional[Sequence[str]] = None -) -> Dict[MessageEntity, str]: +) -> dict[MessageEntity, str]: """ Returns a :obj:`dict` that maps :class:`telegram.MessageEntity` to :obj:`str`. It contains entities filtered by their ``type`` attribute as @@ -55,13 +56,13 @@ def parse_message_entities( Args: text (:obj:`str`): The text to extract the entity from. - entities (List[:class:`telegram.MessageEntity`]): The entities to extract the text from. - types (List[:obj:`str`], optional): List of ``MessageEntity`` types as strings. If the + entities (list[:class:`telegram.MessageEntity`]): The entities to extract the text from. + types (list[:obj:`str`], optional): List of ``MessageEntity`` types as strings. If the ``type`` attribute of an entity is contained in this list, it will be returned. Defaults to :attr:`telegram.MessageEntity.ALL_TYPES`. Returns: - Dict[:class:`telegram.MessageEntity`, :obj:`str`]: A dictionary of entities mapped to + dict[:class:`telegram.MessageEntity`, :obj:`str`]: A dictionary of entities mapped to the text that belongs to them, calculated based on UTF-16 codepoints. """ if types is None: diff --git a/telegram/_utils/enum.py b/telegram/_utils/enum.py index 20a045c02fe..e58d3c0cb0a 100644 --- a/telegram/_utils/enum.py +++ b/telegram/_utils/enum.py @@ -25,14 +25,14 @@ """ import enum as _enum import sys -from typing import Type, TypeVar, Union +from typing import TypeVar, Union _A = TypeVar("_A") _B = TypeVar("_B") _Enum = TypeVar("_Enum", bound=_enum.Enum) -def get_member(enum_cls: Type[_Enum], value: _A, default: _B) -> Union[_Enum, _A, _B]: +def get_member(enum_cls: type[_Enum], value: _A, default: _B) -> Union[_Enum, _A, _B]: """Tries to call ``enum_cls(value)`` to convert the value into an enumeration member. If that fails, the ``default`` is returned. """ diff --git a/telegram/_utils/files.py b/telegram/_utils/files.py index 121c7b3392e..7f7e29fc15c 100644 --- a/telegram/_utils/files.py +++ b/telegram/_utils/files.py @@ -29,7 +29,7 @@ """ from pathlib import Path -from typing import IO, TYPE_CHECKING, Any, Optional, Tuple, Type, TypeVar, Union, cast, overload +from typing import IO, TYPE_CHECKING, Any, Optional, TypeVar, Union, cast, overload from telegram._utils.types import FileInput, FilePathInput @@ -40,16 +40,16 @@ @overload -def load_file(obj: IO[bytes]) -> Tuple[Optional[str], bytes]: ... +def load_file(obj: IO[bytes]) -> tuple[Optional[str], bytes]: ... @overload -def load_file(obj: _T) -> Tuple[None, _T]: ... +def load_file(obj: _T) -> tuple[None, _T]: ... def load_file( obj: Optional[FileInput], -) -> Tuple[Optional[str], Union[bytes, "InputFile", str, Path, None]]: +) -> tuple[Optional[str], Union[bytes, "InputFile", str, Path, None]]: """If the input is a file handle, read the data and name and return it. Otherwise, return the input unchanged. """ @@ -95,7 +95,7 @@ def is_local_file(obj: Optional[FilePathInput]) -> bool: def parse_file_input( # pylint: disable=too-many-return-statements file_input: Union[FileInput, "TelegramObject"], - tg_type: Optional[Type["TelegramObject"]] = None, + tg_type: Optional[type["TelegramObject"]] = None, filename: Optional[str] = None, attach: bool = False, local_mode: bool = False, diff --git a/telegram/_utils/types.py b/telegram/_utils/types.py index 8a01fdc2dea..f9748773222 100644 --- a/telegram/_utils/types.py +++ b/telegram/_utils/types.py @@ -23,19 +23,9 @@ user. Changes to this module are not considered breaking changes and may not be documented in the changelog. """ +from collections.abc import Collection from pathlib import Path -from typing import ( - IO, - TYPE_CHECKING, - Any, - Collection, - Dict, - Literal, - Optional, - Tuple, - TypeVar, - Union, -) +from typing import IO, TYPE_CHECKING, Any, Literal, Optional, TypeVar, Union if TYPE_CHECKING: from telegram import ( @@ -57,7 +47,7 @@ """Valid input for passing files to Telegram. Either a file id as string, a file like object, a local file path as string, :class:`pathlib.Path` or the file contents as :obj:`bytes`.""" -JSONDict = Dict[str, Any] +JSONDict = dict[str, Any] """Dictionary containing response from Telegram or data to send to the API.""" DVValueType = TypeVar("DVValueType") # pylint: disable=invalid-name @@ -82,9 +72,9 @@ .. versionadded:: 20.0 """ -FieldTuple = Tuple[str, Union[bytes, IO[bytes]], str] +FieldTuple = tuple[str, Union[bytes, IO[bytes]], str] """Alias for return type of `InputFile.field_tuple`.""" -UploadFileDict = Dict[str, FieldTuple] +UploadFileDict = dict[str, FieldTuple] """Dictionary containing file data to be uploaded to the API.""" HTTPVersion = Literal["1.1", "2.0", "2"] @@ -97,7 +87,7 @@ MarkdownVersion = Literal[1, 2] SocketOpt = Union[ - Tuple[int, int, int], - Tuple[int, int, Union[bytes, bytearray]], - Tuple[int, int, None, int], + tuple[int, int, int], + tuple[int, int, Union[bytes, bytearray]], + tuple[int, int, None, int], ] diff --git a/telegram/_utils/warnings.py b/telegram/_utils/warnings.py index dcc3fc150d9..2ddb2317d79 100644 --- a/telegram/_utils/warnings.py +++ b/telegram/_utils/warnings.py @@ -26,14 +26,14 @@ the changelog. """ import warnings -from typing import Type, Union +from typing import Union from telegram.warnings import PTBUserWarning def warn( message: Union[str, PTBUserWarning], - category: Type[Warning] = PTBUserWarning, + category: type[Warning] = PTBUserWarning, stacklevel: int = 0, ) -> None: """ @@ -48,7 +48,7 @@ def warn( .. versionchanged:: 21.2 Now also accepts a :obj:`PTBUserWarning` instance. - category (:obj:`Type[Warning]`, optional): Specify the Warning class to pass to + category (:obj:`type[Warning]`, optional): Specify the Warning class to pass to ``warnings.warn()``. Defaults to :class:`telegram.warnings.PTBUserWarning`. stacklevel (:obj:`int`, optional): Specify the stacklevel to pass to ``warnings.warn()``. Pass the same value as you'd pass directly to ``warnings.warn()``. Defaults to ``0``. diff --git a/telegram/_utils/warnings_transition.py b/telegram/_utils/warnings_transition.py index a135ee5e648..43bb6c225aa 100644 --- a/telegram/_utils/warnings_transition.py +++ b/telegram/_utils/warnings_transition.py @@ -23,7 +23,7 @@ .. versionadded:: 20.2 """ -from typing import Any, Callable, Type, Union +from typing import Any, Callable, Union from telegram._utils.warnings import warn from telegram.warnings import PTBDeprecationWarning, PTBUserWarning @@ -56,7 +56,7 @@ def warn_about_deprecated_arg_return_new_arg( bot_api_version: str, ptb_version: str, stacklevel: int = 2, - warn_callback: Callable[[Union[str, PTBUserWarning], Type[Warning], int], None] = warn, + warn_callback: Callable[[Union[str, PTBUserWarning], type[Warning], int], None] = warn, ) -> Any: """A helper function for the transition in API when argument is renamed. diff --git a/telegram/_videochat.py b/telegram/_videochat.py index b392fa6d65b..916d8f9ef9c 100644 --- a/telegram/_videochat.py +++ b/telegram/_videochat.py @@ -18,7 +18,8 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains objects related to Telegram video chats.""" import datetime as dtm -from typing import TYPE_CHECKING, Optional, Sequence, Tuple +from collections.abc import Sequence +from typing import TYPE_CHECKING, Optional from telegram._telegramobject import TelegramObject from telegram._user import User @@ -102,7 +103,7 @@ class VideoChatParticipantsInvited(TelegramObject): |sequenceclassargs| Attributes: - users (Tuple[:class:`telegram.User`]): New members that were invited to the video chat. + users (tuple[:class:`telegram.User`]): New members that were invited to the video chat. .. versionchanged:: 20.0 |tupleclassattrs| @@ -118,7 +119,7 @@ def __init__( api_kwargs: Optional[JSONDict] = None, ) -> None: super().__init__(api_kwargs=api_kwargs) - self.users: Tuple[User, ...] = parse_sequence_arg(users) + self.users: tuple[User, ...] = parse_sequence_arg(users) self._id_attrs = (self.users,) self._freeze() diff --git a/telegram/_webhookinfo.py b/telegram/_webhookinfo.py index a6f309a930d..607a6f6b12b 100644 --- a/telegram/_webhookinfo.py +++ b/telegram/_webhookinfo.py @@ -17,8 +17,9 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains an object that represents a Telegram WebhookInfo.""" +from collections.abc import Sequence from datetime import datetime -from typing import TYPE_CHECKING, Optional, Sequence, Tuple +from typing import TYPE_CHECKING, Optional from telegram._telegramobject import TelegramObject from telegram._utils.argumentparsing import parse_sequence_arg @@ -89,7 +90,7 @@ class WebhookInfo(TelegramObject): most recent error that happened when trying to deliver an update via webhook. max_connections (:obj:`int`): Optional. Maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery. - allowed_updates (Tuple[:obj:`str`]): Optional. A list of update types the bot is + allowed_updates (tuple[:obj:`str`]): Optional. A list of update types the bot is subscribed to. Defaults to all update types, except :attr:`telegram.Update.chat_member`. @@ -144,7 +145,7 @@ def __init__( self.last_error_date: Optional[datetime] = last_error_date self.last_error_message: Optional[str] = last_error_message self.max_connections: Optional[int] = max_connections - self.allowed_updates: Tuple[str, ...] = parse_sequence_arg(allowed_updates) + self.allowed_updates: tuple[str, ...] = parse_sequence_arg(allowed_updates) self.last_synchronization_error_date: Optional[datetime] = last_synchronization_error_date self._id_attrs = ( diff --git a/telegram/constants.py b/telegram/constants.py index 582de62c495..cffe79880cb 100644 --- a/telegram/constants.py +++ b/telegram/constants.py @@ -108,7 +108,7 @@ import datetime import sys from enum import Enum -from typing import Final, List, NamedTuple, Optional, Tuple +from typing import Final, NamedTuple, Optional from telegram._utils.datetime import UTC from telegram._utils.enum import IntEnum, StringEnum @@ -141,8 +141,8 @@ class _AccentColor(NamedTuple): identifier: int name: Optional[str] = None - light_colors: Tuple[int, ...] = () - dark_colors: Tuple[int, ...] = () + light_colors: tuple[int, ...] = () + dark_colors: tuple[int, ...] = () #: :class:`typing.NamedTuple`: A tuple containing the two components of the version number: @@ -162,9 +162,9 @@ class _AccentColor(NamedTuple): # constants above this line are tested -#: List[:obj:`int`]: Ports supported by +#: list[:obj:`int`]: Ports supported by #: :paramref:`telegram.Bot.set_webhook.url`. -SUPPORTED_WEBHOOK_PORTS: Final[List[int]] = [443, 80, 88, 8443] +SUPPORTED_WEBHOOK_PORTS: Final[list[int]] = [443, 80, 88, 8443] #: :obj:`datetime.datetime`, value of unix 0. #: This date literal is used in :class:`telegram.InaccessibleMessage` @@ -180,9 +180,9 @@ class AccentColor(Enum): - ``identifier`` (:obj:`int`): The identifier of the accent color. - ``name`` (:obj:`str`): Optional. The name of the accent color. - - ``light_colors`` (Tuple[:obj:`str`]): Optional. The light colors of the accent color as HEX + - ``light_colors`` (tuple[:obj:`str`]): Optional. The light colors of the accent color as HEX value. - - ``dark_colors`` (Tuple[:obj:`str`]): Optional. The dark colors of the accent color as HEX + - ``dark_colors`` (tuple[:obj:`str`]): Optional. The dark colors of the accent color as HEX value. Since Telegram gives no exact specification for the accent colors, future accent colors might @@ -2083,9 +2083,9 @@ class ProfileAccentColor(Enum): - ``identifier`` (:obj:`int`): The identifier of the accent color. - ``name`` (:obj:`str`): Optional. The name of the accent color. - - ``light_colors`` (Tuple[:obj:`str`]): Optional. The light colors of the accent color as HEX + - ``light_colors`` (tuple[:obj:`str`]): Optional. The light colors of the accent color as HEX value. - - ``dark_colors`` (Tuple[:obj:`str`]): Optional. The dark colors of the accent color as HEX + - ``dark_colors`` (tuple[:obj:`str`]): Optional. The dark colors of the accent color as HEX value. Since Telegram gives no exact specification for the accent colors, future accent colors might diff --git a/telegram/error.py b/telegram/error.py index 6dcc509a8d4..6dae43d0577 100644 --- a/telegram/error.py +++ b/telegram/error.py @@ -36,20 +36,7 @@ "TimedOut", ) -from typing import Optional, Tuple, Union - - -def _lstrip_str(in_s: str, lstr: str) -> str: - """ - Args: - in_s (:obj:`str`): in string - lstr (:obj:`str`): substr to strip from left side - - Returns: - :obj:`str`: The stripped string. - - """ - return in_s[len(lstr) :] if in_s.startswith(lstr) else in_s +from typing import Optional, Union class TelegramError(Exception): @@ -70,9 +57,9 @@ class TelegramError(Exception): def __init__(self, message: str): super().__init__() - msg = _lstrip_str(message, "Error: ") - msg = _lstrip_str(msg, "[Error]: ") - msg = _lstrip_str(msg, "Bad Request: ") + msg = message.removeprefix("Error: ") + msg = msg.removeprefix("[Error]: ") + msg = msg.removeprefix("Bad Request: ") if msg != message: # api_error - capitalize the msg... msg = msg.capitalize() @@ -94,7 +81,7 @@ def __repr__(self) -> str: """ return f"{self.__class__.__name__}('{self.message}')" - def __reduce__(self) -> Tuple[type, Tuple[str]]: + def __reduce__(self) -> tuple[type, tuple[str]]: """Defines how to serialize the exception for pickle. .. seealso:: @@ -209,7 +196,7 @@ def __init__(self, new_chat_id: int): super().__init__(f"Group migrated to supergroup. New chat id: {new_chat_id}") self.new_chat_id: int = new_chat_id - def __reduce__(self) -> Tuple[type, Tuple[int]]: # type: ignore[override] + def __reduce__(self) -> tuple[type, tuple[int]]: # type: ignore[override] return self.__class__, (self.new_chat_id,) @@ -234,7 +221,7 @@ def __init__(self, retry_after: int): super().__init__(f"Flood control exceeded. Retry in {retry_after} seconds") self.retry_after: int = retry_after - def __reduce__(self) -> Tuple[type, Tuple[float]]: # type: ignore[override] + def __reduce__(self) -> tuple[type, tuple[float]]: # type: ignore[override] return self.__class__, (self.retry_after,) @@ -243,7 +230,7 @@ class Conflict(TelegramError): __slots__ = () - def __reduce__(self) -> Tuple[type, Tuple[str]]: + def __reduce__(self) -> tuple[type, tuple[str]]: return self.__class__, (self.message,) @@ -261,5 +248,5 @@ def __init__(self, message: Union[str, Exception]): super().__init__(f"PassportDecryptionError: {message}") self._msg = str(message) - def __reduce__(self) -> Tuple[type, Tuple[str]]: + def __reduce__(self) -> tuple[type, tuple[str]]: return self.__class__, (self._msg,) diff --git a/telegram/ext/_aioratelimiter.py b/telegram/ext/_aioratelimiter.py index 3a5af9b8530..e690037edba 100644 --- a/telegram/ext/_aioratelimiter.py +++ b/telegram/ext/_aioratelimiter.py @@ -22,7 +22,8 @@ import asyncio import contextlib import sys -from typing import Any, AsyncIterator, Callable, Coroutine, Dict, List, Optional, Union +from collections.abc import AsyncIterator, Coroutine +from typing import Any, Callable, Optional, Union try: from aiolimiter import AsyncLimiter @@ -152,7 +153,7 @@ def __init__( self._group_max_rate = 0 self._group_time_period = 0 - self._group_limiters: Dict[Union[str, int], AsyncLimiter] = {} + self._group_limiters: dict[Union[str, int], AsyncLimiter] = {} self._max_retries: int = max_retries self._retry_after_event = asyncio.Event() self._retry_after_event.set() @@ -187,10 +188,10 @@ async def _run_request( self, chat: bool, group: Union[str, int, bool], - callback: Callable[..., Coroutine[Any, Any, Union[bool, JSONDict, List[JSONDict]]]], + callback: Callable[..., Coroutine[Any, Any, Union[bool, JSONDict, list[JSONDict]]]], args: Any, - kwargs: Dict[str, Any], - ) -> Union[bool, JSONDict, List[JSONDict]]: + kwargs: dict[str, Any], + ) -> Union[bool, JSONDict, list[JSONDict]]: base_context = self._base_limiter if (chat and self._base_limiter) else null_context() group_context = ( self._get_group_limiter(group) if group and self._group_max_rate else null_context() @@ -205,13 +206,13 @@ async def _run_request( # mypy doesn't understand that the last run of the for loop raises an exception async def process_request( self, - callback: Callable[..., Coroutine[Any, Any, Union[bool, JSONDict, List[JSONDict]]]], + callback: Callable[..., Coroutine[Any, Any, Union[bool, JSONDict, list[JSONDict]]]], args: Any, - kwargs: Dict[str, Any], + kwargs: dict[str, Any], endpoint: str, # noqa: ARG002 - data: Dict[str, Any], + data: dict[str, Any], rate_limit_args: Optional[int], - ) -> Union[bool, JSONDict, List[JSONDict]]: + ) -> Union[bool, JSONDict, list[JSONDict]]: """ Processes a request by applying rate limiting. diff --git a/telegram/ext/_application.py b/telegram/ext/_application.py index 904119c18da..d0997a1fce2 100644 --- a/telegram/ext/_application.py +++ b/telegram/ext/_application.py @@ -26,30 +26,11 @@ import signal import sys from collections import defaultdict +from collections.abc import Awaitable, Coroutine, Generator, Mapping, Sequence from copy import deepcopy from pathlib import Path from types import MappingProxyType, TracebackType -from typing import ( - TYPE_CHECKING, - Any, - AsyncContextManager, - Awaitable, - Callable, - Coroutine, - DefaultDict, - Dict, - Generator, - Generic, - List, - Mapping, - NoReturn, - Optional, - Sequence, - Set, - Type, - TypeVar, - Union, -) +from typing import TYPE_CHECKING, Any, Callable, Generic, NoReturn, Optional, TypeVar, Union from telegram._update import Update from telegram._utils.defaultvalue import ( @@ -132,7 +113,10 @@ def __init__(self, state: Optional[object] = None) -> None: self.state: Optional[object] = state -class Application(Generic[BT, CCT, UD, CD, BD, JQ], AsyncContextManager["Application"]): +class Application( + Generic[BT, CCT, UD, CD, BD, JQ], + contextlib.AbstractAsyncContextManager["Application"], +): """This class dispatches all kinds of updates to its registered handlers, and is the entry point to a PTB application. @@ -224,12 +208,12 @@ class Application(Generic[BT, CCT, UD, CD, BD, JQ], AsyncContextManager["Applica bot_data (:obj:`dict`): A dictionary handlers can use to store data for the bot. persistence (:class:`telegram.ext.BasePersistence`): The persistence class to store data that should be persistent over restarts. - handlers (Dict[:obj:`int`, List[:class:`telegram.ext.BaseHandler`]]): A dictionary mapping + handlers (dict[:obj:`int`, list[:class:`telegram.ext.BaseHandler`]]): A dictionary mapping each handler group to the list of handlers registered to that group. .. seealso:: :meth:`add_handler`, :meth:`add_handlers`. - error_handlers (Dict[:term:`coroutine function`, :obj:`bool`]): A dictionary where the keys + error_handlers (dict[:term:`coroutine function`, :obj:`bool`]): A dictionary where the keys are error handlers and the values indicate whether they are to be run blocking. .. seealso:: @@ -323,8 +307,8 @@ def __init__( self.update_queue: asyncio.Queue[object] = update_queue self.context_types: ContextTypes[CCT, UD, CD, BD] = context_types self.updater: Optional[Updater] = updater - self.handlers: Dict[int, List[BaseHandler[Any, CCT, Any]]] = {} - self.error_handlers: Dict[ + self.handlers: dict[int, list[BaseHandler[Any, CCT, Any]]] = {} + self.error_handlers: dict[ HandlerCallback[object, CCT, None], Union[bool, DefaultValue[bool]] ] = {} self.post_init: Optional[ @@ -338,8 +322,8 @@ def __init__( ] = post_stop self._update_processor = update_processor self.bot_data: BD = self.context_types.bot_data() - self._user_data: DefaultDict[int, UD] = defaultdict(self.context_types.user_data) - self._chat_data: DefaultDict[int, CD] = defaultdict(self.context_types.chat_data) + self._user_data: defaultdict[int, UD] = defaultdict(self.context_types.user_data) + self._chat_data: defaultdict[int, CD] = defaultdict(self.context_types.chat_data) # Read only mapping self.user_data: Mapping[int, UD] = MappingProxyType(self._user_data) self.chat_data: Mapping[int, CD] = MappingProxyType(self._chat_data) @@ -350,14 +334,14 @@ def __init__( self.persistence = persistence # Some bookkeeping for persistence logic - self._chat_ids_to_be_updated_in_persistence: Set[int] = set() - self._user_ids_to_be_updated_in_persistence: Set[int] = set() - self._chat_ids_to_be_deleted_in_persistence: Set[int] = set() - self._user_ids_to_be_deleted_in_persistence: Set[int] = set() + self._chat_ids_to_be_updated_in_persistence: set[int] = set() + self._user_ids_to_be_updated_in_persistence: set[int] = set() + self._chat_ids_to_be_deleted_in_persistence: set[int] = set() + self._user_ids_to_be_deleted_in_persistence: set[int] = set() # This attribute will hold references to the conversation dicts of all conversation # handlers so that we can extract the changed states during `update_persistence` - self._conversation_handler_conversations: Dict[ + self._conversation_handler_conversations: dict[ str, TrackingDict[ConversationKey, object] ] = {} @@ -369,7 +353,7 @@ def __init__( self.__update_persistence_task: Optional[asyncio.Task] = None self.__update_persistence_event = asyncio.Event() self.__update_persistence_lock = asyncio.Lock() - self.__create_task_tasks: Set[asyncio.Task] = set() # Used for awaiting tasks upon exit + self.__create_task_tasks: set[asyncio.Task] = set() # Used for awaiting tasks upon exit self.__stop_running_marker = asyncio.Event() async def __aenter__(self: _AppType) -> _AppType: # noqa: PYI019 @@ -391,7 +375,7 @@ async def __aenter__(self: _AppType) -> _AppType: # noqa: PYI019 async def __aexit__( self, - exc_type: Optional[Type[BaseException]], + exc_type: Optional[type[BaseException]], exc_val: Optional[BaseException], exc_tb: Optional[TracebackType], ) -> None: @@ -762,7 +746,7 @@ def run_polling( write_timeout: ODVInput[float] = DEFAULT_NONE, connect_timeout: ODVInput[float] = DEFAULT_NONE, pool_timeout: ODVInput[float] = DEFAULT_NONE, - allowed_updates: Optional[List[str]] = None, + allowed_updates: Optional[list[str]] = None, drop_pending_updates: Optional[bool] = None, close_loop: bool = True, stop_signals: ODVInput[Sequence[int]] = DEFAULT_NONE, @@ -839,7 +823,7 @@ def run_polling( :meth:`telegram.ext.ApplicationBuilder.get_updates_pool_timeout`. drop_pending_updates (:obj:`bool`, optional): Whether to clean any pending updates on Telegram servers before actually starting to poll. Default is :obj:`False`. - allowed_updates (List[:obj:`str`], optional): Passed to + allowed_updates (list[:obj:`str`], optional): Passed to :meth:`telegram.Bot.get_updates`. close_loop (:obj:`bool`, optional): If :obj:`True`, the current event loop will be closed upon shutdown. Defaults to :obj:`True`. @@ -904,7 +888,7 @@ def run_webhook( key: Optional[Union[str, Path]] = None, bootstrap_retries: int = 0, webhook_url: Optional[str] = None, - allowed_updates: Optional[List[str]] = None, + allowed_updates: Optional[list[str]] = None, drop_pending_updates: Optional[bool] = None, ip_address: Optional[str] = None, max_connections: int = 40, @@ -970,7 +954,7 @@ def run_webhook( webhook_url (:obj:`str`, optional): Explicitly specify the webhook url. Useful behind NAT, reverse proxy, etc. Default is derived from :paramref:`listen`, :paramref:`port`, :paramref:`url_path`, :paramref:`cert`, and :paramref:`key`. - allowed_updates (List[:obj:`str`], optional): Passed to + allowed_updates (list[:obj:`str`], optional): Passed to :meth:`telegram.Bot.set_webhook`. drop_pending_updates (:obj:`bool`, optional): Whether to clean any pending updates on Telegram servers before actually starting to poll. Default is :obj:`False`. @@ -1421,7 +1405,7 @@ def add_handlers( self, handlers: Union[ Sequence[BaseHandler[Any, CCT, Any]], - Dict[int, Sequence[BaseHandler[Any, CCT, Any]]], + dict[int, Sequence[BaseHandler[Any, CCT, Any]]], ], group: Union[int, DefaultValue[int]] = _DEFAULT_0, ) -> None: @@ -1432,7 +1416,7 @@ def add_handlers( Args: handlers (Sequence[:class:`telegram.ext.BaseHandler`] | \ - Dict[int, Sequence[:class:`telegram.ext.BaseHandler`]]): + dict[int, Sequence[:class:`telegram.ext.BaseHandler`]]): Specify a sequence of handlers *or* a dictionary where the keys are groups and values are handlers. @@ -1693,7 +1677,7 @@ async def __update_persistence(self) -> None: _LOGGER.debug("Starting next run of updating the persistence.") - coroutines: Set[Coroutine] = set() + coroutines: set[Coroutine] = set() # Mypy doesn't know that persistence.set_bot (see above) already checks that # self.bot is an instance of ExtBot if callback_data should be stored ... diff --git a/telegram/ext/_applicationbuilder.py b/telegram/ext/_applicationbuilder.py index 838c47495c6..f4bfee761e1 100644 --- a/telegram/ext/_applicationbuilder.py +++ b/telegram/ext/_applicationbuilder.py @@ -18,20 +18,9 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains the Builder classes for the telegram.ext module.""" from asyncio import Queue +from collections.abc import Collection, Coroutine from pathlib import Path -from typing import ( - TYPE_CHECKING, - Any, - Callable, - Collection, - Coroutine, - Dict, - Generic, - Optional, - Type, - TypeVar, - Union, -) +from typing import TYPE_CHECKING, Any, Callable, Generic, Optional, TypeVar, Union import httpx @@ -212,8 +201,8 @@ def __init__(self: "InitApplicationBuilder"): self._persistence: ODVInput[BasePersistence] = DEFAULT_NONE self._context_types: DVType[ContextTypes] = DefaultValue(ContextTypes()) - self._application_class: DVType[Type[Application]] = DefaultValue(Application) - self._application_kwargs: Dict[str, object] = {} + self._application_class: DVType[type[Application]] = DefaultValue(Application) + self._application_kwargs: dict[str, object] = {} self._update_processor: BaseUpdateProcessor = SimpleUpdateProcessor( max_concurrent_updates=1 ) @@ -350,8 +339,8 @@ def build( def application_class( self: BuilderType, - application_class: Type[Application[Any, Any, Any, Any, Any, Any]], - kwargs: Optional[Dict[str, object]] = None, + application_class: type[Application[Any, Any, Any, Any, Any, Any]], + kwargs: Optional[dict[str, object]] = None, ) -> BuilderType: """Sets a custom subclass instead of :class:`telegram.ext.Application`. The subclass's ``__init__`` should look like this @@ -365,7 +354,7 @@ def __init__(self, custom_arg_1, custom_arg_2, ..., **kwargs): Args: application_class (:obj:`type`): A subclass of :class:`telegram.ext.Application` - kwargs (Dict[:obj:`str`, :obj:`object`], optional): Keyword arguments for the + kwargs (dict[:obj:`str`, :obj:`object`], optional): Keyword arguments for the initialization. Defaults to an empty dict. Returns: @@ -1397,9 +1386,9 @@ def rate_limiter( ApplicationBuilder[ # by Pylance correctly. ExtBot[None], ContextTypes.DEFAULT_TYPE, - Dict[Any, Any], - Dict[Any, Any], - Dict[Any, Any], + dict[Any, Any], + dict[Any, Any], + dict[Any, Any], JobQueue[ContextTypes.DEFAULT_TYPE], ] ) diff --git a/telegram/ext/_basepersistence.py b/telegram/ext/_basepersistence.py index 126437a0a48..9f919b14a79 100644 --- a/telegram/ext/_basepersistence.py +++ b/telegram/ext/_basepersistence.py @@ -18,7 +18,7 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains the BasePersistence class.""" from abc import ABC, abstractmethod -from typing import Dict, Generic, NamedTuple, NoReturn, Optional +from typing import Generic, NamedTuple, NoReturn, Optional from telegram._bot import Bot from telegram.ext._extbot import ExtBot @@ -184,7 +184,7 @@ def set_bot(self, bot: Bot) -> None: self.bot = bot @abstractmethod - async def get_user_data(self) -> Dict[int, UD]: + async def get_user_data(self) -> dict[int, UD]: """Will be called by :class:`telegram.ext.Application` upon creation with a persistence object. It should return the ``user_data`` if stored, or an empty :obj:`dict`. In the latter case, the dictionary should produce values @@ -198,12 +198,12 @@ async def get_user_data(self) -> Dict[int, UD]: This method may now return a :obj:`dict` instead of a :obj:`collections.defaultdict` Returns: - Dict[:obj:`int`, :obj:`dict` | :attr:`telegram.ext.ContextTypes.user_data`]: + dict[:obj:`int`, :obj:`dict` | :attr:`telegram.ext.ContextTypes.user_data`]: The restored user data. """ @abstractmethod - async def get_chat_data(self) -> Dict[int, CD]: + async def get_chat_data(self) -> dict[int, CD]: """Will be called by :class:`telegram.ext.Application` upon creation with a persistence object. It should return the ``chat_data`` if stored, or an empty :obj:`dict`. In the latter case, the dictionary should produce values @@ -217,7 +217,7 @@ async def get_chat_data(self) -> Dict[int, CD]: This method may now return a :obj:`dict` instead of a :obj:`collections.defaultdict` Returns: - Dict[:obj:`int`, :obj:`dict` | :attr:`telegram.ext.ContextTypes.chat_data`]: + dict[:obj:`int`, :obj:`dict` | :attr:`telegram.ext.ContextTypes.chat_data`]: The restored chat data. """ @@ -233,7 +233,7 @@ async def get_bot_data(self) -> BD: if :class:`telegram.ext.ContextTypes` are used. Returns: - Dict[:obj:`int`, :obj:`dict` | :attr:`telegram.ext.ContextTypes.bot_data`]: + dict[:obj:`int`, :obj:`dict` | :attr:`telegram.ext.ContextTypes.bot_data`]: The restored bot data. """ @@ -248,8 +248,8 @@ async def get_callback_data(self) -> Optional[CDCData]: Changed this method into an :external:func:`~abc.abstractmethod`. Returns: - Tuple[List[Tuple[:obj:`str`, :obj:`float`, Dict[:obj:`str`, :class:`object`]]], - Dict[:obj:`str`, :obj:`str`]] | :obj:`None`: The restored metadata or :obj:`None`, + tuple[list[tuple[:obj:`str`, :obj:`float`, dict[:obj:`str`, :class:`object`]]], + dict[:obj:`str`, :obj:`str`]] | :obj:`None`: The restored metadata or :obj:`None`, if no data was stored. """ @@ -324,8 +324,8 @@ async def update_callback_data(self, data: CDCData) -> None: Changed this method into an :external:func:`~abc.abstractmethod`. Args: - data (Tuple[List[Tuple[:obj:`str`, :obj:`float`, \ - Dict[:obj:`str`, :obj:`Any`]]], Dict[:obj:`str`, :obj:`str`]] | :obj:`None`): + data (tuple[list[tuple[:obj:`str`, :obj:`float`, \ + dict[:obj:`str`, :obj:`Any`]]], dict[:obj:`str`, :obj:`str`]] | :obj:`None`): The relevant data to restore :class:`telegram.ext.CallbackDataCache`. """ diff --git a/telegram/ext/_baseratelimiter.py b/telegram/ext/_baseratelimiter.py index 3d7a6afb1e5..df2478f2bc9 100644 --- a/telegram/ext/_baseratelimiter.py +++ b/telegram/ext/_baseratelimiter.py @@ -18,7 +18,8 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains a class that allows to rate limit requests to the Bot API.""" from abc import ABC, abstractmethod -from typing import Any, Callable, Coroutine, Dict, Generic, List, Optional, Union +from collections.abc import Coroutine +from typing import Any, Callable, Generic, Optional, Union from telegram._utils.types import JSONDict from telegram.ext._utils.types import RLARGS @@ -56,13 +57,13 @@ async def shutdown(self) -> None: @abstractmethod async def process_request( self, - callback: Callable[..., Coroutine[Any, Any, Union[bool, JSONDict, List[JSONDict]]]], + callback: Callable[..., Coroutine[Any, Any, Union[bool, JSONDict, list[JSONDict]]]], args: Any, - kwargs: Dict[str, Any], + kwargs: dict[str, Any], endpoint: str, - data: Dict[str, Any], + data: dict[str, Any], rate_limit_args: Optional[RLARGS], - ) -> Union[bool, JSONDict, List[JSONDict]]: + ) -> Union[bool, JSONDict, list[JSONDict]]: """ Process a request. Must be implemented by a subclass. @@ -107,13 +108,13 @@ async def process_request( Args: callback (Callable[..., :term:`coroutine`]): The coroutine function that must be called to make the request. - args (Tuple[:obj:`object`]): The positional arguments for the :paramref:`callback` + args (tuple[:obj:`object`]): The positional arguments for the :paramref:`callback` function. - kwargs (Dict[:obj:`str`, :obj:`object`]): The keyword arguments for the + kwargs (dict[:obj:`str`, :obj:`object`]): The keyword arguments for the :paramref:`callback` function. endpoint (:obj:`str`): The endpoint that the request is made for, e.g. ``"sendMessage"``. - data (Dict[:obj:`str`, :obj:`object`]): The parameters that were passed to the method + data (dict[:obj:`str`, :obj:`object`]): The parameters that were passed to the method of :class:`~telegram.ext.ExtBot`. Any ``api_kwargs`` are included in this and any :paramref:`~telegram.ext.ExtBot.defaults` are already applied. @@ -136,6 +137,6 @@ async def process_request( the request. Returns: - :obj:`bool` | Dict[:obj:`str`, :obj:`object`] | :obj:`None`: The result of the + :obj:`bool` | dict[:obj:`str`, :obj:`object`] | :obj:`None`: The result of the callback function. """ diff --git a/telegram/ext/_baseupdateprocessor.py b/telegram/ext/_baseupdateprocessor.py index 8e9af01fc3b..38228b6c81e 100644 --- a/telegram/ext/_baseupdateprocessor.py +++ b/telegram/ext/_baseupdateprocessor.py @@ -19,13 +19,17 @@ """This module contains the BaseProcessor class.""" from abc import ABC, abstractmethod from asyncio import BoundedSemaphore +from contextlib import AbstractAsyncContextManager from types import TracebackType -from typing import Any, AsyncContextManager, Awaitable, Optional, Type, TypeVar, final +from typing import TYPE_CHECKING, Any, Optional, TypeVar, final + +if TYPE_CHECKING: + from collections.abc import Awaitable _BUPT = TypeVar("_BUPT", bound="BaseUpdateProcessor") -class BaseUpdateProcessor(AsyncContextManager["BaseUpdateProcessor"], ABC): +class BaseUpdateProcessor(AbstractAsyncContextManager["BaseUpdateProcessor"], ABC): """An abstract base class for update processors. You can use this class to implement your own update processor. @@ -88,7 +92,7 @@ async def __aenter__(self: _BUPT) -> _BUPT: # noqa: PYI019 async def __aexit__( self, - exc_type: Optional[Type[BaseException]], + exc_type: Optional[type[BaseException]], exc_val: Optional[BaseException], exc_tb: Optional[TracebackType], ) -> None: diff --git a/telegram/ext/_callbackcontext.py b/telegram/ext/_callbackcontext.py index dfd2c3cc8d7..4a2bc6eb6f0 100644 --- a/telegram/ext/_callbackcontext.py +++ b/telegram/ext/_callbackcontext.py @@ -17,21 +17,10 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains the CallbackContext class.""" -from typing import ( - TYPE_CHECKING, - Any, - Awaitable, - Dict, - Generator, - Generic, - List, - Match, - NoReturn, - Optional, - Type, - TypeVar, - Union, -) + +from collections.abc import Awaitable, Generator +from re import Match +from typing import TYPE_CHECKING, Any, Generic, NoReturn, Optional, TypeVar, Union from telegram._callbackquery import CallbackQuery from telegram._update import Update @@ -105,11 +94,11 @@ class CallbackContext(Generic[BT, UD, CD, BD]): coroutine (:term:`awaitable`): Optional. Only present in error handlers if the error was caused by an awaitable run with :meth:`Application.create_task` or a handler callback with :attr:`block=False `. - matches (List[:meth:`re.Match `]): Optional. If the associated update + matches (list[:meth:`re.Match `]): Optional. If the associated update originated from a :class:`filters.Regex`, this will contain a list of match objects for every pattern where ``re.search(pattern, string)`` returned a match. Note that filters short circuit, so combined regex filters will not always be evaluated. - args (List[:obj:`str`]): Optional. Arguments passed to a command if the associated update + args (list[:obj:`str`]): Optional. Arguments passed to a command if the associated update is handled by :class:`telegram.ext.CommandHandler`, :class:`telegram.ext.PrefixHandler` or :class:`telegram.ext.StringCommandHandler`. It contains a list of the words in the text after the command, using any whitespace string as a delimiter. @@ -145,8 +134,8 @@ def __init__( self._application: Application[BT, ST, UD, CD, BD, Any] = application self._chat_id: Optional[int] = chat_id self._user_id: Optional[int] = user_id - self.args: Optional[List[str]] = None - self.matches: Optional[List[Match[str]]] = None + self.args: Optional[list[str]] = None + self.matches: Optional[list[Match[str]]] = None self.error: Optional[Exception] = None self.job: Optional[Job[Any]] = None self.coroutine: Optional[ @@ -282,7 +271,7 @@ def drop_callback_data(self, callback_query: CallbackQuery) -> None: @classmethod def from_error( - cls: Type["CCT"], + cls: type["CCT"], update: object, error: Exception, application: "Application[BT, CCT, UD, CD, BD, Any]", @@ -335,7 +324,7 @@ def from_error( @classmethod def from_update( - cls: Type["CCT"], + cls: type["CCT"], update: object, application: "Application[Any, CCT, Any, Any, Any, Any]", ) -> "CCT": @@ -365,7 +354,7 @@ def from_update( @classmethod def from_job( - cls: Type["CCT"], + cls: type["CCT"], job: "Job[CCT]", application: "Application[Any, CCT, Any, Any, Any, Any]", ) -> "CCT": @@ -387,11 +376,11 @@ def from_job( self.job = job return self - def update(self, data: Dict[str, object]) -> None: + def update(self, data: dict[str, object]) -> None: """Updates ``self.__slots__`` with the passed data. Args: - data (Dict[:obj:`str`, :obj:`object`]): The data. + data (dict[:obj:`str`, :obj:`object`]): The data. """ for key, value in data.items(): setattr(self, key, value) diff --git a/telegram/ext/_callbackdatacache.py b/telegram/ext/_callbackdatacache.py index 02aebde5cfd..97649d2eb91 100644 --- a/telegram/ext/_callbackdatacache.py +++ b/telegram/ext/_callbackdatacache.py @@ -18,8 +18,9 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains the CallbackDataCache class.""" import time +from collections.abc import MutableMapping from datetime import datetime -from typing import TYPE_CHECKING, Any, Dict, MutableMapping, Optional, Tuple, Union, cast +from typing import TYPE_CHECKING, Any, Optional, Union, cast from uuid import uuid4 try: @@ -70,7 +71,7 @@ def __init__(self, callback_data: Optional[str] = None) -> None: ) self.callback_data: Optional[str] = callback_data - def __reduce__(self) -> Tuple[type, Tuple[Optional[str]]]: # type: ignore[override] + def __reduce__(self) -> tuple[type, tuple[Optional[str]]]: # type: ignore[override] """Defines how to serialize the exception for pickle. See :py:meth:`object.__reduce__` for more info. @@ -87,7 +88,7 @@ def __init__( self, keyboard_uuid: str, access_time: Optional[float] = None, - button_data: Optional[Dict[str, object]] = None, + button_data: Optional[dict[str, object]] = None, ): self.keyboard_uuid = keyboard_uuid self.button_data = button_data or {} @@ -97,7 +98,7 @@ def update_access_time(self) -> None: """Updates the access time with the current time.""" self.access_time = time.time() - def to_tuple(self) -> Tuple[str, float, Dict[str, object]]: + def to_tuple(self) -> tuple[str, float, dict[str, object]]: """Gives a tuple representation consisting of the keyboard uuid, the access time and the button data. """ @@ -140,8 +141,8 @@ class CallbackDataCache: maxsize (:obj:`int`, optional): Maximum number of items in each of the internal mappings. Defaults to ``1024``. - persistent_data (Tuple[List[Tuple[:obj:`str`, :obj:`float`, \ - Dict[:obj:`str`, :class:`object`]]], Dict[:obj:`str`, :obj:`str`]], optional): \ + persistent_data (tuple[list[tuple[:obj:`str`, :obj:`float`, \ + dict[:obj:`str`, :class:`object`]]], dict[:obj:`str`, :obj:`str`]], optional): \ Data to initialize the cache with, as returned by \ :meth:`telegram.ext.BasePersistence.get_callback_data`. @@ -181,8 +182,8 @@ def load_persistence_data(self, persistent_data: CDCData) -> None: .. versionadded:: 20.0 Args: - persistent_data (Tuple[List[Tuple[:obj:`str`, :obj:`float`, \ - Dict[:obj:`str`, :class:`object`]]], Dict[:obj:`str`, :obj:`str`]], optional): \ + persistent_data (tuple[list[tuple[:obj:`str`, :obj:`float`, \ + dict[:obj:`str`, :class:`object`]]], dict[:obj:`str`, :obj:`str`]], optional): \ Data to load, as returned by \ :meth:`telegram.ext.BasePersistence.get_callback_data`. """ @@ -205,8 +206,8 @@ def maxsize(self) -> int: @property def persistence_data(self) -> CDCData: - """Tuple[List[Tuple[:obj:`str`, :obj:`float`, Dict[:obj:`str`, :class:`object`]]], - Dict[:obj:`str`, :obj:`str`]]: The data that needs to be persisted to allow + """tuple[list[tuple[:obj:`str`, :obj:`float`, dict[:obj:`str`, :class:`object`]]], + dict[:obj:`str`, :obj:`str`]]: The data that needs to be persisted to allow caching callback data across bot reboots. """ # While building a list/dict from the LRUCaches has linear runtime (in the number of @@ -269,7 +270,7 @@ def __put_button(callback_data: object, keyboard_data: _KeyboardData) -> str: def __get_keyboard_uuid_and_button_data( self, callback_data: str - ) -> Union[Tuple[str, object], Tuple[None, InvalidCallbackData]]: + ) -> Union[tuple[str, object], tuple[None, InvalidCallbackData]]: keyboard, button = self.extract_uuids(callback_data) try: # we get the values before calling update() in case KeyErrors are raised @@ -283,7 +284,7 @@ def __get_keyboard_uuid_and_button_data( return keyboard, button_data @staticmethod - def extract_uuids(callback_data: str) -> Tuple[str, str]: + def extract_uuids(callback_data: str) -> tuple[str, str]: """Extracts the keyboard uuid and the button uuid from the given :paramref:`callback_data`. Args: diff --git a/telegram/ext/_contexttypes.py b/telegram/ext/_contexttypes.py index 3754ff429a3..03495531d24 100644 --- a/telegram/ext/_contexttypes.py +++ b/telegram/ext/_contexttypes.py @@ -17,13 +17,13 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains the auxiliary class ContextTypes.""" -from typing import Any, Dict, Generic, Type, overload +from typing import Any, Generic, overload from telegram.ext._callbackcontext import CallbackContext from telegram.ext._extbot import ExtBot from telegram.ext._utils.types import BD, CCT, CD, UD -ADict = Dict[Any, Any] +ADict = dict[Any, Any] class ContextTypes(Generic[CCT, UD, CD, BD]): @@ -83,109 +83,109 @@ def __init__( ): ... @overload - def __init__(self: "ContextTypes[CCT, ADict, ADict, ADict]", context: Type[CCT]): ... + def __init__(self: "ContextTypes[CCT, ADict, ADict, ADict]", context: type[CCT]): ... @overload def __init__( self: "ContextTypes[CallbackContext[ExtBot[Any], UD, ADict, ADict], UD, ADict, ADict]", - user_data: Type[UD], + user_data: type[UD], ): ... @overload def __init__( self: "ContextTypes[CallbackContext[ExtBot[Any], ADict, CD, ADict], ADict, CD, ADict]", - chat_data: Type[CD], + chat_data: type[CD], ): ... @overload def __init__( self: "ContextTypes[CallbackContext[ExtBot[Any], ADict, ADict, BD], ADict, ADict, BD]", - bot_data: Type[BD], + bot_data: type[BD], ): ... @overload def __init__( - self: "ContextTypes[CCT, UD, ADict, ADict]", context: Type[CCT], user_data: Type[UD] + self: "ContextTypes[CCT, UD, ADict, ADict]", context: type[CCT], user_data: type[UD] ): ... @overload def __init__( - self: "ContextTypes[CCT, ADict, CD, ADict]", context: Type[CCT], chat_data: Type[CD] + self: "ContextTypes[CCT, ADict, CD, ADict]", context: type[CCT], chat_data: type[CD] ): ... @overload def __init__( - self: "ContextTypes[CCT, ADict, ADict, BD]", context: Type[CCT], bot_data: Type[BD] + self: "ContextTypes[CCT, ADict, ADict, BD]", context: type[CCT], bot_data: type[BD] ): ... @overload def __init__( self: "ContextTypes[CallbackContext[ExtBot[Any], UD, CD, ADict], UD, CD, ADict]", - user_data: Type[UD], - chat_data: Type[CD], + user_data: type[UD], + chat_data: type[CD], ): ... @overload def __init__( self: "ContextTypes[CallbackContext[ExtBot[Any], UD, ADict, BD], UD, ADict, BD]", - user_data: Type[UD], - bot_data: Type[BD], + user_data: type[UD], + bot_data: type[BD], ): ... @overload def __init__( self: "ContextTypes[CallbackContext[ExtBot[Any], ADict, CD, BD], ADict, CD, BD]", - chat_data: Type[CD], - bot_data: Type[BD], + chat_data: type[CD], + bot_data: type[BD], ): ... @overload def __init__( self: "ContextTypes[CCT, UD, CD, ADict]", - context: Type[CCT], - user_data: Type[UD], - chat_data: Type[CD], + context: type[CCT], + user_data: type[UD], + chat_data: type[CD], ): ... @overload def __init__( self: "ContextTypes[CCT, UD, ADict, BD]", - context: Type[CCT], - user_data: Type[UD], - bot_data: Type[BD], + context: type[CCT], + user_data: type[UD], + bot_data: type[BD], ): ... @overload def __init__( self: "ContextTypes[CCT, ADict, CD, BD]", - context: Type[CCT], - chat_data: Type[CD], - bot_data: Type[BD], + context: type[CCT], + chat_data: type[CD], + bot_data: type[BD], ): ... @overload def __init__( self: "ContextTypes[CallbackContext[ExtBot[Any], UD, CD, BD], UD, CD, BD]", - user_data: Type[UD], - chat_data: Type[CD], - bot_data: Type[BD], + user_data: type[UD], + chat_data: type[CD], + bot_data: type[BD], ): ... @overload def __init__( self: "ContextTypes[CCT, UD, CD, BD]", - context: Type[CCT], - user_data: Type[UD], - chat_data: Type[CD], - bot_data: Type[BD], + context: type[CCT], + user_data: type[UD], + chat_data: type[CD], + bot_data: type[BD], ): ... def __init__( # type: ignore[misc] self, - context: "Type[CallbackContext[ExtBot[Any], ADict, ADict, ADict]]" = CallbackContext, - bot_data: Type[ADict] = dict, - chat_data: Type[ADict] = dict, - user_data: Type[ADict] = dict, + context: "type[CallbackContext[ExtBot[Any], ADict, ADict, ADict]]" = CallbackContext, + bot_data: type[ADict] = dict, + chat_data: type[ADict] = dict, + user_data: type[ADict] = dict, ): if not issubclass(context, CallbackContext): raise TypeError("context must be a subclass of CallbackContext.") @@ -198,28 +198,28 @@ def __init__( # type: ignore[misc] self._user_data = user_data @property - def context(self) -> Type[CCT]: + def context(self) -> type[CCT]: """The type of the ``context`` argument of all (error-)handler callbacks and job callbacks. """ return self._context # type: ignore[return-value] @property - def bot_data(self) -> Type[BD]: + def bot_data(self) -> type[BD]: """The type of :attr:`context.bot_data ` of all (error-)handler callbacks and job callbacks. """ return self._bot_data # type: ignore[return-value] @property - def chat_data(self) -> Type[CD]: + def chat_data(self) -> type[CD]: """The type of :attr:`context.chat_data ` of all (error-)handler callbacks and job callbacks. """ return self._chat_data # type: ignore[return-value] @property - def user_data(self) -> Type[UD]: + def user_data(self) -> type[UD]: """The type of :attr:`context.user_data ` of all (error-)handler callbacks and job callbacks. """ diff --git a/telegram/ext/_defaults.py b/telegram/ext/_defaults.py index 100d54e6ef0..93e7e3748b8 100644 --- a/telegram/ext/_defaults.py +++ b/telegram/ext/_defaults.py @@ -18,7 +18,7 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains the class Defaults, which allows passing default values to Application.""" import datetime -from typing import Any, Dict, NoReturn, Optional, final +from typing import Any, NoReturn, Optional, final from telegram import LinkPreviewOptions from telegram._utils.datetime import UTC @@ -228,7 +228,7 @@ def __eq__(self, other: object) -> bool: return False @property - def api_defaults(self) -> Dict[str, Any]: # skip-cq: PY-D0003 + def api_defaults(self) -> dict[str, Any]: # skip-cq: PY-D0003 return self._api_defaults @property diff --git a/telegram/ext/_dictpersistence.py b/telegram/ext/_dictpersistence.py index d046561a253..1efce417e30 100644 --- a/telegram/ext/_dictpersistence.py +++ b/telegram/ext/_dictpersistence.py @@ -19,7 +19,7 @@ """This module contains the DictPersistence class.""" import json from copy import deepcopy -from typing import TYPE_CHECKING, Any, Dict, Optional, cast +from typing import TYPE_CHECKING, Any, Optional, cast from telegram.ext import BasePersistence, PersistenceInput from telegram.ext._utils.types import CDCData, ConversationDict, ConversationKey @@ -28,7 +28,7 @@ from telegram._utils.types import JSONDict -class DictPersistence(BasePersistence[Dict[Any, Any], Dict[Any, Any], Dict[Any, Any]]): +class DictPersistence(BasePersistence[dict[Any, Any], dict[Any, Any], dict[Any, Any]]): """Using Python's :obj:`dict` and :mod:`json` for making your bot persistent. Attention: @@ -170,7 +170,7 @@ def __init__( ) from exc @property - def user_data(self) -> Optional[Dict[int, Dict[Any, Any]]]: + def user_data(self) -> Optional[dict[int, dict[Any, Any]]]: """:obj:`dict`: The user_data as a dict.""" return self._user_data @@ -182,7 +182,7 @@ def user_data_json(self) -> str: return json.dumps(self.user_data) @property - def chat_data(self) -> Optional[Dict[int, Dict[Any, Any]]]: + def chat_data(self) -> Optional[dict[int, dict[Any, Any]]]: """:obj:`dict`: The chat_data as a dict.""" return self._chat_data @@ -194,7 +194,7 @@ def chat_data_json(self) -> str: return json.dumps(self.chat_data) @property - def bot_data(self) -> Optional[Dict[Any, Any]]: + def bot_data(self) -> Optional[dict[Any, Any]]: """:obj:`dict`: The bot_data as a dict.""" return self._bot_data @@ -207,8 +207,8 @@ def bot_data_json(self) -> str: @property def callback_data(self) -> Optional[CDCData]: - """Tuple[List[Tuple[:obj:`str`, :obj:`float`, Dict[:obj:`str`, :class:`object`]]], \ - Dict[:obj:`str`, :obj:`str`]]: The metadata on the stored callback data. + """tuple[list[tuple[:obj:`str`, :obj:`float`, dict[:obj:`str`, :class:`object`]]], \ + dict[:obj:`str`, :obj:`str`]]: The metadata on the stored callback data. .. versionadded:: 13.6 """ @@ -225,7 +225,7 @@ def callback_data_json(self) -> str: return json.dumps(self.callback_data) @property - def conversations(self) -> Optional[Dict[str, ConversationDict]]: + def conversations(self) -> Optional[dict[str, ConversationDict]]: """:obj:`dict`: The conversations as a dict.""" return self._conversations @@ -238,7 +238,7 @@ def conversations_json(self) -> str: return self._encode_conversations_to_json(self.conversations) return json.dumps(self.conversations) - async def get_user_data(self) -> Dict[int, Dict[object, object]]: + async def get_user_data(self) -> dict[int, dict[object, object]]: """Returns the user_data created from the ``user_data_json`` or an empty :obj:`dict`. Returns: @@ -248,7 +248,7 @@ async def get_user_data(self) -> Dict[int, Dict[object, object]]: self._user_data = {} return deepcopy(self.user_data) # type: ignore[arg-type] - async def get_chat_data(self) -> Dict[int, Dict[object, object]]: + async def get_chat_data(self) -> dict[int, dict[object, object]]: """Returns the chat_data created from the ``chat_data_json`` or an empty :obj:`dict`. Returns: @@ -258,7 +258,7 @@ async def get_chat_data(self) -> Dict[int, Dict[object, object]]: self._chat_data = {} return deepcopy(self.chat_data) # type: ignore[arg-type] - async def get_bot_data(self) -> Dict[object, object]: + async def get_bot_data(self) -> dict[object, object]: """Returns the bot_data created from the ``bot_data_json`` or an empty :obj:`dict`. Returns: @@ -274,8 +274,8 @@ async def get_callback_data(self) -> Optional[CDCData]: .. versionadded:: 13.6 Returns: - Tuple[List[Tuple[:obj:`str`, :obj:`float`, Dict[:obj:`str`, :class:`object`]]], \ - Dict[:obj:`str`, :obj:`str`]]: The restored metadata or :obj:`None`, \ + tuple[list[tuple[:obj:`str`, :obj:`float`, dict[:obj:`str`, :class:`object`]]], \ + dict[:obj:`str`, :obj:`str`]]: The restored metadata or :obj:`None`, \ if no data was stored. """ if self.callback_data is None: @@ -311,7 +311,7 @@ async def update_conversation( self._conversations[name][key] = new_state self._conversations_json = None - async def update_user_data(self, user_id: int, data: Dict[Any, Any]) -> None: + async def update_user_data(self, user_id: int, data: dict[Any, Any]) -> None: """Will update the user_data (if changed). Args: @@ -325,7 +325,7 @@ async def update_user_data(self, user_id: int, data: Dict[Any, Any]) -> None: self._user_data[user_id] = data self._user_data_json = None - async def update_chat_data(self, chat_id: int, data: Dict[Any, Any]) -> None: + async def update_chat_data(self, chat_id: int, data: dict[Any, Any]) -> None: """Will update the chat_data (if changed). Args: @@ -339,7 +339,7 @@ async def update_chat_data(self, chat_id: int, data: Dict[Any, Any]) -> None: self._chat_data[chat_id] = data self._chat_data_json = None - async def update_bot_data(self, data: Dict[Any, Any]) -> None: + async def update_bot_data(self, data: dict[Any, Any]) -> None: """Will update the bot_data (if changed). Args: @@ -356,8 +356,8 @@ async def update_callback_data(self, data: CDCData) -> None: .. versionadded:: 13.6 Args: - data (Tuple[List[Tuple[:obj:`str`, :obj:`float`, Dict[:obj:`str`, :class:`object`]]], \ - Dict[:obj:`str`, :obj:`str`]]): The relevant data to restore + data (tuple[list[tuple[:obj:`str`, :obj:`float`, dict[:obj:`str`, :class:`object`]]], \ + dict[:obj:`str`, :obj:`str`]]): The relevant data to restore :class:`telegram.ext.CallbackDataCache`. """ if self._callback_data == data: @@ -391,21 +391,21 @@ async def drop_user_data(self, user_id: int) -> None: self._user_data.pop(user_id, None) self._user_data_json = None - async def refresh_user_data(self, user_id: int, user_data: Dict[Any, Any]) -> None: + async def refresh_user_data(self, user_id: int, user_data: dict[Any, Any]) -> None: """Does nothing. .. versionadded:: 13.6 .. seealso:: :meth:`telegram.ext.BasePersistence.refresh_user_data` """ - async def refresh_chat_data(self, chat_id: int, chat_data: Dict[Any, Any]) -> None: + async def refresh_chat_data(self, chat_id: int, chat_data: dict[Any, Any]) -> None: """Does nothing. .. versionadded:: 13.6 .. seealso:: :meth:`telegram.ext.BasePersistence.refresh_chat_data` """ - async def refresh_bot_data(self, bot_data: Dict[Any, Any]) -> None: + async def refresh_bot_data(self, bot_data: dict[Any, Any]) -> None: """Does nothing. .. versionadded:: 13.6 @@ -420,7 +420,7 @@ async def flush(self) -> None: """ @staticmethod - def _encode_conversations_to_json(conversations: Dict[str, ConversationDict]) -> str: + def _encode_conversations_to_json(conversations: dict[str, ConversationDict]) -> str: """Helper method to encode a conversations dict (that uses tuples as keys) to a JSON-serializable way. Use :meth:`self._decode_conversations_from_json` to decode. @@ -430,7 +430,7 @@ def _encode_conversations_to_json(conversations: Dict[str, ConversationDict]) -> Returns: :obj:`str`: The JSON-serialized conversations dict """ - tmp: Dict[str, JSONDict] = {} + tmp: dict[str, JSONDict] = {} for handler, states in conversations.items(): tmp[handler] = {} for key, state in states.items(): @@ -438,7 +438,7 @@ def _encode_conversations_to_json(conversations: Dict[str, ConversationDict]) -> return json.dumps(tmp) @staticmethod - def _decode_conversations_from_json(json_string: str) -> Dict[str, ConversationDict]: + def _decode_conversations_from_json(json_string: str) -> dict[str, ConversationDict]: """Helper method to decode a conversations dict (that uses tuples as keys) from a JSON-string created with :meth:`self._encode_conversations_to_json`. @@ -449,7 +449,7 @@ def _decode_conversations_from_json(json_string: str) -> Dict[str, ConversationD :obj:`dict`: The conversations dict after decoding """ tmp = json.loads(json_string) - conversations: Dict[str, ConversationDict] = {} + conversations: dict[str, ConversationDict] = {} for handler, states in tmp.items(): conversations[handler] = {} for key, state in states.items(): @@ -457,7 +457,7 @@ def _decode_conversations_from_json(json_string: str) -> Dict[str, ConversationD return conversations @staticmethod - def _decode_user_chat_data_from_json(data: str) -> Dict[int, Dict[object, object]]: + def _decode_user_chat_data_from_json(data: str) -> dict[int, dict[object, object]]: """Helper method to decode chat or user data (that uses ints as keys) from a JSON-string. @@ -467,7 +467,7 @@ def _decode_user_chat_data_from_json(data: str) -> Dict[int, Dict[object, object Returns: :obj:`dict`: The user/chat_data defaultdict after decoding """ - tmp: Dict[int, Dict[object, object]] = {} + tmp: dict[int, dict[object, object]] = {} decoded_data = json.loads(data) for user, user_data in decoded_data.items(): int_user_id = int(user) diff --git a/telegram/ext/_extbot.py b/telegram/ext/_extbot.py index 3d91acf0d4f..2a4cdb2e4cb 100644 --- a/telegram/ext/_extbot.py +++ b/telegram/ext/_extbot.py @@ -18,19 +18,15 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains an object that represents a Telegram Bot with convenience extensions.""" +from collections.abc import Sequence from copy import copy from datetime import datetime from typing import ( TYPE_CHECKING, Any, Callable, - Dict, Generic, - List, Optional, - Sequence, - Tuple, - Type, TypeVar, Union, cast, @@ -267,7 +263,7 @@ def __repr__(self) -> str: def _warn( cls, message: Union[str, PTBUserWarning], - category: Type[Warning] = PTBUserWarning, + category: type[Warning] = PTBUserWarning, stacklevel: int = 0, ) -> None: """We override this method to add one more level to the stacklevel, so that the warning @@ -340,7 +336,7 @@ async def _do_post( write_timeout: ODVInput[float] = DEFAULT_NONE, connect_timeout: ODVInput[float] = DEFAULT_NONE, pool_timeout: ODVInput[float] = DEFAULT_NONE, - ) -> Union[bool, JSONDict, List[JSONDict]]: + ) -> Union[bool, JSONDict, list[JSONDict]]: """Order of method calls is: Bot.some_method -> Bot._post -> Bot._do_post. So we can override Bot._do_post to add rate limiting. """ @@ -421,7 +417,7 @@ def _merge_lpo_defaults( } ) - def _insert_defaults(self, data: Dict[str, object]) -> None: + def _insert_defaults(self, data: dict[str, object]) -> None: """Inserts the defaults values for optional kwargs for which tg.ext.Defaults provides convenience functionality, i.e. the kwargs with a tg.utils.helpers.DefaultValue default @@ -645,7 +641,7 @@ async def get_updates( connect_timeout: ODVInput[float] = DEFAULT_NONE, pool_timeout: ODVInput[float] = DEFAULT_NONE, api_kwargs: Optional[JSONDict] = None, - ) -> Tuple[Update, ...]: + ) -> tuple[Update, ...]: updates = await super().get_updates( offset=offset, limit=limit, @@ -670,7 +666,7 @@ def _effective_inline_results( ], next_offset: Optional[str] = None, current_offset: Optional[str] = None, - ) -> Tuple[Sequence["InlineQueryResult"], Optional[str]]: + ) -> tuple[Sequence["InlineQueryResult"], Optional[str]]: """This method is called by Bot.answer_inline_query to build the actual results list. Overriding this to call self._replace_keyboard suffices """ @@ -746,7 +742,7 @@ async def do_api_request( self, endpoint: str, api_kwargs: Optional[JSONDict] = None, - return_type: Optional[Type[TelegramObject]] = None, + return_type: Optional[type[TelegramObject]] = None, *, read_timeout: ODVInput[float] = DEFAULT_NONE, write_timeout: ODVInput[float] = DEFAULT_NONE, @@ -854,7 +850,7 @@ async def copy_messages( pool_timeout: ODVInput[float] = DEFAULT_NONE, api_kwargs: Optional[JSONDict] = None, rate_limit_args: Optional[RLARGS] = None, - ) -> Tuple["MessageId", ...]: + ) -> tuple["MessageId", ...]: # We override this method to call self._replace_keyboard return await super().copy_messages( chat_id=chat_id, @@ -1744,7 +1740,7 @@ async def forward_messages( pool_timeout: ODVInput[float] = DEFAULT_NONE, api_kwargs: Optional[JSONDict] = None, rate_limit_args: Optional[RLARGS] = None, - ) -> Tuple[MessageId, ...]: + ) -> tuple[MessageId, ...]: return await super().forward_messages( chat_id=chat_id, from_chat_id=from_chat_id, @@ -1769,7 +1765,7 @@ async def get_chat_administrators( pool_timeout: ODVInput[float] = DEFAULT_NONE, api_kwargs: Optional[JSONDict] = None, rate_limit_args: Optional[RLARGS] = None, - ) -> Tuple[ChatMember, ...]: + ) -> tuple[ChatMember, ...]: return await super().get_chat_administrators( chat_id=chat_id, read_timeout=read_timeout, @@ -1872,7 +1868,7 @@ async def get_forum_topic_icon_stickers( pool_timeout: ODVInput[float] = DEFAULT_NONE, api_kwargs: Optional[JSONDict] = None, rate_limit_args: Optional[RLARGS] = None, - ) -> Tuple[Sticker, ...]: + ) -> tuple[Sticker, ...]: return await super().get_forum_topic_icon_stickers( read_timeout=read_timeout, write_timeout=write_timeout, @@ -1894,7 +1890,7 @@ async def get_game_high_scores( pool_timeout: ODVInput[float] = DEFAULT_NONE, api_kwargs: Optional[JSONDict] = None, rate_limit_args: Optional[RLARGS] = None, - ) -> Tuple[GameHighScore, ...]: + ) -> tuple[GameHighScore, ...]: return await super().get_game_high_scores( user_id=user_id, chat_id=chat_id, @@ -1936,7 +1932,7 @@ async def get_my_commands( pool_timeout: ODVInput[float] = DEFAULT_NONE, api_kwargs: Optional[JSONDict] = None, rate_limit_args: Optional[RLARGS] = None, - ) -> Tuple[BotCommand, ...]: + ) -> tuple[BotCommand, ...]: return await super().get_my_commands( scope=scope, language_code=language_code, @@ -1997,7 +1993,7 @@ async def get_custom_emoji_stickers( pool_timeout: ODVInput[float] = DEFAULT_NONE, api_kwargs: Optional[JSONDict] = None, rate_limit_args: Optional[RLARGS] = None, - ) -> Tuple[Sticker, ...]: + ) -> tuple[Sticker, ...]: return await super().get_custom_emoji_stickers( custom_emoji_ids=custom_emoji_ids, read_timeout=read_timeout, @@ -2859,7 +2855,7 @@ async def send_media_group( caption: Optional[str] = None, parse_mode: ODVInput[str] = DEFAULT_NONE, caption_entities: Optional[Sequence["MessageEntity"]] = None, - ) -> Tuple[Message, ...]: + ) -> tuple[Message, ...]: return await super().send_media_group( chat_id=chat_id, media=media, @@ -3497,7 +3493,7 @@ async def set_game_score( async def set_my_commands( self, - commands: Sequence[Union[BotCommand, Tuple[str, str]]], + commands: Sequence[Union[BotCommand, tuple[str, str]]], scope: Optional[BotCommandScope] = None, language_code: Optional[str] = None, *, diff --git a/telegram/ext/_handlers/callbackqueryhandler.py b/telegram/ext/_handlers/callbackqueryhandler.py index 5e0a0a12aa0..4aa36c28769 100644 --- a/telegram/ext/_handlers/callbackqueryhandler.py +++ b/telegram/ext/_handlers/callbackqueryhandler.py @@ -19,7 +19,8 @@ """This module contains the CallbackQueryHandler class.""" import asyncio import re -from typing import TYPE_CHECKING, Any, Callable, Match, Optional, Pattern, TypeVar, Union, cast +from re import Match, Pattern +from typing import TYPE_CHECKING, Any, Callable, Optional, TypeVar, Union, cast from telegram import Update from telegram._utils.defaultvalue import DEFAULT_TRUE diff --git a/telegram/ext/_handlers/choseninlineresulthandler.py b/telegram/ext/_handlers/choseninlineresulthandler.py index feac28ba658..538bc430852 100644 --- a/telegram/ext/_handlers/choseninlineresulthandler.py +++ b/telegram/ext/_handlers/choseninlineresulthandler.py @@ -18,7 +18,8 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains the ChosenInlineResultHandler class.""" import re -from typing import TYPE_CHECKING, Any, Match, Optional, Pattern, TypeVar, Union, cast +from re import Match, Pattern +from typing import TYPE_CHECKING, Any, Optional, TypeVar, Union, cast from telegram import Update from telegram._utils.defaultvalue import DEFAULT_TRUE diff --git a/telegram/ext/_handlers/commandhandler.py b/telegram/ext/_handlers/commandhandler.py index 54d01acd6d0..894f897094e 100644 --- a/telegram/ext/_handlers/commandhandler.py +++ b/telegram/ext/_handlers/commandhandler.py @@ -18,7 +18,7 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains the CommandHandler class.""" import re -from typing import TYPE_CHECKING, Any, FrozenSet, List, Optional, Tuple, TypeVar, Union +from typing import TYPE_CHECKING, Any, Optional, TypeVar, Union from telegram import MessageEntity, Update from telegram._utils.defaultvalue import DEFAULT_TRUE @@ -101,7 +101,7 @@ async def callback(update: Update, context: CallbackContext) :exc:`ValueError`: When the command is too long or has illegal chars. Attributes: - commands (FrozenSet[:obj:`str`]): The set of commands this handler should listen for. + commands (frozenset[:obj:`str`]): The set of commands this handler should listen for. callback (:term:`coroutine function`): The callback function for this handler. filters (:class:`telegram.ext.filters.BaseFilter`): Optional. Only allow updates with these filters. @@ -134,7 +134,7 @@ def __init__( for comm in commands: if not re.match(r"^[\da-z_]{1,32}$", comm): raise ValueError(f"Command `{comm}` is not a valid bot command") - self.commands: FrozenSet[str] = commands + self.commands: frozenset[str] = commands self.filters: filters_module.BaseFilter = ( filters if filters is not None else filters_module.UpdateType.MESSAGES @@ -145,7 +145,7 @@ def __init__( if (isinstance(self.has_args, int)) and (self.has_args < 0): raise ValueError("CommandHandler argument has_args cannot be a negative integer") - def _check_correct_args(self, args: List[str]) -> Optional[bool]: + def _check_correct_args(self, args: list[str]) -> Optional[bool]: """Determines whether the args are correct for this handler. Implemented in check_update(). Args: args (:obj:`list`): The args for the handler. @@ -161,7 +161,7 @@ def _check_correct_args(self, args: List[str]) -> Optional[bool]: def check_update( self, update: object - ) -> Optional[Union[bool, Tuple[List[str], Optional[Union[bool, FilterDataDict]]]]]: + ) -> Optional[Union[bool, tuple[list[str], Optional[Union[bool, FilterDataDict]]]]]: """Determines whether an update should be passed to this handler's :attr:`callback`. Args: @@ -206,7 +206,7 @@ def collect_additional_context( context: CCT, update: Update, # noqa: ARG002 application: "Application[Any, CCT, Any, Any, Any, Any]", # noqa: ARG002 - check_result: Optional[Union[bool, Tuple[List[str], Optional[bool]]]], + check_result: Optional[Union[bool, tuple[list[str], Optional[bool]]]], ) -> None: """Add text after the command to :attr:`CallbackContext.args` as list, split on single whitespaces and add output of data filters to :attr:`CallbackContext` as well. diff --git a/telegram/ext/_handlers/conversationhandler.py b/telegram/ext/_handlers/conversationhandler.py index 83fa373fc61..1cb9564ea4d 100644 --- a/telegram/ext/_handlers/conversationhandler.py +++ b/telegram/ext/_handlers/conversationhandler.py @@ -20,20 +20,7 @@ import asyncio import datetime from dataclasses import dataclass -from typing import ( - TYPE_CHECKING, - Any, - Dict, - Final, - Generic, - List, - NoReturn, - Optional, - Set, - Tuple, - Union, - cast, -) +from typing import TYPE_CHECKING, Any, Final, Generic, NoReturn, Optional, Union, cast from telegram import Update from telegram._utils.defaultvalue import DEFAULT_TRUE, DefaultValue @@ -55,7 +42,7 @@ if TYPE_CHECKING: from telegram.ext import Application, Job, JobQueue -_CheckUpdateType = Tuple[object, ConversationKey, BaseHandler[Update, CCT, object], object] +_CheckUpdateType = tuple[object, ConversationKey, BaseHandler[Update, CCT, object], object] _LOGGER = get_logger(__name__, class_name="ConversationHandler") @@ -192,16 +179,16 @@ class ConversationHandler(BaseHandler[Update, CCT, object]): * :any:`Persistent Conversation Bot ` Args: - entry_points (List[:class:`telegram.ext.BaseHandler`]): A list of :obj:`BaseHandler` + entry_points (list[:class:`telegram.ext.BaseHandler`]): A list of :obj:`BaseHandler` objects that can trigger the start of the conversation. The first handler whose :meth:`check_update` method returns :obj:`True` will be used. If all return :obj:`False`, the update is not handled. - states (Dict[:obj:`object`, List[:class:`telegram.ext.BaseHandler`]]): A :obj:`dict` that + states (dict[:obj:`object`, list[:class:`telegram.ext.BaseHandler`]]): A :obj:`dict` that defines the different states of conversation a user can be in and one or more associated :obj:`BaseHandler` objects that should be used in that state. The first handler whose :meth:`check_update` method returns :obj:`True` will be used. - fallbacks (List[:class:`telegram.ext.BaseHandler`]): A list of handlers that might be used + fallbacks (list[:class:`telegram.ext.BaseHandler`]): A list of handlers that might be used if the user is in a conversation, but every handler for their current state returned :obj:`False` on :meth:`check_update`. The first handler which :meth:`check_update` method returns :obj:`True` will be used. If all return :obj:`False`, the update is not @@ -238,7 +225,7 @@ class ConversationHandler(BaseHandler[Update, CCT, object]): .. versionchanged:: 20.0 Was previously named as ``persistence``. - map_to_parent (Dict[:obj:`object`, :obj:`object`], optional): A :obj:`dict` that can be + map_to_parent (dict[:obj:`object`, :obj:`object`], optional): A :obj:`dict` that can be used to instruct a child conversation handler to transition into a mapped state on its parent conversation handler in place of a specified nested state. block (:obj:`bool`, optional): Pass :obj:`False` or :obj:`True` to set a default value for @@ -297,9 +284,9 @@ class ConversationHandler(BaseHandler[Update, CCT, object]): # pylint: disable=super-init-not-called def __init__( self: "ConversationHandler[CCT]", - entry_points: List[BaseHandler[Update, CCT, object]], - states: Dict[object, List[BaseHandler[Update, CCT, object]]], - fallbacks: List[BaseHandler[Update, CCT, object]], + entry_points: list[BaseHandler[Update, CCT, object]], + states: dict[object, list[BaseHandler[Update, CCT, object]]], + fallbacks: list[BaseHandler[Update, CCT, object]], allow_reentry: bool = False, per_chat: bool = True, per_user: bool = True, @@ -307,7 +294,7 @@ def __init__( conversation_timeout: Optional[Union[float, datetime.timedelta]] = None, name: Optional[str] = None, persistent: bool = False, - map_to_parent: Optional[Dict[object, object]] = None, + map_to_parent: Optional[dict[object, object]] = None, block: DVType[bool] = DEFAULT_TRUE, ): # these imports need to be here because of circular import error otherwise @@ -324,9 +311,9 @@ def __init__( # Store the actual setting in a protected variable instead self._block: DVType[bool] = block - self._entry_points: List[BaseHandler[Update, CCT, object]] = entry_points - self._states: Dict[object, List[BaseHandler[Update, CCT, object]]] = states - self._fallbacks: List[BaseHandler[Update, CCT, object]] = fallbacks + self._entry_points: list[BaseHandler[Update, CCT, object]] = entry_points + self._states: dict[object, list[BaseHandler[Update, CCT, object]]] = states + self._fallbacks: list[BaseHandler[Update, CCT, object]] = fallbacks self._allow_reentry: bool = allow_reentry self._per_user: bool = per_user @@ -336,14 +323,14 @@ def __init__( conversation_timeout ) self._name: Optional[str] = name - self._map_to_parent: Optional[Dict[object, object]] = map_to_parent + self._map_to_parent: Optional[dict[object, object]] = map_to_parent # if conversation_timeout is used, this dict is used to schedule a job which runs when the # conv has timed out. - self.timeout_jobs: Dict[ConversationKey, Job[Any]] = {} + self.timeout_jobs: dict[ConversationKey, Job[Any]] = {} self._timeout_jobs_lock = asyncio.Lock() self._conversations: ConversationDict = {} - self._child_conversations: Set[ConversationHandler] = set() + self._child_conversations: set[ConversationHandler] = set() if persistent and not self.name: raise ValueError("Conversations can't be persistent when handler is unnamed.") @@ -359,7 +346,7 @@ def __init__( stacklevel=2, ) - all_handlers: List[BaseHandler[Update, CCT, object]] = [] + all_handlers: list[BaseHandler[Update, CCT, object]] = [] all_handlers.extend(entry_points) all_handlers.extend(fallbacks) @@ -466,8 +453,8 @@ def __repr__(self) -> str: ) @property - def entry_points(self) -> List[BaseHandler[Update, CCT, object]]: - """List[:class:`telegram.ext.BaseHandler`]: A list of :obj:`BaseHandler` objects that can + def entry_points(self) -> list[BaseHandler[Update, CCT, object]]: + """list[:class:`telegram.ext.BaseHandler`]: A list of :obj:`BaseHandler` objects that can trigger the start of the conversation. """ return self._entry_points @@ -479,8 +466,8 @@ def entry_points(self, _: object) -> NoReturn: ) @property - def states(self) -> Dict[object, List[BaseHandler[Update, CCT, object]]]: - """Dict[:obj:`object`, List[:class:`telegram.ext.BaseHandler`]]: A :obj:`dict` that + def states(self) -> dict[object, list[BaseHandler[Update, CCT, object]]]: + """dict[:obj:`object`, list[:class:`telegram.ext.BaseHandler`]]: A :obj:`dict` that defines the different states of conversation a user can be in and one or more associated :obj:`BaseHandler` objects that should be used in that state. """ @@ -491,8 +478,8 @@ def states(self, _: object) -> NoReturn: raise AttributeError("You can not assign a new value to states after initialization.") @property - def fallbacks(self) -> List[BaseHandler[Update, CCT, object]]: - """List[:class:`telegram.ext.BaseHandler`]: A list of handlers that might be used if + def fallbacks(self) -> list[BaseHandler[Update, CCT, object]]: + """list[:class:`telegram.ext.BaseHandler`]: A list of handlers that might be used if the user is in a conversation, but every handler for their current state returned :obj:`False` on :meth:`check_update`. """ @@ -578,8 +565,8 @@ def persistent(self, _: object) -> NoReturn: raise AttributeError("You can not assign a new value to persistent after initialization.") @property - def map_to_parent(self) -> Optional[Dict[object, object]]: - """Dict[:obj:`object`, :obj:`object`]: Optional. A :obj:`dict` that can be + def map_to_parent(self) -> Optional[dict[object, object]]: + """dict[:obj:`object`, :obj:`object`]: Optional. A :obj:`dict` that can be used to instruct a nested :class:`ConversationHandler` to transition into a mapped state on its parent :class:`ConversationHandler` in place of a specified nested state. """ @@ -593,7 +580,7 @@ def map_to_parent(self, _: object) -> NoReturn: async def _initialize_persistence( self, application: "Application" - ) -> Dict[str, TrackingDict[ConversationKey, object]]: + ) -> dict[str, TrackingDict[ConversationKey, object]]: """Initializes the persistence for this handler and its child conversations. While this method is marked as protected, we expect it to be called by the Application/parent conversations. It's just protected to hide it from users. @@ -648,7 +635,7 @@ def _get_key(self, update: Update) -> ConversationKey: chat = update.effective_chat user = update.effective_user - key: List[Union[int, str]] = [] + key: list[Union[int, str]] = [] if self.per_chat: if chat is None: diff --git a/telegram/ext/_handlers/inlinequeryhandler.py b/telegram/ext/_handlers/inlinequeryhandler.py index 9d2cbb710b2..4c52417f601 100644 --- a/telegram/ext/_handlers/inlinequeryhandler.py +++ b/telegram/ext/_handlers/inlinequeryhandler.py @@ -18,7 +18,8 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains the InlineQueryHandler class.""" import re -from typing import TYPE_CHECKING, Any, List, Match, Optional, Pattern, TypeVar, Union, cast +from re import Match, Pattern +from typing import TYPE_CHECKING, Any, Optional, TypeVar, Union, cast from telegram import Update from telegram._utils.defaultvalue import DEFAULT_TRUE @@ -67,7 +68,7 @@ async def callback(update: Update, context: CallbackContext) :meth:`telegram.ext.Application.process_update`. Defaults to :obj:`True`. .. seealso:: :wiki:`Concurrency` - chat_types (List[:obj:`str`], optional): List of allowed chat types. If passed, will only + chat_types (list[:obj:`str`], optional): List of allowed chat types. If passed, will only handle inline queries with the appropriate :attr:`telegram.InlineQuery.chat_type`. .. versionadded:: 13.5 @@ -75,7 +76,7 @@ async def callback(update: Update, context: CallbackContext) callback (:term:`coroutine function`): The callback function for this handler. pattern (:obj:`str` | :func:`re.Pattern `): Optional. Regex pattern to test :attr:`telegram.InlineQuery.query` against. - chat_types (List[:obj:`str`]): Optional. List of allowed chat types. + chat_types (list[:obj:`str`]): Optional. List of allowed chat types. .. versionadded:: 13.5 block (:obj:`bool`): Determines whether the return value of the callback should be @@ -91,7 +92,7 @@ def __init__( callback: HandlerCallback[Update, CCT, RT], pattern: Optional[Union[str, Pattern[str]]] = None, block: DVType[bool] = DEFAULT_TRUE, - chat_types: Optional[List[str]] = None, + chat_types: Optional[list[str]] = None, ): super().__init__(callback, block=block) @@ -99,7 +100,7 @@ def __init__( pattern = re.compile(pattern) self.pattern: Optional[Union[str, Pattern[str]]] = pattern - self.chat_types: Optional[List[str]] = chat_types + self.chat_types: Optional[list[str]] = chat_types def check_update(self, update: object) -> Optional[Union[bool, Match[str]]]: """ diff --git a/telegram/ext/_handlers/messagehandler.py b/telegram/ext/_handlers/messagehandler.py index 43d8c8d8115..e613f4d3638 100644 --- a/telegram/ext/_handlers/messagehandler.py +++ b/telegram/ext/_handlers/messagehandler.py @@ -17,7 +17,7 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains the MessageHandler class.""" -from typing import TYPE_CHECKING, Any, Dict, List, Optional, TypeVar, Union +from typing import TYPE_CHECKING, Any, Optional, TypeVar, Union from telegram import Update from telegram._utils.defaultvalue import DEFAULT_TRUE @@ -85,7 +85,7 @@ def __init__( filters if filters is not None else filters_module.ALL ) - def check_update(self, update: object) -> Optional[Union[bool, Dict[str, List[Any]]]]: + def check_update(self, update: object) -> Optional[Union[bool, dict[str, list[Any]]]]: """Determines whether an update should be passed to this handler's :attr:`callback`. Args: @@ -104,7 +104,7 @@ def collect_additional_context( context: CCT, update: Update, # noqa: ARG002 application: "Application[Any, CCT, Any, Any, Any, Any]", # noqa: ARG002 - check_result: Optional[Union[bool, Dict[str, object]]], + check_result: Optional[Union[bool, dict[str, object]]], ) -> None: """Adds possible output of data filters to the :class:`CallbackContext`.""" if isinstance(check_result, dict): diff --git a/telegram/ext/_handlers/precheckoutqueryhandler.py b/telegram/ext/_handlers/precheckoutqueryhandler.py index de035364ec9..265351ed339 100644 --- a/telegram/ext/_handlers/precheckoutqueryhandler.py +++ b/telegram/ext/_handlers/precheckoutqueryhandler.py @@ -20,7 +20,8 @@ import re -from typing import Optional, Pattern, TypeVar, Union +from re import Pattern +from typing import Optional, TypeVar, Union from telegram import Update from telegram._utils.defaultvalue import DEFAULT_TRUE diff --git a/telegram/ext/_handlers/prefixhandler.py b/telegram/ext/_handlers/prefixhandler.py index bda265e1056..c68c6fd8c05 100644 --- a/telegram/ext/_handlers/prefixhandler.py +++ b/telegram/ext/_handlers/prefixhandler.py @@ -18,7 +18,7 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains the PrefixHandler class.""" import itertools -from typing import TYPE_CHECKING, Any, Dict, FrozenSet, List, Optional, Tuple, TypeVar, Union +from typing import TYPE_CHECKING, Any, Optional, TypeVar, Union from telegram import Update from telegram._utils.defaultvalue import DEFAULT_TRUE @@ -108,7 +108,7 @@ async def callback(update: Update, context: CallbackContext) .. seealso:: :wiki:`Concurrency` Attributes: - commands (FrozenSet[:obj:`str`]): The commands that this handler will listen for, i.e. the + commands (frozenset[:obj:`str`]): The commands that this handler will listen for, i.e. the combinations of :paramref:`prefix` and :paramref:`command`. callback (:term:`coroutine function`): The callback function for this handler. filters (:class:`telegram.ext.filters.BaseFilter`): Optional. Only allow updates with these @@ -136,7 +136,7 @@ def __init__( commands = {command.lower()} if isinstance(command, str) else {x.lower() for x in command} - self.commands: FrozenSet[str] = frozenset( + self.commands: frozenset[str] = frozenset( p + c for p, c in itertools.product(prefixes, commands) ) self.filters: filters_module.BaseFilter = ( @@ -145,7 +145,7 @@ def __init__( def check_update( self, update: object - ) -> Optional[Union[bool, Tuple[List[str], Optional[Union[bool, Dict[Any, Any]]]]]]: + ) -> Optional[Union[bool, tuple[list[str], Optional[Union[bool, dict[Any, Any]]]]]]: """Determines whether an update should be passed to this handler's :attr:`callback`. Args: @@ -173,7 +173,7 @@ def collect_additional_context( context: CCT, update: Update, # noqa: ARG002 application: "Application[Any, CCT, Any, Any, Any, Any]", # noqa: ARG002 - check_result: Optional[Union[bool, Tuple[List[str], Optional[bool]]]], + check_result: Optional[Union[bool, tuple[list[str], Optional[bool]]]], ) -> None: """Add text after the command to :attr:`CallbackContext.args` as list, split on single whitespaces and add output of data filters to :attr:`CallbackContext` as well. diff --git a/telegram/ext/_handlers/stringcommandhandler.py b/telegram/ext/_handlers/stringcommandhandler.py index ff655d9d6c4..22d34c555f2 100644 --- a/telegram/ext/_handlers/stringcommandhandler.py +++ b/telegram/ext/_handlers/stringcommandhandler.py @@ -18,7 +18,7 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains the StringCommandHandler class.""" -from typing import TYPE_CHECKING, Any, List, Optional +from typing import TYPE_CHECKING, Any, Optional from telegram._utils.defaultvalue import DEFAULT_TRUE from telegram._utils.types import DVType @@ -79,14 +79,14 @@ def __init__( super().__init__(callback, block=block) self.command: str = command - def check_update(self, update: object) -> Optional[List[str]]: + def check_update(self, update: object) -> Optional[list[str]]: """Determines whether an update should be passed to this handler's :attr:`callback`. Args: update (:obj:`object`): The incoming update. Returns: - List[:obj:`str`]: List containing the text command split on whitespace. + list[:obj:`str`]: List containing the text command split on whitespace. """ if isinstance(update, str) and update.startswith("/"): @@ -100,7 +100,7 @@ def collect_additional_context( context: CCT, update: str, # noqa: ARG002 application: "Application[Any, CCT, Any, Any, Any, Any]", # noqa: ARG002 - check_result: Optional[List[str]], + check_result: Optional[list[str]], ) -> None: """Add text after the command to :attr:`CallbackContext.args` as list, split on single whitespaces. diff --git a/telegram/ext/_handlers/stringregexhandler.py b/telegram/ext/_handlers/stringregexhandler.py index bd97469495a..f5c0c64a862 100644 --- a/telegram/ext/_handlers/stringregexhandler.py +++ b/telegram/ext/_handlers/stringregexhandler.py @@ -19,7 +19,8 @@ """This module contains the StringRegexHandler class.""" import re -from typing import TYPE_CHECKING, Any, Match, Optional, Pattern, TypeVar, Union +from re import Match, Pattern +from typing import TYPE_CHECKING, Any, Optional, TypeVar, Union from telegram._utils.defaultvalue import DEFAULT_TRUE from telegram._utils.types import DVType diff --git a/telegram/ext/_handlers/typehandler.py b/telegram/ext/_handlers/typehandler.py index 48a4530bcfa..f473f2a5f3b 100644 --- a/telegram/ext/_handlers/typehandler.py +++ b/telegram/ext/_handlers/typehandler.py @@ -18,7 +18,7 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains the TypeHandler class.""" -from typing import Optional, Type, TypeVar +from typing import Optional, TypeVar from telegram._utils.defaultvalue import DEFAULT_TRUE from telegram._utils.types import DVType @@ -27,6 +27,9 @@ RT = TypeVar("RT") UT = TypeVar("UT") +# If this is written directly next to the type variable mypy gets confused with [valid-type]. This +# could be reported to them, but I doubt they would change this since we override a builtin type +GenericUT = type[UT] class TypeHandler(BaseHandler[UT, CCT, RT]): @@ -71,13 +74,13 @@ async def callback(update: object, context: CallbackContext) def __init__( self: "TypeHandler[UT, CCT, RT]", - type: Type[UT], # pylint: disable=redefined-builtin + type: GenericUT[UT], # pylint: disable=redefined-builtin callback: HandlerCallback[UT, CCT, RT], strict: bool = False, block: DVType[bool] = DEFAULT_TRUE, ): super().__init__(callback, block=block) - self.type: Type[UT] = type + self.type: GenericUT[UT] = type self.strict: Optional[bool] = strict def check_update(self, update: object) -> bool: diff --git a/telegram/ext/_jobqueue.py b/telegram/ext/_jobqueue.py index db84841d5be..b73d0545e22 100644 --- a/telegram/ext/_jobqueue.py +++ b/telegram/ext/_jobqueue.py @@ -20,7 +20,7 @@ import asyncio import datetime import weakref -from typing import TYPE_CHECKING, Any, Generic, Optional, Tuple, Union, cast, overload +from typing import TYPE_CHECKING, Any, Generic, Optional, Union, cast, overload try: import pytz @@ -152,7 +152,7 @@ def scheduler_configuration(self) -> JSONDict: .. versionadded:: 20.7 Returns: - Dict[:obj:`str`, :obj:`object`]: The configuration values as dictionary. + dict[:obj:`str`, :obj:`object`]: The configuration values as dictionary. """ timezone: object = pytz.utc @@ -532,7 +532,7 @@ def run_daily( self, callback: JobCallback[CCT], time: datetime.time, - days: Tuple[int, ...] = _ALL_DAYS, + days: tuple[int, ...] = _ALL_DAYS, data: Optional[object] = None, name: Optional[str] = None, chat_id: Optional[int] = None, @@ -556,7 +556,7 @@ async def callback(context: CallbackContext) time (:obj:`datetime.time`): Time of day at which the job should run. If the timezone (:obj:`datetime.time.tzinfo`) is :obj:`None`, the default timezone of the bot will be used, which is UTC unless :attr:`telegram.ext.Defaults.tzinfo` is used. - days (Tuple[:obj:`int`], optional): Defines on which days of the week the job should + days (tuple[:obj:`int`], optional): Defines on which days of the week the job should run (where ``0-6`` correspond to sunday - saturday). By default, the job will run every day. @@ -693,20 +693,20 @@ async def stop(self, wait: bool = True) -> None: # so give it a tiny bit of time to actually shut down. await asyncio.sleep(0.01) - def jobs(self) -> Tuple["Job[CCT]", ...]: + def jobs(self) -> tuple["Job[CCT]", ...]: """Returns a tuple of all *scheduled* jobs that are currently in the :class:`JobQueue`. Returns: - Tuple[:class:`Job`]: Tuple of all *scheduled* jobs. + tuple[:class:`Job`]: Tuple of all *scheduled* jobs. """ return tuple(Job.from_aps_job(job) for job in self.scheduler.get_jobs()) - def get_jobs_by_name(self, name: str) -> Tuple["Job[CCT]", ...]: + def get_jobs_by_name(self, name: str) -> tuple["Job[CCT]", ...]: """Returns a tuple of all *pending/scheduled* jobs with the given name that are currently in the :class:`JobQueue`. Returns: - Tuple[:class:`Job`]: Tuple of all *pending* or *scheduled* jobs matching the name. + tuple[:class:`Job`]: Tuple of all *pending* or *scheduled* jobs matching the name. """ return tuple(job for job in self.jobs() if job.name == name) diff --git a/telegram/ext/_picklepersistence.py b/telegram/ext/_picklepersistence.py index adc8220af48..a0d96ce84fd 100644 --- a/telegram/ext/_picklepersistence.py +++ b/telegram/ext/_picklepersistence.py @@ -20,7 +20,7 @@ import pickle from copy import deepcopy from pathlib import Path -from typing import Any, Callable, Dict, Optional, Set, Tuple, Type, TypeVar, Union, cast, overload +from typing import Any, Callable, Optional, TypeVar, Union, cast, overload from telegram import Bot, TelegramObject from telegram._utils.types import FilePathInput @@ -35,7 +35,7 @@ TelegramObj = TypeVar("TelegramObj", bound=TelegramObject) -def _all_subclasses(cls: Type[TelegramObj]) -> Set[Type[TelegramObj]]: +def _all_subclasses(cls: type[TelegramObj]) -> set[type[TelegramObj]]: """Gets all subclasses of the specified object, recursively. from https://stackoverflow.com/a/3862957/9706202 """ @@ -43,7 +43,7 @@ def _all_subclasses(cls: Type[TelegramObj]) -> Set[Type[TelegramObj]]: return set(subclasses).union([s for c in subclasses for s in _all_subclasses(c)]) -def _reconstruct_to(cls: Type[TelegramObj], kwargs: dict) -> TelegramObj: +def _reconstruct_to(cls: type[TelegramObj], kwargs: dict) -> TelegramObj: """ This method is used for unpickling. The data, which is in the form a dictionary, is converted back into a class. Works mostly the same as :meth:`TelegramObject.__setstate__`. @@ -55,7 +55,7 @@ def _reconstruct_to(cls: Type[TelegramObj], kwargs: dict) -> TelegramObj: return obj -def _custom_reduction(cls: TelegramObj) -> Tuple[Callable, Tuple[Type[TelegramObj], dict]]: +def _custom_reduction(cls: TelegramObj) -> tuple[Callable, tuple[type[TelegramObj], dict]]: """ This method is used for pickling. The bot attribute is preserved so _BotPickler().persistent_id works as intended. @@ -76,7 +76,7 @@ def __init__(self, bot: Bot, *args: Any, **kwargs: Any): def reducer_override( self, obj: TelegramObj - ) -> Tuple[Callable, Tuple[Type[TelegramObj], dict]]: + ) -> tuple[Callable, tuple[type[TelegramObj], dict]]: """ This method is used for pickling. The bot attribute is preserved so _BotPickler().persistent_id works as intended. @@ -199,7 +199,7 @@ class PicklePersistence(BasePersistence[UD, CD, BD]): @overload def __init__( - self: "PicklePersistence[Dict[Any, Any], Dict[Any, Any], Dict[Any, Any]]", + self: "PicklePersistence[dict[Any, Any], dict[Any, Any], dict[Any, Any]]", filepath: FilePathInput, store_data: Optional[PersistenceInput] = None, single_file: bool = True, @@ -231,11 +231,11 @@ def __init__( self.filepath: Path = Path(filepath) self.single_file: Optional[bool] = single_file self.on_flush: Optional[bool] = on_flush - self.user_data: Optional[Dict[int, UD]] = None - self.chat_data: Optional[Dict[int, CD]] = None + self.user_data: Optional[dict[int, UD]] = None + self.chat_data: Optional[dict[int, CD]] = None self.bot_data: Optional[BD] = None self.callback_data: Optional[CDCData] = None - self.conversations: Optional[Dict[str, Dict[Tuple[Union[int, str], ...], object]]] = None + self.conversations: Optional[dict[str, dict[tuple[Union[int, str], ...], object]]] = None self.context_types: ContextTypes[Any, UD, CD, BD] = cast( ContextTypes[Any, UD, CD, BD], context_types or ContextTypes() ) @@ -290,11 +290,11 @@ def _dump_file(self, filepath: Path, data: object) -> None: with filepath.open("wb") as file: _BotPickler(self.bot, file, protocol=pickle.HIGHEST_PROTOCOL).dump(data) - async def get_user_data(self) -> Dict[int, UD]: + async def get_user_data(self) -> dict[int, UD]: """Returns the user_data from the pickle file if it exists or an empty :obj:`dict`. Returns: - Dict[:obj:`int`, :obj:`dict`]: The restored user data. + dict[:obj:`int`, :obj:`dict`]: The restored user data. """ if self.user_data: pass @@ -307,11 +307,11 @@ async def get_user_data(self) -> Dict[int, UD]: self._load_singlefile() return deepcopy(self.user_data) # type: ignore[arg-type] - async def get_chat_data(self) -> Dict[int, CD]: + async def get_chat_data(self) -> dict[int, CD]: """Returns the chat_data from the pickle file if it exists or an empty :obj:`dict`. Returns: - Dict[:obj:`int`, :obj:`dict`]: The restored chat data. + dict[:obj:`int`, :obj:`dict`]: The restored chat data. """ if self.chat_data: pass @@ -348,8 +348,8 @@ async def get_callback_data(self) -> Optional[CDCData]: .. versionadded:: 13.6 Returns: - Tuple[List[Tuple[:obj:`str`, :obj:`float`, Dict[:obj:`str`, :class:`object`]]], - Dict[:obj:`str`, :obj:`str`]] | :obj:`None`: The restored metadata or :obj:`None`, + tuple[list[tuple[:obj:`str`, :obj:`float`, dict[:obj:`str`, :class:`object`]]], + dict[:obj:`str`, :obj:`str`]] | :obj:`None`: The restored metadata or :obj:`None`, if no data was stored. """ if self.callback_data: @@ -466,8 +466,8 @@ async def update_callback_data(self, data: CDCData) -> None: .. versionadded:: 13.6 Args: - data (Tuple[List[Tuple[:obj:`str`, :obj:`float`, \ - Dict[:obj:`str`, :class:`object`]]], Dict[:obj:`str`, :obj:`str`]]): + data (tuple[list[tuple[:obj:`str`, :obj:`float`, \ + dict[:obj:`str`, :class:`object`]]], dict[:obj:`str`, :obj:`str`]]): The relevant data to restore :class:`telegram.ext.CallbackDataCache`. """ if self.callback_data == data: diff --git a/telegram/ext/_updater.py b/telegram/ext/_updater.py index 30635e40ada..96bc6a3ed20 100644 --- a/telegram/ext/_updater.py +++ b/telegram/ext/_updater.py @@ -20,20 +20,10 @@ import asyncio import contextlib import ssl +from collections.abc import Coroutine from pathlib import Path from types import TracebackType -from typing import ( - TYPE_CHECKING, - Any, - AsyncContextManager, - Callable, - Coroutine, - List, - Optional, - Type, - TypeVar, - Union, -) +from typing import TYPE_CHECKING, Any, Callable, Optional, TypeVar, Union from telegram._utils.defaultvalue import DEFAULT_80, DEFAULT_IP, DEFAULT_NONE, DefaultValue from telegram._utils.logging import get_logger @@ -58,7 +48,7 @@ _LOGGER = get_logger(__name__) -class Updater(AsyncContextManager["Updater"]): +class Updater(contextlib.AbstractAsyncContextManager["Updater"]): """This class fetches updates for the bot either via long polling or by starting a webhook server. Received updates are enqueued into the :attr:`update_queue` and may be fetched from there to handle them appropriately. @@ -152,7 +142,7 @@ async def __aenter__(self: _UpdaterType) -> _UpdaterType: # noqa: PYI019 async def __aexit__( self, - exc_type: Optional[Type[BaseException]], + exc_type: Optional[type[BaseException]], exc_val: Optional[BaseException], exc_tb: Optional[TracebackType], ) -> None: @@ -220,7 +210,7 @@ async def start_polling( write_timeout: ODVInput[float] = DEFAULT_NONE, connect_timeout: ODVInput[float] = DEFAULT_NONE, pool_timeout: ODVInput[float] = DEFAULT_NONE, - allowed_updates: Optional[List[str]] = None, + allowed_updates: Optional[list[str]] = None, drop_pending_updates: Optional[bool] = None, error_callback: Optional[Callable[[TelegramError], None]] = None, ) -> "asyncio.Queue[object]": @@ -275,7 +265,7 @@ async def start_polling( Deprecated in favor of setting the timeout via :meth:`telegram.ext.ApplicationBuilder.get_updates_pool_timeout` or :paramref:`telegram.Bot.get_updates_request`. - allowed_updates (List[:obj:`str`], optional): Passed to + allowed_updates (list[:obj:`str`], optional): Passed to :meth:`telegram.Bot.get_updates`. drop_pending_updates (:obj:`bool`, optional): Whether to clean any pending updates on Telegram servers before actually starting to poll. Default is :obj:`False`. @@ -354,7 +344,7 @@ async def _start_polling( pool_timeout: ODVInput[float], bootstrap_retries: int, drop_pending_updates: Optional[bool], - allowed_updates: Optional[List[str]], + allowed_updates: Optional[list[str]], ready: asyncio.Event, error_callback: Optional[Callable[[TelegramError], None]], ) -> None: @@ -467,7 +457,7 @@ async def start_webhook( key: Optional[Union[str, Path]] = None, bootstrap_retries: int = 0, webhook_url: Optional[str] = None, - allowed_updates: Optional[List[str]] = None, + allowed_updates: Optional[list[str]] = None, drop_pending_updates: Optional[bool] = None, ip_address: Optional[str] = None, max_connections: int = 40, @@ -526,7 +516,7 @@ async def start_webhook( Defaults to :obj:`None`. .. versionadded :: 13.4 - allowed_updates (List[:obj:`str`], optional): Passed to + allowed_updates (list[:obj:`str`], optional): Passed to :meth:`telegram.Bot.set_webhook`. Defaults to :obj:`None`. max_connections (:obj:`int`, optional): Passed to :meth:`telegram.Bot.set_webhook`. Defaults to ``40``. @@ -634,7 +624,7 @@ async def _start_webhook( port: int, url_path: str, bootstrap_retries: int, - allowed_updates: Optional[List[str]], + allowed_updates: Optional[list[str]], cert: Optional[Union[str, Path]] = None, key: Optional[Union[str, Path]] = None, drop_pending_updates: Optional[bool] = None, @@ -777,7 +767,7 @@ async def _bootstrap( self, max_retries: int, webhook_url: Optional[str], - allowed_updates: Optional[List[str]], + allowed_updates: Optional[list[str]], drop_pending_updates: Optional[bool] = None, cert: Optional[bytes] = None, bootstrap_interval: float = 1, diff --git a/telegram/ext/_utils/_update_parsing.py b/telegram/ext/_utils/_update_parsing.py index f74c35e8c45..7bc4c498956 100644 --- a/telegram/ext/_utils/_update_parsing.py +++ b/telegram/ext/_utils/_update_parsing.py @@ -25,12 +25,12 @@ user. Changes to this module are not considered breaking changes and may not be documented in the changelog. """ -from typing import FrozenSet, Optional +from typing import Optional from telegram._utils.types import SCT -def parse_chat_id(chat_id: Optional[SCT[int]]) -> FrozenSet[int]: +def parse_chat_id(chat_id: Optional[SCT[int]]) -> frozenset[int]: """Accepts a chat id or collection of chat ids and returns a frozenset of chat ids.""" if chat_id is None: return frozenset() @@ -39,12 +39,12 @@ def parse_chat_id(chat_id: Optional[SCT[int]]) -> FrozenSet[int]: return frozenset(chat_id) -def parse_username(username: Optional[SCT[str]]) -> FrozenSet[str]: +def parse_username(username: Optional[SCT[str]]) -> frozenset[str]: """Accepts a username or collection of usernames and returns a frozenset of usernames. Strips the leading ``@`` if present. """ if username is None: return frozenset() if isinstance(username, str): - return frozenset({username[1:] if username.startswith("@") else username}) - return frozenset({usr[1:] if usr.startswith("@") else usr for usr in username}) + return frozenset({username.removeprefix("@")}) + return frozenset(usr.removeprefix("@") for usr in username) diff --git a/telegram/ext/_utils/trackingdict.py b/telegram/ext/_utils/trackingdict.py index 682cd648613..05ca5122bce 100644 --- a/telegram/ext/_utils/trackingdict.py +++ b/telegram/ext/_utils/trackingdict.py @@ -26,7 +26,8 @@ the changelog. """ from collections import UserDict -from typing import Final, Generic, List, Mapping, Optional, Set, Tuple, TypeVar, Union +from collections.abc import Mapping +from typing import Final, Generic, Optional, TypeVar, Union from telegram._utils.defaultvalue import DEFAULT_NONE, DefaultValue @@ -52,7 +53,7 @@ class TrackingDict(UserDict, Generic[_KT, _VT]): def __init__(self) -> None: super().__init__() - self._write_access_keys: Set[_KT] = set() + self._write_access_keys: set[_KT] = set() def __setitem__(self, key: _KT, value: _VT) -> None: self.__track_write(key) @@ -62,19 +63,19 @@ def __delitem__(self, key: _KT) -> None: self.__track_write(key) super().__delitem__(key) - def __track_write(self, key: Union[_KT, Set[_KT]]) -> None: + def __track_write(self, key: Union[_KT, set[_KT]]) -> None: if isinstance(key, set): self._write_access_keys |= key else: self._write_access_keys.add(key) - def pop_accessed_keys(self) -> Set[_KT]: + def pop_accessed_keys(self) -> set[_KT]: """Returns all keys that were write-accessed since the last time this method was called.""" out = self._write_access_keys self._write_access_keys = set() return out - def pop_accessed_write_items(self) -> List[Tuple[_KT, _VT]]: + def pop_accessed_write_items(self) -> list[tuple[_KT, _VT]]: """ Returns all keys & corresponding values as set of tuples that were write-accessed since the last time this method was called. If a key was deleted, the value will be diff --git a/telegram/ext/_utils/types.py b/telegram/ext/_utils/types.py index 5f9fc083218..62393355f5a 100644 --- a/telegram/ext/_utils/types.py +++ b/telegram/ext/_utils/types.py @@ -25,18 +25,8 @@ user. Changes to this module are not considered breaking changes and may not be documented in the changelog. """ -from typing import ( - TYPE_CHECKING, - Any, - Callable, - Coroutine, - Dict, - List, - MutableMapping, - Tuple, - TypeVar, - Union, -) +from collections.abc import Coroutine, MutableMapping +from typing import TYPE_CHECKING, Any, Callable, TypeVar, Union if TYPE_CHECKING: from typing import Optional @@ -63,17 +53,17 @@ .. versionadded:: 20.0 """ -ConversationKey = Tuple[Union[int, str], ...] +ConversationKey = tuple[Union[int, str], ...] ConversationDict = MutableMapping[ConversationKey, object] -"""Dict[Tuple[:obj:`int` | :obj:`str`, ...], Optional[:obj:`object`]]: +"""dict[tuple[:obj:`int` | :obj:`str`, ...], Optional[:obj:`object`]]: Dicts as maintained by the :class:`telegram.ext.ConversationHandler`. .. versionadded:: 13.6 """ -CDCData = Tuple[List[Tuple[str, float, Dict[str, Any]]], Dict[str, str]] -"""Tuple[List[Tuple[:obj:`str`, :obj:`float`, Dict[:obj:`str`, :class:`object`]]], \ - Dict[:obj:`str`, :obj:`str`]]: Data returned by +CDCData = tuple[list[tuple[str, float, dict[str, Any]]], dict[str, str]] +"""tuple[list[tuple[:obj:`str`, :obj:`float`, dict[:obj:`str`, :class:`object`]]], \ + dict[:obj:`str`, :obj:`str`]]: Data returned by :attr:`telegram.ext.CallbackDataCache.persistence_data`. .. versionadded:: 13.6 @@ -113,4 +103,4 @@ """Type of the rate limiter arguments. .. versionadded:: 20.0""" -FilterDataDict = Dict[str, List[Any]] +FilterDataDict = dict[str, list[Any]] diff --git a/telegram/ext/_utils/webhookhandler.py b/telegram/ext/_utils/webhookhandler.py index a174fbaa476..d707f9f45c9 100644 --- a/telegram/ext/_utils/webhookhandler.py +++ b/telegram/ext/_utils/webhookhandler.py @@ -24,7 +24,7 @@ from socket import socket from ssl import SSLContext from types import TracebackType -from typing import TYPE_CHECKING, Optional, Type, Union +from typing import TYPE_CHECKING, Optional, Union # Instead of checking for ImportError here, we do that in `updater.py`, where we import from # this module. Doing it here would be tricky, as the classes below subclass tornado classes @@ -210,7 +210,7 @@ def _validate_post(self) -> None: def log_exception( self, - typ: Optional[Type[BaseException]], + typ: Optional[type[BaseException]], value: Optional[BaseException], tb: Optional[TracebackType], ) -> None: diff --git a/telegram/ext/filters.py b/telegram/ext/filters.py index fe5b8a79d60..7b1f5a45b7f 100644 --- a/telegram/ext/filters.py +++ b/telegram/ext/filters.py @@ -104,22 +104,9 @@ import mimetypes import re from abc import ABC, abstractmethod -from typing import ( - Collection, - Dict, - FrozenSet, - Iterable, - List, - Match, - NoReturn, - Optional, - Pattern, - Sequence, - Set, - Tuple, - Union, - cast, -) +from collections.abc import Collection, Iterable, Sequence +from re import Match, Pattern +from typing import NoReturn, Optional, Union, cast from telegram import Chat as TGChat from telegram import ( @@ -320,7 +307,7 @@ def check_update(self, update: Update) -> Optional[Union[bool, FilterDataDict]]: update (:class:`telegram.Update`): The update to check. Returns: - :obj:`bool` | Dict[:obj:`str`, :obj:`list`] | :obj:`None`: If the update should be + :obj:`bool` | dict[:obj:`str`, :obj:`list`] | :obj:`None`: If the update should be handled by this filter, returns :obj:`True` or a dict with lists, in case the filter is a data filter. If the update should not be handled by this filter, :obj:`False` or :obj:`None`. @@ -361,7 +348,7 @@ def check_update(self, update: Update) -> Optional[Union[bool, FilterDataDict]]: update (:class:`telegram.Update`): The update to check. Returns: - :obj:`bool` | Dict[:obj:`str`, :obj:`list`] | :obj:`None`: If the update should be + :obj:`bool` | dict[:obj:`str`, :obj:`list`] | :obj:`None`: If the update should be handled by this filter, returns :obj:`True` or a dict with lists, in case the filter is a data filter. If the update should not be handled by this filter, :obj:`False` or :obj:`None`. @@ -441,7 +428,7 @@ def __init__( self.data_filter = True @staticmethod - def _merge(base_output: Union[bool, Dict], comp_output: Union[bool, Dict]) -> FilterDataDict: + def _merge(base_output: Union[bool, dict], comp_output: Union[bool, dict]) -> FilterDataDict: base = base_output if isinstance(base_output, dict) else {} comp = comp_output if isinstance(comp_output, dict) else {} for k in comp: @@ -585,13 +572,13 @@ class Caption(MessageFilter): :attr:`telegram.ext.filters.CAPTION` Args: - strings (List[:obj:`str`] | Tuple[:obj:`str`], optional): Which captions to allow. Only + strings (list[:obj:`str`] | tuple[:obj:`str`], optional): Which captions to allow. Only exact matches are allowed. If not specified, will allow any message with a caption. """ __slots__ = ("strings",) - def __init__(self, strings: Optional[Union[List[str], Tuple[str, ...]]] = None): + def __init__(self, strings: Optional[Union[list[str], tuple[str, ...]]] = None): self.strings: Optional[Sequence[str]] = strings super().__init__(name=f"filters.Caption({strings})" if strings else "filters.CAPTION") @@ -660,7 +647,7 @@ def __init__(self, pattern: Union[str, Pattern[str]]): self.pattern: Pattern[str] = pattern super().__init__(name=f"filters.CaptionRegex({self.pattern})", data_filter=True) - def filter(self, message: Message) -> Optional[Dict[str, List[Match[str]]]]: + def filter(self, message: Message) -> Optional[dict[str, list[Match[str]]]]: if message.caption and (match := self.pattern.search(message.caption)): return {"matches": [match]} return {} @@ -686,8 +673,8 @@ def __init__( self._username_name: str = "username" self.allow_empty: bool = allow_empty - self._chat_ids: Set[int] = set() - self._usernames: Set[str] = set() + self._chat_ids: set[int] = set() + self._usernames: set[str] = set() self._set_chat_ids(chat_id) self._set_usernames(username) @@ -712,7 +699,7 @@ def _set_usernames(self, username: Optional[SCT[str]]) -> None: self._usernames = set(parse_username(username)) @property - def chat_ids(self) -> FrozenSet[int]: + def chat_ids(self) -> frozenset[int]: return frozenset(self._chat_ids) @chat_ids.setter @@ -720,7 +707,7 @@ def chat_ids(self, chat_id: SCT[int]) -> None: self._set_chat_ids(chat_id) @property - def usernames(self) -> FrozenSet[str]: + def usernames(self) -> frozenset[str]: """Which username(s) to allow through. Warning: @@ -1617,7 +1604,7 @@ def __init__(self, lang: SCT[str]): lang = cast(str, lang) self.lang: Sequence[str] = [lang] else: - lang = cast(List[str], lang) + lang = cast(list[str], lang) self.lang = lang super().__init__(name=f"filters.Language({self.lang})") @@ -1795,7 +1782,7 @@ def __init__(self, pattern: Union[str, Pattern[str]]): self.pattern: Pattern[str] = pattern super().__init__(name=f"filters.Regex({self.pattern})", data_filter=True) - def filter(self, message: Message) -> Optional[Dict[str, List[Match[str]]]]: + def filter(self, message: Message) -> Optional[dict[str, list[Match[str]]]]: if message.text and (match := self.pattern.search(message.text)): return {"matches": [match]} return {} @@ -2440,7 +2427,7 @@ class SuccessfulPayment(MessageFilter): :attr:`telegram.ext.filters.SUCCESSFUL_PAYMENT` Args: - invoice_payloads (List[:obj:`str`] | Tuple[:obj:`str`], optional): Which + invoice_payloads (list[:obj:`str`] | tuple[:obj:`str`], optional): Which invoice payloads to allow. Only exact matches are allowed. If not specified, will allow any invoice payload. @@ -2449,7 +2436,7 @@ class SuccessfulPayment(MessageFilter): __slots__ = ("invoice_payloads",) - def __init__(self, invoice_payloads: Optional[Union[List[str], Tuple[str, ...]]] = None): + def __init__(self, invoice_payloads: Optional[Union[list[str], tuple[str, ...]]] = None): self.invoice_payloads: Optional[Sequence[str]] = invoice_payloads super().__init__( name=( @@ -2498,13 +2485,13 @@ class Text(MessageFilter): commands. Args: - strings (List[:obj:`str`] | Tuple[:obj:`str`], optional): Which messages to allow. Only + strings (list[:obj:`str`] | tuple[:obj:`str`], optional): Which messages to allow. Only exact matches are allowed. If not specified, will allow any text message. """ __slots__ = ("strings",) - def __init__(self, strings: Optional[Union[List[str], Tuple[str, ...]]] = None): + def __init__(self, strings: Optional[Union[list[str], tuple[str, ...]]] = None): self.strings: Optional[Sequence[str]] = strings super().__init__(name=f"filters.Text({strings})" if strings else "filters.TEXT") @@ -2694,7 +2681,7 @@ def _get_chat_or_user(self, message: Message) -> Optional[TGUser]: return message.from_user @property - def user_ids(self) -> FrozenSet[int]: + def user_ids(self) -> frozenset[int]: """ Which user ID(s) to allow through. @@ -2832,7 +2819,7 @@ def _get_chat_or_user(self, message: Message) -> Optional[TGUser]: return message.via_bot @property - def bot_ids(self) -> FrozenSet[int]: + def bot_ids(self) -> frozenset[int]: """ Which bot ID(s) to allow through. diff --git a/telegram/request/_baserequest.py b/telegram/request/_baserequest.py index aa0fe232cf4..446315a5b47 100644 --- a/telegram/request/_baserequest.py +++ b/telegram/request/_baserequest.py @@ -19,9 +19,10 @@ """This module contains an abstract class to make POST and GET requests.""" import abc import json +from contextlib import AbstractAsyncContextManager from http import HTTPStatus from types import TracebackType -from typing import AsyncContextManager, Final, List, Optional, Tuple, Type, TypeVar, Union, final +from typing import Final, Optional, TypeVar, Union, final from telegram._utils.defaultvalue import DEFAULT_NONE as _DEFAULT_NONE from telegram._utils.defaultvalue import DefaultValue @@ -49,7 +50,7 @@ class BaseRequest( - AsyncContextManager["BaseRequest"], + AbstractAsyncContextManager["BaseRequest"], abc.ABC, ): """Abstract interface class that allows python-telegram-bot to make requests to the Bot API. @@ -122,7 +123,7 @@ async def __aenter__(self: RT) -> RT: async def __aexit__( self, - exc_type: Optional[Type[BaseException]], + exc_type: Optional[type[BaseException]], exc_val: Optional[BaseException], exc_tb: Optional[TracebackType], ) -> None: @@ -166,7 +167,7 @@ async def post( write_timeout: ODVInput[float] = DEFAULT_NONE, connect_timeout: ODVInput[float] = DEFAULT_NONE, pool_timeout: ODVInput[float] = DEFAULT_NONE, - ) -> Union[JSONDict, List[JSONDict], bool]: + ) -> Union[JSONDict, list[JSONDict], bool]: """Makes a request to the Bot API handles the return code and parses the answer. Warning: @@ -421,7 +422,7 @@ async def do_request( write_timeout: ODVInput[float] = DEFAULT_NONE, connect_timeout: ODVInput[float] = DEFAULT_NONE, pool_timeout: ODVInput[float] = DEFAULT_NONE, - ) -> Tuple[int, bytes]: + ) -> tuple[int, bytes]: """Makes a request to the Bot API. Must be implemented by a subclass. Warning: @@ -451,6 +452,6 @@ async def do_request( :attr:`DEFAULT_NONE`. Returns: - Tuple[:obj:`int`, :obj:`bytes`]: The HTTP return code & the payload part of the server + tuple[:obj:`int`, :obj:`bytes`]: The HTTP return code & the payload part of the server response. """ diff --git a/telegram/request/_httpxrequest.py b/telegram/request/_httpxrequest.py index a2e13582df0..08c2bfcc511 100644 --- a/telegram/request/_httpxrequest.py +++ b/telegram/request/_httpxrequest.py @@ -17,7 +17,8 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains methods to make POST and GET requests using the httpx library.""" -from typing import Any, Collection, Dict, Optional, Tuple, Union +from collections.abc import Collection +from typing import Any, Optional, Union import httpx @@ -122,7 +123,7 @@ class HTTPXRequest(BaseRequest): :meth:`do_request`. Defaults to ``20`` seconds. .. versionadded:: 21.0 - httpx_kwargs (Dict[:obj:`str`, Any], optional): Additional keyword arguments to be passed + httpx_kwargs (dict[:obj:`str`, Any], optional): Additional keyword arguments to be passed to the `httpx.AsyncClient `_ constructor. @@ -153,7 +154,7 @@ def __init__( socket_options: Optional[Collection[SocketOpt]] = None, proxy: Optional[Union[str, httpx.Proxy, httpx.URL]] = None, media_write_timeout: Optional[float] = 20.0, - httpx_kwargs: Optional[Dict[str, Any]] = None, + httpx_kwargs: Optional[dict[str, Any]] = None, ): if proxy_url is not None and proxy is not None: raise ValueError("The parameters `proxy_url` and `proxy` are mutually exclusive.") @@ -261,7 +262,7 @@ async def do_request( write_timeout: ODVInput[float] = BaseRequest.DEFAULT_NONE, connect_timeout: ODVInput[float] = BaseRequest.DEFAULT_NONE, pool_timeout: ODVInput[float] = BaseRequest.DEFAULT_NONE, - ) -> Tuple[int, bytes]: + ) -> tuple[int, bytes]: """See :meth:`BaseRequest.do_request`.""" if self._client.is_closed: raise RuntimeError("This HTTPXRequest is not initialized!") diff --git a/telegram/request/_requestdata.py b/telegram/request/_requestdata.py index 71b2654e5b6..9e89f0090bf 100644 --- a/telegram/request/_requestdata.py +++ b/telegram/request/_requestdata.py @@ -18,7 +18,7 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains a class that holds the parameters of a request to the Bot API.""" import json -from typing import Any, Dict, List, Optional, Union, final +from typing import Any, Optional, Union, final from urllib.parse import urlencode from telegram._utils.strings import TextEncoding @@ -45,19 +45,19 @@ class RequestData: __slots__ = ("_parameters", "contains_files") - def __init__(self, parameters: Optional[List[RequestParameter]] = None): - self._parameters: List[RequestParameter] = parameters or [] + def __init__(self, parameters: Optional[list[RequestParameter]] = None): + self._parameters: list[RequestParameter] = parameters or [] self.contains_files: bool = any(param.input_files for param in self._parameters) @property - def parameters(self) -> Dict[str, Union[str, int, List[Any], Dict[Any, Any]]]: + def parameters(self) -> dict[str, Union[str, int, list[Any], dict[Any, Any]]]: """Gives the parameters as mapping of parameter name to the parameter value, which can be a single object of type :obj:`int`, :obj:`float`, :obj:`str` or :obj:`bool` or any (possibly nested) composition of lists, tuples and dictionaries, where each entry, key and value is of one of the mentioned types. Returns: - Dict[:obj:`str`, Union[:obj:`str`, :obj:`int`, List[any], Dict[any, any]]] + dict[:obj:`str`, Union[:obj:`str`, :obj:`int`, list[any], dict[any, any]]] """ return { param.name: param.value # type: ignore[misc] @@ -66,7 +66,7 @@ def parameters(self) -> Dict[str, Union[str, int, List[Any], Dict[Any, Any]]]: } @property - def json_parameters(self) -> Dict[str, str]: + def json_parameters(self) -> dict[str, str]: """Gives the parameters as mapping of parameter name to the respective JSON encoded value. @@ -76,7 +76,7 @@ def json_parameters(self) -> Dict[str, str]: :attr:`parameters` - note that string valued keys should not be JSON encoded. Returns: - Dict[:obj:`str`, :obj:`str`] + dict[:obj:`str`, :obj:`str`] """ return { param.name: param.json_value @@ -84,11 +84,11 @@ def json_parameters(self) -> Dict[str, str]: if param.json_value is not None } - def url_encoded_parameters(self, encode_kwargs: Optional[Dict[str, Any]] = None) -> str: + def url_encoded_parameters(self, encode_kwargs: Optional[dict[str, Any]] = None) -> str: """Encodes the parameters with :func:`urllib.parse.urlencode`. Args: - encode_kwargs (Dict[:obj:`str`, any], optional): Additional keyword arguments to pass + encode_kwargs (dict[:obj:`str`, any], optional): Additional keyword arguments to pass along to :func:`urllib.parse.urlencode`. Returns: @@ -98,13 +98,13 @@ def url_encoded_parameters(self, encode_kwargs: Optional[Dict[str, Any]] = None) return urlencode(self.json_parameters, **encode_kwargs) return urlencode(self.json_parameters) - def parametrized_url(self, url: str, encode_kwargs: Optional[Dict[str, Any]] = None) -> str: + def parametrized_url(self, url: str, encode_kwargs: Optional[dict[str, Any]] = None) -> str: """Shortcut for attaching the return value of :meth:`url_encoded_parameters` to the :paramref:`url`. Args: url (:obj:`str`): The URL the parameters will be attached to. - encode_kwargs (Dict[:obj:`str`, any], optional): Additional keyword arguments to pass + encode_kwargs (dict[:obj:`str`, any], optional): Additional keyword arguments to pass along to :func:`urllib.parse.urlencode`. Returns: diff --git a/telegram/request/_requestparameter.py b/telegram/request/_requestparameter.py index 88ed231c066..311b37ff350 100644 --- a/telegram/request/_requestparameter.py +++ b/telegram/request/_requestparameter.py @@ -18,9 +18,10 @@ # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains a class that describes a single parameter of a request to the Bot API.""" import json +from collections.abc import Sequence from dataclasses import dataclass from datetime import datetime -from typing import List, Optional, Sequence, Tuple, final +from typing import Optional, final from telegram._files.inputfile import InputFile from telegram._files.inputmedia import InputMedia, InputPaidMedia @@ -47,13 +48,13 @@ class RequestParameter: Args: name (:obj:`str`): The name of the parameter. value (:obj:`object` | :obj:`None`): The value of the parameter. Must be JSON-dumpable. - input_files (List[:class:`telegram.InputFile`], optional): A list of files that should be + input_files (list[:class:`telegram.InputFile`], optional): A list of files that should be uploaded along with this parameter. Attributes: name (:obj:`str`): The name of the parameter. value (:obj:`object` | :obj:`None`): The value of the parameter. - input_files (List[:class:`telegram.InputFile` | :obj:`None`): A list of files that should + input_files (list[:class:`telegram.InputFile` | :obj:`None`): A list of files that should be uploaded along with this parameter. """ @@ -61,7 +62,7 @@ class RequestParameter: name: str value: object - input_files: Optional[List[InputFile]] + input_files: Optional[list[InputFile]] @property def json_value(self) -> Optional[str]: @@ -92,7 +93,7 @@ def multipart_data(self) -> Optional[UploadFileDict]: @staticmethod def _value_and_input_files_from_input( # pylint: disable=too-many-return-statements value: object, - ) -> Tuple[object, List[InputFile]]: + ) -> tuple[object, list[InputFile]]: """Converts `value` into something that we can json-dump. Returns two values: 1. the JSON-dumpable value. May be `None` in case the value is an InputFile which must not be uploaded via an attach:// URI diff --git a/tests/auxil/bot_method_checks.py b/tests/auxil/bot_method_checks.py index 7b69863b1c3..a498693cea7 100644 --- a/tests/auxil/bot_method_checks.py +++ b/tests/auxil/bot_method_checks.py @@ -21,7 +21,8 @@ import functools import inspect import re -from typing import Any, Callable, Collection, Dict, Iterable, List, Optional, Tuple +from collections.abc import Collection, Iterable +from typing import Any, Callable, Optional import pytest @@ -57,9 +58,9 @@ def check_shortcut_signature( shortcut: Callable, bot_method: Callable, - shortcut_kwargs: List[str], - additional_kwargs: List[str], - annotation_overrides: Optional[Dict[str, Tuple[Any, Any]]] = None, + shortcut_kwargs: list[str], + additional_kwargs: list[str], + annotation_overrides: Optional[dict[str, tuple[Any, Any]]] = None, ) -> bool: """ Checks that the signature of a shortcut matches the signature of the underlying bot method. @@ -389,7 +390,7 @@ async def make_assertion( url, request_data: RequestData, method_name: str, - kwargs_need_default: List[str], + kwargs_need_default: list[str], return_value, manually_passed_value: Any = DEFAULT_NONE, expected_defaults_value: Any = DEFAULT_NONE, @@ -451,7 +452,7 @@ async def make_assertion( ) # Check InputMedia (parse_mode can have a default) - def check_input_media(m: Dict): + def check_input_media(m: dict): parse_mode = m.get("parse_mode") if no_value_expected and parse_mode is not None: pytest.fail("InputMedia has non-None parse_mode, expected it to be absent") diff --git a/tests/auxil/networking.py b/tests/auxil/networking.py index a695eb232f7..d103154f93b 100644 --- a/tests/auxil/networking.py +++ b/tests/auxil/networking.py @@ -17,7 +17,7 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. from pathlib import Path -from typing import Optional, Tuple +from typing import Optional import pytest from httpx import AsyncClient, AsyncHTTPTransport, Response @@ -83,7 +83,7 @@ async def do_request( write_timeout: ODVInput[float] = BaseRequest.DEFAULT_NONE, connect_timeout: ODVInput[float] = BaseRequest.DEFAULT_NONE, pool_timeout: ODVInput[float] = BaseRequest.DEFAULT_NONE, - ) -> Tuple[int, bytes]: + ) -> tuple[int, bytes]: pytest.fail("OfflineRequest: Network access disallowed in this test") diff --git a/tests/conftest.py b/tests/conftest.py index 69c8ce96037..70a19009624 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -21,7 +21,6 @@ import logging import sys from pathlib import Path -from typing import Dict, List from uuid import uuid4 import pytest @@ -76,7 +75,7 @@ def no_rerun_after_xfail_or_flood(error, name, test: pytest.Function, plugin): return not (xfail_present or did_we_flood) -def pytest_collection_modifyitems(items: List[pytest.Item]): +def pytest_collection_modifyitems(items: list[pytest.Item]): """Here we add a flaky marker to all request making tests and a (no_)req marker to the rest.""" for item in items: # items are the test methods parent = item.parent # Get the parent of the item (class, or module if defined outside) @@ -145,7 +144,7 @@ def event_loop(request): @pytest.fixture(scope="session") -def bot_info() -> Dict[str, str]: +def bot_info() -> dict[str, str]: return BOT_INFO_PROVIDER.get_info() diff --git a/tests/docs/admonition_inserter.py b/tests/docs/admonition_inserter.py index fa19d9a0f9d..bc03c7a10f6 100644 --- a/tests/docs/admonition_inserter.py +++ b/tests/docs/admonition_inserter.py @@ -96,7 +96,7 @@ def test_admonitions_dict(self, admonition_inserter): ( "available_in", telegram.Sticker, - ":attr:`telegram.StickerSet.stickers`", # Tuple[telegram.Sticker] + ":attr:`telegram.StickerSet.stickers`", # tuple[telegram.Sticker] ), ( "available_in", diff --git a/tests/ext/test_application.py b/tests/ext/test_application.py index 2826f4cad99..ec6da310c42 100644 --- a/tests/ext/test_application.py +++ b/tests/ext/test_application.py @@ -302,15 +302,19 @@ def after_updater_shutdown(*args, **kwargs): ) if updater: - async with ApplicationBuilder().bot(one_time_bot).concurrent_updates( - update_processor - ).build(): + async with ( + ApplicationBuilder().bot(one_time_bot).concurrent_updates(update_processor).build() + ): pass assert self.test_flag == {"bot", "update_processor", "updater"} else: - async with ApplicationBuilder().bot(one_time_bot).updater(None).concurrent_updates( - update_processor - ).build(): + async with ( + ApplicationBuilder() + .bot(one_time_bot) + .updater(None) + .concurrent_updates(update_processor) + .build() + ): pass assert self.test_flag == {"bot", "update_processor"} diff --git a/tests/ext/test_filters.py b/tests/ext/test_filters.py index 76b8dec916f..ce728bb7d9e 100644 --- a/tests/ext/test_filters.py +++ b/tests/ext/test_filters.py @@ -103,7 +103,7 @@ def filter_class(obj): # The total no. of filters is about 72 as of 31/10/21. # Gather all the filters to test using DFS- visited = [] - classes = inspect.getmembers(filters, predicate=filter_class) # List[Tuple[str, type]] + classes = inspect.getmembers(filters, predicate=filter_class) # list[tuple[str, type]] stack = classes.copy() while stack: cls = stack[-1][-1] # get last element and its class diff --git a/tests/ext/test_picklepersistence.py b/tests/ext/test_picklepersistence.py index ef23715b54d..d30b248142e 100644 --- a/tests/ext/test_picklepersistence.py +++ b/tests/ext/test_picklepersistence.py @@ -872,9 +872,12 @@ async def test_custom_pickler_unpickler_simple( "A load persistent id instruction was encountered,\nbut no persistent_load " "function was specified." ) - with Path("pickletest_chat_data").open("rb") as f, pytest.raises( - pickle.UnpicklingError, - match=err_msg if sys.version_info < (3, 12) else err_msg.replace("\n", " "), + with ( + Path("pickletest_chat_data").open("rb") as f, + pytest.raises( + pickle.UnpicklingError, + match=err_msg if sys.version_info < (3, 12) else err_msg.replace("\n", " "), + ), ): pickle.load(f) diff --git a/tests/request/test_request.py b/tests/request/test_request.py index bd186c2efb3..cbb51344079 100644 --- a/tests/request/test_request.py +++ b/tests/request/test_request.py @@ -22,9 +22,10 @@ import json import logging from collections import defaultdict +from collections.abc import Coroutine from dataclasses import dataclass from http import HTTPStatus -from typing import Any, Callable, Coroutine, Tuple +from typing import Any, Callable import httpx import pytest @@ -67,7 +68,7 @@ def mocker_factory( response: bytes, return_code: int = HTTPStatus.OK -) -> Callable[[Tuple[Any]], Coroutine[Any, Any, Tuple[int, bytes]]]: +) -> Callable[[tuple[Any]], Coroutine[Any, Any, tuple[int, bytes]]]: async def make_assertion(*args, **kwargs): return return_code, response @@ -219,8 +220,9 @@ async def test_illegal_json_response(self, monkeypatch, httpx_request: HTTPXRequ monkeypatch.setattr(httpx_request, "do_request", mocker_factory(response=server_response)) - with pytest.raises(TelegramError, match="Invalid server response"), caplog.at_level( - logging.ERROR + with ( + pytest.raises(TelegramError, match="Invalid server response"), + caplog.at_level(logging.ERROR), ): await httpx_request.post(None, None, None) @@ -413,7 +415,7 @@ async def initialize(self_) -> None: async def shutdown(self_) -> None: pass - async def do_request(self_, *args, **kwargs) -> Tuple[int, bytes]: + async def do_request(self_, *args, **kwargs) -> tuple[int, bytes]: self.test_flag = ( kwargs.get("read_timeout"), kwargs.get("connect_timeout"), diff --git a/tests/request/test_requestdata.py b/tests/request/test_requestdata.py index 3dc8ca1af97..9fa3480c1d7 100644 --- a/tests/request/test_requestdata.py +++ b/tests/request/test_requestdata.py @@ -17,7 +17,7 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. import json -from typing import Any, Dict +from typing import Any from urllib.parse import quote import pytest @@ -30,7 +30,7 @@ @pytest.fixture(scope="module") -def inputfiles() -> Dict[bool, InputFile]: +def inputfiles() -> dict[bool, InputFile]: return {True: InputFile(obj="data", attach=True), False: InputFile(obj="data", attach=False)} @@ -52,7 +52,7 @@ def input_media_photo() -> InputMediaPhoto: @pytest.fixture(scope="module") -def simple_params() -> Dict[str, Any]: +def simple_params() -> dict[str, Any]: return { "string": "string", "integer": 1, @@ -62,7 +62,7 @@ def simple_params() -> Dict[str, Any]: @pytest.fixture(scope="module") -def simple_jsons() -> Dict[str, Any]: +def simple_jsons() -> dict[str, Any]: return { "string": "string", "integer": json.dumps(1), @@ -79,7 +79,7 @@ def simple_rqs(simple_params) -> RequestData: @pytest.fixture(scope="module") -def file_params(inputfiles, input_media_video, input_media_photo) -> Dict[str, Any]: +def file_params(inputfiles, input_media_video, input_media_photo) -> dict[str, Any]: return { "inputfile_attach": inputfiles[True], "inputfile_no_attach": inputfiles[False], @@ -89,7 +89,7 @@ def file_params(inputfiles, input_media_video, input_media_photo) -> Dict[str, A @pytest.fixture(scope="module") -def file_jsons(inputfiles, input_media_video, input_media_photo) -> Dict[str, Any]: +def file_jsons(inputfiles, input_media_video, input_media_photo) -> dict[str, Any]: input_media_video_dict = input_media_video.to_dict() input_media_video_dict["media"] = input_media_video.media.attach_uri input_media_video_dict["thumbnail"] = input_media_video.thumbnail.attach_uri @@ -110,14 +110,14 @@ def file_rqs(file_params) -> RequestData: @pytest.fixture(scope="module") -def mixed_params(file_params, simple_params) -> Dict[str, Any]: +def mixed_params(file_params, simple_params) -> dict[str, Any]: both = file_params.copy() both.update(simple_params) return both @pytest.fixture(scope="module") -def mixed_jsons(file_jsons, simple_jsons) -> Dict[str, Any]: +def mixed_jsons(file_jsons, simple_jsons) -> dict[str, Any]: both = file_jsons.copy() both.update(simple_jsons) return both diff --git a/tests/request/test_requestparameter.py b/tests/request/test_requestparameter.py index d7ad2088a73..4106a69a53a 100644 --- a/tests/request/test_requestparameter.py +++ b/tests/request/test_requestparameter.py @@ -17,7 +17,7 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. import datetime -from typing import Sequence +from collections.abc import Sequence import pytest diff --git a/tests/test_bot.py b/tests/test_bot.py index 1c8671c97bd..7f060fb0992 100644 --- a/tests/test_bot.py +++ b/tests/test_bot.py @@ -27,7 +27,6 @@ from collections import defaultdict from http import HTTPStatus from io import BytesIO -from typing import Tuple import httpx import pytest @@ -334,9 +333,12 @@ async def shutdown(): assert self.test_flag == "stop" async def test_equality(self): - async with make_bot(token=FALLBACKS[0]["token"]) as a, make_bot( - token=FALLBACKS[0]["token"] - ) as b, Bot(token=FALLBACKS[0]["token"]) as c, make_bot(token=FALLBACKS[1]["token"]) as d: + async with ( + make_bot(token=FALLBACKS[0]["token"]) as a, + make_bot(token=FALLBACKS[0]["token"]) as b, + Bot(token=FALLBACKS[0]["token"]) as c, + make_bot(token=FALLBACKS[1]["token"]) as d, + ): e = Update(123456789) f = Bot(token=FALLBACKS[0]["token"]) @@ -2172,7 +2174,7 @@ async def initialize(self_) -> None: async def shutdown(self_) -> None: pass - async def do_request(self_, *args, **kwargs) -> Tuple[int, bytes]: + async def do_request(self_, *args, **kwargs) -> tuple[int, bytes]: nonlocal test_flag test_flag = ( kwargs.get("read_timeout"), diff --git a/tests/test_messageentity.py b/tests/test_messageentity.py index 4c981f45319..b65ccf418f5 100644 --- a/tests/test_messageentity.py +++ b/tests/test_messageentity.py @@ -17,7 +17,6 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. import random -from typing import List, Tuple import pytest @@ -86,7 +85,7 @@ def test_enum_init(self): def test_fix_utf16(self): text = "𠌕 bold 𝄢 italic underlined: 𝛙𝌢𑁍" - inputs_outputs: List[Tuple[Tuple[int, int, str], Tuple[int, int]]] = [ + inputs_outputs: list[tuple[tuple[int, int, str], tuple[int, int]]] = [ ((2, 4, MessageEntity.BOLD), (3, 4)), ((9, 6, MessageEntity.ITALIC), (11, 6)), ((28, 3, MessageEntity.UNDERLINE), (30, 6)), diff --git a/tests/test_official/arg_type_checker.py b/tests/test_official/arg_type_checker.py index 24ef867ba70..c6d5bae5386 100644 --- a/tests/test_official/arg_type_checker.py +++ b/tests/test_official/arg_type_checker.py @@ -23,9 +23,10 @@ import inspect import logging import re +from collections.abc import Sequence from datetime import datetime from types import FunctionType -from typing import Any, Sequence +from typing import Any from telegram._utils.defaultvalue import DefaultValue from telegram._utils.types import FileInput, ODVInput diff --git a/tests/test_official/exceptions.py b/tests/test_official/exceptions.py index c6122f312e9..50551559bb5 100644 --- a/tests/test_official/exceptions.py +++ b/tests/test_official/exceptions.py @@ -57,7 +57,7 @@ class ParamTypeCheckingExceptions: ("reaction", False): "ReactionType", # + str ("options", False): "InputPollOption", # + str # TODO: Deprecated and will be corrected (and removed) in next major PTB version: - ("file_hashes", True): "List[str]", + ("file_hashes", True): "list[str]", } # Special cases for other parameters that accept more types than the official API, and are diff --git a/tests/test_official/helpers.py b/tests/test_official/helpers.py index 6851bf85fa2..68ffffa09e3 100644 --- a/tests/test_official/helpers.py +++ b/tests/test_official/helpers.py @@ -20,7 +20,8 @@ import functools import re -from typing import TYPE_CHECKING, Any, Sequence, _eval_type, get_type_hints +from collections.abc import Sequence +from typing import TYPE_CHECKING, Any, _eval_type, get_type_hints from bs4 import PageElement, Tag From 6540f288f58566e9b29aa4cb6f1897200bfba6f4 Mon Sep 17 00:00:00 2001 From: Bibo-Joshi <22366557+Bibo-Joshi@users.noreply.github.com> Date: Thu, 31 Oct 2024 08:27:58 +0100 Subject: [PATCH 16/25] Use `sphinx-build-compatibility` to Keep Sphinx Compatibility (#4492) --- docs/requirements-docs.txt | 4 +++- docs/source/conf.py | 4 ++++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt index 1ae17a68faf..ab62b887813 100644 --- a/docs/requirements-docs.txt +++ b/docs/requirements-docs.txt @@ -4,4 +4,6 @@ furo-sphinx-search @ git+https://github.com/harshil21/furo-sphinx-search@v0.2.0. sphinx-paramlinks==0.6.0 sphinxcontrib-mermaid==1.0.0 sphinx-copybutton==0.5.2 -sphinx-inline-tabs==2023.4.21 \ No newline at end of file +sphinx-inline-tabs==2023.4.21 +# Temporary. See #4387 +sphinx-build-compatibility @ git+https://github.com/readthedocs/sphinx-build-compatibility.git@58aabc5f207c6c2421f23d3578adc0b14af57047 diff --git a/docs/source/conf.py b/docs/source/conf.py index caac474d34c..f54a3a4c7d8 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -48,6 +48,10 @@ "sphinx_search.extension", ] +# Temporary. See #4387 +if os.environ.get("READTHEDOCS", "") == "True": + extensions.append("sphinx_build_compatibility.extension") + # For shorter links to Wiki in docstrings extlinks = { "wiki": ("https://github.com/python-telegram-bot/python-telegram-bot/wiki/%s", "%s"), From 3c8f6ed42b6381339ac0c41f630d48ec9ab25fec Mon Sep 17 00:00:00 2001 From: Bibo-Joshi <22366557+Bibo-Joshi@users.noreply.github.com> Date: Fri, 1 Nov 2024 22:17:14 +0100 Subject: [PATCH 17/25] Fix Linkcheck Workflow (#4545) --- .github/workflows/docs-linkcheck.yml | 5 ++++- README.rst | 4 ++-- telegram/_files/inputfile.py | 4 ++-- 3 files changed, 8 insertions(+), 5 deletions(-) diff --git a/.github/workflows/docs-linkcheck.yml b/.github/workflows/docs-linkcheck.yml index f34fcc17d22..ea78626c31b 100644 --- a/.github/workflows/docs-linkcheck.yml +++ b/.github/workflows/docs-linkcheck.yml @@ -3,6 +3,9 @@ on: schedule: # First day of month at 05:46 in every 2nd month - cron: '46 5 1 */2 *' + pull_request: + paths: + - .github/workflows/docs-linkcheck.yml jobs: test-sphinx-build: @@ -10,7 +13,7 @@ jobs: runs-on: ${{matrix.os}} strategy: matrix: - python-version: [3.10] + python-version: ['3.10'] os: [ubuntu-latest] fail-fast: False steps: diff --git a/README.rst b/README.rst index 035180a3ce0..aba1c2c09fd 100644 --- a/README.rst +++ b/README.rst @@ -121,7 +121,7 @@ To enable you to verify that a release file that you downloaded was indeed provi Starting with v21.4, all releases are signed via `sigstore `_. The corresponding signature files are uploaded to the `GitHub releases page`_. -To verify the signature, please install the `sigstore Python client `_ and follow the instructions for `verifying signatures from GitHub Actions `_. As input for the ``--repository`` parameter, please use the value ``python-telegram-bot/python-telegram-bot``. +To verify the signature, please install the `sigstore Python client `_ and follow the instructions for `verifying signatures from GitHub Actions `_. As input for the ``--repository`` parameter, please use the value ``python-telegram-bot/python-telegram-bot``. Earlier releases are signed with a GPG key. The signatures are uploaded to both the `GitHub releases page`_ and the `PyPI project `_ and end with a suffix ``.asc``. @@ -232,4 +232,4 @@ License You may copy, distribute and modify the software provided that modifications are described and licensed for free under `LGPL-3 `_. Derivatives works (including modifications or anything statically linked to the library) can only be redistributed under LGPL-3, but applications that use the library don't have to be. -.. _`GitHub releases page`: https://github.com/python-telegram-bot/python-telegram-bot/releases> +.. _`GitHub releases page`: https://github.com/python-telegram-bot/python-telegram-bot/releases diff --git a/telegram/_files/inputfile.py b/telegram/_files/inputfile.py index d376d16a106..61e5a94192d 100644 --- a/telegram/_files/inputfile.py +++ b/telegram/_files/inputfile.py @@ -56,8 +56,8 @@ class InputFile: read_file_handle (:obj:`bool`, optional): If :obj:`True` and :paramref:`obj` is a file handle, the data will be read from the file handle on initialization of this object. If :obj:`False`, the file handle will be passed on to the - `networking backend `_ which will have to - handle the reading. Defaults to :obj:`True`. + :attr:`networking backend ` which will have + to handle the reading. Defaults to :obj:`True`. Tip: If you upload extremely large files, you may want to set this to :obj:`False` to From bd6a60bb30c716d9dd510a007e082b47acd68ffe Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Sat, 2 Nov 2024 18:04:50 +0100 Subject: [PATCH 18/25] Bump `srvaroa/labeler` from 1.11.0 to 1.11.1 (#4549) Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .github/workflows/labelling.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/labelling.yml b/.github/workflows/labelling.yml index fa497fc41ce..c0eaa2aab23 100644 --- a/.github/workflows/labelling.yml +++ b/.github/workflows/labelling.yml @@ -11,7 +11,7 @@ jobs: pull-requests: write # for srvaroa/labeler to add labels in PR runs-on: ubuntu-latest steps: - - uses: srvaroa/labeler@v1.11.0 + - uses: srvaroa/labeler@v1.11.1 # Config file at .github/labeler.yml env: GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}" From 507d6bc0e3649916b2f416aff3a2e6c35fc03de2 Mon Sep 17 00:00:00 2001 From: Bibo-Joshi <22366557+Bibo-Joshi@users.noreply.github.com> Date: Sun, 3 Nov 2024 16:35:16 +0100 Subject: [PATCH 19/25] Improve Exception Handling in `File.download_*` (#4542) --- telegram/_files/file.py | 42 +++++++++++++++++++++++++++++++++------ tests/_files/test_file.py | 24 +++++++++------------- 2 files changed, 45 insertions(+), 21 deletions(-) diff --git a/telegram/_files/file.py b/telegram/_files/file.py index c9b8d22d49a..640dfc96884 100644 --- a/telegram/_files/file.py +++ b/telegram/_files/file.py @@ -128,9 +128,8 @@ async def download_to_drive( ) -> Path: """ Download this file. By default, the file is saved in the current working directory with - :attr:`file_path` as file name. If the file has no filename, the file ID will be used as - filename. If :paramref:`custom_path` is supplied as a :obj:`str` or :obj:`pathlib.Path`, - it will be saved to that path. + :attr:`file_path` as file name. If :paramref:`custom_path` is supplied as a :obj:`str` or + :obj:`pathlib.Path`, it will be saved to that path. Note: If :paramref:`custom_path` isn't provided and :attr:`file_path` is the path of a @@ -152,6 +151,11 @@ async def download_to_drive( * This method was previously called ``download``. It was split into :meth:`download_to_drive` and :meth:`download_to_memory`. + .. versionchanged:: NEXT.VERSION + Raises :exc:`RuntimeError` if :attr:`file_path` is not set. Note that files without + a :attr:`file_path` could never be downloaded, as this attribute is mandatory for that + operation. + Args: custom_path (:class:`pathlib.Path` | :obj:`str` , optional): The path where the file will be saved to. If not specified, will be saved in the current working directory @@ -175,7 +179,13 @@ async def download_to_drive( Returns: :class:`pathlib.Path`: Returns the Path object the file was downloaded to. + Raises: + RuntimeError: If :attr:`file_path` is not set. + """ + if not self.file_path: + raise RuntimeError("No `file_path` available for this file. Can not download.") + local_file = is_local_file(self.file_path) url = None if local_file else self._get_encoded_url() @@ -198,10 +208,8 @@ async def download_to_drive( filename = Path(custom_path) elif local_file: return Path(self.file_path) - elif self.file_path: - filename = Path(Path(self.file_path).name) else: - filename = Path.cwd() / self.file_id + filename = Path(Path(self.file_path).name) buf = await self.get_bot().request.retrieve( url, @@ -237,6 +245,11 @@ async def download_to_memory( .. versionadded:: 20.0 + .. versionchanged:: NEXT.VERSION + Raises :exc:`RuntimeError` if :attr:`file_path` is not set. Note that files without + a :attr:`file_path` could never be downloaded, as this attribute is mandatory for that + operation. + Args: out (:obj:`io.BufferedIOBase`): A file-like object. Must be opened for writing in binary mode. @@ -254,7 +267,13 @@ async def download_to_memory( pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to :paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to :attr:`~telegram.request.BaseRequest.DEFAULT_NONE`. + + Raises: + RuntimeError: If :attr:`file_path` is not set. """ + if not self.file_path: + raise RuntimeError("No `file_path` available for this file. Can not download.") + local_file = is_local_file(self.file_path) url = None if local_file else self._get_encoded_url() path = Path(self.file_path) if local_file else None @@ -283,6 +302,11 @@ async def download_as_bytearray( ) -> bytearray: """Download this file and return it as a bytearray. + .. versionchanged:: NEXT.VERSION + Raises :exc:`RuntimeError` if :attr:`file_path` is not set. Note that files without + a :attr:`file_path` could never be downloaded, as this attribute is mandatory for that + operation. + Args: buf (:obj:`bytearray`, optional): Extend the given bytearray with the downloaded data. @@ -312,7 +336,13 @@ async def download_as_bytearray( :obj:`bytearray`: The same object as :paramref:`buf` if it was specified. Otherwise a newly allocated :obj:`bytearray`. + Raises: + RuntimeError: If :attr:`file_path` is not set. + """ + if not self.file_path: + raise RuntimeError("No `file_path` available for this file. Can not download.") + if buf is None: buf = bytearray() diff --git a/tests/_files/test_file.py b/tests/_files/test_file.py index 70874d5feb8..fbf71dc70ba 100644 --- a/tests/_files/test_file.py +++ b/tests/_files/test_file.py @@ -17,6 +17,7 @@ # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. import os +from io import BytesIO from pathlib import Path from tempfile import TemporaryFile, mkstemp @@ -181,21 +182,6 @@ async def test(*args, **kwargs): os.close(file_handle) custom_path.unlink(missing_ok=True) - async def test_download_no_filename(self, monkeypatch, file): - async def test(*args, **kwargs): - return self.file_content - - file.file_path = None - - monkeypatch.setattr(file.get_bot().request, "retrieve", test) - out_file = await file.download_to_drive() - - assert str(out_file)[-len(file.file_id) :] == file.file_id - try: - assert out_file.read_bytes() == self.file_content - finally: - out_file.unlink(missing_ok=True) - async def test_download_file_obj(self, monkeypatch, file): async def test(*args, **kwargs): return self.file_content @@ -272,6 +258,14 @@ async def test(*args, **kwargs): assert buf2[len(buf) :] == buf assert buf2[: len(buf)] == buf + async def test_download_no_file_path(self): + with pytest.raises(RuntimeError, match="No `file_path` available"): + await File(self.file_id, self.file_unique_id).download_to_drive() + with pytest.raises(RuntimeError, match="No `file_path` available"): + await File(self.file_id, self.file_unique_id).download_to_memory(BytesIO()) + with pytest.raises(RuntimeError, match="No `file_path` available"): + await File(self.file_id, self.file_unique_id).download_as_bytearray() + class TestFileWithRequest(FileTestBase): async def test_error_get_empty_file_id(self, bot): From 032a859149280d60448d7783a5bed3c422c6711b Mon Sep 17 00:00:00 2001 From: Bibo-Joshi <22366557+Bibo-Joshi@users.noreply.github.com> Date: Sun, 3 Nov 2024 21:43:40 +0100 Subject: [PATCH 20/25] Update Automation to Label Changes (#4552) --- .github/ISSUE_TEMPLATE/bug-report.yml | 2 +- .github/ISSUE_TEMPLATE/feature-request.yml | 2 +- .github/labeler.yml | 4 ++-- .github/workflows/stale.yml | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 509f689df40..3b8dd46e5fb 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -1,7 +1,7 @@ name: Bug Report description: Create a report to help us improve title: "[BUG]" -labels: ["bug :bug:"] +labels: ["📋 triage"] body: - type: markdown diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml index 6c7ff80390e..efd7f4d2bdd 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.yml +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -1,7 +1,7 @@ name: Feature Request description: Suggest an idea for this project title: "[FEATURE]" -labels: ["enhancement"] +labels: ["📋 triage"] body: - type: textarea diff --git a/.github/labeler.yml b/.github/labeler.yml index 120c88f4b36..3d2eb437df9 100644 --- a/.github/labeler.yml +++ b/.github/labeler.yml @@ -3,7 +3,7 @@ version: 1 labels: -- label: "dependencies" +- label: "⚙️ dependencies" authors: ["dependabot[bot]", "pre-commit-ci[bot]"] -- label: "code quality ✨" +- label: "🛠 code-quality" authors: ["pre-commit-ci[bot]"] diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml index 56ba7410946..3b07166b244 100644 --- a/.github/workflows/stale.yml +++ b/.github/workflows/stale.yml @@ -13,7 +13,7 @@ jobs: days-before-stale: 3 days-before-close: 2 days-before-pr-stale: -1 - stale-issue-label: 'stale' + stale-issue-label: '📋 stale' only-labels: 'question' stale-issue-message: '' close-issue-message: 'This issue has been automatically closed due to inactivity. Feel free to comment in order to reopen or ask again in our Telegram support group at https://t.me/pythontelegrambotgroup.' From 7a8f4412b2fea84bd1499be07423dac6a9b34f71 Mon Sep 17 00:00:00 2001 From: Bibo-Joshi <22366557+Bibo-Joshi@users.noreply.github.com> Date: Mon, 4 Nov 2024 19:08:04 +0100 Subject: [PATCH 21/25] Update Issue Templates to Use Issue Types (#4553) --- .github/ISSUE_TEMPLATE/bug-report.yml | 2 +- .github/ISSUE_TEMPLATE/feature-request.yml | 2 +- .github/ISSUE_TEMPLATE/question.yml | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 3b8dd46e5fb..53c89496b21 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -1,7 +1,7 @@ name: Bug Report description: Create a report to help us improve -title: "[BUG]" labels: ["📋 triage"] +type: '🐛 bug' body: - type: markdown diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml index efd7f4d2bdd..e6cc817a1bd 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.yml +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -1,7 +1,7 @@ name: Feature Request description: Suggest an idea for this project -title: "[FEATURE]" labels: ["📋 triage"] +type: '💡 feature' body: - type: textarea diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml index 1836230ff21..220da04007e 100644 --- a/.github/ISSUE_TEMPLATE/question.yml +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -1,7 +1,7 @@ name: Question description: Get help with errors or general questions -title: "[QUESTION]" labels: ["question"] +type: '❔ question' body: - type: markdown From 62f89758d7174c138f525a447dcdaafe08e7dc1c Mon Sep 17 00:00:00 2001 From: Bibo-Joshi <22366557+Bibo-Joshi@users.noreply.github.com> Date: Mon, 4 Nov 2024 20:11:10 +0100 Subject: [PATCH 22/25] Bot API 7.11 (#4546) --- README.rst | 4 +- docs/source/telegram.at-tree.rst | 1 + docs/source/telegram.copytextbutton.rst | 6 + docs/source/telegram.payments-tree.rst | 1 + .../telegram.transactionpartnerfragment.rst | 2 +- .../telegram.transactionpartnerother.rst | 2 +- ...telegram.transactionpartnertelegramads.rst | 2 +- ...telegram.transactionpartnertelegramapi.rst | 7 + .../telegram.transactionpartneruser.rst | 2 +- docs/substitutions/global.rst | 2 + telegram/__init__.py | 4 + telegram/_bot.py | 142 ++++++++++++++---- telegram/_callbackquery.py | 2 + telegram/_chat.py | 40 +++++ telegram/_copytextbutton.py | 55 +++++++ telegram/_inline/inlinekeyboardbutton.py | 13 ++ telegram/_message.py | 54 ++++++- telegram/_messageentity.py | 18 ++- telegram/_messageid.py | 10 +- telegram/_payment/stars.py | 38 ++++- telegram/_user.py | 38 +++++ telegram/constants.py | 32 +++- telegram/ext/_extbot.py | 40 +++++ tests/_inline/test_inlinekeyboardbutton.py | 9 ++ tests/test_bot.py | 10 ++ tests/test_copytextbutton.py | 70 +++++++++ tests/test_stars.py | 46 ++++-- 27 files changed, 583 insertions(+), 67 deletions(-) create mode 100644 docs/source/telegram.copytextbutton.rst create mode 100644 docs/source/telegram.transactionpartnertelegramapi.rst create mode 100644 telegram/_copytextbutton.py create mode 100644 tests/test_copytextbutton.py diff --git a/README.rst b/README.rst index aba1c2c09fd..dd19bbbbdeb 100644 --- a/README.rst +++ b/README.rst @@ -11,7 +11,7 @@ :target: https://pypi.org/project/python-telegram-bot/ :alt: Supported Python versions -.. image:: https://img.shields.io/badge/Bot%20API-7.10-blue?logo=telegram +.. image:: https://img.shields.io/badge/Bot%20API-7.11-blue?logo=telegram :target: https://core.telegram.org/bots/api-changelog :alt: Supported Bot API version @@ -81,7 +81,7 @@ After installing_ the library, be sure to check out the section on `working with Telegram API support ~~~~~~~~~~~~~~~~~~~~ -All types and methods of the Telegram Bot API **7.10** are natively supported by this library. +All types and methods of the Telegram Bot API **7.11** are natively supported by this library. In addition, Bot API functionality not yet natively included can still be used as described `in our wiki `_. Notable Features diff --git a/docs/source/telegram.at-tree.rst b/docs/source/telegram.at-tree.rst index f40223391fc..bdeb7015985 100644 --- a/docs/source/telegram.at-tree.rst +++ b/docs/source/telegram.at-tree.rst @@ -29,6 +29,7 @@ Available Types telegram.chat telegram.chatadministratorrights telegram.chatbackground + telegram.copytextbutton telegram.backgroundtype telegram.backgroundtypefill telegram.backgroundtypewallpaper diff --git a/docs/source/telegram.copytextbutton.rst b/docs/source/telegram.copytextbutton.rst new file mode 100644 index 00000000000..7110fbf8b6b --- /dev/null +++ b/docs/source/telegram.copytextbutton.rst @@ -0,0 +1,6 @@ +CopyTextButton +============== + +.. autoclass:: telegram.CopyTextButton + :members: + :show-inheritance: \ No newline at end of file diff --git a/docs/source/telegram.payments-tree.rst b/docs/source/telegram.payments-tree.rst index ba4c838cae7..590a96fdaa5 100644 --- a/docs/source/telegram.payments-tree.rst +++ b/docs/source/telegram.payments-tree.rst @@ -28,4 +28,5 @@ Your bot can accept payments from Telegram users. Please see the `introduction t telegram.transactionpartnerfragment telegram.transactionpartnerother telegram.transactionpartnertelegramads + telegram.transactionpartnertelegramapi telegram.transactionpartneruser diff --git a/docs/source/telegram.transactionpartnerfragment.rst b/docs/source/telegram.transactionpartnerfragment.rst index 0845b4a800b..c65f9262f81 100644 --- a/docs/source/telegram.transactionpartnerfragment.rst +++ b/docs/source/telegram.transactionpartnerfragment.rst @@ -4,4 +4,4 @@ TransactionPartnerFragment .. autoclass:: telegram.TransactionPartnerFragment :members: :show-inheritance: - :inherited-members: TelegramObject + :inherited-members: TransactionPartner diff --git a/docs/source/telegram.transactionpartnerother.rst b/docs/source/telegram.transactionpartnerother.rst index c3ffddc7de0..b0c14f0713c 100644 --- a/docs/source/telegram.transactionpartnerother.rst +++ b/docs/source/telegram.transactionpartnerother.rst @@ -4,4 +4,4 @@ TransactionPartnerOther .. autoclass:: telegram.TransactionPartnerOther :members: :show-inheritance: - :inherited-members: TelegramObject + :inherited-members: TransactionPartner diff --git a/docs/source/telegram.transactionpartnertelegramads.rst b/docs/source/telegram.transactionpartnertelegramads.rst index 926b25bdcd4..ce9a52a117f 100644 --- a/docs/source/telegram.transactionpartnertelegramads.rst +++ b/docs/source/telegram.transactionpartnertelegramads.rst @@ -4,4 +4,4 @@ TransactionPartnerTelegramAds .. autoclass:: telegram.TransactionPartnerTelegramAds :members: :show-inheritance: - :inherited-members: TelegramObject + :inherited-members: TransactionPartner diff --git a/docs/source/telegram.transactionpartnertelegramapi.rst b/docs/source/telegram.transactionpartnertelegramapi.rst new file mode 100644 index 00000000000..9aeba6b94b8 --- /dev/null +++ b/docs/source/telegram.transactionpartnertelegramapi.rst @@ -0,0 +1,7 @@ +TransactionPartnerTelegramApi +============================= + +.. autoclass:: telegram.TransactionPartnerTelegramApi + :members: + :show-inheritance: + :inherited-members: TransactionPartner diff --git a/docs/source/telegram.transactionpartneruser.rst b/docs/source/telegram.transactionpartneruser.rst index d2e145e1866..def37495344 100644 --- a/docs/source/telegram.transactionpartneruser.rst +++ b/docs/source/telegram.transactionpartneruser.rst @@ -4,4 +4,4 @@ TransactionPartnerUser .. autoclass:: telegram.TransactionPartnerUser :members: :show-inheritance: - :inherited-members: TelegramObject + :inherited-members: TransactionPartner diff --git a/docs/substitutions/global.rst b/docs/substitutions/global.rst index 88a604cd139..ab9c69249c9 100644 --- a/docs/substitutions/global.rst +++ b/docs/substitutions/global.rst @@ -93,3 +93,5 @@ .. |show_cap_above_med| replace:: :obj:`True`, if the caption must be shown above the message media. .. |tg_stars| replace:: `Telegram Stars `__ + +.. |allow_paid_broadcast| replace:: Pass True to allow up to :tg-const:`telegram.constants.FloodLimit.PAID_MESSAGES_PER_SECOND` messages per second, ignoring `broadcasting limits `__ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance. diff --git a/telegram/__init__.py b/telegram/__init__.py index 0ff15a7a9a4..a4902d4d882 100644 --- a/telegram/__init__.py +++ b/telegram/__init__.py @@ -81,6 +81,7 @@ "ChatShared", "ChosenInlineResult", "Contact", + "CopyTextButton", "Credentials", "DataCredentials", "Dice", @@ -235,6 +236,7 @@ "TransactionPartnerFragment", "TransactionPartnerOther", "TransactionPartnerTelegramAds", + "TransactionPartnerTelegramApi", "TransactionPartnerUser", "Update", "User", @@ -330,6 +332,7 @@ from ._chatmemberupdated import ChatMemberUpdated from ._chatpermissions import ChatPermissions from ._choseninlineresult import ChosenInlineResult +from ._copytextbutton import CopyTextButton from ._dice import Dice from ._files.animation import Animation from ._files.audio import Audio @@ -471,6 +474,7 @@ TransactionPartnerFragment, TransactionPartnerOther, TransactionPartnerTelegramAds, + TransactionPartnerTelegramApi, TransactionPartnerUser, ) from ._payment.successfulpayment import SuccessfulPayment diff --git a/telegram/_bot.py b/telegram/_bot.py index 345dac4ed13..44866870280 100644 --- a/telegram/_bot.py +++ b/telegram/_bot.py @@ -672,6 +672,7 @@ async def _send_message( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, reply_to_message_id: Optional[int] = None, @@ -708,33 +709,22 @@ async def _send_message( allow_sending_without_reply=allow_sending_without_reply, ) - data["disable_notification"] = disable_notification - data["protect_content"] = protect_content - data["parse_mode"] = parse_mode - - if reply_parameters is not None: - data["reply_parameters"] = reply_parameters - - if link_preview_options is not None: - data["link_preview_options"] = link_preview_options - - if reply_markup is not None: - data["reply_markup"] = reply_markup - - if message_thread_id is not None: - data["message_thread_id"] = message_thread_id - - if caption is not None: - data["caption"] = caption - - if caption_entities is not None: - data["caption_entities"] = caption_entities - - if business_connection_id is not None: - data["business_connection_id"] = business_connection_id - - if message_effect_id is not None: - data["message_effect_id"] = message_effect_id + data.update( + { + "allow_paid_broadcast": allow_paid_broadcast, + "business_connection_id": business_connection_id, + "caption": caption, + "caption_entities": caption_entities, + "disable_notification": disable_notification, + "link_preview_options": link_preview_options, + "message_thread_id": message_thread_id, + "message_effect_id": message_effect_id, + "parse_mode": parse_mode, + "protect_content": protect_content, + "reply_markup": reply_markup, + "reply_parameters": reply_parameters, + } + ) result = await self._post( endpoint, @@ -925,6 +915,7 @@ async def send_message( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, reply_to_message_id: Optional[int] = None, @@ -976,6 +967,9 @@ async def send_message( message_effect_id (:obj:`str`, optional): |message_effect_id| .. versionadded:: 21.3 + allow_paid_broadcast (:obj:`bool`, optional): |allow_paid_broadcast| + + .. versionadded:: NEXT.VERSION Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| @@ -1034,6 +1028,7 @@ async def send_message( link_preview_options=link_preview_options, reply_parameters=reply_parameters, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, read_timeout=read_timeout, write_timeout=write_timeout, connect_timeout=connect_timeout, @@ -1283,6 +1278,7 @@ async def send_photo( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, show_caption_above_media: Optional[bool] = None, *, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -1350,6 +1346,9 @@ async def send_photo( message_effect_id (:obj:`str`, optional): |message_effect_id| .. versionadded:: 21.3 + allow_paid_broadcast (:obj:`bool`, optional): |allow_paid_broadcast| + + .. versionadded:: NEXT.VERSION show_caption_above_media (:obj:`bool`, optional): Pass |show_cap_above_med| .. versionadded:: 21.3 @@ -1413,6 +1412,7 @@ async def send_photo( api_kwargs=api_kwargs, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_audio( @@ -1433,6 +1433,7 @@ async def send_audio( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, reply_to_message_id: Optional[int] = None, @@ -1508,6 +1509,9 @@ async def send_audio( message_effect_id (:obj:`str`, optional): |message_effect_id| .. versionadded:: 21.3 + allow_paid_broadcast (:obj:`bool`, optional): |allow_paid_broadcast| + + .. versionadded:: NEXT.VERSION Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| @@ -1570,6 +1574,7 @@ async def send_audio( api_kwargs=api_kwargs, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_document( @@ -1588,6 +1593,7 @@ async def send_document( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, reply_to_message_id: Optional[int] = None, @@ -1662,6 +1668,9 @@ async def send_document( message_effect_id (:obj:`str`, optional): |message_effect_id| .. versionadded:: 21.3 + allow_paid_broadcast (:obj:`bool`, optional): |allow_paid_broadcast| + + .. versionadded:: NEXT.VERSION Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| @@ -1720,6 +1729,7 @@ async def send_document( api_kwargs=api_kwargs, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_sticker( @@ -1734,6 +1744,7 @@ async def send_sticker( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, reply_to_message_id: Optional[int] = None, @@ -1788,6 +1799,9 @@ async def send_sticker( message_effect_id (:obj:`str`, optional): |message_effect_id| .. versionadded:: 21.3 + allow_paid_broadcast (:obj:`bool`, optional): |allow_paid_broadcast| + + .. versionadded:: NEXT.VERSION Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| @@ -1838,6 +1852,7 @@ async def send_sticker( api_kwargs=api_kwargs, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_video( @@ -1860,6 +1875,7 @@ async def send_video( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, show_caption_above_media: Optional[bool] = None, *, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -1944,6 +1960,9 @@ async def send_video( message_effect_id (:obj:`str`, optional): |message_effect_id| .. versionadded:: 21.3 + allow_paid_broadcast (:obj:`bool`, optional): |allow_paid_broadcast| + + .. versionadded:: NEXT.VERSION show_caption_above_media (:obj:`bool`, optional): Pass |show_cap_above_med| .. versionadded:: 21.3 @@ -2012,6 +2031,7 @@ async def send_video( api_kwargs=api_kwargs, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_video_note( @@ -2028,6 +2048,7 @@ async def send_video_note( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, reply_to_message_id: Optional[int] = None, @@ -2097,6 +2118,9 @@ async def send_video_note( message_effect_id (:obj:`str`, optional): |message_effect_id| .. versionadded:: 21.3 + allow_paid_broadcast (:obj:`bool`, optional): |allow_paid_broadcast| + + .. versionadded:: NEXT.VERSION Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| @@ -2155,6 +2179,7 @@ async def send_video_note( api_kwargs=api_kwargs, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_animation( @@ -2176,6 +2201,7 @@ async def send_animation( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, show_caption_above_media: Optional[bool] = None, *, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -2254,6 +2280,9 @@ async def send_animation( message_effect_id (:obj:`str`, optional): |message_effect_id| .. versionadded:: 21.3 + allow_paid_broadcast (:obj:`bool`, optional): |allow_paid_broadcast| + + .. versionadded:: NEXT.VERSION show_caption_above_media (:obj:`bool`, optional): Pass |show_cap_above_med| .. versionadded:: 21.3 @@ -2321,6 +2350,7 @@ async def send_animation( api_kwargs=api_kwargs, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_voice( @@ -2338,6 +2368,7 @@ async def send_voice( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, reply_to_message_id: Optional[int] = None, @@ -2409,6 +2440,9 @@ async def send_voice( message_effect_id (:obj:`str`, optional): |message_effect_id| .. versionadded:: 21.3 + allow_paid_broadcast (:obj:`bool`, optional): |allow_paid_broadcast| + + .. versionadded:: NEXT.VERSION Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| @@ -2468,6 +2502,7 @@ async def send_voice( api_kwargs=api_kwargs, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_media_group( @@ -2482,6 +2517,7 @@ async def send_media_group( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, reply_to_message_id: Optional[int] = None, @@ -2535,6 +2571,9 @@ async def send_media_group( message_effect_id (:obj:`str`, optional): |message_effect_id| .. versionadded:: 21.3 + allow_paid_broadcast (:obj:`bool`, optional): |allow_paid_broadcast| + + .. versionadded:: NEXT.VERSION Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| @@ -2629,6 +2668,7 @@ async def send_media_group( "reply_parameters": reply_parameters, "business_connection_id": business_connection_id, "message_effect_id": message_effect_id, + "allow_paid_broadcast": allow_paid_broadcast, } result = await self._post( @@ -2659,6 +2699,7 @@ async def send_location( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, reply_to_message_id: Optional[int] = None, @@ -2718,6 +2759,9 @@ async def send_location( message_effect_id (:obj:`str`, optional): |message_effect_id| .. versionadded:: 21.3 + allow_paid_broadcast (:obj:`bool`, optional): |allow_paid_broadcast| + + .. versionadded:: NEXT.VERSION Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| @@ -2788,6 +2832,7 @@ async def send_location( api_kwargs=api_kwargs, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def edit_message_live_location( @@ -2970,6 +3015,7 @@ async def send_venue( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, reply_to_message_id: Optional[int] = None, @@ -3025,6 +3071,9 @@ async def send_venue( message_effect_id (:obj:`str`, optional): |message_effect_id| .. versionadded:: 21.3 + allow_paid_broadcast (:obj:`bool`, optional): |allow_paid_broadcast| + + .. versionadded:: NEXT.VERSION Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| @@ -3106,6 +3155,7 @@ async def send_venue( api_kwargs=api_kwargs, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_contact( @@ -3122,6 +3172,7 @@ async def send_contact( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, reply_to_message_id: Optional[int] = None, @@ -3167,6 +3218,9 @@ async def send_contact( message_effect_id (:obj:`str`, optional): |message_effect_id| .. versionadded:: 21.3 + allow_paid_broadcast (:obj:`bool`, optional): |allow_paid_broadcast| + + .. versionadded:: NEXT.VERSION Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| @@ -3239,6 +3293,7 @@ async def send_contact( api_kwargs=api_kwargs, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_game( @@ -3252,6 +3307,7 @@ async def send_game( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, reply_to_message_id: Optional[int] = None, @@ -3287,6 +3343,9 @@ async def send_game( message_effect_id (:obj:`str`, optional): |message_effect_id| .. versionadded:: 21.3 + allow_paid_broadcast (:obj:`bool`, optional): |allow_paid_broadcast| + + .. versionadded:: NEXT.VERSION Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| @@ -3334,6 +3393,7 @@ async def send_game( api_kwargs=api_kwargs, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_chat_action( @@ -4148,7 +4208,8 @@ async def edit_message_media( api_kwargs: Optional[JSONDict] = None, ) -> Union[Message, bool]: """ - Use this method to edit animation, audio, document, photo, or video messages. If a message + Use this method to edit animation, audio, document, photo, or video messages, or to add + media to text messages. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo or a video otherwise. When an inline message is edited, a new file can't be uploaded; use a previously uploaded file via its @@ -4973,6 +5034,7 @@ async def send_invoice( message_thread_id: Optional[int] = None, reply_parameters: Optional["ReplyParameters"] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, reply_to_message_id: Optional[int] = None, @@ -5090,6 +5152,9 @@ async def send_invoice( message_effect_id (:obj:`str`, optional): |message_effect_id| .. versionadded:: 21.3 + allow_paid_broadcast (:obj:`bool`, optional): |allow_paid_broadcast| + + .. versionadded:: NEXT.VERSION Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| @@ -5159,6 +5224,7 @@ async def send_invoice( pool_timeout=pool_timeout, api_kwargs=api_kwargs, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def answer_shipping_query( @@ -6999,6 +7065,7 @@ async def send_poll( question_parse_mode: ODVInput[str] = DEFAULT_NONE, question_entities: Optional[Sequence["MessageEntity"]] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, reply_to_message_id: Optional[int] = None, @@ -7096,6 +7163,9 @@ async def send_poll( message_effect_id (:obj:`str`, optional): |message_effect_id| .. versionadded:: 21.3 + allow_paid_broadcast (:obj:`bool`, optional): |allow_paid_broadcast| + + .. versionadded:: NEXT.VERSION Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| @@ -7162,6 +7232,7 @@ async def send_poll( api_kwargs=api_kwargs, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def stop_poll( @@ -7225,6 +7296,7 @@ async def send_dice( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, reply_to_message_id: Optional[int] = None, @@ -7274,6 +7346,9 @@ async def send_dice( message_effect_id (:obj:`str`, optional): |message_effect_id| .. versionadded:: 21.3 + allow_paid_broadcast (:obj:`bool`, optional): |allow_paid_broadcast| + + .. versionadded:: NEXT.VERSION Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| @@ -7322,6 +7397,7 @@ async def send_dice( api_kwargs=api_kwargs, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def get_my_default_administrator_rights( @@ -7652,6 +7728,7 @@ async def copy_message( message_thread_id: Optional[int] = None, reply_parameters: Optional["ReplyParameters"] = None, show_caption_above_media: Optional[bool] = None, + allow_paid_broadcast: Optional[bool] = None, *, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, reply_to_message_id: Optional[int] = None, @@ -7699,6 +7776,9 @@ async def copy_message( show_caption_above_media (:obj:`bool`, optional): Pass |show_cap_above_med| .. versionadded:: 21.3 + allow_paid_broadcast (:obj:`bool`, optional): |allow_paid_broadcast| + + .. versionadded:: NEXT.VERSION Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| @@ -7757,6 +7837,7 @@ async def copy_message( "message_thread_id": message_thread_id, "reply_parameters": reply_parameters, "show_caption_above_media": show_caption_above_media, + "allow_paid_broadcast": allow_paid_broadcast, } result = await self._post( @@ -9188,6 +9269,7 @@ async def send_paid_media( reply_markup: Optional[ReplyMarkup] = None, business_connection_id: Optional[str] = None, payload: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, reply_to_message_id: Optional[int] = None, @@ -9231,6 +9313,9 @@ async def send_paid_media( business_connection_id (:obj:`str`, optional): |business_id_str| .. versionadded:: 21.5 + allow_paid_broadcast (:obj:`bool`, optional): |allow_paid_broadcast| + + .. versionadded:: NEXT.VERSION Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| @@ -9274,6 +9359,7 @@ async def send_paid_media( pool_timeout=pool_timeout, api_kwargs=api_kwargs, business_connection_id=business_connection_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def create_chat_subscription_invite_link( diff --git a/telegram/_callbackquery.py b/telegram/_callbackquery.py index af44a3243c3..9264feaaa8f 100644 --- a/telegram/_callbackquery.py +++ b/telegram/_callbackquery.py @@ -834,6 +834,7 @@ async def copy_message( message_thread_id: Optional[int] = None, reply_parameters: Optional["ReplyParameters"] = None, show_caption_above_media: Optional[bool] = None, + allow_paid_broadcast: Optional[bool] = None, *, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, reply_to_message_id: Optional[int] = None, @@ -881,6 +882,7 @@ async def copy_message( message_thread_id=message_thread_id, reply_parameters=reply_parameters, show_caption_above_media=show_caption_above_media, + allow_paid_broadcast=allow_paid_broadcast, ) MAX_ANSWER_TEXT_LENGTH: Final[int] = ( diff --git a/telegram/_chat.py b/telegram/_chat.py index 7e5dc0ad89c..bb0e24b1da5 100644 --- a/telegram/_chat.py +++ b/telegram/_chat.py @@ -1012,6 +1012,7 @@ async def send_message( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -1053,6 +1054,7 @@ async def send_message( api_kwargs=api_kwargs, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def delete_message( @@ -1130,6 +1132,7 @@ async def send_media_group( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -1172,6 +1175,7 @@ async def send_media_group( reply_parameters=reply_parameters, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_chat_action( @@ -1225,6 +1229,7 @@ async def send_photo( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, show_caption_above_media: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, @@ -1268,6 +1273,7 @@ async def send_photo( has_spoiler=has_spoiler, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, show_caption_above_media=show_caption_above_media, ) @@ -1284,6 +1290,7 @@ async def send_contact( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -1325,6 +1332,7 @@ async def send_contact( message_thread_id=message_thread_id, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_audio( @@ -1344,6 +1352,7 @@ async def send_audio( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -1389,6 +1398,7 @@ async def send_audio( thumbnail=thumbnail, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_document( @@ -1406,6 +1416,7 @@ async def send_document( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -1449,6 +1460,7 @@ async def send_document( message_thread_id=message_thread_id, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_dice( @@ -1461,6 +1473,7 @@ async def send_dice( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -1497,6 +1510,7 @@ async def send_dice( message_thread_id=message_thread_id, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_game( @@ -1509,6 +1523,7 @@ async def send_game( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -1545,6 +1560,7 @@ async def send_game( message_thread_id=message_thread_id, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_invoice( @@ -1576,6 +1592,7 @@ async def send_invoice( message_thread_id: Optional[int] = None, reply_parameters: Optional["ReplyParameters"] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -1641,6 +1658,7 @@ async def send_invoice( message_thread_id=message_thread_id, reply_parameters=reply_parameters, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_location( @@ -1658,6 +1676,7 @@ async def send_location( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -1701,6 +1720,7 @@ async def send_location( message_thread_id=message_thread_id, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_animation( @@ -1721,6 +1741,7 @@ async def send_animation( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, show_caption_above_media: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, @@ -1768,6 +1789,7 @@ async def send_animation( thumbnail=thumbnail, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, show_caption_above_media=show_caption_above_media, ) @@ -1782,6 +1804,7 @@ async def send_sticker( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -1819,6 +1842,7 @@ async def send_sticker( emoji=emoji, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_venue( @@ -1838,6 +1862,7 @@ async def send_venue( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -1883,6 +1908,7 @@ async def send_venue( message_thread_id=message_thread_id, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_video( @@ -1904,6 +1930,7 @@ async def send_video( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, show_caption_above_media: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, @@ -1952,6 +1979,7 @@ async def send_video( has_spoiler=has_spoiler, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, show_caption_above_media=show_caption_above_media, ) @@ -1968,6 +1996,7 @@ async def send_video_note( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -2009,6 +2038,7 @@ async def send_video_note( message_thread_id=message_thread_id, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_voice( @@ -2025,6 +2055,7 @@ async def send_voice( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -2067,6 +2098,7 @@ async def send_voice( message_thread_id=message_thread_id, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_poll( @@ -2092,6 +2124,7 @@ async def send_poll( question_parse_mode: ODVInput[str] = DEFAULT_NONE, question_entities: Optional[Sequence["MessageEntity"]] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -2129,6 +2162,7 @@ async def send_poll( connect_timeout=connect_timeout, pool_timeout=pool_timeout, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, explanation=explanation, explanation_parse_mode=explanation_parse_mode, open_period=open_period, @@ -2156,6 +2190,7 @@ async def send_copy( message_thread_id: Optional[int] = None, reply_parameters: Optional["ReplyParameters"] = None, show_caption_above_media: Optional[bool] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -2197,6 +2232,7 @@ async def send_copy( protect_content=protect_content, message_thread_id=message_thread_id, show_caption_above_media=show_caption_above_media, + allow_paid_broadcast=allow_paid_broadcast, ) async def copy_message( @@ -2212,6 +2248,7 @@ async def copy_message( message_thread_id: Optional[int] = None, reply_parameters: Optional["ReplyParameters"] = None, show_caption_above_media: Optional[bool] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -2253,6 +2290,7 @@ async def copy_message( protect_content=protect_content, message_thread_id=message_thread_id, show_caption_above_media=show_caption_above_media, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_copies( @@ -3352,6 +3390,7 @@ async def send_paid_media( reply_markup: Optional[ReplyMarkup] = None, business_connection_id: Optional[str] = None, payload: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, reply_to_message_id: Optional[int] = None, @@ -3394,6 +3433,7 @@ async def send_paid_media( api_kwargs=api_kwargs, business_connection_id=business_connection_id, payload=payload, + allow_paid_broadcast=allow_paid_broadcast, ) diff --git a/telegram/_copytextbutton.py b/telegram/_copytextbutton.py new file mode 100644 index 00000000000..e3dee813b9a --- /dev/null +++ b/telegram/_copytextbutton.py @@ -0,0 +1,55 @@ +#!/usr/bin/env python +# +# A library that provides a Python interface to the Telegram Bot API +# Copyright (C) 2015-2024 +# Leandro Toledo de Souza +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Lesser Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Lesser Public License for more details. +# +# You should have received a copy of the GNU Lesser Public License +# along with this program. If not, see [http://www.gnu.org/licenses/]. +"""This module contains an object that represents a Telegram CopyTextButton.""" +from typing import Optional + +from telegram._telegramobject import TelegramObject +from telegram._utils.types import JSONDict + + +class CopyTextButton(TelegramObject): + """ + This object represents an inline keyboard button that copies specified text to the clipboard. + + Objects of this class are comparable in terms of equality. Two objects of this class are + considered equal, if their :attr:`text` is equal. + + .. versionadded:: NEXT.VERSION + + Args: + text (:obj:`str`): The text to be copied to the clipboard; + :tg-const:`telegram.constants.InlineKeyboardButtonLimit.MIN_COPY_TEXT`- + :tg-const:`telegram.constants.InlineKeyboardButtonLimit.MAX_COPY_TEXT` characters + + Attributes: + text (:obj:`str`): The text to be copied to the clipboard; + :tg-const:`telegram.constants.InlineKeyboardButtonLimit.MIN_COPY_TEXT`- + :tg-const:`telegram.constants.InlineKeyboardButtonLimit.MAX_COPY_TEXT` characters + + """ + + __slots__ = ("text",) + + def __init__(self, text: str, *, api_kwargs: Optional[JSONDict] = None): + super().__init__(api_kwargs=api_kwargs) + self.text: str = text + + self._id_attrs = (self.text,) + + self._freeze() diff --git a/telegram/_inline/inlinekeyboardbutton.py b/telegram/_inline/inlinekeyboardbutton.py index cff4df66a21..62031af8cd2 100644 --- a/telegram/_inline/inlinekeyboardbutton.py +++ b/telegram/_inline/inlinekeyboardbutton.py @@ -21,6 +21,7 @@ from typing import TYPE_CHECKING, Final, Optional, Union from telegram import constants +from telegram._copytextbutton import CopyTextButton from telegram._games.callbackgame import CallbackGame from telegram._loginurl import LoginUrl from telegram._switchinlinequerychosenchat import SwitchInlineQueryChosenChat @@ -123,6 +124,10 @@ class InlineKeyboardButton(TelegramObject): This offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting something from multiple options. Not supported in channels and for messages sent on behalf of a Telegram Business account. + copy_text (:class:`telegram.CopyTextButton`, optional): Description of the button that + copies the specified text to the clipboard. + + .. versionadded:: NEXT.VERSION callback_game (:class:`telegram.CallbackGame`, optional): Description of the game that will be launched when the user presses the button @@ -192,6 +197,10 @@ class InlineKeyboardButton(TelegramObject): This offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting something from multiple options. Not supported in channels and for messages sent on behalf of a Telegram Business account. + copy_text (:class:`telegram.CopyTextButton`): Optional. Description of the button that + copies the specified text to the clipboard. + + .. versionadded:: NEXT.VERSION callback_game (:class:`telegram.CallbackGame`): Optional. Description of the game that will be launched when the user presses the button. @@ -224,6 +233,7 @@ class InlineKeyboardButton(TelegramObject): __slots__ = ( "callback_data", "callback_game", + "copy_text", "login_url", "pay", "switch_inline_query", @@ -246,6 +256,7 @@ def __init__( login_url: Optional[LoginUrl] = None, web_app: Optional[WebAppInfo] = None, switch_inline_query_chosen_chat: Optional[SwitchInlineQueryChosenChat] = None, + copy_text: Optional[CopyTextButton] = None, *, api_kwargs: Optional[JSONDict] = None, ): @@ -265,6 +276,7 @@ def __init__( self.switch_inline_query_chosen_chat: Optional[SwitchInlineQueryChosenChat] = ( switch_inline_query_chosen_chat ) + self.copy_text: Optional[CopyTextButton] = copy_text self._id_attrs = () self._set_id_attrs() @@ -299,6 +311,7 @@ def de_json( data["switch_inline_query_chosen_chat"] = SwitchInlineQueryChosenChat.de_json( data.get("switch_inline_query_chosen_chat"), bot ) + data["copy_text"] = CopyTextButton.de_json(data.get("copy_text"), bot) return super().de_json(data=data, bot=bot) diff --git a/telegram/_message.py b/telegram/_message.py index 44490482b29..6390c8b0532 100644 --- a/telegram/_message.py +++ b/telegram/_message.py @@ -280,7 +280,10 @@ class Message(MaybeInaccessibleMessage): and notice that some positional arguments changed position as a result. Args: - message_id (:obj:`int`): Unique message identifier inside this chat. + message_id (:obj:`int`): Unique message identifier inside this chat. In specific instances + (e.g., message containing a video sent to a big chat), the server might automatically + schedule a message instead of sending it immediately. In such cases, this field will be + ``0`` and the relevant message will be unusable until it is actually sent. from_user (:class:`telegram.User`, optional): Sender of the message; may be empty for messages sent to channels. For backward compatibility, if the message was sent on behalf of a chat, the field contains a fake sender user in non-channel chats. @@ -590,7 +593,10 @@ class Message(MaybeInaccessibleMessage): .. versionadded:: 21.4 Attributes: - message_id (:obj:`int`): Unique message identifier inside this chat. + message_id (:obj:`int`): Unique message identifier inside this chat. In specific instances + (e.g., message containing a video sent to a big chat), the server might automatically + schedule a message instead of sending it immediately. In such cases, this field will be + ``0`` and the relevant message will be unusable until it is actually sent. from_user (:class:`telegram.User`): Optional. Sender of the message; may be empty for messages sent to channels. For backward compatibility, if the message was sent on behalf of a chat, the field contains a fake sender user in non-channel chats. @@ -1715,6 +1721,7 @@ async def reply_text( link_preview_options: ODVInput["LinkPreviewOptions"] = DEFAULT_NONE, reply_parameters: Optional["ReplyParameters"] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -1780,6 +1787,7 @@ async def reply_text( api_kwargs=api_kwargs, business_connection_id=self.business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def reply_markdown( @@ -1793,6 +1801,7 @@ async def reply_markdown( link_preview_options: ODVInput["LinkPreviewOptions"] = DEFAULT_NONE, reply_parameters: Optional["ReplyParameters"] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -1864,6 +1873,7 @@ async def reply_markdown( api_kwargs=api_kwargs, business_connection_id=self.business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def reply_markdown_v2( @@ -1877,6 +1887,7 @@ async def reply_markdown_v2( link_preview_options: ODVInput["LinkPreviewOptions"] = DEFAULT_NONE, reply_parameters: Optional["ReplyParameters"] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -1944,6 +1955,7 @@ async def reply_markdown_v2( api_kwargs=api_kwargs, business_connection_id=self.business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def reply_html( @@ -1957,6 +1969,7 @@ async def reply_html( link_preview_options: ODVInput["LinkPreviewOptions"] = DEFAULT_NONE, reply_parameters: Optional["ReplyParameters"] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -2024,6 +2037,7 @@ async def reply_html( api_kwargs=api_kwargs, business_connection_id=self.business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def reply_media_group( @@ -2036,6 +2050,7 @@ async def reply_media_group( message_thread_id: ODVInput[int] = DEFAULT_NONE, reply_parameters: Optional["ReplyParameters"] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -2103,6 +2118,7 @@ async def reply_media_group( caption_entities=caption_entities, business_connection_id=self.business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def reply_photo( @@ -2118,6 +2134,7 @@ async def reply_photo( has_spoiler: Optional[bool] = None, reply_parameters: Optional["ReplyParameters"] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, show_caption_above_media: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, @@ -2185,6 +2202,7 @@ async def reply_photo( has_spoiler=has_spoiler, business_connection_id=self.business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, show_caption_above_media=show_caption_above_media, ) @@ -2204,6 +2222,7 @@ async def reply_audio( thumbnail: Optional[FileInput] = None, reply_parameters: Optional["ReplyParameters"] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -2273,6 +2292,7 @@ async def reply_audio( thumbnail=thumbnail, business_connection_id=self.business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def reply_document( @@ -2289,6 +2309,7 @@ async def reply_document( thumbnail: Optional[FileInput] = None, reply_parameters: Optional["ReplyParameters"] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -2356,6 +2377,7 @@ async def reply_document( thumbnail=thumbnail, business_connection_id=self.business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def reply_animation( @@ -2375,6 +2397,7 @@ async def reply_animation( thumbnail: Optional[FileInput] = None, reply_parameters: Optional["ReplyParameters"] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, show_caption_above_media: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, @@ -2446,6 +2469,7 @@ async def reply_animation( thumbnail=thumbnail, business_connection_id=self.business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, show_caption_above_media=show_caption_above_media, ) @@ -2459,6 +2483,7 @@ async def reply_sticker( emoji: Optional[str] = None, reply_parameters: Optional["ReplyParameters"] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -2520,6 +2545,7 @@ async def reply_sticker( emoji=emoji, business_connection_id=self.business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def reply_video( @@ -2540,6 +2566,7 @@ async def reply_video( thumbnail: Optional[FileInput] = None, reply_parameters: Optional["ReplyParameters"] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, show_caption_above_media: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, @@ -2612,6 +2639,7 @@ async def reply_video( thumbnail=thumbnail, business_connection_id=self.business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, show_caption_above_media=show_caption_above_media, ) @@ -2627,6 +2655,7 @@ async def reply_video_note( thumbnail: Optional[FileInput] = None, reply_parameters: Optional["ReplyParameters"] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -2692,6 +2721,7 @@ async def reply_video_note( thumbnail=thumbnail, business_connection_id=self.business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def reply_voice( @@ -2707,6 +2737,7 @@ async def reply_voice( message_thread_id: ODVInput[int] = DEFAULT_NONE, reply_parameters: Optional["ReplyParameters"] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -2773,6 +2804,7 @@ async def reply_voice( message_thread_id=message_thread_id, business_connection_id=self.business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def reply_location( @@ -2789,6 +2821,7 @@ async def reply_location( message_thread_id: ODVInput[int] = DEFAULT_NONE, reply_parameters: Optional["ReplyParameters"] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -2856,6 +2889,7 @@ async def reply_location( message_thread_id=message_thread_id, business_connection_id=self.business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def reply_venue( @@ -2874,6 +2908,7 @@ async def reply_venue( message_thread_id: ODVInput[int] = DEFAULT_NONE, reply_parameters: Optional["ReplyParameters"] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -2943,6 +2978,7 @@ async def reply_venue( message_thread_id=message_thread_id, business_connection_id=self.business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def reply_contact( @@ -2957,6 +2993,7 @@ async def reply_contact( message_thread_id: ODVInput[int] = DEFAULT_NONE, reply_parameters: Optional["ReplyParameters"] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -3022,6 +3059,7 @@ async def reply_contact( message_thread_id=message_thread_id, business_connection_id=self.business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def reply_poll( @@ -3046,6 +3084,7 @@ async def reply_poll( question_parse_mode: ODVInput[str] = DEFAULT_NONE, question_entities: Optional[Sequence["MessageEntity"]] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -3119,6 +3158,7 @@ async def reply_poll( question_parse_mode=question_parse_mode, question_entities=question_entities, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def reply_dice( @@ -3130,6 +3170,7 @@ async def reply_dice( message_thread_id: ODVInput[int] = DEFAULT_NONE, reply_parameters: Optional["ReplyParameters"] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -3190,6 +3231,7 @@ async def reply_dice( message_thread_id=message_thread_id, business_connection_id=self.business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def reply_chat_action( @@ -3245,6 +3287,7 @@ async def reply_game( message_thread_id: ODVInput[int] = DEFAULT_NONE, reply_parameters: Optional["ReplyParameters"] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -3307,6 +3350,7 @@ async def reply_game( message_thread_id=message_thread_id, business_connection_id=self.business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def reply_invoice( @@ -3338,6 +3382,7 @@ async def reply_invoice( message_thread_id: ODVInput[int] = DEFAULT_NONE, reply_parameters: Optional["ReplyParameters"] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -3428,6 +3473,7 @@ async def reply_invoice( protect_content=protect_content, message_thread_id=message_thread_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def forward( @@ -3492,6 +3538,7 @@ async def copy( message_thread_id: Optional[int] = None, reply_parameters: Optional["ReplyParameters"] = None, show_caption_above_media: Optional[bool] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -3537,6 +3584,7 @@ async def copy( protect_content=protect_content, message_thread_id=message_thread_id, show_caption_above_media=show_caption_above_media, + allow_paid_broadcast=allow_paid_broadcast, ) async def reply_copy( @@ -3552,6 +3600,7 @@ async def reply_copy( message_thread_id: ODVInput[int] = DEFAULT_NONE, reply_parameters: Optional["ReplyParameters"] = None, show_caption_above_media: Optional[bool] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -3616,6 +3665,7 @@ async def reply_copy( protect_content=protect_content, message_thread_id=message_thread_id, show_caption_above_media=show_caption_above_media, + allow_paid_broadcast=allow_paid_broadcast, ) async def edit_text( diff --git a/telegram/_messageentity.py b/telegram/_messageentity.py index 4b076d5e540..2fa5953d56d 100644 --- a/telegram/_messageentity.py +++ b/telegram/_messageentity.py @@ -45,10 +45,11 @@ class MessageEntity(TelegramObject): considered equal, if their :attr:`type`, :attr:`offset` and :attr:`length` are equal. Args: - type (:obj:`str`): Type of the entity. Can be :attr:`MENTION` (@username), - :attr:`HASHTAG` (#hashtag), :attr:`CASHTAG` ($USD), :attr:`BOT_COMMAND` - (/start@jobs_bot), :attr:`URL` (https://telegram.org), - :attr:`EMAIL` (do-not-reply@telegram.org), :attr:`PHONE_NUMBER` (+1-212-555-0123), + type (:obj:`str`): Type of the entity. Can be :attr:`MENTION` (``@username``), + :attr:`HASHTAG` (``#hashtag`` or ``#hashtag@chatusername``), :attr:`CASHTAG` (``$USD`` + or ``USD@chatusername``), :attr:`BOT_COMMAND` (``/start@jobs_bot``), :attr:`URL` + (``https://telegram.org``), :attr:`EMAIL` (``do-not-reply@telegram.org``), + :attr:`PHONE_NUMBER` (``+1-212-555-0123``), :attr:`BOLD` (**bold text**), :attr:`ITALIC` (*italic text*), :attr:`UNDERLINE` (underlined text), :attr:`STRIKETHROUGH`, :attr:`SPOILER` (spoiler message), :attr:`BLOCKQUOTE` (block quotation), :attr:`CODE` (monowidth string), :attr:`PRE` @@ -74,10 +75,11 @@ class MessageEntity(TelegramObject): .. versionadded:: 20.0 Attributes: - type (:obj:`str`): Type of the entity. Can be :attr:`MENTION` (@username), - :attr:`HASHTAG` (#hashtag), :attr:`CASHTAG` ($USD), :attr:`BOT_COMMAND` - (/start@jobs_bot), :attr:`URL` (https://telegram.org), - :attr:`EMAIL` (do-not-reply@telegram.org), :attr:`PHONE_NUMBER` (+1-212-555-0123), + type (:obj:`str`): Type of the entity. Can be :attr:`MENTION` (``@username``), + :attr:`HASHTAG` (``#hashtag`` or ``#hashtag@chatusername``), :attr:`CASHTAG` (``$USD`` + or ``USD@chatusername``), :attr:`BOT_COMMAND` (``/start@jobs_bot``), :attr:`URL` + (``https://telegram.org``), :attr:`EMAIL` (``do-not-reply@telegram.org``), + :attr:`PHONE_NUMBER` (``+1-212-555-0123``), :attr:`BOLD` (**bold text**), :attr:`ITALIC` (*italic text*), :attr:`UNDERLINE` (underlined text), :attr:`STRIKETHROUGH`, :attr:`SPOILER` (spoiler message), :attr:`BLOCKQUOTE` (block quotation), :attr:`CODE` (monowidth string), :attr:`PRE` diff --git a/telegram/_messageid.py b/telegram/_messageid.py index bbfedf47037..b63fbe97dcc 100644 --- a/telegram/_messageid.py +++ b/telegram/_messageid.py @@ -31,10 +31,16 @@ class MessageId(TelegramObject): considered equal, if their :attr:`message_id` is equal. Args: - message_id (:obj:`int`): Unique message identifier. + message_id (:obj:`int`): Unique message identifier. In specific instances + (e.g., message containing a video sent to a big chat), the server might automatically + schedule a message instead of sending it immediately. In such cases, this field will be + ``0`` and the relevant message will be unusable until it is actually sent. Attributes: - message_id (:obj:`int`): Unique message identifier. + message_id (:obj:`int`): Unique message identifier. In specific instances + (e.g., message containing a video sent to a big chat), the server might automatically + schedule a message instead of sending it immediately. In such cases, this field will be + ``0`` and the relevant message will be unusable until it is actually sent. """ __slots__ = ("message_id",) diff --git a/telegram/_payment/stars.py b/telegram/_payment/stars.py index 32678915a45..b420805f514 100644 --- a/telegram/_payment/stars.py +++ b/telegram/_payment/stars.py @@ -218,12 +218,14 @@ class TransactionPartner(TelegramObject): FRAGMENT: Final[str] = constants.TransactionPartnerType.FRAGMENT """:const:`telegram.constants.TransactionPartnerType.FRAGMENT`""" - USER: Final[str] = constants.TransactionPartnerType.USER - """:const:`telegram.constants.TransactionPartnerType.USER`""" OTHER: Final[str] = constants.TransactionPartnerType.OTHER """:const:`telegram.constants.TransactionPartnerType.OTHER`""" TELEGRAM_ADS: Final[str] = constants.TransactionPartnerType.TELEGRAM_ADS """:const:`telegram.constants.TransactionPartnerType.TELEGRAM_ADS`""" + TELEGRAM_API: Final[str] = constants.TransactionPartnerType.TELEGRAM_API + """:const:`telegram.constants.TransactionPartnerType.TELEGRAM_API`""" + USER: Final[str] = constants.TransactionPartnerType.USER + """:const:`telegram.constants.TransactionPartnerType.USER`""" def __init__(self, type: str, *, api_kwargs: Optional[JSONDict] = None) -> None: super().__init__(api_kwargs=api_kwargs) @@ -258,8 +260,9 @@ def de_json( _class_mapping: dict[str, type[TransactionPartner]] = { cls.FRAGMENT: TransactionPartnerFragment, cls.USER: TransactionPartnerUser, - cls.OTHER: TransactionPartnerOther, cls.TELEGRAM_ADS: TransactionPartnerTelegramAds, + cls.TELEGRAM_API: TransactionPartnerTelegramApi, + cls.OTHER: TransactionPartnerOther, } if cls is TransactionPartner and data.get("type") in _class_mapping: @@ -421,6 +424,35 @@ def __init__(self, *, api_kwargs: Optional[JSONDict] = None) -> None: self._freeze() +class TransactionPartnerTelegramApi(TransactionPartner): + """Describes a transaction with payment for + `paid broadcasting `_. + + Objects of this class are comparable in terms of equality. Two objects of this class are + considered equal, if their :attr:`request_count` is equal. + + .. versionadded:: NEXT.VERSION + + Args: + request_count (:obj:`int`): The number of successful requests that exceeded regular limits + and were therefore billed. + + Attributes: + type (:obj:`str`): The type of the transaction partner, + always :tg-const:`telegram.TransactionPartner.TELEGRAM_API`. + request_count (:obj:`int`): The number of successful requests that exceeded regular limits + and were therefore billed. + """ + + __slots__ = ("request_count",) + + def __init__(self, request_count: int, *, api_kwargs: Optional[JSONDict] = None) -> None: + super().__init__(type=TransactionPartner.TELEGRAM_API, api_kwargs=api_kwargs) + with self._unfrozen(): + self.request_count: int = request_count + self._id_attrs = (self.request_count,) + + class StarTransaction(TelegramObject): """Describes a Telegram Star transaction. diff --git a/telegram/_user.py b/telegram/_user.py index 9e8e1f0ea1f..980ce7e4991 100644 --- a/telegram/_user.py +++ b/telegram/_user.py @@ -427,6 +427,7 @@ async def send_message( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, disable_web_page_preview: Optional[bool] = None, @@ -471,6 +472,7 @@ async def send_message( api_kwargs=api_kwargs, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def delete_message( @@ -551,6 +553,7 @@ async def send_photo( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, show_caption_above_media: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, @@ -597,6 +600,7 @@ async def send_photo( has_spoiler=has_spoiler, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, show_caption_above_media=show_caption_above_media, ) @@ -611,6 +615,7 @@ async def send_media_group( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -656,6 +661,7 @@ async def send_media_group( caption_entities=caption_entities, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_audio( @@ -675,6 +681,7 @@ async def send_audio( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -723,6 +730,7 @@ async def send_audio( thumbnail=thumbnail, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_chat_action( @@ -778,6 +786,7 @@ async def send_contact( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -822,6 +831,7 @@ async def send_contact( message_thread_id=message_thread_id, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_dice( @@ -834,6 +844,7 @@ async def send_dice( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -873,6 +884,7 @@ async def send_dice( message_thread_id=message_thread_id, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_document( @@ -890,6 +902,7 @@ async def send_document( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -936,6 +949,7 @@ async def send_document( message_thread_id=message_thread_id, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_game( @@ -948,6 +962,7 @@ async def send_game( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -987,6 +1002,7 @@ async def send_game( message_thread_id=message_thread_id, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_invoice( @@ -1018,6 +1034,7 @@ async def send_invoice( message_thread_id: Optional[int] = None, reply_parameters: Optional["ReplyParameters"] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -1086,6 +1103,7 @@ async def send_invoice( protect_content=protect_content, message_thread_id=message_thread_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_location( @@ -1103,6 +1121,7 @@ async def send_location( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -1149,6 +1168,7 @@ async def send_location( message_thread_id=message_thread_id, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_animation( @@ -1169,6 +1189,7 @@ async def send_animation( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, show_caption_above_media: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, @@ -1219,6 +1240,7 @@ async def send_animation( thumbnail=thumbnail, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, show_caption_above_media=show_caption_above_media, ) @@ -1233,6 +1255,7 @@ async def send_sticker( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -1273,6 +1296,7 @@ async def send_sticker( emoji=emoji, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_video( @@ -1294,6 +1318,7 @@ async def send_video( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, show_caption_above_media: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, @@ -1345,6 +1370,7 @@ async def send_video( has_spoiler=has_spoiler, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, show_caption_above_media=show_caption_above_media, ) @@ -1365,6 +1391,7 @@ async def send_venue( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -1413,6 +1440,7 @@ async def send_venue( message_thread_id=message_thread_id, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_video_note( @@ -1428,6 +1456,7 @@ async def send_video_note( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -1472,6 +1501,7 @@ async def send_video_note( thumbnail=thumbnail, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_voice( @@ -1488,6 +1518,7 @@ async def send_voice( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -1533,6 +1564,7 @@ async def send_voice( message_thread_id=message_thread_id, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_poll( @@ -1558,6 +1590,7 @@ async def send_poll( question_parse_mode: ODVInput[str] = DEFAULT_NONE, question_entities: Optional[Sequence["MessageEntity"]] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -1610,6 +1643,7 @@ async def send_poll( question_parse_mode=question_parse_mode, question_entities=question_entities, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_copy( @@ -1625,6 +1659,7 @@ async def send_copy( message_thread_id: Optional[int] = None, reply_parameters: Optional["ReplyParameters"] = None, show_caption_above_media: Optional[bool] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -1667,6 +1702,7 @@ async def send_copy( protect_content=protect_content, message_thread_id=message_thread_id, show_caption_above_media=show_caption_above_media, + allow_paid_broadcast=allow_paid_broadcast, ) async def copy_message( @@ -1682,6 +1718,7 @@ async def copy_message( message_thread_id: Optional[int] = None, reply_parameters: Optional["ReplyParameters"] = None, show_caption_above_media: Optional[bool] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -1724,6 +1761,7 @@ async def copy_message( protect_content=protect_content, message_thread_id=message_thread_id, show_caption_above_media=show_caption_above_media, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_copies( diff --git a/telegram/constants.py b/telegram/constants.py index cffe79880cb..5ff4b8147fc 100644 --- a/telegram/constants.py +++ b/telegram/constants.py @@ -152,7 +152,7 @@ class _AccentColor(NamedTuple): #: :data:`telegram.__bot_api_version_info__`. #: #: .. versionadded:: 20.0 -BOT_API_VERSION_INFO: Final[_BotAPIVersion] = _BotAPIVersion(major=7, minor=10) +BOT_API_VERSION_INFO: Final[_BotAPIVersion] = _BotAPIVersion(major=7, minor=11) #: :obj:`str`: Telegram Bot API #: version supported by this version of `python-telegram-bot`. Also available as #: :data:`telegram.__bot_api_version__`. @@ -1154,6 +1154,14 @@ class FloodLimit(IntEnum): """:obj:`int`: The number of messages that can roughly be sent to a particular group within one minute. """ + PAID_MESSAGES_PER_SECOND = 1000 + """:obj:`int`: The number of messages that can be sent per second when paying with the bot's + Telegram Star balance. See e.g. parameter + :paramref:`~telegram.Bot.send_message.allow_paid_broadcast` of + :meth:`~telegram.Bot.send_message`. + + .. versionadded:: NEXT.VERSION + """ class ForumIconColor(IntEnum): @@ -1261,15 +1269,23 @@ class InlineKeyboardButtonLimit(IntEnum): __slots__ = () MIN_CALLBACK_DATA = 1 - """:obj:`int`: Minimum value allowed for + """:obj:`int`: Minimum length allowed for :paramref:`~telegram.InlineKeyboardButton.callback_data` parameter of :class:`telegram.InlineKeyboardButton` """ MAX_CALLBACK_DATA = 64 - """:obj:`int`: Maximum value allowed for + """:obj:`int`: Maximum length allowed for :paramref:`~telegram.InlineKeyboardButton.callback_data` parameter of :class:`telegram.InlineKeyboardButton` """ + MIN_COPY_TEXT = 1 + """:obj:`int`: Minimum length allowed for + :paramref:`~telegram.CopyTextButton.text` parameter of :class:`telegram.CopyTextButton` + """ + MAX_COPY_TEXT = 256 + """:obj:`int`: Maximum length allowed for + :paramref:`~telegram.CopyTextButton.text` parameter of :class:`telegram.CopyTextButton` + """ class InlineKeyboardMarkupLimit(IntEnum): @@ -2592,12 +2608,18 @@ class TransactionPartnerType(StringEnum): FRAGMENT = "fragment" """:obj:`str`: Withdrawal transaction with Fragment.""" - USER = "user" - """:obj:`str`: Transaction with a user.""" OTHER = "other" """:obj:`str`: Transaction with unknown source or recipient.""" TELEGRAM_ADS = "telegram_ads" """:obj:`str`: Transaction with Telegram Ads.""" + TELEGRAM_API = "telegram_api" + """:obj:`str`: Transaction with with payment for + `paid broadcasting `_. + + ..versionadded:: NEXT.VERSION + """ + USER = "user" + """:obj:`str`: Transaction with a user.""" class ParseMode(StringEnum): diff --git a/telegram/ext/_extbot.py b/telegram/ext/_extbot.py index 2a4cdb2e4cb..66921e415df 100644 --- a/telegram/ext/_extbot.py +++ b/telegram/ext/_extbot.py @@ -592,6 +592,7 @@ async def _send_message( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -624,6 +625,7 @@ async def _send_message( api_kwargs=api_kwargs, business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) if isinstance(result, Message): self._insert_callback_data(result) @@ -801,6 +803,7 @@ async def copy_message( message_thread_id: Optional[int] = None, reply_parameters: Optional["ReplyParameters"] = None, show_caption_above_media: Optional[bool] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -832,6 +835,7 @@ async def copy_message( pool_timeout=pool_timeout, api_kwargs=self._merge_api_rl_kwargs(api_kwargs, rate_limit_args), show_caption_above_media=show_caption_above_media, + allow_paid_broadcast=allow_paid_broadcast, ) async def copy_messages( @@ -2398,6 +2402,7 @@ async def send_animation( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, show_caption_above_media: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, @@ -2436,6 +2441,7 @@ async def send_animation( pool_timeout=pool_timeout, api_kwargs=self._merge_api_rl_kwargs(api_kwargs, rate_limit_args), message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, show_caption_above_media=show_caption_above_media, ) @@ -2457,6 +2463,7 @@ async def send_audio( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -2493,6 +2500,7 @@ async def send_audio( pool_timeout=pool_timeout, api_kwargs=self._merge_api_rl_kwargs(api_kwargs, rate_limit_args), message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_chat_action( @@ -2535,6 +2543,7 @@ async def send_contact( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -2567,6 +2576,7 @@ async def send_contact( business_connection_id=business_connection_id, api_kwargs=self._merge_api_rl_kwargs(api_kwargs, rate_limit_args), message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_dice( @@ -2580,6 +2590,7 @@ async def send_dice( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -2607,6 +2618,7 @@ async def send_dice( pool_timeout=pool_timeout, api_kwargs=self._merge_api_rl_kwargs(api_kwargs, rate_limit_args), message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_document( @@ -2625,6 +2637,7 @@ async def send_document( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -2659,6 +2672,7 @@ async def send_document( pool_timeout=pool_timeout, api_kwargs=self._merge_api_rl_kwargs(api_kwargs, rate_limit_args), message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_game( @@ -2672,6 +2686,7 @@ async def send_game( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -2699,6 +2714,7 @@ async def send_game( pool_timeout=pool_timeout, api_kwargs=self._merge_api_rl_kwargs(api_kwargs, rate_limit_args), message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_invoice( @@ -2731,6 +2747,7 @@ async def send_invoice( message_thread_id: Optional[int] = None, reply_parameters: Optional["ReplyParameters"] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -2777,6 +2794,7 @@ async def send_invoice( pool_timeout=pool_timeout, api_kwargs=self._merge_api_rl_kwargs(api_kwargs, rate_limit_args), message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_location( @@ -2795,6 +2813,7 @@ async def send_location( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -2829,6 +2848,7 @@ async def send_location( pool_timeout=pool_timeout, api_kwargs=self._merge_api_rl_kwargs(api_kwargs, rate_limit_args), message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_media_group( @@ -2843,6 +2863,7 @@ async def send_media_group( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -2875,6 +2896,7 @@ async def send_media_group( parse_mode=parse_mode, caption_entities=caption_entities, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_message( @@ -2891,6 +2913,7 @@ async def send_message( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, disable_web_page_preview: Optional[bool] = None, reply_to_message_id: Optional[int] = None, @@ -2923,6 +2946,7 @@ async def send_message( api_kwargs=self._merge_api_rl_kwargs(api_kwargs, rate_limit_args), link_preview_options=link_preview_options, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_photo( @@ -2940,6 +2964,7 @@ async def send_photo( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, show_caption_above_media: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, @@ -2974,6 +2999,7 @@ async def send_photo( pool_timeout=pool_timeout, api_kwargs=self._merge_api_rl_kwargs(api_kwargs, rate_limit_args), message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, show_caption_above_media=show_caption_above_media, ) @@ -3001,6 +3027,7 @@ async def send_poll( question_parse_mode: ODVInput[str] = DEFAULT_NONE, question_entities: Optional[Sequence["MessageEntity"]] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -3041,6 +3068,7 @@ async def send_poll( question_parse_mode=question_parse_mode, question_entities=question_entities, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_sticker( @@ -3055,6 +3083,7 @@ async def send_sticker( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -3083,6 +3112,7 @@ async def send_sticker( emoji=emoji, api_kwargs=self._merge_api_rl_kwargs(api_kwargs, rate_limit_args), message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_venue( @@ -3103,6 +3133,7 @@ async def send_venue( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -3139,6 +3170,7 @@ async def send_venue( pool_timeout=pool_timeout, api_kwargs=self._merge_api_rl_kwargs(api_kwargs, rate_limit_args), message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_video( @@ -3161,6 +3193,7 @@ async def send_video( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, show_caption_above_media: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, @@ -3200,6 +3233,7 @@ async def send_video( pool_timeout=pool_timeout, api_kwargs=self._merge_api_rl_kwargs(api_kwargs, rate_limit_args), message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, show_caption_above_media=show_caption_above_media, ) @@ -3217,6 +3251,7 @@ async def send_video_note( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -3249,6 +3284,7 @@ async def send_video_note( api_kwargs=self._merge_api_rl_kwargs(api_kwargs, rate_limit_args), business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def send_voice( @@ -3266,6 +3302,7 @@ async def send_voice( reply_parameters: Optional["ReplyParameters"] = None, business_connection_id: Optional[str] = None, message_effect_id: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, reply_to_message_id: Optional[int] = None, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, @@ -3299,6 +3336,7 @@ async def send_voice( api_kwargs=self._merge_api_rl_kwargs(api_kwargs, rate_limit_args), business_connection_id=business_connection_id, message_effect_id=message_effect_id, + allow_paid_broadcast=allow_paid_broadcast, ) async def set_chat_administrator_custom_title( @@ -4232,6 +4270,7 @@ async def send_paid_media( reply_markup: Optional[ReplyMarkup] = None, business_connection_id: Optional[str] = None, payload: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, *, allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, reply_to_message_id: Optional[int] = None, @@ -4263,6 +4302,7 @@ async def send_paid_media( api_kwargs=self._merge_api_rl_kwargs(api_kwargs, rate_limit_args), business_connection_id=business_connection_id, payload=payload, + allow_paid_broadcast=allow_paid_broadcast, ) async def create_chat_subscription_invite_link( diff --git a/tests/_inline/test_inlinekeyboardbutton.py b/tests/_inline/test_inlinekeyboardbutton.py index 6e406f3ecc3..a71e774898d 100644 --- a/tests/_inline/test_inlinekeyboardbutton.py +++ b/tests/_inline/test_inlinekeyboardbutton.py @@ -21,6 +21,7 @@ from telegram import ( CallbackGame, + CopyTextButton, InlineKeyboardButton, LoginUrl, SwitchInlineQueryChosenChat, @@ -46,6 +47,7 @@ def inline_keyboard_button(): switch_inline_query_chosen_chat=( InlineKeyboardButtonTestBase.switch_inline_query_chosen_chat ), + copy_text=InlineKeyboardButtonTestBase.copy_text, ) @@ -60,6 +62,7 @@ class InlineKeyboardButtonTestBase: login_url = LoginUrl("http://google.com") web_app = WebAppInfo(url="https://example.com") switch_inline_query_chosen_chat = SwitchInlineQueryChosenChat("a_bot", True, False, True, True) + copy_text = CopyTextButton("python-telegram-bot") class TestInlineKeyboardButtonWithoutRequest(InlineKeyboardButtonTestBase): @@ -86,6 +89,7 @@ def test_expected_values(self, inline_keyboard_button): inline_keyboard_button.switch_inline_query_chosen_chat == self.switch_inline_query_chosen_chat ) + assert inline_keyboard_button.copy_text == self.copy_text def test_to_dict(self, inline_keyboard_button): inline_keyboard_button_dict = inline_keyboard_button.to_dict() @@ -115,6 +119,9 @@ def test_to_dict(self, inline_keyboard_button): inline_keyboard_button_dict["switch_inline_query_chosen_chat"] == inline_keyboard_button.switch_inline_query_chosen_chat.to_dict() ) + assert ( + inline_keyboard_button_dict["copy_text"] == inline_keyboard_button.copy_text.to_dict() + ) def test_de_json(self, offline_bot): json_dict = { @@ -128,6 +135,7 @@ def test_de_json(self, offline_bot): "login_url": self.login_url.to_dict(), "pay": self.pay, "switch_inline_query_chosen_chat": self.switch_inline_query_chosen_chat.to_dict(), + "copy_text": self.copy_text.to_dict(), } inline_keyboard_button = InlineKeyboardButton.de_json(json_dict, None) @@ -149,6 +157,7 @@ def test_de_json(self, offline_bot): inline_keyboard_button.switch_inline_query_chosen_chat == self.switch_inline_query_chosen_chat ) + assert inline_keyboard_button.copy_text == self.copy_text none = InlineKeyboardButton.de_json({}, offline_bot) assert none is None diff --git a/tests/test_bot.py b/tests/test_bot.py index 7f060fb0992..8ff0dec8d7b 100644 --- a/tests/test_bot.py +++ b/tests/test_bot.py @@ -2253,6 +2253,16 @@ async def make_assertion(url, request_data: RequestData, *args, **kwargs): monkeypatch.setattr(offline_bot.request, "post", make_assertion) assert await offline_bot.send_message(2, "text", message_effect_id=42) + async def test_allow_paid_broadcast_argument(self, offline_bot, monkeypatch): + """We can't test every single method easily, so we just test one. Our linting will catch + any unused args with the others.""" + + async def make_assertion(url, request_data: RequestData, *args, **kwargs): + return request_data.parameters.get("allow_paid_broadcast") == 42 + + monkeypatch.setattr(offline_bot.request, "post", make_assertion) + assert await offline_bot.send_message(2, "text", allow_paid_broadcast=42) + async def test_get_business_connection(self, offline_bot, monkeypatch): bci = "42" user = User(1, "first", False) diff --git a/tests/test_copytextbutton.py b/tests/test_copytextbutton.py new file mode 100644 index 00000000000..7092456d490 --- /dev/null +++ b/tests/test_copytextbutton.py @@ -0,0 +1,70 @@ +#!/usr/bin/env python +# +# A library that provides a Python interface to the Telegram Bot API +# Copyright (C) 2015-2024 +# Leandro Toledo de Souza +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Lesser Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Lesser Public License for more details. +# +# You should have received a copy of the GNU Lesser Public License +# along with this program. If not, see [http://www.gnu.org/licenses/]. + +import pytest + +from telegram import BotCommand, CopyTextButton +from tests.auxil.slots import mro_slots + + +@pytest.fixture(scope="module") +def copy_text_button(): + return CopyTextButton(text=CopyTextButtonTestBase.text) + + +class CopyTextButtonTestBase: + text = "This is some text" + + +class TestCopyTextButtonWithoutRequest(CopyTextButtonTestBase): + def test_slot_behaviour(self, copy_text_button): + for attr in copy_text_button.__slots__: + assert getattr(copy_text_button, attr, "err") != "err", f"got extra slot '{attr}'" + assert len(mro_slots(copy_text_button)) == len( + set(mro_slots(copy_text_button)) + ), "duplicate slot" + + def test_de_json(self, offline_bot): + json_dict = {"text": self.text} + copy_text_button = CopyTextButton.de_json(json_dict, offline_bot) + assert copy_text_button.api_kwargs == {} + + assert copy_text_button.text == self.text + assert CopyTextButton.de_json(None, offline_bot) is None + + def test_to_dict(self, copy_text_button): + copy_text_button_dict = copy_text_button.to_dict() + + assert isinstance(copy_text_button_dict, dict) + assert copy_text_button_dict["text"] == copy_text_button.text + + def test_equality(self): + a = CopyTextButton(self.text) + b = CopyTextButton(self.text) + c = CopyTextButton("text") + d = BotCommand("start", "description") + + assert a == b + assert hash(a) == hash(b) + + assert a != c + assert hash(a) != hash(c) + + assert a != d + assert hash(a) != hash(d) diff --git a/tests/test_stars.py b/tests/test_stars.py index d812c7cbbba..12329b62e75 100644 --- a/tests/test_stars.py +++ b/tests/test_stars.py @@ -36,6 +36,7 @@ TransactionPartnerFragment, TransactionPartnerOther, TransactionPartnerTelegramAds, + TransactionPartnerTelegramApi, TransactionPartnerUser, User, ) @@ -78,11 +79,6 @@ def transaction_partner_user(): ) -@pytest.fixture -def transaction_partner_other(): - return TransactionPartnerOther() - - def transaction_partner_fragment(): return TransactionPartnerFragment( withdrawal_state=withdrawal_state_succeeded(), @@ -114,8 +110,9 @@ def star_transactions(): params=[ TransactionPartner.FRAGMENT, TransactionPartner.OTHER, - TransactionPartner.USER, TransactionPartner.TELEGRAM_ADS, + TransactionPartner.TELEGRAM_API, + TransactionPartner.USER, ], ) def tp_scope_type(request): @@ -127,14 +124,16 @@ def tp_scope_type(request): params=[ TransactionPartnerFragment, TransactionPartnerOther, - TransactionPartnerUser, TransactionPartnerTelegramAds, + TransactionPartnerTelegramApi, + TransactionPartnerUser, ], ids=[ TransactionPartner.FRAGMENT, TransactionPartner.OTHER, - TransactionPartner.USER, TransactionPartner.TELEGRAM_ADS, + TransactionPartner.TELEGRAM_API, + TransactionPartner.USER, ], ) def tp_scope_class(request): @@ -146,14 +145,16 @@ def tp_scope_class(request): params=[ (TransactionPartnerFragment, TransactionPartner.FRAGMENT), (TransactionPartnerOther, TransactionPartner.OTHER), - (TransactionPartnerUser, TransactionPartner.USER), (TransactionPartnerTelegramAds, TransactionPartner.TELEGRAM_ADS), + (TransactionPartnerTelegramApi, TransactionPartner.TELEGRAM_API), + (TransactionPartnerUser, TransactionPartner.USER), ], ids=[ TransactionPartner.FRAGMENT, TransactionPartner.OTHER, - TransactionPartner.USER, TransactionPartner.TELEGRAM_ADS, + TransactionPartner.TELEGRAM_API, + TransactionPartner.USER, ], ) def tp_scope_class_and_type(request): @@ -169,6 +170,7 @@ def transaction_partner(tp_scope_class_and_type): "invoice_payload": TransactionPartnerTestBase.invoice_payload, "withdrawal_state": TransactionPartnerTestBase.withdrawal_state.to_dict(), "user": TransactionPartnerTestBase.user.to_dict(), + "request_count": TransactionPartnerTestBase.request_count, }, bot=None, ) @@ -382,6 +384,7 @@ class TransactionPartnerTestBase: withdrawal_state = withdrawal_state_succeeded() user = transaction_partner_user().user invoice_payload = "payload" + request_count = 42 class TestTransactionPartnerWithoutRequest(TransactionPartnerTestBase): @@ -400,11 +403,15 @@ def test_de_json(self, offline_bot, tp_scope_class_and_type): "invoice_payload": self.invoice_payload, "withdrawal_state": self.withdrawal_state.to_dict(), "user": self.user.to_dict(), + "request_count": self.request_count, } tp = TransactionPartner.de_json(json_dict, offline_bot) - assert set(tp.api_kwargs.keys()) == {"user", "withdrawal_state", "invoice_payload"} - set( - cls.__slots__ - ) + assert set(tp.api_kwargs.keys()) == { + "user", + "withdrawal_state", + "invoice_payload", + "request_count", + } - set(cls.__slots__) assert isinstance(tp, TransactionPartner) assert type(tp) is cls @@ -414,6 +421,8 @@ def test_de_json(self, offline_bot, tp_scope_class_and_type): if "user" in cls.__slots__: assert tp.user == self.user assert tp.invoice_payload == self.invoice_payload + if "request_count" in cls.__slots__: + assert tp.request_count == self.request_count assert cls.de_json(None, offline_bot) is None assert TransactionPartner.de_json({}, offline_bot) is None @@ -424,12 +433,14 @@ def test_de_json_invalid_type(self, offline_bot): "invoice_payload": self.invoice_payload, "withdrawal_state": self.withdrawal_state.to_dict(), "user": self.user.to_dict(), + "request_count": self.request_count, } tp = TransactionPartner.de_json(json_dict, offline_bot) assert tp.api_kwargs == { "withdrawal_state": self.withdrawal_state.to_dict(), "user": self.user.to_dict(), "invoice_payload": self.invoice_payload, + "request_count": self.request_count, } assert type(tp) is TransactionPartner @@ -443,6 +454,7 @@ def test_de_json_subclass(self, tp_scope_class, offline_bot): "invoice_payload": self.invoice_payload, "withdrawal_state": self.withdrawal_state.to_dict(), "user": self.user.to_dict(), + "request_count": self.request_count, } assert type(tp_scope_class.de_json(json_dict, offline_bot)) is tp_scope_class @@ -494,6 +506,14 @@ def test_equality(self, transaction_partner, offline_bot): assert c != f assert hash(c) != hash(f) + if hasattr(c, "request_count"): + json_dict = c.to_dict() + json_dict["request_count"] = 1 + f = c.__class__.de_json(json_dict, offline_bot) + + assert c != f + assert hash(c) != hash(f) + class RevenueWithdrawalStateTestBase: date = datetime.datetime(2024, 1, 1, 0, 0, 0, 0, tzinfo=UTC) From dab75fb9636b0b7c2aba899f6a6023c552bab614 Mon Sep 17 00:00:00 2001 From: Bibo-Joshi <22366557+Bibo-Joshi@users.noreply.github.com> Date: Mon, 4 Nov 2024 20:33:56 +0100 Subject: [PATCH 23/25] Add `Message.reply_paid_media` (#4551) --- telegram/_message.py | 72 +++++++++++++++++++++++++++++++++++++++++++ tests/test_message.py | 66 ++++++++++++++++++++++++++++++++------- 2 files changed, 127 insertions(+), 11 deletions(-) diff --git a/telegram/_message.py b/telegram/_message.py index 6390c8b0532..33f1bc1506d 100644 --- a/telegram/_message.py +++ b/telegram/_message.py @@ -105,6 +105,7 @@ InputMediaDocument, InputMediaPhoto, InputMediaVideo, + InputPaidMedia, InputPollOption, LabeledPrice, MessageId, @@ -3668,6 +3669,77 @@ async def reply_copy( allow_paid_broadcast=allow_paid_broadcast, ) + async def reply_paid_media( + self, + star_count: int, + media: Sequence["InputPaidMedia"], + caption: Optional[str] = None, + parse_mode: ODVInput[str] = DEFAULT_NONE, + caption_entities: Optional[Sequence["MessageEntity"]] = None, + show_caption_above_media: Optional[bool] = None, + disable_notification: ODVInput[bool] = DEFAULT_NONE, + protect_content: ODVInput[bool] = DEFAULT_NONE, + reply_parameters: Optional["ReplyParameters"] = None, + reply_markup: Optional[ReplyMarkup] = None, + payload: Optional[str] = None, + allow_paid_broadcast: Optional[bool] = None, + *, + reply_to_message_id: Optional[int] = None, + allow_sending_without_reply: ODVInput[bool] = DEFAULT_NONE, + do_quote: Optional[Union[bool, _ReplyKwargs]] = None, + read_timeout: ODVInput[float] = DEFAULT_NONE, + write_timeout: ODVInput[float] = DEFAULT_NONE, + connect_timeout: ODVInput[float] = DEFAULT_NONE, + pool_timeout: ODVInput[float] = DEFAULT_NONE, + api_kwargs: Optional[JSONDict] = None, + ) -> "Message": + """Shortcut for:: + + await bot.send_paid_media( + chat_id=message.chat.id, + business_connection_id=message.business_connection_id, + *args, + **kwargs + ) + + For the documentation of the arguments, please see :meth:`telegram.Bot.send_paid_media`. + + .. versionadded:: NEXT.VERSION + + Keyword Args: + do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote| + Mutually exclusive with :paramref:`quote`. + + Returns: + :class:`telegram.Message`: On success, the sent message is returned. + + """ + chat_id, effective_reply_parameters = await self._parse_quote_arguments( + do_quote, None, reply_to_message_id, reply_parameters + ) + return await self.get_bot().send_paid_media( + chat_id=chat_id, + caption=caption, + star_count=star_count, + media=media, + payload=payload, + business_connection_id=self.business_connection_id, + parse_mode=parse_mode, + caption_entities=caption_entities, + disable_notification=disable_notification, + reply_parameters=effective_reply_parameters, + allow_sending_without_reply=allow_sending_without_reply, + reply_markup=reply_markup, + read_timeout=read_timeout, + write_timeout=write_timeout, + connect_timeout=connect_timeout, + pool_timeout=pool_timeout, + api_kwargs=api_kwargs, + protect_content=protect_content, + show_caption_above_media=show_caption_above_media, + allow_paid_broadcast=allow_paid_broadcast, + ) + async def edit_text( self, text: str, diff --git a/tests/test_message.py b/tests/test_message.py index 602d1e1f8a8..a9fb9a46cfb 100644 --- a/tests/test_message.py +++ b/tests/test_message.py @@ -16,6 +16,7 @@ # # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. +import contextlib from copy import copy from datetime import datetime @@ -39,6 +40,7 @@ GiveawayCompleted, GiveawayCreated, GiveawayWinners, + InputPaidMediaPhoto, Invoice, LinkPreviewOptions, Location, @@ -447,11 +449,14 @@ async def check_quote_parsing( """Used in testing reply_* below. Makes sure that quote and do_quote are handled correctly """ - with pytest.raises(ValueError, match="`quote` and `do_quote` are mutually exclusive"): - await method(*args, quote=True, do_quote=True) + with contextlib.suppress(TypeError): + # for newer methods that don't have the deprecated argument + with pytest.raises(ValueError, match="`quote` and `do_quote` are mutually exclusive"): + await method(*args, quote=True, do_quote=True) - with pytest.warns(PTBDeprecationWarning, match="`quote` parameter is deprecated"): - await method(*args, quote=True) + # for newer methods that don't have the deprecated argument + with pytest.warns(PTBDeprecationWarning, match="`quote` parameter is deprecated"): + await method(*args, quote=True) with pytest.raises( ValueError, @@ -465,13 +470,16 @@ async def make_assertion(*args, **kwargs): monkeypatch.setattr(message.get_bot(), bot_method_name, make_assertion) for param in ("quote", "do_quote"): - chat_id, reply_parameters = await method(*args, **{param: True}) - if chat_id != message.chat.id: - pytest.fail(f"chat_id is {chat_id} but should be {message.chat.id}") - if reply_parameters is None or reply_parameters.message_id != message.message_id: - pytest.fail( - f"reply_parameters is {reply_parameters} but should be {message.message_id}" - ) + with contextlib.suppress(TypeError): + # for newer methods that don't have the deprecated argument + chat_id, reply_parameters = await method(*args, **{param: True}) + if chat_id != message.chat.id: + pytest.fail(f"chat_id is {chat_id} but should be {message.chat.id}") + if reply_parameters is None or reply_parameters.message_id != message.message_id: + pytest.fail( + f"reply_parameters is {reply_parameters} " + "but should be {message.message_id}" + ) input_chat_id = object() input_reply_parameters = ReplyParameters(message_id=1, chat_id=42) @@ -2349,6 +2357,42 @@ async def make_assertion(*_, **kwargs): monkeypatch, ) + async def test_reply_paid_media(self, monkeypatch, message): + async def make_assertion(*_, **kwargs): + id_ = kwargs["chat_id"] == message.chat_id + media = kwargs["media"][0].media == "media" + star_count = kwargs["star_count"] == 5 + return id_ and media and star_count + + assert check_shortcut_signature( + Message.reply_paid_media, + Bot.send_paid_media, + ["chat_id", "reply_to_message_id", "business_connection_id"], + ["do_quote", "reply_to_message_id"], + ) + assert await check_shortcut_call( + message.reply_paid_media, + message.get_bot(), + "send_paid_media", + skip_params=["reply_to_message_id"], + shortcut_kwargs=["business_connection_id"], + ) + assert await check_defaults_handling( + message.reply_paid_media, message.get_bot(), no_default_kwargs={"message_thread_id"} + ) + + monkeypatch.setattr(message.get_bot(), "send_paid_media", make_assertion) + assert await message.reply_paid_media( + star_count=5, media=[InputPaidMediaPhoto(media="media")] + ) + await self.check_quote_parsing( + message, + message.reply_paid_media, + "send_paid_media", + ["test", [InputPaidMediaPhoto(media="media")]], + monkeypatch, + ) + async def test_edit_text(self, monkeypatch, message): async def make_assertion(*_, **kwargs): chat_id = kwargs["chat_id"] == message.chat_id From 0eb11ff3e9a3dcfea4dbe5ad83d42c95eea41e76 Mon Sep 17 00:00:00 2001 From: Bibo-Joshi <22366557+Bibo-Joshi@users.noreply.github.com> Date: Mon, 4 Nov 2024 20:38:41 +0100 Subject: [PATCH 24/25] Documentation Improvements (#4536, #4556) Co-authored-by: Abubakar Alaya --- AUTHORS.rst | 1 + README.rst | 2 +- tests/README.rst | 2 +- 3 files changed, 3 insertions(+), 2 deletions(-) diff --git a/AUTHORS.rst b/AUTHORS.rst index 8f2024e4404..1106c1e7dd0 100644 --- a/AUTHORS.rst +++ b/AUTHORS.rst @@ -23,6 +23,7 @@ The following wonderful people contributed directly or indirectly to this projec - `Abdelrahman `_ - `Abshar `_ +- `Abubakar Alaya `_ - `Alateas `_ - `Ales Dokshanin `_ - `Alexandre `_ diff --git a/README.rst b/README.rst index dd19bbbbdeb..7788e075d7c 100644 --- a/README.rst +++ b/README.rst @@ -230,6 +230,6 @@ License ------- You may copy, distribute and modify the software provided that modifications are described and licensed for free under `LGPL-3 `_. -Derivatives works (including modifications or anything statically linked to the library) can only be redistributed under LGPL-3, but applications that use the library don't have to be. +Derivative works (including modifications or anything statically linked to the library) can only be redistributed under LGPL-3, but applications that use the library don't have to be. .. _`GitHub releases page`: https://github.com/python-telegram-bot/python-telegram-bot/releases diff --git a/tests/README.rst b/tests/README.rst index c9f3cac63be..a6724558041 100644 --- a/tests/README.rst +++ b/tests/README.rst @@ -98,7 +98,7 @@ Bots used in tests If you run the tests locally, the test setup will use one of the two public bots available. Which bot of the two gets chosen for the test session is random. Whereas when the tests on the -Github Actions CI are run, the test setup allocates a different, but same bot is for every combination of Python version and +Github Actions CI are run, the test setup allocates a different, but the same bot is allocated for every combination of Python version and OS. The operating systems and Python versions the CI runs the tests on can be viewed in the `corresponding workflow`_. From 151123745e9e8d53c54fd6715008b3e8c85bdc82 Mon Sep 17 00:00:00 2001 From: Bibo-Joshi <22366557+Bibo-Joshi@users.noreply.github.com> Date: Mon, 4 Nov 2024 21:29:59 +0100 Subject: [PATCH 25/25] Bump Version to v21.7 (#4557) --- CHANGES.rst | 50 ++++++++++++++++++++++++ telegram/_bot.py | 38 +++++++++--------- telegram/_copytextbutton.py | 2 +- telegram/_files/file.py | 6 +-- telegram/_inline/inlinekeyboardbutton.py | 4 +- telegram/_message.py | 2 +- telegram/_payment/stars.py | 2 +- telegram/_version.py | 2 +- telegram/constants.py | 4 +- telegram/ext/_application.py | 2 +- 10 files changed, 81 insertions(+), 31 deletions(-) diff --git a/CHANGES.rst b/CHANGES.rst index ba37e99a308..32dee75b1f7 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -4,6 +4,56 @@ Changelog ========= +Version 21.7 +============ +*Released 2024-11-04* + +This is the technical changelog for version 21.7. More elaborate release notes can be found in the news channel `@pythontelegrambotchannel `_. + +Major Changes +------------- + +- Full Support for Bot API 7.11 (:pr:`4546` closes :issue:`4543`) +- Add ``Message.reply_paid_media`` (:pr:`4551`) +- Drop Support for Python 3.8 (:pr:`4398` by `elpekenin `_) + +Minor Changes +------------- + +- Allow ``Sequence`` in ``Application.add_handlers`` (:pr:`4531` by `roast-lord `_ closes :issue:`4530`) +- Improve Exception Handling in ``File.download_*`` (:pr:`4542`) +- Use Stable Python 3.13 Release in Test Suite (:pr:`4535`) + +Documentation Improvements +-------------------------- + +- Documentation Improvements (:pr:`4536` by `Ecode2 `_, :pr:`4556`) +- Fix Linkcheck Workflow (:pr:`4545`) +- Use ``sphinx-build-compatibility`` to Keep Sphinx Compatibility (:pr:`4492`) + +Internal Changes +---------------- + +- Improve Test Instability Caused by ``Message`` Fixtures (:pr:`4507`) +- Stabilize Some Flaky Tests (:pr:`4500`) +- Reduce Creation of HTTP Clients in Tests (:pr:`4493`) +- Update ``pytest-xdist`` Usage (:pr:`4491`) +- Fix Failing Tests by Making Them Independent (:pr:`4494`) +- Introduce Codecov's Test Analysis (:pr:`4487`) +- Maintenance Work on ``Bot`` Tests (:pr:`4489`) +- Introduce ``conftest.py`` for File Related Tests (:pr:`4488`) +- Update Issue Templates to Use Issue Types (:pr:`4553`) +- Update Automation to Label Changes (:pr:`4552`) + +Dependency Updates +------------------ + +- Bump ``srvaroa/labeler`` from 1.11.0 to 1.11.1 (:pr:`4549`) +- Bump ``sphinx`` from 8.0.2 to 8.1.3 (:pr:`4532`) +- Bump ``sphinxcontrib-mermaid`` from 0.9.2 to 1.0.0 (:pr:`4529`) +- Bump ``srvaroa/labeler`` from 1.10.1 to 1.11.0 (:pr:`4509`) +- Bump ``Bibo-Joshi/pyright-type-completeness`` from 1.0.0 to 1.0.1 (:pr:`4510`) + Version 21.6 ============ diff --git a/telegram/_bot.py b/telegram/_bot.py index 44866870280..cc2ba38fb3a 100644 --- a/telegram/_bot.py +++ b/telegram/_bot.py @@ -969,7 +969,7 @@ async def send_message( .. versionadded:: 21.3 allow_paid_broadcast (:obj:`bool`, optional): |allow_paid_broadcast| - .. versionadded:: NEXT.VERSION + .. versionadded:: 21.7 Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| @@ -1348,7 +1348,7 @@ async def send_photo( .. versionadded:: 21.3 allow_paid_broadcast (:obj:`bool`, optional): |allow_paid_broadcast| - .. versionadded:: NEXT.VERSION + .. versionadded:: 21.7 show_caption_above_media (:obj:`bool`, optional): Pass |show_cap_above_med| .. versionadded:: 21.3 @@ -1511,7 +1511,7 @@ async def send_audio( .. versionadded:: 21.3 allow_paid_broadcast (:obj:`bool`, optional): |allow_paid_broadcast| - .. versionadded:: NEXT.VERSION + .. versionadded:: 21.7 Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| @@ -1670,7 +1670,7 @@ async def send_document( .. versionadded:: 21.3 allow_paid_broadcast (:obj:`bool`, optional): |allow_paid_broadcast| - .. versionadded:: NEXT.VERSION + .. versionadded:: 21.7 Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| @@ -1801,7 +1801,7 @@ async def send_sticker( .. versionadded:: 21.3 allow_paid_broadcast (:obj:`bool`, optional): |allow_paid_broadcast| - .. versionadded:: NEXT.VERSION + .. versionadded:: 21.7 Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| @@ -1962,7 +1962,7 @@ async def send_video( .. versionadded:: 21.3 allow_paid_broadcast (:obj:`bool`, optional): |allow_paid_broadcast| - .. versionadded:: NEXT.VERSION + .. versionadded:: 21.7 show_caption_above_media (:obj:`bool`, optional): Pass |show_cap_above_med| .. versionadded:: 21.3 @@ -2120,7 +2120,7 @@ async def send_video_note( .. versionadded:: 21.3 allow_paid_broadcast (:obj:`bool`, optional): |allow_paid_broadcast| - .. versionadded:: NEXT.VERSION + .. versionadded:: 21.7 Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| @@ -2282,7 +2282,7 @@ async def send_animation( .. versionadded:: 21.3 allow_paid_broadcast (:obj:`bool`, optional): |allow_paid_broadcast| - .. versionadded:: NEXT.VERSION + .. versionadded:: 21.7 show_caption_above_media (:obj:`bool`, optional): Pass |show_cap_above_med| .. versionadded:: 21.3 @@ -2442,7 +2442,7 @@ async def send_voice( .. versionadded:: 21.3 allow_paid_broadcast (:obj:`bool`, optional): |allow_paid_broadcast| - .. versionadded:: NEXT.VERSION + .. versionadded:: 21.7 Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| @@ -2573,7 +2573,7 @@ async def send_media_group( .. versionadded:: 21.3 allow_paid_broadcast (:obj:`bool`, optional): |allow_paid_broadcast| - .. versionadded:: NEXT.VERSION + .. versionadded:: 21.7 Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| @@ -2761,7 +2761,7 @@ async def send_location( .. versionadded:: 21.3 allow_paid_broadcast (:obj:`bool`, optional): |allow_paid_broadcast| - .. versionadded:: NEXT.VERSION + .. versionadded:: 21.7 Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| @@ -3073,7 +3073,7 @@ async def send_venue( .. versionadded:: 21.3 allow_paid_broadcast (:obj:`bool`, optional): |allow_paid_broadcast| - .. versionadded:: NEXT.VERSION + .. versionadded:: 21.7 Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| @@ -3220,7 +3220,7 @@ async def send_contact( .. versionadded:: 21.3 allow_paid_broadcast (:obj:`bool`, optional): |allow_paid_broadcast| - .. versionadded:: NEXT.VERSION + .. versionadded:: 21.7 Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| @@ -3345,7 +3345,7 @@ async def send_game( .. versionadded:: 21.3 allow_paid_broadcast (:obj:`bool`, optional): |allow_paid_broadcast| - .. versionadded:: NEXT.VERSION + .. versionadded:: 21.7 Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| @@ -5154,7 +5154,7 @@ async def send_invoice( .. versionadded:: 21.3 allow_paid_broadcast (:obj:`bool`, optional): |allow_paid_broadcast| - .. versionadded:: NEXT.VERSION + .. versionadded:: 21.7 Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| @@ -7165,7 +7165,7 @@ async def send_poll( .. versionadded:: 21.3 allow_paid_broadcast (:obj:`bool`, optional): |allow_paid_broadcast| - .. versionadded:: NEXT.VERSION + .. versionadded:: 21.7 Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| @@ -7348,7 +7348,7 @@ async def send_dice( .. versionadded:: 21.3 allow_paid_broadcast (:obj:`bool`, optional): |allow_paid_broadcast| - .. versionadded:: NEXT.VERSION + .. versionadded:: 21.7 Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| @@ -7778,7 +7778,7 @@ async def copy_message( .. versionadded:: 21.3 allow_paid_broadcast (:obj:`bool`, optional): |allow_paid_broadcast| - .. versionadded:: NEXT.VERSION + .. versionadded:: 21.7 Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| @@ -9315,7 +9315,7 @@ async def send_paid_media( .. versionadded:: 21.5 allow_paid_broadcast (:obj:`bool`, optional): |allow_paid_broadcast| - .. versionadded:: NEXT.VERSION + .. versionadded:: 21.7 Keyword Args: allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply| diff --git a/telegram/_copytextbutton.py b/telegram/_copytextbutton.py index e3dee813b9a..a2bf499a715 100644 --- a/telegram/_copytextbutton.py +++ b/telegram/_copytextbutton.py @@ -30,7 +30,7 @@ class CopyTextButton(TelegramObject): Objects of this class are comparable in terms of equality. Two objects of this class are considered equal, if their :attr:`text` is equal. - .. versionadded:: NEXT.VERSION + .. versionadded:: 21.7 Args: text (:obj:`str`): The text to be copied to the clipboard; diff --git a/telegram/_files/file.py b/telegram/_files/file.py index 640dfc96884..98575caded6 100644 --- a/telegram/_files/file.py +++ b/telegram/_files/file.py @@ -151,7 +151,7 @@ async def download_to_drive( * This method was previously called ``download``. It was split into :meth:`download_to_drive` and :meth:`download_to_memory`. - .. versionchanged:: NEXT.VERSION + .. versionchanged:: 21.7 Raises :exc:`RuntimeError` if :attr:`file_path` is not set. Note that files without a :attr:`file_path` could never be downloaded, as this attribute is mandatory for that operation. @@ -245,7 +245,7 @@ async def download_to_memory( .. versionadded:: 20.0 - .. versionchanged:: NEXT.VERSION + .. versionchanged:: 21.7 Raises :exc:`RuntimeError` if :attr:`file_path` is not set. Note that files without a :attr:`file_path` could never be downloaded, as this attribute is mandatory for that operation. @@ -302,7 +302,7 @@ async def download_as_bytearray( ) -> bytearray: """Download this file and return it as a bytearray. - .. versionchanged:: NEXT.VERSION + .. versionchanged:: 21.7 Raises :exc:`RuntimeError` if :attr:`file_path` is not set. Note that files without a :attr:`file_path` could never be downloaded, as this attribute is mandatory for that operation. diff --git a/telegram/_inline/inlinekeyboardbutton.py b/telegram/_inline/inlinekeyboardbutton.py index 62031af8cd2..32edb655411 100644 --- a/telegram/_inline/inlinekeyboardbutton.py +++ b/telegram/_inline/inlinekeyboardbutton.py @@ -127,7 +127,7 @@ class InlineKeyboardButton(TelegramObject): copy_text (:class:`telegram.CopyTextButton`, optional): Description of the button that copies the specified text to the clipboard. - .. versionadded:: NEXT.VERSION + .. versionadded:: 21.7 callback_game (:class:`telegram.CallbackGame`, optional): Description of the game that will be launched when the user presses the button @@ -200,7 +200,7 @@ class InlineKeyboardButton(TelegramObject): copy_text (:class:`telegram.CopyTextButton`): Optional. Description of the button that copies the specified text to the clipboard. - .. versionadded:: NEXT.VERSION + .. versionadded:: 21.7 callback_game (:class:`telegram.CallbackGame`): Optional. Description of the game that will be launched when the user presses the button. diff --git a/telegram/_message.py b/telegram/_message.py index 33f1bc1506d..6c87df7fda4 100644 --- a/telegram/_message.py +++ b/telegram/_message.py @@ -3704,7 +3704,7 @@ async def reply_paid_media( For the documentation of the arguments, please see :meth:`telegram.Bot.send_paid_media`. - .. versionadded:: NEXT.VERSION + .. versionadded:: 21.7 Keyword Args: do_quote (:obj:`bool` | :obj:`dict`, optional): |do_quote| diff --git a/telegram/_payment/stars.py b/telegram/_payment/stars.py index b420805f514..a47d3b44ff8 100644 --- a/telegram/_payment/stars.py +++ b/telegram/_payment/stars.py @@ -431,7 +431,7 @@ class TransactionPartnerTelegramApi(TransactionPartner): Objects of this class are comparable in terms of equality. Two objects of this class are considered equal, if their :attr:`request_count` is equal. - .. versionadded:: NEXT.VERSION + .. versionadded:: 21.7 Args: request_count (:obj:`int`): The number of successful requests that exceeded regular limits diff --git a/telegram/_version.py b/telegram/_version.py index bb946f5359f..5f9c77cc584 100644 --- a/telegram/_version.py +++ b/telegram/_version.py @@ -51,6 +51,6 @@ def __str__(self) -> str: __version_info__: Final[Version] = Version( - major=21, minor=6, micro=0, releaselevel="final", serial=0 + major=21, minor=7, micro=0, releaselevel="final", serial=0 ) __version__: Final[str] = str(__version_info__) diff --git a/telegram/constants.py b/telegram/constants.py index 5ff4b8147fc..52a47d54cdc 100644 --- a/telegram/constants.py +++ b/telegram/constants.py @@ -1160,7 +1160,7 @@ class FloodLimit(IntEnum): :paramref:`~telegram.Bot.send_message.allow_paid_broadcast` of :meth:`~telegram.Bot.send_message`. - .. versionadded:: NEXT.VERSION + .. versionadded:: 21.7 """ @@ -2616,7 +2616,7 @@ class TransactionPartnerType(StringEnum): """:obj:`str`: Transaction with with payment for `paid broadcasting `_. - ..versionadded:: NEXT.VERSION + ..versionadded:: 21.7 """ USER = "user" """:obj:`str`: Transaction with a user.""" diff --git a/telegram/ext/_application.py b/telegram/ext/_application.py index d0997a1fce2..49c7417bdc5 100644 --- a/telegram/ext/_application.py +++ b/telegram/ext/_application.py @@ -1420,7 +1420,7 @@ def add_handlers( Specify a sequence of handlers *or* a dictionary where the keys are groups and values are handlers. - .. versionchanged:: NEXT.VERSION + .. versionchanged:: 21.7 Accepts any :class:`collections.abc.Sequence` as input instead of just a list or tuple.