-
Notifications
You must be signed in to change notification settings - Fork 6.1k
Expand file tree
/
Copy path_bot.py
More file actions
10009 lines (8620 loc) · 409 KB
/
Copy path_bot.py
File metadata and controls
10009 lines (8620 loc) · 409 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/env python
# pylint: disable=too-many-arguments
#
# A library that provides a Python interface to the Telegram Bot API
# Copyright (C) 2015-2024
# Leandro Toledo de Souza <devs@python-telegram-bot.org>
#
# 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 Bot."""
import asyncio
import contextlib
import copy
import pickle
from collections.abc import Sequence
from datetime import datetime, timedelta
from types import TracebackType
from typing import (
TYPE_CHECKING,
Any,
Callable,
NoReturn,
Optional,
TypeVar,
Union,
cast,
no_type_check,
)
try:
from cryptography.hazmat.backends import default_backend
from cryptography.hazmat.primitives import serialization
CRYPTO_INSTALLED = True
except ImportError:
default_backend = None # type: ignore[assignment]
serialization = None # type: ignore[assignment]
CRYPTO_INSTALLED = False
from telegram._botcommand import BotCommand
from telegram._botcommandscope import BotCommandScope
from telegram._botdescription import BotDescription, BotShortDescription
from telegram._botname import BotName
from telegram._business import BusinessConnection
from telegram._chatadministratorrights import ChatAdministratorRights
from telegram._chatboost import UserChatBoosts
from telegram._chatfullinfo import ChatFullInfo
from telegram._chatinvitelink import ChatInviteLink
from telegram._chatmember import ChatMember
from telegram._chatpermissions import ChatPermissions
from telegram._files.animation import Animation
from telegram._files.audio import Audio
from telegram._files.chatphoto import ChatPhoto
from telegram._files.contact import Contact
from telegram._files.document import Document
from telegram._files.file import File
from telegram._files.inputmedia import InputMedia, InputPaidMedia
from telegram._files.location import Location
from telegram._files.photosize import PhotoSize
from telegram._files.sticker import MaskPosition, Sticker, StickerSet
from telegram._files.venue import Venue
from telegram._files.video import Video
from telegram._files.videonote import VideoNote
from telegram._files.voice import Voice
from telegram._forumtopic import ForumTopic
from telegram._games.gamehighscore import GameHighScore
from telegram._gifts import Gift, Gifts
from telegram._inline.inlinequeryresultsbutton import InlineQueryResultsButton
from telegram._inline.preparedinlinemessage import PreparedInlineMessage
from telegram._menubutton import MenuButton
from telegram._message import Message
from telegram._messageid import MessageId
from telegram._payment.stars import StarTransactions
from telegram._poll import InputPollOption, Poll
from telegram._reaction import ReactionType, ReactionTypeCustomEmoji, ReactionTypeEmoji
from telegram._reply import ReplyParameters
from telegram._sentwebappmessage import SentWebAppMessage
from telegram._telegramobject import TelegramObject
from telegram._update import Update
from telegram._user import User
from telegram._userprofilephotos import UserProfilePhotos
from telegram._utils.argumentparsing import parse_lpo_and_dwpp, parse_sequence_arg
from telegram._utils.defaultvalue import DEFAULT_NONE, DefaultValue
from telegram._utils.files import is_local_file, parse_file_input
from telegram._utils.logging import get_logger
from telegram._utils.repr import build_repr_with_selected_attrs
from telegram._utils.strings import to_camel_case
from telegram._utils.types import CorrectOptionID, FileInput, JSONDict, ODVInput, ReplyMarkup
from telegram._utils.warnings import warn
from telegram._webhookinfo import WebhookInfo
from telegram.constants import InlineQueryLimit, ReactionEmoji
from telegram.error import EndPointNotFound, InvalidToken
from telegram.request import BaseRequest, RequestData
from telegram.request._httpxrequest import HTTPXRequest
from telegram.request._requestparameter import RequestParameter
from telegram.warnings import PTBDeprecationWarning, PTBUserWarning
if TYPE_CHECKING:
from telegram import (
InlineKeyboardMarkup,
InlineQueryResult,
InputFile,
InputMediaAudio,
InputMediaDocument,
InputMediaPhoto,
InputMediaVideo,
InputSticker,
LabeledPrice,
LinkPreviewOptions,
MessageEntity,
PassportElementError,
ShippingOption,
)
BT = TypeVar("BT", bound="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
.. code:: python
async with bot:
# code
is roughly equivalent to
.. code:: python
try:
await bot.initialize()
# code
finally:
await bot.shutdown()
.. seealso:: :meth:`__aenter__` and :meth:`__aexit__`.
Note:
* Most bot methods have the argument ``api_kwargs`` which allows passing arbitrary keywords
to the Telegram API. This can be used to access new features of the API before they are
incorporated into PTB. The limitations to this argument are the same as the ones
described in :meth:`do_api_request`.
* Bots should not be serialized since if you for e.g. change the bots token, then your
serialized instance will not reflect that change. Trying to pickle a bot instance will
raise :exc:`pickle.PicklingError`. Trying to deepcopy a bot instance will raise
:exc:`TypeError`.
Examples:
:any:`Raw API Bot <examples.rawapibot>`
.. seealso:: :wiki:`Your First Bot <Extensions---Your-first-Bot>`,
:wiki:`Builder Pattern <Builder-Pattern>`
.. versionadded:: 13.2
Objects of this class are comparable in terms of equality. Two objects of this class are
considered equal, if their :attr:`bot` is equal.
.. versionchanged:: 20.0
* Removed the deprecated methods ``kick_chat_member``, ``kickChatMember``,
``get_chat_members_count`` and ``getChatMembersCount``.
* Removed the deprecated property ``commands``.
* Removed the deprecated ``defaults`` parameter. If you want to use
:class:`telegram.ext.Defaults`, please use the subclass :class:`telegram.ext.ExtBot`
instead.
* Attempting to pickle a bot instance will now raise :exc:`pickle.PicklingError`.
* Attempting to deepcopy a bot instance will now raise :exc:`TypeError`.
* The following are now keyword-only arguments in Bot methods:
``location``, ``filename``, ``venue``, ``contact``,
``{read, write, connect, pool}_timeout``, ``api_kwargs``. Use a named argument for those,
and notice that some positional arguments changed position as a result.
* For uploading files, file paths are now always accepted. If :paramref:`local_mode` is
:obj:`False`, the file contents will be read in binary mode and uploaded. Otherwise,
the file path will be passed in the
`file URI scheme <https://en.wikipedia.org/wiki/File_URI_scheme>`_.
.. versionchanged:: 20.5
Removed deprecated methods ``set_sticker_set_thumb`` and ``setStickerSetThumb``.
Use :meth:`set_sticker_set_thumbnail` and :meth:`setStickerSetThumbnail` instead.
Args:
token (:obj:`str`): Bot's unique authentication token.
base_url (:obj:`str`, optional): Telegram Bot API service URL.
base_file_url (:obj:`str`, optional): Telegram Bot API file URL.
request (:class:`telegram.request.BaseRequest`, optional): Pre initialized
:class:`telegram.request.BaseRequest` instances. Will be used for all bot methods
*except* for :meth:`get_updates`. If not passed, an instance of
:class:`telegram.request.HTTPXRequest` will be used.
get_updates_request (:class:`telegram.request.BaseRequest`, optional): Pre initialized
:class:`telegram.request.BaseRequest` instances. Will be used exclusively for
:meth:`get_updates`. If not passed, an instance of
:class:`telegram.request.HTTPXRequest` will be used.
private_key (:obj:`bytes`, optional): Private key for decryption of telegram passport data.
private_key_password (:obj:`bytes`, optional): Password for above private key.
local_mode (:obj:`bool`, optional): Set to :obj:`True`, if the :paramref:`base_url` is
the URI of a `Local Bot API Server <https://core.telegram.org/bots/api#using-a-local\
-bot-api-server>`_ that runs with the ``--local`` flag. Currently, the only effect of
this is that files are uploaded using their local path in the
`file URI scheme <https://en.wikipedia.org/wiki/File_URI_scheme>`_.
Defaults to :obj:`False`.
.. versionadded:: 20.0.
.. include:: inclusions/bot_methods.rst
.. |removed_thumb_arg| replace:: Removed deprecated argument ``thumb``. Use
``thumbnail`` instead.
"""
# This is a class variable since we want to override the logger name in ExtBot
# without having to change all places where this is used
_LOGGER = get_logger(__name__)
__slots__ = (
"_base_file_url",
"_base_url",
"_bot_user",
"_initialized",
"_local_mode",
"_private_key",
"_request",
"_token",
)
def __init__(
self,
token: str,
base_url: str = "https://api.telegram.org/bot",
base_file_url: str = "https://api.telegram.org/file/bot",
request: Optional[BaseRequest] = None,
get_updates_request: Optional[BaseRequest] = None,
private_key: Optional[bytes] = None,
private_key_password: Optional[bytes] = None,
local_mode: bool = False,
):
super().__init__(api_kwargs=None)
if not token:
raise InvalidToken("You must pass the token you received from https://t.me/Botfather!")
self._token: str = token
self._base_url: str = base_url + self._token
self._base_file_url: str = base_file_url + self._token
self._local_mode: bool = local_mode
self._bot_user: Optional[User] = None
self._private_key: Optional[bytes] = None
self._initialized: bool = False
self._request: tuple[BaseRequest, BaseRequest] = (
HTTPXRequest() if get_updates_request is None else get_updates_request,
HTTPXRequest() if request is None else request,
)
# this section is about issuing a warning when using HTTP/2 and connect to a self hosted
# bot api instance, which currently only supports HTTP/1.1. Checking if a custom base url
# is set is the best way to do that.
warning_string = ""
if (
isinstance(self._request[0], HTTPXRequest)
and self._request[0].http_version == "2"
and not base_url.startswith("https://api.telegram.org/bot")
):
warning_string = "get_updates_request"
if (
isinstance(self._request[1], HTTPXRequest)
and self._request[1].http_version == "2"
and not base_url.startswith("https://api.telegram.org/bot")
):
if warning_string:
warning_string += " and request"
else:
warning_string = "request"
if warning_string:
self._warn(
f"You set the HTTP version for the {warning_string} HTTPXRequest instance to "
"HTTP/2. The self hosted bot api instances only support HTTP/1.1. You should "
"either run a HTTP proxy in front of it which supports HTTP/2 or use HTTP/1.1.",
PTBUserWarning,
stacklevel=2,
)
if private_key:
if not CRYPTO_INSTALLED:
raise RuntimeError(
"To use Telegram Passports, PTB must be installed via `pip install "
'"python-telegram-bot[passport]"`.'
)
self._private_key = serialization.load_pem_private_key(
private_key, password=private_key_password, backend=default_backend()
)
self._freeze()
async def __aenter__(self: BT) -> BT:
"""
|async_context_manager| :meth:`initializes <initialize>` the Bot.
Returns:
The initialized Bot instance.
Raises:
:exc:`Exception`: If an exception is raised during initialization, :meth:`shutdown`
is called in this case.
"""
try:
await self.initialize()
except Exception:
await self.shutdown()
raise
return self
async def __aexit__(
self,
exc_type: Optional[type[BaseException]],
exc_val: Optional[BaseException],
exc_tb: Optional[TracebackType],
) -> None:
"""|async_context_manager| :meth:`shuts down <shutdown>` the Bot."""
# Make sure not to return `True` so that exceptions are not suppressed
# https://docs.python.org/3/reference/datamodel.html?#object.__aexit__
await self.shutdown()
def __reduce__(self) -> NoReturn:
"""Customizes how :func:`copy.deepcopy` processes objects of this type. Bots can not
be pickled and this method will always raise an exception.
.. versionadded:: 20.0
Raises:
:exc:`pickle.PicklingError`
"""
raise pickle.PicklingError("Bot objects cannot be pickled!")
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.
.. versionadded:: 20.0
Raises:
:exc:`TypeError`
"""
raise TypeError("Bot objects cannot be deepcopied!")
def __eq__(self, other: object) -> bool:
"""Defines equality condition for the :class:`telegram.Bot` object.
Two objects of this class are considered to be equal if their attributes
:attr:`bot` are equal.
Returns:
:obj:`True` if both attributes :attr:`bot` are equal. :obj:`False` otherwise.
"""
if isinstance(other, Bot):
return self.bot == other.bot
return super().__eq__(other)
def __hash__(self) -> int:
"""See :meth:`telegram.TelegramObject.__hash__`"""
if self._bot_user is None:
return super().__hash__()
return hash((self.bot, Bot))
def __repr__(self) -> str:
"""Give a string representation of the bot in the form ``Bot[token=...]``.
As this class doesn't implement :meth:`object.__str__`, the default implementation
will be used, which is equivalent to :meth:`__repr__`.
Returns:
:obj:`str`
"""
return build_repr_with_selected_attrs(self, token=self.token)
@property
def token(self) -> str:
""":obj:`str`: Bot's unique authentication token.
.. versionadded:: 20.0
"""
return self._token
@property
def base_url(self) -> str:
""":obj:`str`: Telegram Bot API service URL, built from :paramref:`Bot.base_url` and
:paramref:`Bot.token`.
.. versionadded:: 20.0
"""
return self._base_url
@property
def base_file_url(self) -> str:
""":obj:`str`: Telegram Bot API file URL, built from :paramref:`Bot.base_file_url` and
:paramref:`Bot.token`.
.. versionadded:: 20.0
"""
return self._base_file_url
@property
def local_mode(self) -> bool:
""":obj:`bool`: Whether this bot is running in local mode.
.. versionadded:: 20.0
"""
return self._local_mode
# Proper type hints are difficult because:
# 1. cryptography doesn't have a nice base class, so it would get lengthy
# 2. we can't import cryptography if it's not installed
@property
def private_key(self) -> Optional[Any]:
"""Deserialized private key for decryption of telegram passport data.
.. versionadded:: 20.0
"""
return self._private_key
@property
def request(self) -> BaseRequest:
"""The :class:`~telegram.request.BaseRequest` object used by this bot.
Warning:
Requests to the Bot API are made by the various methods of this class. This attribute
should *not* be used manually.
"""
return self._request[1]
@property
def bot(self) -> User:
""":class:`telegram.User`: User instance for the bot as returned by :meth:`get_me`.
Warning:
This value is the cached return value of :meth:`get_me`. If the bots profile is
changed during runtime, this value won't reflect the changes until :meth:`get_me` is
called again.
.. seealso:: :meth:`initialize`
"""
if self._bot_user is None:
raise RuntimeError(
f"{self.__class__.__name__} is not properly initialized. Call "
f"`{self.__class__.__name__}.initialize` before accessing this property."
)
return self._bot_user
@property
def id(self) -> int:
""":obj:`int`: Unique identifier for this bot. Shortcut for the corresponding attribute of
:attr:`bot`.
"""
return self.bot.id
@property
def first_name(self) -> str:
""":obj:`str`: Bot's first name. Shortcut for the corresponding attribute of
:attr:`bot`.
"""
return self.bot.first_name
@property
def last_name(self) -> str:
""":obj:`str`: Optional. Bot's last name. Shortcut for the corresponding attribute of
:attr:`bot`.
"""
return self.bot.last_name # type: ignore
@property
def username(self) -> str:
""":obj:`str`: Bot's username. Shortcut for the corresponding attribute of
:attr:`bot`.
"""
return self.bot.username # type: ignore
@property
def link(self) -> str:
""":obj:`str`: Convenience property. Returns the t.me link of the bot."""
return f"https://t.me/{self.username}"
@property
def can_join_groups(self) -> bool:
""":obj:`bool`: Bot's :attr:`telegram.User.can_join_groups` attribute. Shortcut for the
corresponding attribute of :attr:`bot`.
"""
return self.bot.can_join_groups # type: ignore
@property
def can_read_all_group_messages(self) -> bool:
""":obj:`bool`: Bot's :attr:`telegram.User.can_read_all_group_messages` attribute.
Shortcut for the corresponding attribute of :attr:`bot`.
"""
return self.bot.can_read_all_group_messages # type: ignore
@property
def supports_inline_queries(self) -> bool:
""":obj:`bool`: Bot's :attr:`telegram.User.supports_inline_queries` attribute.
Shortcut for the corresponding attribute of :attr:`bot`.
"""
return self.bot.supports_inline_queries # type: ignore
@property
def name(self) -> str:
""":obj:`str`: Bot's @username. Shortcut for the corresponding attribute of :attr:`bot`."""
return f"@{self.username}"
@classmethod
def _warn(
cls,
message: Union[str, PTBUserWarning],
category: type[Warning] = PTBUserWarning,
stacklevel: int = 0,
) -> None:
"""Convenience method to issue a warning. This method is here mostly to make it easier
for ExtBot to add 1 level to all warning calls.
"""
warn(message=message, category=category, stacklevel=stacklevel + 1)
def _parse_file_input(
self,
file_input: Union[FileInput, "TelegramObject"],
tg_type: Optional[type["TelegramObject"]] = None,
filename: Optional[str] = None,
attach: bool = False,
) -> Union[str, "InputFile", Any]:
return parse_file_input(
file_input=file_input,
tg_type=tg_type,
filename=filename,
attach=attach,
local_mode=self._local_mode,
)
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*
be done in ExtBot instead of Bot, shortcuts like `Message.reply_text` need to work for both
Bot and ExtBot, so they also have the `DEFAULT_NONE` default values.
This makes it necessary to convert `DefaultValue(obj)` to `obj` at some point between
`Message.reply_text` and the request to TG. Doing this here in a centralized manner is a
rather clean and minimally invasive solution, i.e. the link between tg and tg.ext is as
small as possible.
See also _insert_defaults_for_ilq
ExtBot overrides this method to actually insert default values.
If in the future we come up with a better way of making `Defaults` work, we can cut this
link as well.
"""
# We
# 1) set the correct parse_mode for all InputMedia objects
# 2) replace all DefaultValue instances with the corresponding normal value.
for key, val in data.items():
# 1)
if isinstance(val, InputMedia):
# Copy object as not to edit it in-place
new = copy.copy(val)
with new._unfrozen():
new.parse_mode = DefaultValue.get_value(new.parse_mode)
data[key] = new
elif (
key == "media"
and isinstance(val, Sequence)
and not isinstance(val[0], InputPaidMedia)
):
# Copy objects as not to edit them in-place
copy_list = [copy.copy(media) for media in val]
for media in copy_list:
with media._unfrozen():
media.parse_mode = DefaultValue.get_value(media.parse_mode)
data[key] = copy_list
# 2)
else:
data[key] = DefaultValue.get_value(val)
async def _post(
self,
endpoint: str,
data: Optional[JSONDict] = 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,
) -> Any:
# 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:
data = {}
if api_kwargs:
data.update(api_kwargs)
# Insert is in-place, so no return value for data
self._insert_defaults(data)
# Drop any None values because Telegram doesn't handle them well
data = {key: value for key, value in data.items() if value is not None}
return await self._do_post(
endpoint=endpoint,
data=data,
read_timeout=read_timeout,
write_timeout=write_timeout,
connect_timeout=connect_timeout,
pool_timeout=pool_timeout,
)
async def _do_post(
self,
endpoint: str,
data: JSONDict,
*,
read_timeout: ODVInput[float] = DEFAULT_NONE,
write_timeout: ODVInput[float] = DEFAULT_NONE,
connect_timeout: ODVInput[float] = DEFAULT_NONE,
pool_timeout: ODVInput[float] = DEFAULT_NONE,
) -> 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
request_data = RequestData(
parameters=[RequestParameter.from_input(key, value) for key, value in data.items()],
)
request = self._request[0] if endpoint == "getUpdates" else self._request[1]
self._LOGGER.debug("Calling Bot API endpoint `%s` with parameters `%s`", endpoint, data)
result = await request.post(
url=f"{self._base_url}/{endpoint}",
request_data=request_data,
read_timeout=read_timeout,
write_timeout=write_timeout,
connect_timeout=connect_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(
self,
endpoint: str,
data: JSONDict,
disable_notification: ODVInput[bool] = DEFAULT_NONE,
reply_markup: Optional[ReplyMarkup] = None,
protect_content: ODVInput[bool] = DEFAULT_NONE,
message_thread_id: Optional[int] = None,
caption: Optional[str] = None,
parse_mode: ODVInput[str] = DEFAULT_NONE,
caption_entities: Optional[Sequence["MessageEntity"]] = None,
link_preview_options: ODVInput["LinkPreviewOptions"] = None,
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,
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,
) -> Any:
"""Protected method to send or edit messages of any type.
It is here to reduce repetition of if-else closes in the different bot methods,
i.e. this method takes care of adding its parameters to `data` if appropriate.
Depending on the bot method, returns either `True` or the message.
However, it's hard to tell mypy which methods expects which of these return values and
using `Any` instead saves us a lot of `type: ignore` comments
"""
# We don't check if (DEFAULT_)None here, so that _post is able to insert the defaults
# correctly, if necessary:
if allow_sending_without_reply is not DEFAULT_NONE and reply_parameters is not None:
raise ValueError(
"`allow_sending_without_reply` and `reply_parameters` are mutually exclusive."
)
if reply_to_message_id is not None and reply_parameters is not None:
raise ValueError(
"`reply_to_message_id` and `reply_parameters` are mutually exclusive."
)
if reply_to_message_id is not None:
reply_parameters = ReplyParameters(
message_id=reply_to_message_id,
allow_sending_without_reply=allow_sending_without_reply,
)
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,
data,
read_timeout=read_timeout,
write_timeout=write_timeout,
connect_timeout=connect_timeout,
pool_timeout=pool_timeout,
api_kwargs=api_kwargs,
)
if result is True:
return result
return Message.de_json(result, self)
async def initialize(self) -> None:
"""Initialize resources used by this class. Currently calls :meth:`get_me` to
cache :attr:`bot` and calls :meth:`telegram.request.BaseRequest.initialize` for
the request objects used by this bot.
.. seealso:: :meth:`shutdown`
.. versionadded:: 20.0
"""
if self._initialized:
self._LOGGER.debug("This Bot is already initialized.")
return
await asyncio.gather(self._request[0].initialize(), self._request[1].initialize())
# Since the bot is to be initialized only once, we can also use it for
# verifying the token passed and raising an exception if it's invalid.
try:
await self.get_me()
except InvalidToken as exc:
raise InvalidToken(f"The token `{self._token}` was rejected by the server.") from exc
self._initialized = True
async def shutdown(self) -> None:
"""Stop & clear resources used by this class. Currently just calls
:meth:`telegram.request.BaseRequest.shutdown` for the request objects used by this bot.
.. seealso:: :meth:`initialize`
.. versionadded:: 20.0
"""
if not self._initialized:
self._LOGGER.debug("This Bot is already shut down. Returning.")
return
await asyncio.gather(self._request[0].shutdown(), self._request[1].shutdown())
self._initialized = False
async def do_api_request(
self,
endpoint: str,
api_kwargs: Optional[JSONDict] = None,
return_type: Optional[type[TelegramObject]] = 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,
) -> Any:
"""Do a request to the Telegram API.
This method is here to make it easier to use new API methods that are not yet supported
by this library.
Hint:
Since PTB does not know which arguments are passed to this method, some caution is
necessary in terms of PTBs utility functionalities. In particular
* passing objects of any class defined in the :mod:`telegram` module is supported
* when uploading files, a :class:`telegram.InputFile` must be passed as the value for
the corresponding argument. Passing a file path or file-like object will not work.
File paths will work only in combination with :paramref:`~Bot.local_mode`.
* when uploading files, PTB can still correctly determine that
a special write timeout value should be used instead of the default
:paramref:`telegram.request.HTTPXRequest.write_timeout`.
* insertion of default values specified via :class:`telegram.ext.Defaults` will not
work (only relevant for :class:`telegram.ext.ExtBot`).
* The only exception is :class:`telegram.ext.Defaults.tzinfo`, which will be correctly
applied to :class:`datetime.datetime` objects.
.. versionadded:: 20.8
Args:
endpoint (:obj:`str`): The API endpoint to use, e.g. ``getMe`` or ``get_me``.
api_kwargs (:obj:`dict`, optional): The keyword arguments to pass to the API call.
If not specified, no arguments are passed.
return_type (:class:`telegram.TelegramObject`, optional): If specified, the result of
the API call will be deserialized into an instance of this class or tuple of
instances of this class. If not specified, the raw result of the API call will be
returned.
Returns:
The result of the API call. If :paramref:`return_type` is not specified, this is a
:obj:`dict` or :obj:`bool`, otherwise an instance of :paramref:`return_type` or a
tuple of :paramref:`return_type`.
Raises:
:class:`telegram.error.TelegramError`
"""
if hasattr(self, endpoint):
self._warn(
(
f"Please use 'Bot.{endpoint}' instead of "
f"'Bot.do_api_request(\"{endpoint}\", ...)'"
),
stacklevel=2,
)
camel_case_endpoint = to_camel_case(endpoint)
try:
result = await self._post(
camel_case_endpoint,
api_kwargs=api_kwargs,
read_timeout=read_timeout,
write_timeout=write_timeout,
connect_timeout=connect_timeout,
pool_timeout=pool_timeout,
)
except InvalidToken as exc:
# TG returns 404 Not found for
# 1) malformed tokens
# 2) correct tokens but non-existing method, e.g. api.tg.org/botTOKEN/unkonwnMethod
# 2) is relevant only for Bot.do_api_request, that's why we have special handling for
# that here rather than in BaseRequest._request_wrapper
if self._initialized:
raise EndPointNotFound(
f"Endpoint '{camel_case_endpoint}' not found in Bot API"
) from exc
raise InvalidToken(
"Either the bot token was rejected by Telegram or the endpoint "
f"'{camel_case_endpoint}' does not exist."
) from exc
if return_type is None or isinstance(result, bool):
return result
if isinstance(result, list):
return return_type.de_list(result, self)
return return_type.de_json(result, self)
async def get_me(
self,
*,
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,
) -> User:
"""A simple method for testing your bot's auth token. Requires no parameters.
Returns:
:class:`telegram.User`: A :class:`telegram.User` instance representing that bot if the
credentials are valid, :obj:`None` otherwise.
Raises:
:class:`telegram.error.TelegramError`
"""
result = await self._post(
"getMe",
read_timeout=read_timeout,
write_timeout=write_timeout,
connect_timeout=connect_timeout,
pool_timeout=pool_timeout,
api_kwargs=api_kwargs,
)
self._bot_user = User.de_json(result, self)
return self._bot_user # type: ignore[return-value]
async def send_message(
self,
chat_id: Union[int, str],
text: str,
parse_mode: ODVInput[str] = DEFAULT_NONE,
entities: Optional[Sequence["MessageEntity"]] = None,
disable_notification: ODVInput[bool] = DEFAULT_NONE,
protect_content: ODVInput[bool] = DEFAULT_NONE,
reply_markup: Optional[ReplyMarkup] = None,
message_thread_id: Optional[int] = None,
link_preview_options: ODVInput["LinkPreviewOptions"] = DEFAULT_NONE,
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,
disable_web_page_preview: Optional[bool] = 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:
"""Use this method to send text messages.
Args:
chat_id (:obj:`int` | :obj:`str`): |chat_id_channel|
text (:obj:`str`): Text of the message to be sent. Max
:tg-const:`telegram.constants.MessageLimit.MAX_TEXT_LENGTH` characters after
entities parsing.
parse_mode (:obj:`str`): |parse_mode|
entities (Sequence[:class:`telegram.MessageEntity`], optional): Sequence of special
entities that appear in message text, which can be specified instead of
:paramref:`parse_mode`.
.. versionchanged:: 20.0
|sequenceargs|
link_preview_options (:obj:`LinkPreviewOptions`, optional): Link preview generation
options for the message. Mutually exclusive with
:paramref:`disable_web_page_preview`.
.. versionadded:: 20.8
disable_notification (:obj:`bool`, optional): |disable_notification|
protect_content (:obj:`bool`, optional): |protect_content|
.. versionadded:: 13.10
reply_markup (:class:`InlineKeyboardMarkup` | :class:`ReplyKeyboardMarkup` | \
:class:`ReplyKeyboardRemove` | :class:`ForceReply`, optional):
Additional interface options. An object for an inline keyboard, custom reply
keyboard, instructions to remove reply keyboard or to force a reply from the user.
message_thread_id (:obj:`int`, optional): |message_thread_id_arg|
.. versionadded:: 20.0
reply_parameters (:class:`telegram.ReplyParameters`, optional): |reply_parameters|
.. versionadded:: 20.8
business_connection_id (:obj:`str`, optional): |business_id_str|
.. versionadded:: 21.1
message_effect_id (:obj:`str`, optional): |message_effect_id|
.. versionadded:: 21.3
allow_paid_broadcast (:obj:`bool`, optional): |allow_paid_broadcast|
.. versionadded:: 21.7
Keyword Args:
allow_sending_without_reply (:obj:`bool`, optional): |allow_sending_without_reply|
Mutually exclusive with :paramref:`reply_parameters`, which this is a convenience
parameter for
.. versionchanged:: 20.8
Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated|
.. versionchanged:: 21.0
|keyword_only_arg|
reply_to_message_id (:obj:`int`, optional): |reply_to_msg_id|
Mutually exclusive with :paramref:`reply_parameters`, which this is a convenience
parameter for
.. versionchanged:: 20.8
Bot API 7.0 introduced :paramref:`reply_parameters` |rtm_aswr_deprecated|
.. versionchanged:: 21.0
|keyword_only_arg|
disable_web_page_preview (:obj:`bool`, optional): Disables link previews for links in
this message. Convenience parameter for setting :paramref:`link_preview_options`.
Mutually exclusive with :paramref:`link_preview_options`.
.. versionchanged:: 20.8
Bot API 7.0 introduced :paramref:`link_preview_options` replacing this