APScheduler API -- apscheduler.schedulers.base

apscheduler.schedulers.base

API

class apscheduler.schedulers.base.BaseScheduler(gconfig={}, **options)

Abstract base class for all schedulers. Takes the following keyword arguments:

Parameters:
  • logger (str|logging.Logger) – logger to use for the scheduler’s logging (defaults to apscheduler.scheduler)
  • timezone (str|datetime.tzinfo) – the default time zone (defaults to the local timezone)
  • job_defaults (dict) – default values for newly added jobs
  • jobstores (dict) – a dictionary of job store alias -> job store instance or configuration dict
  • executors (dict) – a dictionary of executor alias -> executor instance or configuration dict

See also

Configuring the scheduler

add_executor(executor, alias=‘default‘, **executor_opts)

Adds an executor to this scheduler. Any extra keyword arguments will be passed to the executor plugin’s constructor, assuming that the first argument is the name of an executor plugin.

Parameters:
  • executor (str|unicode|apscheduler.executors.base.BaseExecutor) – either an executor instance or the name of an executor plugin
  • alias (str|unicode) – alias for the scheduler
Raises ValueError:
 
if there is already an executor by the given alias

add_job(func, trigger=None, args=None, kwargs=None, id=None, name=None, misfire_grace_time=undefined, coalesce=undefined, max_instances=undefined, next_run_time=undefined, jobstore=‘default‘, executor=‘default‘, replace_existing=False, **trigger_args)

Adds the given job to the job list and wakes up the scheduler if it’s already running.

Any option that defaults to undefined will be replaced with the corresponding default value when the job is scheduled (which happens when the scheduler is started, or immediately if the scheduler is already running).

The func argument can be given either as a callable object or a textual reference in the package.module:some.object format, where the first half (separated by :) is an importable module and the second half is a reference to the callable object, relative to the module.

The trigger argument can either be:
  1. the alias name of the trigger (e.g. date, interval or cron), in which case any extra keyword arguments to this method are passed on to the trigger’s constructor
  2. an instance of a trigger class
Parameters:
  • func – callable (or a textual reference to one) to run at the given time
  • trigger (str|apscheduler.triggers.base.BaseTrigger) – trigger that determines when func is called
  • args (list|tuple) – list of positional arguments to call func with
  • kwargs (dict) – dict of keyword arguments to call func with
  • id (str|unicode) – explicit identifier for the job (for modifying it later)
  • name (str|unicode) – textual description of the job
  • misfire_grace_time (int) – seconds after the designated run time that the job is still allowed to be run
  • coalesce (bool) – run once instead of many times if the scheduler determines that the job should be run more than once in succession
  • max_instances (int) – maximum number of concurrently running instances allowed for this job
  • next_run_time (datetime) – when to first run the job, regardless of the trigger (pass None to add the job as paused)
  • jobstore (str|unicode) – alias of the job store to store the job in
  • executor (str|unicode) – alias of the executor to run the job with
  • replace_existing (bool) – True to replace an existing job with the same id (but retain the number of runs from the existing one)
Return type:
Job

add_jobstore(jobstore, alias=‘default‘, **jobstore_opts)

Adds a job store to this scheduler. Any extra keyword arguments will be passed to the job store plugin’s constructor, assuming that the first argument is the name of a job store plugin.

Parameters:
  • jobstore (str|unicode|apscheduler.jobstores.base.BaseJobStore) – job store to be added
  • alias (str|unicode) – alias for the job store
Raises ValueError:
 
if there is already a job store by the given alias

add_listener(callback, mask=EVENT_ALL)

Adds a listener for scheduler events. When a matching event occurs, callback is executed with the event object as its sole argument. If the mask parameter is not provided, the callback will receive events of all types.

Parameters:
  • callback – any callable that takes one argument
  • mask (int) – bitmask that indicates which events should be listened to

See also

apscheduler.events

See also

Scheduler events

configure(gconfig={}, prefix=‘apscheduler.‘, **options)

Reconfigures the scheduler with the given options. Can only be done when the scheduler isn’t running.

Parameters:
  • gconfig (dict) – a “global” configuration dictionary whose values can be overridden by keyword arguments to this method
  • prefix (str|unicode) – pick only those keys from gconfig that are prefixed with this string (pass an empty string or None to use all keys)
