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-31 16:40:53 +01:00
Code Issues Projects Releases Packages Wiki Activity

Deprecate MessageQueue (#2393)

Browse source
This commit is contained in:
Bibo-Joshi 2021-02-19 17:29:50 +01:00 committed by GitHub
parent a34f0b9bee
commit c77ef7eef3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 22 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
telegram/ext/messagequeue.py
View file

@ -24,9 +24,11 @@ import functools
import queue as q import queue as q
import threading import threading
import time import time
import warnings
from typing import TYPE_CHECKING, Callable, List, NoReturn from typing import TYPE_CHECKING, Callable, List, NoReturn
from telegram.ext.utils.promise import Promise from telegram.ext.utils.promise import Promise
from telegram.utils.deprecate import TelegramDeprecationWarning
if TYPE_CHECKING: if TYPE_CHECKING:
from telegram import Bot from telegram import Bot
@ -44,6 +46,10 @@ class DelayQueue(threading.Thread):
Processes callbacks from queue with specified throughput limits. Creates a separate thread to Processes callbacks from queue with specified throughput limits. Creates a separate thread to
process callbacks with delays. process callbacks with delays.
.. deprecated:: 13.3
:class:`telegram.ext.DelayQueue` in its current form is deprecated and will be reinvented
in a future release. See `this thread <https://git.io/JtDbF>`_ for a list of known bugs.
Args: Args:
queue (:obj:`Queue`, optional): Used to pass callbacks to thread. Creates ``Queue`` queue (:obj:`Queue`, optional): Used to pass callbacks to thread. Creates ``Queue``
implicitly if not provided. implicitly if not provided.
@ -82,6 +88,12 @@ class DelayQueue(threading.Thread):
autostart: bool = True, autostart: bool = True,
name: str = None, name: str = None,
): ):
warnings.warn(
'DelayQueue in its current form is deprecated and will be reinvented in a future '
'release. See https://git.io/JtDbF for a list of known bugs.',
category=TelegramDeprecationWarning,
)
self._queue = queue if queue is not None else q.Queue() self._queue = queue if queue is not None else q.Queue()
self.burst_limit = burst_limit self.burst_limit = burst_limit
self.time_limit = time_limit_ms / 1000 self.time_limit = time_limit_ms / 1000
@ -182,6 +194,10 @@ class MessageQueue:
Callables are processed through *group* ``DelayQueue``, then through *all* ``DelayQueue`` for Callables are processed through *group* ``DelayQueue``, then through *all* ``DelayQueue`` for
group-type messages. For non-group messages, only the *all* ``DelayQueue`` is used. group-type messages. For non-group messages, only the *all* ``DelayQueue`` is used.
.. deprecated:: 13.3
:class:`telegram.ext.MessageQueue` in its current form is deprecated and will be reinvented
in a future release. See `this thread <https://git.io/JtDbF>`_ for a list of known bugs.
Args: Args:
all_burst_limit (:obj:`int`, optional): Number of maximum *all-type* callbacks to process all_burst_limit (:obj:`int`, optional): Number of maximum *all-type* callbacks to process
per time-window defined by :attr:`all_time_limit_ms`. Defaults to 30. per time-window defined by :attr:`all_time_limit_ms`. Defaults to 30.
@ -210,6 +226,12 @@ class MessageQueue:
exc_route: Callable[[Exception], None] = None, exc_route: Callable[[Exception], None] = None,
autostart: bool = True, autostart: bool = True,
): ):
warnings.warn(
'MessageQueue in its current form is deprecated and will be reinvented in a future '
'release. See https://git.io/JtDbF for a list of known bugs.',
category=TelegramDeprecationWarning,
)
# create according delay queues, use composition # create according delay queues, use composition
self._all_delayq = DelayQueue( self._all_delayq = DelayQueue(
burst_limit=all_burst_limit, burst_limit=all_burst_limit,