telegram.ext.JobQueue¶

class telegram.ext.JobQueue(bot=None)¶

Bases: object

This class allows you to periodically perform tasks with the bot.

_queue¶

The queue that holds the Jobs.

Type:	`PriorityQueue`

bot¶

The bot instance that should be passed to the jobs. DEPRECATED: Use set_dispatcher instead.

Type:	`telegram.Bot`

get_jobs_by_name(name)¶: Returns a tuple of jobs with the given name that are currently in the JobQueue

jobs()¶: Returns a tuple of all jobs that are currently in the JobQueue.

run_daily(callback, time, days=(0, 1, 2, 3, 4, 5, 6), context=None, name=None)¶

Creates a new Job that runs on a daily basis and adds it to the queue.

Parameters:	callback (`callable`) – The callback function that should be executed by the new job. Callback signature for context based API: `def callback(CallbackContext)` `context.job` is the `telegram.ext.Job` instance. It can be used to access its `job.context` or change it to a repeating job. time (`datetime.time`) – Time of day at which the job should run. If the timezone (`time.tzinfo`) is `None`, UTC will be assumed. days (Tuple[`int`], optional) – Defines on which days of the week the job should run. Defaults to `EVERY_DAY` context (`object`, optional) – Additional data needed for the callback function. Can be accessed through `job.context` in the callback. Defaults to `None`. name (`str`, optional) – The name of the new job. Defaults to `callback.__name__`.
Returns:	The new `Job` instance that has been added to the job queue.
Return type:	`telegram.ext.Job`

Notes

Daily is just an alias for “24 Hours”. That means that if DST changes during that interval, the job might not run at the time one would expect. It is always recommended to pin servers to UTC time, then time related behaviour can always be expected.

run_once(callback, when, context=None, name=None)¶

Creates a new Job that runs once and adds it to the queue.

Parameters:	callback (`callable`) – The callback function that should be executed by the new job. Callback signature for context based API: `def callback(CallbackContext)` `context.job` is the `telegram.ext.Job` instance. It can be used to access its `job.context` or change it to a repeating job. when (`int` \| `float` \| `datetime.timedelta` \| `datetime.datetime` \| `datetime.time`) – Time in or at which the job should run. This parameter will be interpreted depending on its type. `int` or `float` will be interpreted as “seconds from now” in which the job should run. `datetime.timedelta` will be interpreted as “time from now” in which the job should run. `datetime.datetime` will be interpreted as a specific date and time at which the job should run. `datetime.time` will be interpreted as a specific time of day at which the job should run. This could be either today or, if the time has already passed, tomorrow. context (`object`, optional) – Additional data needed for the callback function. Can be accessed through `job.context` in the callback. Defaults to `None`. name (`str`, optional) – The name of the new job. Defaults to `callback.__name__`.
Returns:	The new `Job` instance that has been added to the job queue.
Return type:	`telegram.ext.Job`

run_repeating(callback, interval, first=None, context=None, name=None)¶

Creates a new Job that runs at specified intervals and adds it to the queue.

Parameters:	callback (`callable`) – The callback function that should be executed by the new job. Callback signature for context based API: `def callback(CallbackContext)` `context.job` is the `telegram.ext.Job` instance. It can be used to access its `job.context` or change it to a repeating job. interval (`int` \| `float` \| `datetime.timedelta`) – The interval in which the job will run. If it is an `int` or a `float`, it will be interpreted as seconds. first (`int` \| `float` \| `datetime.timedelta` \| `datetime.datetime` \| `datetime.time`, optional) – Time in or at which the job should run. This parameter will be interpreted depending on its type. `int` or `float` will be interpreted as “seconds from now” in which the job should run. `datetime.timedelta` will be interpreted as “time from now” in which the job should run. `datetime.datetime` will be interpreted as a specific date and time at which the job should run. `datetime.time` will be interpreted as a specific time of day at which the job should run. This could be either today or, if the time has already passed, tomorrow. Defaults to `interval` context (`object`, optional) – Additional data needed for the callback function. Can be accessed through `job.context` in the callback. Defaults to `None`. name (`str`, optional) – The name of the new job. Defaults to `callback.__name__`.
Returns:	The new `Job` instance that has been added to the job queue.
Return type:	`telegram.ext.Job`

Notes

interval is always respected “as-is”. That means that if DST changes during that interval, the job might not run at the time one would expect. It is always recommended to pin servers to UTC time, then time related behaviour can always be expected.

set_dispatcher(dispatcher)¶

Set the dispatcher to be used by this JobQueue. Use this instead of passing a telegram.Bot to the JobQueue, which is deprecated.

Parameters:	dispatcher (`telegram.ext.Dispatcher`) – The dispatcher.

start()¶: Starts the job_queue thread.

stop()¶: Stops the thread.

tick()¶: Run all jobs that are due and re-enqueue them with their interval.