python通用时间调度器sched

转自http://www.h3blog.com/article/python-sched/

sched模块是python中实现了一个通用事件调度器，在调度器类使用一个延迟函数等待特定的时间，执行任务。同时支持多线程应用程序，在每个任务执行后会立刻调用延时函数，以确保其他线程也能执行。

延迟运行事件

在一个延迟或规定时间之后执行事件，需要采用enter()方法，包含4个参数：

• 间隔时间(具体值决定与delayfunc, 这里为秒)
• 优先级(两个事件在同一时间到达的情况)
• 调用的函数
• 函数参数

import sched
import time

#生成调度器
scheduler = sched.scheduler(time.time, time.sleep)

def print_event(name):
    print ('EVENT:', time.time(), name)

print ('START:', time.time())

#分别设置在执行后2秒、3秒之后执行调用函数
scheduler.enter(2, 1, print_event, ('first',))
scheduler.enter(3, 1, print_event, ('second',))

#运行调度器
scheduler.run()

输出结果：

START: 1629355678.1981857
EVENT: 1629355680.199333 first
EVENT: 1629355681.2013113 second

重叠事件

调用run()块执行所有的事件。每个事件都在同一线程中运行，所以如果一个事件需要更长的时间，延迟事件将会有重叠。为了不丢失事件，延迟事件将会在之前事件运行完再被执行，但一些延迟事件可能会晚于原本计划的事件。

import sched
import time

scheduler = sched.scheduler(time.time, time.sleep)

def long_event(name):
    print('BEGIN EVENT :', time.time(), name)
    time.sleep(2)
    print('FINISH EVENT:', time.time(), name)

print('START:', time.time())
scheduler.enter(2, 1, long_event, ('first',))

#事件无法在设想的3秒后执行，将会顺延执行
scheduler.enter(3, 1, long_event, ('second',))

scheduler.run()

输出结果：

START: 1629355992.4173386
BEGIN EVENT : 1629355994.4278436 first
FINISH EVENT: 1629355996.4414725 first
BEGIN EVENT : 1629355996.4414725 second
FINISH EVENT: 1629355998.4542542 second

事件优先级

如果多个事件是同一时间执行，通过设置他们的优先级值，用于确定顺序运行

import sched
import time

scheduler = sched.scheduler(time.time, time.sleep)

def print_event(name):
    print('EVENT:', time.time(), name)

now = time.time()
print('START:', now)
scheduler.enterabs(now+2, 2, print_event, ('first',))
scheduler.enterabs(now+2, 1, print_event, ('second',))

scheduler.run()

输出结果:

START: 1629356104.2926526
EVENT: 1629356106.303349 second
EVENT: 1629356106.303349 first

取消事件

利用enter()和enterabs()返回一个引用事件用来取消它。

import sched
import threading
import time

scheduler = sched.scheduler(time.time, time.sleep)

#建立一个全局 线程计数器
counter = 0

def increment_counter(name):
    global counter
    print('EVENT:', time.time(), name)
    counter += 1
    print('NOW:', counter)

print('START:', time.time())
e1 = scheduler.enter(2, 1, increment_counter, ('E1',))
e2 = scheduler.enter(3, 1, increment_counter, ('E2',))

# 开始一个线程执行事件
t = threading.Thread(target=scheduler.run)
t.start()

# 在主线程,取消第一个预定事件
scheduler.cancel(e1)

# 等待线程调度程序完成运行
t.join()

输出结果：

START: 1629356345.1720746
EVENT: 1629356348.1875248 E2
NOW: 1

除了上面介绍的scheduler方法，还有一些其他方法：

#判断队列是否为空
scheduler.empty()
# 只读属性，返回一个即将到达的事件列表(按到达事件排序)，每个事件都是有 time 、 priority 、 action 、 argument 组成的 namedtuple 。
scheduler.queue