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 2025-03-29 01:37:28 +01:00
Code Issues Projects Releases Packages Wiki Activity

update update_queue and job_queue docstrings on all handlers

Browse source
This commit is contained in:
Jannes Höke 2016-05-28 16:04:19 +02:00
parent 783f9c375c
commit d40f0a8309
10 changed files with 80 additions and 60 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
telegram/ext/callbackqueryhandler.py
View file

@ -31,12 +31,14 @@ class CallbackQueryHandler(Handler):
callback (function): A function that takes ``bot, update`` as callback (function): A function that takes ``bot, update`` as
positional arguments. It will be called when the ``check_update`` positional arguments. It will be called when the ``check_update``
has determined that an update should be processed by this handler. has determined that an update should be processed by this handler.
pass_update_queue (optional[bool]): If the handler should be passed the pass_update_queue (optional[bool]): If set to ``True``, a keyword argument called
update queue as a keyword argument called ``update_queue``. It can ``update_queue`` will be passed to the callback function. It will be the ``Queue``
be used to insert updates. Default is ``False`` instance used by the ``Updater`` and ``Dispatcher`` that contains new updates which can
pass_job_queue (optional[bool]): If the callback should be passed the job queue as a be used to insert updates. Default is ``False``.
keyword argument called ``job_queue``. It can be used to schedule new jobs. pass_job_queue (optional[bool]): If set to ``True``, a keyword argument called
Default is ``False`` ``job_queue`` will be passed to the callback function. It will be a ``JobQueue``
instance created by the ``Updater`` which can be used to schedule new jobs.
Default is ``False``.
""" """
def __init__(self, callback, pass_update_queue=False, pass_job_queue=False): def __init__(self, callback, pass_update_queue=False, pass_job_queue=False):

14
telegram/ext/choseninlineresulthandler.py
View file

@ -32,12 +32,14 @@ class ChosenInlineResultHandler(Handler):
callback (function): A function that takes ``bot, update`` as callback (function): A function that takes ``bot, update`` as
positional arguments. It will be called when the ``check_update`` positional arguments. It will be called when the ``check_update``
has determined that an update should be processed by this handler. has determined that an update should be processed by this handler.
pass_update_queue (optional[bool]): If the handler should be passed the pass_update_queue (optional[bool]): If set to ``True``, a keyword argument called
update queue as a keyword argument called ``update_queue``. It can ``update_queue`` will be passed to the callback function. It will be the ``Queue``
be used to insert updates. Default is ``False`` instance used by the ``Updater`` and ``Dispatcher`` that contains new updates which can
pass_job_queue (optional[bool]): If the callback should be passed the job queue as a be used to insert updates. Default is ``False``.
keyword argument called ``job_queue``. It can be used to schedule new jobs. pass_job_queue (optional[bool]): If set to ``True``, a keyword argument called
Default is ``False`` ``job_queue`` will be passed to the callback function. It will be a ``JobQueue``
instance created by the ``Updater`` which can be used to schedule new jobs.
Default is ``False``.
""" """
def __init__(self, callback, pass_update_queue=False, pass_job_queue=False): def __init__(self, callback, pass_update_queue=False, pass_job_queue=False):

14
telegram/ext/commandhandler.py
View file

