mirror/pyTelegramBotAPI
1
0
Fork 0
mirror of https://github.com/eternnoir/pyTelegramBotAPI.git synced 2023-08-10 21:12:57 +03:00
Code Releases Activity

Added some notes

Browse Source
This commit is contained in:
coder2020official 2022-10-01 21:15:24 +04:00
parent 04ff428bba
commit ea69b8093d
2 changed files with 24 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
telebot/__init__.py
View File

@ -95,6 +95,10 @@ class TeleBot:
See more examples in examples/ directory: See more examples in examples/ directory:
https://github.com/eternnoir/pyTelegramBotAPI/tree/master/examples https://github.com/eternnoir/pyTelegramBotAPI/tree/master/examples
.. note::
Install coloredlogs module to specify colorful_logs=True
:param token: Token of a bot, should be obtained from @BotFather :param token: Token of a bot, should be obtained from @BotFather
:type token: :obj:`str` :type token: :obj:`str`
@ -904,6 +908,10 @@ class TeleBot:
""" """
Wrap polling with infinite loop and exception handling to avoid bot stops polling. Wrap polling with infinite loop and exception handling to avoid bot stops polling.
.. note::
Install watchdog and psutil before using restart_on_change option.
:param timeout: Request connection timeout. :param timeout: Request connection timeout.
:type timeout: :obj:`int` :type timeout: :obj:`int`
@ -974,6 +982,10 @@ class TeleBot:
.. deprecated:: 4.1.1 .. deprecated:: 4.1.1
Use :meth:`infinity_polling` instead. Use :meth:`infinity_polling` instead.
.. note::
Install watchdog and psutil before using restart_on_change option.
:param interval: Delay between two update retrivals :param interval: Delay between two update retrivals
:type interval: :obj:`int` :type interval: :obj:`int`

13
telebot/async_telebot.py
View File

@ -82,6 +82,10 @@ class AsyncTeleBot:
See more examples in examples/ directory: See more examples in examples/ directory:
https://github.com/eternnoir/pyTelegramBotAPI/tree/master/examples https://github.com/eternnoir/pyTelegramBotAPI/tree/master/examples
.. note::
Install coloredlogs module to specify colorful_logs=True
:param token: Token of a bot, obtained from @BotFather :param token: Token of a bot, obtained from @BotFather
:type token: :obj:`str` :type token: :obj:`str`
@ -248,6 +252,10 @@ class AsyncTeleBot:
Set non_stop=True if you want your bot to continue receiving updates Set non_stop=True if you want your bot to continue receiving updates
if there is an error. if there is an error.
.. note::
Install watchdog and psutil before using restart_on_change option.
:param non_stop: Do not stop polling when an ApiException occurs. :param non_stop: Do not stop polling when an ApiException occurs.
:type non_stop: :obj:`bool` :type non_stop: :obj:`bool`
@ -276,7 +284,7 @@ class AsyncTeleBot:
:param none_stop: Deprecated, use non_stop. Old typo, kept for backward compatibility. :param none_stop: Deprecated, use non_stop. Old typo, kept for backward compatibility.
:type none_stop: :obj:`bool` :type none_stop: :obj:`bool`
:param restart_on_change: Restart a file on file(s) change. Defaults to False :param restart_on_change: Restart a file on file(s) change. Defaults to False.
:type restart_on_change: :obj:`bool` :type restart_on_change: :obj:`bool`
:param path_to_watch: Path to watch for changes. Defaults to current directory :param path_to_watch: Path to watch for changes. Defaults to current directory
@ -302,6 +310,9 @@ class AsyncTeleBot:
""" """
Wrap polling with infinite loop and exception handling to avoid bot stops polling. Wrap polling with infinite loop and exception handling to avoid bot stops polling.
.. note::
Install watchdog and psutil before using restart_on_change option.
:param timeout: Timeout in seconds for get_updates(Defaults to None) :param timeout: Timeout in seconds for get_updates(Defaults to None)
:type timeout: :obj:`int` :type timeout: :obj:`int`