Raises SchedulerAlreadyRunningError:
 
if the scheduler is already running

get_job(job_id, jobstore=None)

Returns the Job that matches the given job_id.

Parameters:
  • job_id (str|unicode) – the identifier of the job
  • jobstore (str|unicode) – alias of the job store that most likely contains the job
Returns:
the Job by the given ID, or None if it wasn’t found

Return type:
Job

get_jobs(jobstore=None, pending=None)

Returns a list of pending jobs (if the scheduler hasn’t been started yet) and scheduled jobs, either from a specific job store or from all of them.

Parameters:
  • jobstore (str|unicode) – alias of the job store
  • pending (bool) – False to leave out pending jobs (jobs that are waiting for the scheduler start to be added to their respective job stores), True to only include pending jobs, anything else to return both
Return type:
list[Job]

modify_job(job_id, jobstore=None, **changes)

Modifies the properties of a single job. Modifications are passed to this method as extra keyword arguments.

Parameters:
  • job_id (str|unicode) – the identifier of the job
  • jobstore (str|unicode) – alias of the job store that contains the job
pause_job(job_id, jobstore=None)

Causes the given job not to be executed until it is explicitly resumed.

Parameters:
  • job_id (str|unicode) – the identifier of the job
  • jobstore (str|unicode) – alias of the job store that contains the job
print_jobs(jobstore=None, out=sys.stdout)

Prints out a textual listing of all jobs currently scheduled on either all job stores or just a specific one.

Parameters:
  • jobstore (str|unicode) – alias of the job store, None to list jobs from all stores
  • out (file) – a file-like object to print to (defaults to sys.stdout if nothing is given)
remove_all_jobs(jobstore=None)

Removes all jobs from the specified job store, or all job stores if none is given.

Parameters: jobstore (str|unicode) – alias of the job store
remove_executor(alias, shutdown=True)

Removes the executor by the given alias from this scheduler.

Parameters:
  • alias (str|unicode) – alias of the executor
  • shutdown (bool) – True to shut down the executor after removing it
remove_job(job_id, jobstore=None)

Removes a job, preventing it from being run any more.

Parameters:
  • job_id (str|unicode) – the identifier of the job
  • jobstore (str|unicode) – alias of the job store that contains the job
Raises JobLookupError:
 
if the job was not found

remove_jobstore(alias, shutdown=True)

Removes the job store by the given alias from this scheduler.

Parameters:
  • alias (str|unicode) – alias of the job store
  • shutdown (bool) – True to shut down the job store after removing it
remove_listener(callback)

Removes a previously added event listener.

reschedule_job(job_id, jobstore=None, trigger=None, **trigger_args)

Constructs a new trigger for a job and updates its next run time. Extra keyword arguments are passed directly to the trigger’s constructor.

Parameters:
  • job_id (str|unicode) – the identifier of the job
  • jobstore (str|unicode) – alias of the job store that contains the job
  • trigger – alias of the trigger type or a trigger instance
resume_job(job_id, jobstore=None)

Resumes the schedule of the given job, or removes the job if its schedule is finished.

Parameters:
  • job_id (str|unicode) – the identifier of the job
  • jobstore (str|unicode) – alias of the job store that contains the job
scheduled_job(trigger, args=None, kwargs=None, id=None, name=None, misfire_grace_time=undefined, coalesce=undefined, max_instances=undefined, next_run_time=undefined, jobstore=‘default‘, executor=‘default‘, **trigger_args)

A decorator version of add_job(), except that replace_existing is always True.

Important

The id argument must be given if scheduling a job in a persistent job store. The scheduler cannot, however, enforce this requirement.

shutdown(wait=True)

Shuts down the scheduler. Does not interrupt any currently running jobs.

Parameters: wait (bool) – True to wait until all currently executing jobs have finished
Raises SchedulerNotRunningError:
  if the scheduler has not been started yet
start()

Starts the scheduler. The details of this process depend on the implementation.

Raises SchedulerAlreadyRunningError:
  if the scheduler is already running
wakeup()

Notifies the scheduler that there may be jobs due for execution. Triggers _process_jobs() to be run in an implementation specific manner.

