235 lines
7.8 KiB
Python
235 lines
7.8 KiB
Python
# -*- coding: utf-8 -*-
|
|
"""
|
|
sleekxmpp.xmlstream.scheduler
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
This module provides a task scheduler that works better
|
|
with SleekXMPP's threading usage than the stock version.
|
|
|
|
Part of SleekXMPP: The Sleek XMPP Library
|
|
|
|
:copyright: (c) 2011 Nathanael C. Fritz
|
|
:license: MIT, see LICENSE for more details
|
|
"""
|
|
|
|
import time
|
|
import threading
|
|
import logging
|
|
try:
|
|
import queue
|
|
except ImportError:
|
|
import Queue as queue
|
|
|
|
|
|
log = logging.getLogger(__name__)
|
|
|
|
|
|
class Task(object):
|
|
|
|
"""
|
|
A scheduled task that will be executed by the scheduler
|
|
after a given time interval has passed.
|
|
|
|
:param string name: The name of the task.
|
|
:param int seconds: The number of seconds to wait before executing.
|
|
:param callback: The function to execute.
|
|
:param tuple args: The arguments to pass to the callback.
|
|
:param dict kwargs: The keyword arguments to pass to the callback.
|
|
:param bool repeat: Indicates if the task should repeat.
|
|
Defaults to ``False``.
|
|
:param pointer: A pointer to an event queue for queuing callback
|
|
execution instead of executing immediately.
|
|
"""
|
|
|
|
def __init__(self, name, seconds, callback, args=None,
|
|
kwargs=None, repeat=False, qpointer=None):
|
|
#: The name of the task.
|
|
self.name = name
|
|
|
|
#: The number of seconds to wait before executing.
|
|
self.seconds = seconds
|
|
|
|
#: The function to execute once enough time has passed.
|
|
self.callback = callback
|
|
|
|
#: The arguments to pass to :attr:`callback`.
|
|
self.args = args or tuple()
|
|
|
|
#: The keyword arguments to pass to :attr:`callback`.
|
|
self.kwargs = kwargs or {}
|
|
|
|
#: Indicates if the task should repeat after executing,
|
|
#: using the same :attr:`seconds` delay.
|
|
self.repeat = repeat
|
|
|
|
#: The time when the task should execute next.
|
|
self.next = time.time() + self.seconds
|
|
|
|
#: The main event queue, which allows for callbacks to
|
|
#: be queued for execution instead of executing immediately.
|
|
self.qpointer = qpointer
|
|
|
|
def run(self):
|
|
"""Execute the task's callback.
|
|
|
|
If an event queue was supplied, place the callback in the queue;
|
|
otherwise, execute the callback immediately.
|
|
"""
|
|
if self.qpointer is not None:
|
|
self.qpointer.put(('schedule', self.callback,
|
|
self.args, self.name))
|
|
else:
|
|
self.callback(*self.args, **self.kwargs)
|
|
self.reset()
|
|
return self.repeat
|
|
|
|
def reset(self):
|
|
"""Reset the task's timer so that it will repeat."""
|
|
self.next = time.time() + self.seconds
|
|
|
|
|
|
class Scheduler(object):
|
|
|
|
"""
|
|
A threaded scheduler that allows for updates mid-execution unlike the
|
|
scheduler in the standard library.
|
|
|
|
Based on: http://docs.python.org/library/sched.html#module-sched
|
|
|
|
:param parentstop: An :class:`~threading.Event` to signal stopping
|
|
the scheduler.
|
|
"""
|
|
|
|
def __init__(self, parentstop=None):
|
|
#: A queue for storing tasks
|
|
self.addq = queue.Queue()
|
|
|
|
#: A list of tasks in order of execution time.
|
|
self.schedule = []
|
|
|
|
#: If running in threaded mode, this will be the thread processing
|
|
#: the schedule.
|
|
self.thread = None
|
|
|
|
#: A flag indicating that the scheduler is running.
|
|
self.run = False
|
|
|
|
#: An :class:`~threading.Event` instance for signalling to stop
|
|
#: the scheduler.
|
|
self.stop = parentstop
|
|
|
|
#: Lock for accessing the task queue.
|
|
self.schedule_lock = threading.RLock()
|
|
|
|
def process(self, threaded=True, daemon=False):
|
|
"""Begin accepting and processing scheduled tasks.
|
|
|
|
:param bool threaded: Indicates if the scheduler should execute
|
|
in its own thread. Defaults to ``True``.
|
|
"""
|
|
if threaded:
|
|
self.thread = threading.Thread(name='scheduler_process',
|
|
target=self._process)
|
|
self.thread.daemon = daemon
|
|
self.thread.start()
|
|
else:
|
|
self._process()
|
|
|
|
def _process(self):
|
|
"""Process scheduled tasks."""
|
|
self.run = True
|
|
try:
|
|
while self.run and not self.stop.is_set():
|
|
wait = 0.1
|
|
updated = False
|
|
if self.schedule:
|
|
wait = self.schedule[0].next - time.time()
|
|
try:
|
|
if wait <= 0.0:
|
|
newtask = self.addq.get(False)
|
|
else:
|
|
if wait >= 3.0:
|
|
wait = 3.0
|
|
newtask = None
|
|
elapsed = 0
|
|
while not self.stop.is_set() and \
|
|
newtask is None and \
|
|
elapsed < wait:
|
|
newtask = self.addq.get(True, 0.1)
|
|
elapsed += 0.1
|
|
except queue.Empty:
|
|
cleanup = []
|
|
self.schedule_lock.acquire()
|
|
for task in self.schedule:
|
|
if time.time() >= task.next:
|
|
updated = True
|
|
if not task.run():
|
|
cleanup.append(task)
|
|
else:
|
|
break
|
|
for task in cleanup:
|
|
self.schedule.pop(self.schedule.index(task))
|
|
else:
|
|
updated = True
|
|
self.schedule_lock.acquire()
|
|
self.schedule.append(newtask)
|
|
finally:
|
|
if updated:
|
|
self.schedule = sorted(self.schedule,
|
|
key=lambda task: task.next)
|
|
self.schedule_lock.release()
|
|
except KeyboardInterrupt:
|
|
self.run = False
|
|
except SystemExit:
|
|
self.run = False
|
|
log.debug("Quitting Scheduler thread")
|
|
|
|
def add(self, name, seconds, callback, args=None,
|
|
kwargs=None, repeat=False, qpointer=None):
|
|
"""Schedule a new task.
|
|
|
|
:param string name: The name of the task.
|
|
:param int seconds: The number of seconds to wait before executing.
|
|
:param callback: The function to execute.
|
|
:param tuple args: The arguments to pass to the callback.
|
|
:param dict kwargs: The keyword arguments to pass to the callback.
|
|
:param bool repeat: Indicates if the task should repeat.
|
|
Defaults to ``False``.
|
|
:param pointer: A pointer to an event queue for queuing callback
|
|
execution instead of executing immediately.
|
|
"""
|
|
try:
|
|
self.schedule_lock.acquire()
|
|
for task in self.schedule:
|
|
if task.name == name:
|
|
raise ValueError("Key %s already exists" % name)
|
|
|
|
self.addq.put(Task(name, seconds, callback, args,
|
|
kwargs, repeat, qpointer))
|
|
except:
|
|
raise
|
|
finally:
|
|
self.schedule_lock.release()
|
|
|
|
def remove(self, name):
|
|
"""Remove a scheduled task ahead of schedule, and without
|
|
executing it.
|
|
|
|
:param string name: The name of the task to remove.
|
|
"""
|
|
try:
|
|
self.schedule_lock.acquire()
|
|
the_task = None
|
|
for task in self.schedule:
|
|
if task.name == name:
|
|
the_task = task
|
|
if the_task is not None:
|
|
self.schedule.remove(the_task)
|
|
except:
|
|
raise
|
|
finally:
|
|
self.schedule_lock.release()
|
|
|
|
def quit(self):
|
|
"""Shutdown the scheduler."""
|
|
self.run = False
|