OpenSource/python-telegram-bot
OpenSource/python-telegram-bot
1
0
Fork 0
mirror of https://github.com/python-telegram-bot/python-telegram-bot.git synced 2024-12-28 23:38:31 +01:00
Code Issues Projects Releases Packages Wiki Activity

Refactor Debug logging in Bot to Improve Type Hinting (#4151)

Browse source
This commit is contained in:
Bibo-Joshi 2024-03-24 12:34:08 +01:00 committed by GitHub
parent c0716dd344
commit 8a542e22a0
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
8 changed files with 45 additions and 161 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

147
telegram/_bot.py
View file

@ -21,7 +21,6 @@
import asyncio import asyncio
import contextlib import contextlib
import copy import copy
import functools
import pickle import pickle
from datetime import datetime from datetime import datetime
from types import TracebackType from types import TracebackType
@ -531,20 +530,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
""" """
warn(message=message, category=category, stacklevel=stacklevel + 1) warn(message=message, category=category, stacklevel=stacklevel + 1)
# TODO: After https://youtrack.jetbrains.com/issue/PY-50952 is fixed, we can revisit this and
# consider adding Paramspec from typing_extensions to properly fix this. Currently a workaround
def _log(func: Any): # type: ignore[no-untyped-def] # skipcq: PY-D0003
@functools.wraps(func)
async def decorator(self: "Bot", *args: Any, **kwargs: Any) -> Any:
# pylint: disable=protected-access
self._LOGGER.debug("Entering: %s", func.__name__)
result = await func(self, *args, **kwargs)
self._LOGGER.debug(result)
self._LOGGER.debug("Exiting: %s", func.__name__)
return result
return decorator
def _parse_file_input( def _parse_file_input(
self, self,
file_input: Union[FileInput, "TelegramObject"], file_input: Union[FileInput, "TelegramObject"],
@ -654,7 +639,8 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
request = self._request[0] if endpoint == "getUpdates" else self._request[1] request = self._request[0] if endpoint == "getUpdates" else self._request[1]
return await request.post( self._LOGGER.debug("Calling Bot API endpoint `%s` with parameters `%s`", endpoint, data)
result = await request.post(
url=f"{self._base_url}/{endpoint}", url=f"{self._base_url}/{endpoint}",
request_data=request_data, request_data=request_data,
read_timeout=read_timeout, read_timeout=read_timeout,
@ -662,6 +648,11 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
connect_timeout=connect_timeout, connect_timeout=connect_timeout,
pool_timeout=pool_timeout, pool_timeout=pool_timeout,
) )
self._LOGGER.debug(
"Call to Bot API endpoint `%s` finished with return value `%s`", endpoint, result
)
return result
async def _send_message( async def _send_message(
self, self,
@ -784,7 +775,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
await asyncio.gather(self._request[0].shutdown(), self._request[1].shutdown()) await asyncio.gather(self._request[0].shutdown(), self._request[1].shutdown())
self._initialized = False self._initialized = False
@_log
async def do_api_request( async def do_api_request(
self, self,
endpoint: str, endpoint: str,
@ -843,7 +833,7 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
f"'Bot.do_api_request(\"{endpoint}\", ...)'" f"'Bot.do_api_request(\"{endpoint}\", ...)'"
), ),
PTBDeprecationWarning, PTBDeprecationWarning,
stacklevel=3, stacklevel=2,
) )
camel_case_endpoint = to_camel_case(endpoint) camel_case_endpoint = to_camel_case(endpoint)
@ -879,7 +869,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
return return_type.de_list(result, self) return return_type.de_list(result, self)
return return_type.de_json(result, self) return return_type.de_json(result, self)
@_log
async def get_me( async def get_me(
self, self,
*, *,
@ -910,7 +899,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
self._bot_user = User.de_json(result, self) self._bot_user = User.de_json(result, self)
return self._bot_user # type: ignore[return-value] return self._bot_user # type: ignore[return-value]
@_log
async def send_message( async def send_message(
self, self,
chat_id: Union[int, str], chat_id: Union[int, str],
@ -1031,7 +1019,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def delete_message( async def delete_message(
self, self,
chat_id: Union[str, int], chat_id: Union[str, int],
@ -1090,7 +1077,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def delete_messages( async def delete_messages(
self, self,
chat_id: Union[int, str], chat_id: Union[int, str],
@ -1133,7 +1119,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def forward_message( async def forward_message(
self, self,
chat_id: Union[int, str], chat_id: Union[int, str],
@ -1199,7 +1184,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def forward_messages( async def forward_messages(
self, self,
chat_id: Union[int, str], chat_id: Union[int, str],
@ -1262,7 +1246,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
) )
return MessageId.de_list(result, self) return MessageId.de_list(result, self)
@_log
async def send_photo( async def send_photo(
self, self,
chat_id: Union[int, str], chat_id: Union[int, str],
@ -1395,7 +1378,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def send_audio( async def send_audio(
self, self,
chat_id: Union[int, str], chat_id: Union[int, str],
@ -1543,7 +1525,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def send_document( async def send_document(
self, self,
chat_id: Union[int, str], chat_id: Union[int, str],
@ -1684,7 +1665,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def send_sticker( async def send_sticker(
self, self,
chat_id: Union[int, str], chat_id: Union[int, str],
@ -1793,7 +1773,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def send_video( async def send_video(
self, self,
chat_id: Union[int, str], chat_id: Union[int, str],
@ -1953,7 +1932,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def send_video_note( async def send_video_note(
self, self,
chat_id: Union[int, str], chat_id: Union[int, str],
@ -2086,7 +2064,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def send_animation( async def send_animation(
self, self,
chat_id: Union[int, str], chat_id: Union[int, str],
@ -2238,7 +2215,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def send_voice( async def send_voice(
self, self,
chat_id: Union[int, str], chat_id: Union[int, str],
@ -2375,7 +2351,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def send_media_group( async def send_media_group(
self, self,
chat_id: Union[int, str], chat_id: Union[int, str],
@ -2539,7 +2514,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
return Message.de_list(result, self) return Message.de_list(result, self)
@_log
async def send_location( async def send_location(
self, self,
chat_id: Union[int, str], chat_id: Union[int, str],
@ -2675,7 +2649,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def edit_message_live_location( async def edit_message_live_location(
self, self,
chat_id: Optional[Union[str, int]] = None, chat_id: Optional[Union[str, int]] = None,
@ -2770,7 +2743,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def stop_message_live_location( async def stop_message_live_location(
self, self,
chat_id: Optional[Union[str, int]] = None, chat_id: Optional[Union[str, int]] = None,
@ -2818,7 +2790,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def send_venue( async def send_venue(
self, self,
chat_id: Union[int, str], chat_id: Union[int, str],
@ -2965,7 +2936,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def send_contact( async def send_contact(
self, self,
chat_id: Union[int, str], chat_id: Union[int, str],
@ -3089,7 +3059,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def send_game( async def send_game(
self, self,
chat_id: int, chat_id: int,
@ -3175,7 +3144,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def send_chat_action( async def send_chat_action(
self, self,
chat_id: Union[str, int], chat_id: Union[str, int],
@ -3319,7 +3287,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
return res return res
@_log
async def answer_inline_query( async def answer_inline_query(
self, self,
inline_query_id: str, inline_query_id: str,
@ -3417,7 +3384,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def get_user_profile_photos( async def get_user_profile_photos(
self, self,
user_id: int, user_id: int,
@ -3462,7 +3428,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
return UserProfilePhotos.de_json(result, self) # type: ignore[return-value] return UserProfilePhotos.de_json(result, self) # type: ignore[return-value]
@_log
async def get_file( async def get_file(
self, self,
file_id: Union[ file_id: Union[
@ -3528,7 +3493,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
return File.de_json(result, self) # type: ignore[return-value] return File.de_json(result, self) # type: ignore[return-value]
@_log
async def ban_chat_member( async def ban_chat_member(
self, self,
chat_id: Union[str, int], chat_id: Union[str, int],
@ -3592,7 +3556,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def ban_chat_sender_chat( async def ban_chat_sender_chat(
self, self,
chat_id: Union[str, int], chat_id: Union[str, int],
@ -3636,7 +3599,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def unban_chat_member( async def unban_chat_member(
self, self,
chat_id: Union[str, int], chat_id: Union[str, int],
@ -3681,7 +3643,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def unban_chat_sender_chat( async def unban_chat_sender_chat(
self, self,
chat_id: Union[str, int], chat_id: Union[str, int],
@ -3722,7 +3683,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def answer_callback_query( async def answer_callback_query(
self, self,
callback_query_id: str, callback_query_id: str,
@ -3788,7 +3748,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def edit_message_text( async def edit_message_text(
self, self,
text: str, text: str,
@ -3890,7 +3849,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def edit_message_caption( async def edit_message_caption(
self, self,
chat_id: Optional[Union[str, int]] = None, chat_id: Optional[Union[str, int]] = None,
@ -3960,7 +3918,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def edit_message_media( async def edit_message_media(
self, self,
media: "InputMedia", media: "InputMedia",
@ -4024,7 +3981,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def edit_message_reply_markup( async def edit_message_reply_markup(
self, self,
chat_id: Optional[Union[str, int]] = None, chat_id: Optional[Union[str, int]] = None,
@ -4080,7 +4036,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def get_updates( async def get_updates(
self, self,
offset: Optional[int] = None, offset: Optional[int] = None,
@ -4164,7 +4119,7 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
"the property `read_timeout`. Overriding this property will be mandatory in " "the property `read_timeout`. Overriding this property will be mandatory in "
"future versions. Using 2 seconds as fallback.", "future versions. Using 2 seconds as fallback.",
PTBDeprecationWarning, PTBDeprecationWarning,
stacklevel=3, stacklevel=2,
) )
# Ideally we'd use an aggressive read timeout for the polling. However, # Ideally we'd use an aggressive read timeout for the polling. However,
@ -4192,7 +4147,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
return Update.de_list(result, self) return Update.de_list(result, self)
@_log
async def set_webhook( async def set_webhook(
self, self,
url: str, url: str,
@ -4320,7 +4274,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def delete_webhook( async def delete_webhook(
self, self,
drop_pending_updates: Optional[bool] = None, drop_pending_updates: Optional[bool] = None,
@ -4358,7 +4311,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def leave_chat( async def leave_chat(
self, self,
chat_id: Union[str, int], chat_id: Union[str, int],
@ -4393,7 +4345,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def get_chat( async def get_chat(
self, self,
chat_id: Union[str, int], chat_id: Union[str, int],
@ -4432,7 +4383,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
return Chat.de_json(result, self) # type: ignore[return-value] return Chat.de_json(result, self) # type: ignore[return-value]
@_log
async def get_chat_administrators( async def get_chat_administrators(
self, self,
chat_id: Union[str, int], chat_id: Union[str, int],
@ -4474,7 +4424,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
) )
return ChatMember.de_list(result, self) return ChatMember.de_list(result, self)
@_log
async def get_chat_member_count( async def get_chat_member_count(
self, self,
chat_id: Union[str, int], chat_id: Union[str, int],
@ -4510,7 +4459,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def get_chat_member( async def get_chat_member(
self, self,
chat_id: Union[str, int], chat_id: Union[str, int],
@ -4548,7 +4496,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
) )
return ChatMember.de_json(result, self) # type: ignore[return-value] return ChatMember.de_json(result, self) # type: ignore[return-value]
@_log
async def set_chat_sticker_set( async def set_chat_sticker_set(
self, self,
chat_id: Union[str, int], chat_id: Union[str, int],
@ -4584,7 +4531,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def delete_chat_sticker_set( async def delete_chat_sticker_set(
self, self,
chat_id: Union[str, int], chat_id: Union[str, int],
@ -4617,7 +4563,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def get_webhook_info( async def get_webhook_info(
self, self,
*, *,
@ -4646,7 +4591,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
) )
return WebhookInfo.de_json(result, self) # type: ignore[return-value] return WebhookInfo.de_json(result, self) # type: ignore[return-value]
@_log
async def set_game_score( async def set_game_score(
self, self,
user_id: int, user_id: int,
@ -4711,7 +4655,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def get_game_high_scores( async def get_game_high_scores(
self, self,
user_id: int, user_id: int,
@ -4772,7 +4715,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
return GameHighScore.de_list(result, self) return GameHighScore.de_list(result, self)
@_log
async def send_invoice( async def send_invoice(
self, self,
chat_id: Union[int, str], chat_id: Union[int, str],
@ -4977,7 +4919,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def answer_shipping_query( async def answer_shipping_query(
self, self,
shipping_query_id: str, shipping_query_id: str,
@ -5036,7 +4977,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def answer_pre_checkout_query( async def answer_pre_checkout_query(
self, self,
pre_checkout_query_id: str, pre_checkout_query_id: str,
@ -5093,7 +5033,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def answer_web_app_query( async def answer_web_app_query(
self, self,
web_app_query_id: str, web_app_query_id: str,
@ -5140,7 +5079,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
return SentWebAppMessage.de_json(api_result, self) # type: ignore[return-value] return SentWebAppMessage.de_json(api_result, self) # type: ignore[return-value]
@_log
async def restrict_chat_member( async def restrict_chat_member(
self, self,
chat_id: Union[str, int], chat_id: Union[str, int],
@ -5214,7 +5152,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def promote_chat_member( async def promote_chat_member(
self, self,
chat_id: Union[str, int], chat_id: Union[str, int],
@ -5339,7 +5276,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def set_chat_permissions( async def set_chat_permissions(
self, self,
chat_id: Union[str, int], chat_id: Union[str, int],
@ -5398,7 +5334,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def set_chat_administrator_custom_title( async def set_chat_administrator_custom_title(
self, self,
chat_id: Union[int, str], chat_id: Union[int, str],
@ -5441,7 +5376,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def export_chat_invite_link( async def export_chat_invite_link(
self, self,
chat_id: Union[str, int], chat_id: Union[str, int],
@ -5485,7 +5419,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def create_chat_invite_link( async def create_chat_invite_link(
self, self,
chat_id: Union[str, int], chat_id: Union[str, int],
@ -5563,7 +5496,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
return ChatInviteLink.de_json(result, self) # type: ignore[return-value] return ChatInviteLink.de_json(result, self) # type: ignore[return-value]
@_log
async def edit_chat_invite_link( async def edit_chat_invite_link(
self, self,
chat_id: Union[str, int], chat_id: Union[str, int],
@ -5645,7 +5577,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
return ChatInviteLink.de_json(result, self) # type: ignore[return-value] return ChatInviteLink.de_json(result, self) # type: ignore[return-value]
@_log
async def revoke_chat_invite_link( async def revoke_chat_invite_link(
self, self,
chat_id: Union[str, int], chat_id: Union[str, int],
@ -5693,7 +5624,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
return ChatInviteLink.de_json(result, self) # type: ignore[return-value] return ChatInviteLink.de_json(result, self) # type: ignore[return-value]
@_log
async def approve_chat_join_request( async def approve_chat_join_request(
self, self,
chat_id: Union[str, int], chat_id: Union[str, int],
@ -5734,7 +5664,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def decline_chat_join_request( async def decline_chat_join_request(
self, self,
chat_id: Union[str, int], chat_id: Union[str, int],
@ -5775,7 +5704,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def set_chat_photo( async def set_chat_photo(
self, self,
chat_id: Union[str, int], chat_id: Union[str, int],
@ -5822,7 +5750,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def delete_chat_photo( async def delete_chat_photo(
self, self,
chat_id: Union[str, int], chat_id: Union[str, int],
@ -5859,7 +5786,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def set_chat_title( async def set_chat_title(
self, self,
chat_id: Union[str, int], chat_id: Union[str, int],
@ -5900,7 +5826,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def set_chat_description( async def set_chat_description(
self, self,
chat_id: Union[str, int], chat_id: Union[str, int],
@ -5942,7 +5867,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def pin_chat_message( async def pin_chat_message(
self, self,
chat_id: Union[str, int], chat_id: Union[str, int],
@ -5992,7 +5916,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def unpin_chat_message( async def unpin_chat_message(
self, self,
chat_id: Union[str, int], chat_id: Union[str, int],
@ -6035,7 +5958,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def unpin_all_chat_messages( async def unpin_all_chat_messages(
self, self,
chat_id: Union[str, int], chat_id: Union[str, int],
@ -6074,7 +5996,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def get_sticker_set( async def get_sticker_set(
self, self,
name: str, name: str,
@ -6109,7 +6030,6 @@ class Bot(TelegramObject, AsyncContextManager["Bot"]):
) )
return StickerSet.de_json(result, self) # type: ignore[return-value] return StickerSet.de_json(result, self) # type: ignore[return-value]
@_log
async def get_custom_emoji_stickers( async def get_custom_emoji_stickers(
self, self,
custom_emoji_ids: Sequence[str], custom_emoji_ids: Sequence[str],
@ -6153,7 +6073,6 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
) )
return Sticker.de_list(result, self) return Sticker.de_list(result, self)
@_log
async def upload_sticker_file( async def upload_sticker_file(
self, self,
user_id: int, user_id: int,
@ -6213,7 +6132,6 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
) )
return File.de_json(result, self) # type: ignore[return-value] return File.de_json(result, self) # type: ignore[return-value]
@_log
async def add_sticker_to_set( async def add_sticker_to_set(
self, self,
user_id: int, user_id: int,
@ -6275,7 +6193,6 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def set_sticker_position_in_set( async def set_sticker_position_in_set(
self, self,
sticker: str, sticker: str,
@ -6311,7 +6228,6 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def create_new_sticker_set( async def create_new_sticker_set(
self, self,
user_id: int, user_id: int,
@ -6410,7 +6326,6 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def delete_sticker_from_set( async def delete_sticker_from_set(
self, self,
sticker: str, sticker: str,
@ -6444,7 +6359,6 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def delete_sticker_set( async def delete_sticker_set(
self, self,
name: str, name: str,
@ -6481,7 +6395,6 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def set_sticker_set_thumbnail( async def set_sticker_set_thumbnail(
self, self,
name: str, name: str,
@ -6546,7 +6459,6 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def set_sticker_set_title( async def set_sticker_set_title(
self, self,
name: str, name: str,
@ -6587,7 +6499,6 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def set_sticker_emoji_list( async def set_sticker_emoji_list(
self, self,
sticker: str, sticker: str,
@ -6629,7 +6540,6 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def set_sticker_keywords( async def set_sticker_keywords(
self, self,
sticker: str, sticker: str,
@ -6671,7 +6581,6 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def set_sticker_mask_position( async def set_sticker_mask_position(
self, self,
sticker: str, sticker: str,
@ -6712,7 +6621,6 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def set_custom_emoji_sticker_set_thumbnail( async def set_custom_emoji_sticker_set_thumbnail(
self, self,
name: str, name: str,
@ -6754,7 +6662,6 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def set_passport_data_errors( async def set_passport_data_errors(
self, self,
user_id: int, user_id: int,
@ -6801,7 +6708,6 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def send_poll( async def send_poll(
self, self,
chat_id: Union[int, str], chat_id: Union[int, str],
@ -6958,7 +6864,6 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def stop_poll( async def stop_poll(
self, self,
chat_id: Union[int, str], chat_id: Union[int, str],
@ -7004,7 +6909,6 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
) )
return Poll.de_json(result, self) # type: ignore[return-value] return Poll.de_json(result, self) # type: ignore[return-value]
@_log
async def send_dice( async def send_dice(
self, self,
chat_id: Union[int, str], chat_id: Union[int, str],
@ -7105,7 +7009,6 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def get_my_default_administrator_rights( async def get_my_default_administrator_rights(
self, self,
for_channels: Optional[bool] = None, for_channels: Optional[bool] = None,
@ -7147,7 +7050,6 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
return ChatAdministratorRights.de_json(result, self) # type: ignore[return-value] return ChatAdministratorRights.de_json(result, self) # type: ignore[return-value]
@_log
async def set_my_default_administrator_rights( async def set_my_default_administrator_rights(
self, self,
rights: Optional[ChatAdministratorRights] = None, rights: Optional[ChatAdministratorRights] = None,
@ -7193,7 +7095,6 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def get_my_commands( async def get_my_commands(
self, self,
scope: Optional[BotCommandScope] = None, scope: Optional[BotCommandScope] = None,
@ -7247,7 +7148,6 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
return BotCommand.de_list(result, self) return BotCommand.de_list(result, self)
@_log
async def set_my_commands( async def set_my_commands(
self, self,
commands: Sequence[Union[BotCommand, Tuple[str, str]]], commands: Sequence[Union[BotCommand, Tuple[str, str]]],
@ -7312,7 +7212,6 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def delete_my_commands( async def delete_my_commands(
self, self,
scope: Optional[BotCommandScope] = None, scope: Optional[BotCommandScope] = None,
@ -7360,7 +7259,6 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def log_out( async def log_out(
self, self,
*, *,
@ -7393,7 +7291,6 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def close( async def close(
self, self,
*, *,
@ -7425,7 +7322,6 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def copy_message( async def copy_message(
self, self,
chat_id: Union[int, str], chat_id: Union[int, str],
@ -7551,7 +7447,6 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
) )
return MessageId.de_json(result, self) # type: ignore[return-value] return MessageId.de_json(result, self) # type: ignore[return-value]
@_log
async def copy_messages( async def copy_messages(
self, self,
chat_id: Union[int, str], chat_id: Union[int, str],
@ -7622,7 +7517,6 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
) )
return MessageId.de_list(result, self) return MessageId.de_list(result, self)
@_log
async def set_chat_menu_button( async def set_chat_menu_button(
self, self,
chat_id: Optional[int] = None, chat_id: Optional[int] = None,
@ -7664,7 +7558,6 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def get_chat_menu_button( async def get_chat_menu_button(
self, self,
chat_id: Optional[int] = None, chat_id: Optional[int] = None,
@ -7704,7 +7597,6 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
) )
return MenuButton.de_json(result, bot=self) # type: ignore[return-value] return MenuButton.de_json(result, bot=self) # type: ignore[return-value]
@_log
async def create_invoice_link( async def create_invoice_link(
self, self,
title: str, title: str,
@ -7833,7 +7725,6 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def get_forum_topic_icon_stickers( async def get_forum_topic_icon_stickers(
self, self,
*, *,
@ -7865,7 +7756,6 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
) )
return Sticker.de_list(result, self) return Sticker.de_list(result, self)
@_log
async def create_forum_topic( async def create_forum_topic(
self, self,
chat_id: Union[str, int], chat_id: Union[str, int],
@ -7925,7 +7815,6 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
) )
return ForumTopic.de_json(result, self) # type: ignore[return-value] return ForumTopic.de_json(result, self) # type: ignore[return-value]
@_log
async def edit_forum_topic( async def edit_forum_topic(
self, self,
chat_id: Union[str, int], chat_id: Union[str, int],
@ -7982,7 +7871,6 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def close_forum_topic( async def close_forum_topic(
self, self,
chat_id: Union[str, int], chat_id: Union[str, int],
@ -8027,7 +7915,6 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def reopen_forum_topic( async def reopen_forum_topic(
self, self,
chat_id: Union[str, int], chat_id: Union[str, int],
@ -8072,7 +7959,6 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def delete_forum_topic( async def delete_forum_topic(
self, self,
chat_id: Union[str, int], chat_id: Union[str, int],
@ -8116,7 +8002,6 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def unpin_all_forum_topic_messages( async def unpin_all_forum_topic_messages(
self, self,
chat_id: Union[str, int], chat_id: Union[str, int],
@ -8161,7 +8046,6 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def unpin_all_general_forum_topic_messages( async def unpin_all_general_forum_topic_messages(
self, self,
chat_id: Union[str, int], chat_id: Union[str, int],
@ -8201,7 +8085,6 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def edit_general_forum_topic( async def edit_general_forum_topic(
self, self,
chat_id: Union[str, int], chat_id: Union[str, int],
@ -8245,7 +8128,6 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def close_general_forum_topic( async def close_general_forum_topic(
self, self,
chat_id: Union[str, int], chat_id: Union[str, int],
@ -8285,7 +8167,6 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def reopen_general_forum_topic( async def reopen_general_forum_topic(
self, self,
chat_id: Union[str, int], chat_id: Union[str, int],
@ -8326,7 +8207,6 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def hide_general_forum_topic( async def hide_general_forum_topic(
self, self,
chat_id: Union[str, int], chat_id: Union[str, int],
@ -8367,7 +8247,6 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def unhide_general_forum_topic( async def unhide_general_forum_topic(
self, self,
chat_id: Union[str, int], chat_id: Union[str, int],
@ -8407,7 +8286,6 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def set_my_description( async def set_my_description(
self, self,
description: Optional[str] = None, description: Optional[str] = None,
@ -8453,7 +8331,6 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def set_my_short_description( async def set_my_short_description(
self, self,
short_description: Optional[str] = None, short_description: Optional[str] = None,
@ -8499,7 +8376,6 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def get_my_description( async def get_my_description(
self, self,
language_code: Optional[str] = None, language_code: Optional[str] = None,
@ -8538,7 +8414,6 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
bot=self, bot=self,
) )
@_log
async def get_my_short_description( async def get_my_short_description(
self, self,
language_code: Optional[str] = None, language_code: Optional[str] = None,
@ -8578,7 +8453,6 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
bot=self, bot=self,
) )
@_log
async def set_my_name( async def set_my_name(
self, self,
name: Optional[str] = None, name: Optional[str] = None,
@ -8627,7 +8501,6 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
@_log
async def get_my_name( async def get_my_name(
self, self,
language_code: Optional[str] = None, language_code: Optional[str] = None,
@ -8666,7 +8539,6 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
bot=self, bot=self,
) )
@_log
async def get_user_chat_boosts( async def get_user_chat_boosts(
self, self,
chat_id: Union[str, int], chat_id: Union[str, int],
@ -8709,7 +8581,6 @@ CUSTOM_EMOJI_IDENTIFIER_LIMIT` custom emoji identifiers can be specified.
bot=self, bot=self,
) )
@_log
async def set_message_reaction( async def set_message_reaction(
self, self,
chat_id: Union[str, int], chat_id: Union[str, int],

2
telegram/_chat.py
View file

@ -1169,7 +1169,7 @@ class Chat(TelegramObject):
async def set_administrator_custom_title( async def set_administrator_custom_title(
self, self,
user_id: Union[int, str], user_id: int,
custom_title: str, custom_title: str,
*, *,
read_timeout: ODVInput[float] = DEFAULT_NONE, read_timeout: ODVInput[float] = DEFAULT_NONE,

2
telegram/_message.py
View file

@ -2871,7 +2871,7 @@ class Message(MaybeInaccessibleMessage):
do_quote, quote, reply_to_message_id, reply_parameters do_quote, quote, reply_to_message_id, reply_parameters
) )
return await self.get_bot().send_game( return await self.get_bot().send_game(
chat_id=chat_id, chat_id=chat_id, # type: ignore[arg-type]
game_short_name=game_short_name, game_short_name=game_short_name,
disable_notification=disable_notification, disable_notification=disable_notification,
reply_parameters=effective_reply_parameters, reply_parameters=effective_reply_parameters,

3
telegram/_passport/passportfile.py
View file

@ -203,5 +203,6 @@ class PassportFile(TelegramObject):
pool_timeout=pool_timeout, pool_timeout=pool_timeout,
api_kwargs=api_kwargs, api_kwargs=api_kwargs,
) )
file.set_credentials(self._credentials) if self._credentials:
file.set_credentials(self._credentials)
return file return file

8
telegram/ext/_extbot.py
View file

@ -113,6 +113,7 @@ if TYPE_CHECKING:
from telegram.ext import BaseRateLimiter, Defaults from telegram.ext import BaseRateLimiter, Defaults
HandledTypes = TypeVar("HandledTypes", bound=Union[Message, CallbackQuery, Chat]) HandledTypes = TypeVar("HandledTypes", bound=Union[Message, CallbackQuery, Chat])
KT = TypeVar("KT", bound=ReplyMarkup)
class ExtBot(Bot, Generic[RLARGS]): class ExtBot(Bot, Generic[RLARGS]):
@ -485,11 +486,14 @@ class ExtBot(Bot, Generic[RLARGS]):
data[key] = new_value data[key] = new_value
def _replace_keyboard(self, reply_markup: Optional[ReplyMarkup]) -> Optional[ReplyMarkup]: def _replace_keyboard(self, reply_markup: Optional[KT]) -> Optional[KT]:
# If the reply_markup is an inline keyboard and we allow arbitrary callback data, let the # If the reply_markup is an inline keyboard and we allow arbitrary callback data, let the
# CallbackDataCache build a new keyboard with the data replaced. Otherwise return the input # CallbackDataCache build a new keyboard with the data replaced. Otherwise return the input
if isinstance(reply_markup, InlineKeyboardMarkup) and self.callback_data_cache is not None: if isinstance(reply_markup, InlineKeyboardMarkup) and self.callback_data_cache is not None:
return self.callback_data_cache.process_keyboard(reply_markup) # for some reason mypy doesn't understand that IKB is a subtype of Optional[KT]
return self.callback_data_cache.process_keyboard( # type: ignore[return-value]
reply_markup
)
return reply_markup return reply_markup

2
telegram/ext/_updater.py
View file

@ -793,7 +793,7 @@ class Updater(AsyncContextManager["Updater"]):
if drop_pending_updates: if drop_pending_updates:
_LOGGER.debug("Dropping pending updates from Telegram server") _LOGGER.debug("Dropping pending updates from Telegram server")
await self.bot.set_webhook( await self.bot.set_webhook(
url=webhook_url, url=webhook_url, # type: ignore[arg-type]
certificate=cert, certificate=cert,
allowed_updates=allowed_updates, allowed_updates=allowed_updates,
ip_address=ip_address, ip_address=ip_address,

29
tests/test_bot.py
View file

@ -22,7 +22,6 @@ import datetime as dtm
import inspect import inspect
import logging import logging
import pickle import pickle
import re
import socket import socket
import time import time
from collections import defaultdict from collections import defaultdict
@ -388,22 +387,10 @@ class TestBotWithoutRequest:
with pytest.raises(TypeError, match="Bot objects cannot be deepcopied"): with pytest.raises(TypeError, match="Bot objects cannot be deepcopied"):
copy.deepcopy(bot) copy.deepcopy(bot)
@bot_methods(ext_bot=False)
def test_api_methods_have_log_decorator(self, bot_class, bot_method_name, bot_method):
"""Check that all bot methods have the log decorator ..."""
# not islower() skips the camelcase aliases
if not bot_method_name.islower():
return
source = inspect.getsource(bot_method)
assert (
# Use re.match to only match at *the beginning* of the string
re.match(rf"\s*\@\_log\s*async def {bot_method_name}", source)
), f"{bot_method_name} is missing the @_log decorator"
@pytest.mark.parametrize( @pytest.mark.parametrize(
("cls", "logger_name"), [(Bot, "telegram.Bot"), (ExtBot, "telegram.ext.ExtBot")] ("cls", "logger_name"), [(Bot, "telegram.Bot"), (ExtBot, "telegram.ext.ExtBot")]
) )
async def test_log_decorator(self, bot: PytestExtBot, cls, logger_name, caplog): async def test_bot_method_logging(self, bot: PytestExtBot, cls, logger_name, caplog):
# Second argument makes sure that we ignore logs from e.g. httpx # Second argument makes sure that we ignore logs from e.g. httpx
with caplog.at_level(logging.DEBUG, logger="telegram"): with caplog.at_level(logging.DEBUG, logger="telegram"):
await cls(bot.token).get_me() await cls(bot.token).get_me()
@ -415,11 +402,19 @@ class TestBotWithoutRequest:
caplog.records.pop(idx) caplog.records.pop(idx)
if record.getMessage().startswith("Task exception was never retrieved"): if record.getMessage().startswith("Task exception was never retrieved"):
caplog.records.pop(idx) caplog.records.pop(idx)
assert len(caplog.records) == 3 assert len(caplog.records) == 2
assert all(caplog.records[i].name == logger_name for i in [-1, 0]) assert all(caplog.records[i].name == logger_name for i in [-1, 0])
assert caplog.records[0].getMessage().startswith("Entering: get_me") assert (
assert caplog.records[-1].getMessage().startswith("Exiting: get_me") caplog.records[0]
.getMessage()
.startswith("Calling Bot API endpoint `getMe` with parameters `{}`")
)
assert (
caplog.records[-1]
.getMessage()
.startswith("Call to Bot API endpoint `getMe` finished with return value")
)
@bot_methods() @bot_methods()
def test_camel_case_aliases(self, bot_class, bot_method_name, bot_method): def test_camel_case_aliases(self, bot_class, bot_method_name, bot_method):

13
tests/test_chat.py
View file

@ -576,6 +576,19 @@ class TestChatWithoutRequest(TestChatBase):
custom_title = kwargs["custom_title"] == "custom_title" custom_title = kwargs["custom_title"] == "custom_title"
return chat_id and user_id and custom_title return chat_id and user_id and custom_title
assert check_shortcut_signature(
Chat.set_administrator_custom_title,
Bot.set_chat_administrator_custom_title,
["chat_id"],
[],
)
assert await check_shortcut_call(
chat.set_administrator_custom_title,
chat.get_bot(),
"set_chat_administrator_custom_title",
)
assert await check_defaults_handling(chat.set_administrator_custom_title, chat.get_bot())
monkeypatch.setattr("telegram.Bot.set_chat_administrator_custom_title", make_assertion) monkeypatch.setattr("telegram.Bot.set_chat_administrator_custom_title", make_assertion)
assert await chat.set_administrator_custom_title(user_id=42, custom_title="custom_title") assert await chat.set_administrator_custom_title(user_id=42, custom_title="custom_title")