@ -38,12 +38,14 @@ class CommandHandler(Handler):
arguments passed to the command as a keyword argument called ` arguments passed to the command as a keyword argument called `
``args``. It will contain a list of strings, which is the text ``args``. It will contain a list of strings, which is the text
following the command split on spaces. Default is ``False`` following the command split on spaces. Default is ``False``
pass_update_queue (optional[bool]): If the handler should be passed the pass_update_queue (optional[bool]): If set to ``True``, a keyword argument called
update queue as a keyword argument called ``update_queue``. It can ``update_queue`` will be passed to the callback function. It will be the ``Queue``
be used to insert updates. Default is ``False`` instance used by the ``Updater`` and ``Dispatcher`` that contains new updates which can
pass_job_queue (optional[bool]): If the callback should be passed the job queue as a be used to insert updates. Default is ``False``.
keyword argument called ``job_queue``. It can be used to schedule new jobs. pass_job_queue (optional[bool]): If set to ``True``, a keyword argument called
Default is ``False`` ``job_queue`` will be passed to the callback function. It will be a ``JobQueue``
instance created by the ``Updater`` which can be used to schedule new jobs.
Default is ``False``.
""" """
def __init__(self, def __init__(self,

14
telegram/ext/handler.py
View file

@ -31,12 +31,14 @@ class Handler(object):
callback (function): A function that takes ``bot, update`` as callback (function): A function that takes ``bot, update`` as
positional arguments. It will be called when the ``check_update`` positional arguments. It will be called when the ``check_update``
has determined that an update should be processed by this handler. has determined that an update should be processed by this handler.
pass_update_queue (optional[bool]): If the callback should be passed pass_update_queue (optional[bool]): If set to ``True``, a keyword argument called
the update queue as a keyword argument called ``update_queue``. It ``update_queue`` will be passed to the callback function. It will be the ``Queue``
can be used to insert updates. Default is ``False`` instance used by the ``Updater`` and ``Dispatcher`` that contains new updates which can
pass_job_queue (optional[bool]): If the callback should be passed the job queue as a be used to insert updates. Default is ``False``.
keyword argument called ``job_queue``. It can be used to schedule new jobs. pass_job_queue (optional[bool]): If set to ``True``, a keyword argument called
Default is ``False`` ``job_queue`` will be passed to the callback function. It will be a ``JobQueue``
instance created by the ``Updater`` which can be used to schedule new jobs.
Default is ``False``.
""" """
def __init__(self, callback, pass_update_queue=False, pass_job_queue=False): def __init__(self, callback, pass_update_queue=False, pass_job_queue=False):

14
telegram/ext/inlinequeryhandler.py
View file

@ -31,12 +31,14 @@ class InlineQueryHandler(Handler):
callback (function): A function that takes ``bot, update`` as callback (function): A function that takes ``bot, update`` as
positional arguments. It will be called when the ``check_update`` positional arguments. It will be called when the ``check_update``
has determined that an update should be processed by this handler. has determined that an update should be processed by this handler.
pass_update_queue (optional[bool]): If the handler should be passed the pass_update_queue (optional[bool]): If set to ``True``, a keyword argument called
update queue as a keyword argument called ``update_queue``. It can ``update_queue`` will be passed to the callback function. It will be the ``Queue``
be used to insert updates. Default is ``False`` instance used by the ``Updater`` and ``Dispatcher`` that contains new updates which can
pass_job_queue (optional[bool]): If the callback should be passed the job queue as a be used to insert updates. Default is ``False``.
keyword argument called ``job_queue``. It can be used to schedule new jobs. pass_job_queue (optional[bool]): If set to ``True``, a keyword argument called
Default is ``False`` ``job_queue`` will be passed to the callback function. It will be a ``JobQueue``
instance created by the ``Updater`` which can be used to schedule new jobs.
Default is ``False``.
""" """
def __init__(self, callback, pass_update_queue=False, pass_job_queue=False): def __init__(self, callback, pass_update_queue=False, pass_job_queue=False):

14
telegram/ext/messagehandler.py
View file

@ -99,12 +99,14 @@ class MessageHandler(Handler):
callback (function): A function that takes ``bot, update`` as callback (function): A function that takes ``bot, update`` as
positional arguments. It will be called when the ``check_update`` positional arguments. It will be called when the ``check_update``
has determined that an update should be processed by this handler. has determined that an update should be processed by this handler.
pass_update_queue (optional[bool]): If the handler should be passed the pass_update_queue (optional[bool]): If set to ``True``, a keyword argument called
update queue as a keyword argument called ``update_queue``. It can ``update_queue`` will be passed to the callback function. It will be the ``Queue``
be used to insert updates. Default is ``False`` instance used by the ``Updater`` and ``Dispatcher`` that contains new updates which can
pass_job_queue (optional[bool]): If the callback should be passed the job queue as a be used to insert updates. Default is ``False``.
keyword argument called ``job_queue``. It can be used to schedule new jobs. pass_job_queue (optional[bool]): If set to ``True``, a keyword argument called
Default is ``False`` ``job_queue`` will be passed to the callback function. It will be a ``JobQueue``
instance created by the ``Updater`` which can be used to schedule new jobs.
Default is ``False``.
""" """
def __init__(self, filters, callback, pass_update_queue=False, pass_job_queue=False): def __init__(self, filters, callback, pass_update_queue=False, pass_job_queue=False):

14
telegram/ext/regexhandler.py
View file

@ -45,12 +45,14 @@ class RegexHandler(Handler):
pass_groupdict (optional[bool]): If the callback should be passed the pass_groupdict (optional[bool]): If the callback should be passed the
result of ``re.match(pattern, text).groupdict()`` as a keyword result of ``re.match(pattern, text).groupdict()`` as a keyword
argument called ``groupdict``. Default is ``False`` argument called ``groupdict``. Default is ``False``
pass_update_queue (optional[bool]): If the handler should be passed the pass_update_queue (optional[bool]): If set to ``True``, a keyword argument called
update queue as a keyword argument called ``update_queue``. It can ``update_queue`` will be passed to the callback function. It will be the ``Queue``
be used to insert updates. Default is ``False`` instance used by the ``Updater`` and ``Dispatcher`` that contains new updates which can
pass_job_queue (optional[bool]): If the callback should be passed the job queue as a be used to insert updates. Default is ``False``.
keyword argument called ``job_queue``. It can be used to schedule new jobs. pass_job_queue (optional[bool]): If set to ``True``, a keyword argument called
Default is ``False`` ``job_queue`` will be passed to the callback function. It will be a ``JobQueue``
instance created by the ``Updater`` which can be used to schedule new jobs.
Default is ``False``.
""" """
def __init__(self, def __init__(self,

14
telegram/ext/stringcommandhandler.py
View file

@ -36,12 +36,14 @@ class StringCommandHandler(Handler):
arguments passed to the command as a keyword argument called ` arguments passed to the command as a keyword argument called `
``args``. It will contain a list of strings, which is the text ``args``. It will contain a list of strings, which is the text
following the command split on spaces. Default is ``False`` following the command split on spaces. Default is ``False``
pass_update_queue (optional[bool]): If the handler should be passed the pass_update_queue (optional[bool]): If set to ``True``, a keyword argument called
update queue as a keyword argument called ``update_queue``. It can ``update_queue`` will be passed to the callback function. It will be the ``Queue``
be used to insert updates. Default is ``False`` instance used by the ``Updater`` and ``Dispatcher`` that contains new updates which can
pass_job_queue (optional[bool]): If the callback should be passed the job queue as a be used to insert updates. Default is ``False``.
keyword argument called ``job_queue``. It can be used to schedule new jobs. pass_job_queue (optional[bool]): If set to ``True``, a keyword argument called
Default is ``False`` ``job_queue`` will be passed to the callback function. It will be a ``JobQueue``
instance created by the ``Updater`` which can be used to schedule new jobs.
Default is ``False``.
""" """
def __init__(self, def __init__(self,

14
telegram/ext/stringregexhandler.py
View file

@ -44,12 +44,14 @@ class StringRegexHandler(Handler):
pass_groupdict (optional[bool]): If the callback should be passed the pass_groupdict (optional[bool]): If the callback should be passed the
result of ``re.match(pattern, update).groupdict()`` as a keyword result of ``re.match(pattern, update).groupdict()`` as a keyword
argument called ``groupdict``. Default is ``False`` argument called ``groupdict``. Default is ``False``
pass_update_queue (optional[bool]): If the handler should be passed the pass_update_queue (optional[bool]): If set to ``True``, a keyword argument called
update queue as a keyword argument called ``update_queue``. It can ``update_queue`` will be passed to the callback function. It will be the ``Queue``
be used to insert updates. Default is ``False`` instance used by the ``Updater`` and ``Dispatcher`` that contains new updates which can
pass_job_queue (optional[bool]): If the callback should be passed the job queue as a be used to insert updates. Default is ``False``.
keyword argument called ``job_queue``. It can be used to schedule new jobs. pass_job_queue (optional[bool]): If set to ``True``, a keyword argument called
Default is ``False`` ``job_queue`` will be passed to the callback function. It will be a ``JobQueue``
instance created by the ``Updater`` which can be used to schedule new jobs.
Default is ``False``.
""" """
def __init__(self, def __init__(self,

14
telegram/ext/typehandler.py
View file

@ -34,12 +34,14 @@ class TypeHandler(Handler):
has determined that an update should be processed by this handler. has determined that an update should be processed by this handler.
strict (optional[bool]): Use ``type`` instead of ``isinstance``. strict (optional[bool]): Use ``type`` instead of ``isinstance``.
Default is ``False`` Default is ``False``
pass_update_queue (optional[bool]): If the handler should be passed the pass_update_queue (optional[bool]): If set to ``True``, a keyword argument called
update queue as a keyword argument called ``update_queue``. It can ``update_queue`` will be passed to the callback function. It will be the ``Queue``
be used to insert updates. Default is ``False`` instance used by the ``Updater`` and ``Dispatcher`` that contains new updates which can
pass_job_queue (optional[bool]): If the callback should be passed the job queue as a be used to insert updates. Default is ``False``.
keyword argument called ``job_queue``. It can be used to schedule new jobs. pass_job_queue (optional[bool]): If set to ``True``, a keyword argument called
Default is ``False`` ``job_queue`` will be passed to the callback function. It will be a ``JobQueue``
instance created by the ``Updater`` which can be used to schedule new jobs.
Default is ``False``.
""" """
def __init__(self, def __init__(self,