时间: 2024-10-07 19:35:51

APScheduler API -- apscheduler.schedulers.base的相关文章

APScheduler API -- apscheduler.triggers.interval

apscheduler.triggers.interval API Trigger alias for add_job(): interval class apscheduler.triggers.interval.IntervalTrigger(weeks=0, days=0, hours=0, minutes=0, seconds=0, start_date=None, end_date=None, timezone=None) Bases: apscheduler.triggers.bas

APScheduler API -- apscheduler.triggers.date

apscheduler.triggers.date API Trigger alias for add_job(): date class apscheduler.triggers.date.DateTrigger(run_date=None, timezone=None) Bases: apscheduler.triggers.base.BaseTrigger Triggers once on the given datetime. If run_date is left empty, cur

APScheduler API

apscheduler.triggers.cron API Trigger alias for add_job(): cron class apscheduler.triggers.cron.CronTrigger(year=None, month=None, day=None, week=None, day_of_week=None, hour=None, minute=None, second=None, start_date=None, end_date=None, timezone=No

Python任务调度模块APScheduler

目录 一.APScheduler 是什么&APScheduler四种组成部分? 1.调度器(scheduler) 2.作业存储(job store) 3.执行器(executor) 4.触发器(triggers) 4.1.date 定时调度(作业只会执行一次) 4.2.interval: 每隔一段时间执行一次 4.3.cron: 使用同linux下crontab的方式 二. How:APSched 怎么用? 安装 快速上手 任务操作 1.添加任务 2.删除任务 3.暂停&继续任务 4.修改

Python下APScheduler的简单使用

今天准备实现一个功能需要用到定时执行任务,所以就看到了Python的一个定时任务框架APScheduler,试了一下感觉还不错. 1.APScheduler简介: APScheduler是Python的一个定时任务框架,可以很方便的满足用户定时执行或者周期执行任务的需求,它提供了基于日期date.固定时间间隔interval .以及类似于Linux上的定时任务crontab类型的定时任务.并且该框架不仅可以添加.删除定时任务,还可以将任务存储到数据库中,实现任务的持久化,所以使用起来非常方便.

APScheduler: LookupError: No trigger by the name "interval" was found

APScheduler: LookupError: No trigger by the name "interval" was found 环境 python: 2.6.6 PyInstaller: 2.1 APScheduler: 开始是3.0.1,后来是3.0.5 问题一 问题描述 以前在别的机器上开发的python程序(python2.7),在新的机器上运行时报错 LookupError: No trigger by the name "interval" w

Python任务调度模块 – APScheduler

APScheduler是一个Python定时任务框架,使用起来十分方便.提供了基于日期.固定时间间隔以及crontab类型的任务,并且可以持久化任务.并以daemon方式运行应用.目前最新版本为3.0.x. 在APScheduler中有四个组件: 触发器(trigger)包含调度逻辑,每一个作业有它自己的触发器,用于决定接下来哪一个作业会运行.除了他们自己初始配置意外,触发器完全是无状态的. 作业存储(job store)存储被调度的作业,默认的作业存储是简单地把作业保存在内存中,其他的作业存储

Python任务调度模块 – APScheduler(摘抄)

Python任务调度模块 – APScheduler 2015年6月11日 by debugo · 32 Comments APScheduler是一个Python定时任务框架,使用起来十分方便.提供了基于日期.固定时间间隔以及crontab类型的任务,并且可以持久化任务.并以daemon方式运行应用.目前最新版本为3.0.x.在APScheduler中有四个组件:触发器(trigger)包含调度逻辑,每一个作业有它自己的触发器,用于决定接下来哪一个作业会运行.除了他们自己初始配置意外,触发器完

python3使用pyinstaller打包apscheduler出的错

本来只是想用Python做一个定时任务小工具在服务器上运行,可是服务器在隔离区,各种禁止上外网,使用pip导出列表那种下载库的方法不管用,导致Python的各种库都下不到,官网离线下载又各种缺依赖,好气啊.后来查了一下,原来还有pyinstaller这种好东西,将需要的库和程序打包成一个可运行的程序,这正是我需要的. 为了测试pyinstaller,主要遇到了两个错误,一个是pkg_resources.DistributionNotFound,一个是ImportError: No module