Place the persistent task in a task handler
This commit is contained in:
Vincent Le Goff
parent
e0eb490814
commit
37c9d65a9d
3 changed files with 72 additions and 69 deletions
|
|
@ -1,182 +0,0 @@
|
|||
"""
|
||||
Module containing persistent features and the persistent differed
|
||||
tasks, generated by utils.delay(persistent=True).
|
||||
|
||||
"""
|
||||
|
||||
from datetime import datetime, timedelta
|
||||
|
||||
from twisted.internet import reactor, task
|
||||
from evennia.server.models import ServerConfig
|
||||
from evennia.utils.logger import log_trace, log_err
|
||||
from evennia.utils.dbserialize import dbserialize, dbunserialize
|
||||
|
||||
PERSISTENT_TASKS = None
|
||||
|
||||
class PersistentTasks(object):
|
||||
|
||||
"""A light singleton wrapper allowing to access permanent tasks.
|
||||
|
||||
Permament tasks are created by `utils.delay` when the `persistent`
|
||||
keyword argument is set to True. Tasks are saved in ServerConfig.
|
||||
It's easier to access these tasks (should it be necessary) using
|
||||
`evennia.utils.persistent.PERSISTSENT_TASKS`, which contains one
|
||||
instance of this class, and use its `add and `remove` methods.
|
||||
|
||||
"""
|
||||
|
||||
def __init__(self):
|
||||
self.tasks = {}
|
||||
self.to_save = {}
|
||||
|
||||
def load(self):
|
||||
"""Load from the ServerConfig.
|
||||
|
||||
Note:
|
||||
This should be automatically called when Evennia starts.
|
||||
It populates `self.tasks` according to the ServerConfig.
|
||||
|
||||
"""
|
||||
value = ServerConfig.objects.conf("delayed_tasks", default={})
|
||||
if isinstance(value, basestring):
|
||||
tasks = dbunserialize(value)
|
||||
else:
|
||||
tasks = value
|
||||
|
||||
# At this point, `tasks` contains a dictionary of still-serialized tasks
|
||||
for task_id, value in tasks.items():
|
||||
date, callback, args, kwargs = dbunserialize(value)
|
||||
if isinstance(callback, tuple):
|
||||
# `callback` can be an object and name for instance methods
|
||||
obj, method = callback
|
||||
callback = getattr(obj, method)
|
||||
self.tasks[task_id] = (date, callback, args, kwargs)
|
||||
|
||||
def save(self):
|
||||
"""Save the tasks in ServerConfig."""
|
||||
for task_id, (date, callback, args, kwargs) in self.tasks.items():
|
||||
if task_id in self.to_save:
|
||||
continue
|
||||
|
||||
if getattr(callback, "__self__", None):
|
||||
# `callback` is an instance method
|
||||
obj = callback.__self__
|
||||
name = callback.__name__
|
||||
callback = (obj, name)
|
||||
|
||||
# Check if callback can be pickled. args and kwargs have been checked
|
||||
safe_callback = None
|
||||
|
||||
try:
|
||||
dbserialize(callback)
|
||||
except (TypeError, AttributeError):
|
||||
raise ValueError("the specified callback {} cannot be pickled. " \
|
||||
"It must be a top-level function in a module or an " \
|
||||
"instance method.".format(callback))
|
||||
else:
|
||||
safe_callback = callback
|
||||
|
||||
self.to_save[task_id] = dbserialize((date, safe_callback, args, kwargs))
|
||||
ServerConfig.objects.conf("delayed_tasks", self.to_save)
|
||||
|
||||
def add(self, timedelay, callback, *args, **kwargs):
|
||||
"""Add a new persistent task in the configuration.
|
||||
|
||||
Args:
|
||||
timedelay (int or float): time in sedconds before calling the callback.
|
||||
callback (function or instance method): the callback itself
|
||||
any (any): any additional positional arguments to send to the callback
|
||||
|
||||
Kwargs:
|
||||
any (any): additional keyword arguments to send to the callback
|
||||
|
||||
Note:
|
||||
This doesn't create any delay at this time to call the task,
|
||||
but the task is written in ServerConfig along with the
|
||||
others.
|
||||
|
||||
"""
|
||||
now = datetime.now()
|
||||
delta = timedelta(seconds=timedelay)
|
||||
|
||||
# Choose a free task_id
|
||||
safe_args = []
|
||||
safe_kwargs = {}
|
||||
used_ids = self.tasks.keys()
|
||||
task_id = 1
|
||||
while task_id in used_ids:
|
||||
task_id += 1
|
||||
|
||||
# Check that args and kwargs contain picklable information
|
||||
for arg in args:
|
||||
try:
|
||||
dbserialize(arg)
|
||||
except (TypeError, AttributeError):
|
||||
logger.log_err("The positional argument {} cannot be " \
|
||||
"pickled and will not be present in the arguments " \
|
||||
"fed to the callback {}".format(arg, callback))
|
||||
else:
|
||||
safe_args.append(arg)
|
||||
|
||||
for key, value in kwargs.items():
|
||||
try:
|
||||
dbserialize(value)
|
||||
except (TypeError, AttributeError):
|
||||
logger.log_err("The {} keyword argument {} cannot be " \
|
||||
"pickled and will not be present in the arguments " \
|
||||
"fed to the callback {}".format(key, value, callback))
|
||||
else:
|
||||
safe_kwargs[key] = value
|
||||
|
||||
self.tasks[task_id] = (now + delta, callback, safe_args, safe_kwargs)
|
||||
self.save()
|
||||
return task_id
|
||||
|
||||
def remove(self, task_id):
|
||||
"""Remove a task without executing it.
|
||||
|
||||
Args:
|
||||
task_id (int): an existing task ID.
|
||||
|
||||
"""
|
||||
del self.tasks[task_id]
|
||||
if task_id in self.to_save:
|
||||
del self.to_save[task_id]
|
||||
|
||||
self.save()
|
||||
|
||||
def do_task(self, task_id):
|
||||
"""Execute the task (call its callback).
|
||||
|
||||
Args:
|
||||
task_id (int): a valid task ID.
|
||||
|
||||
Note:
|
||||
This will also remove it from the list of current tasks.
|
||||
|
||||
"""
|
||||
date, callback, args, kwargs = self.tasks.pop(task_id)
|
||||
if task_id in self.to_save:
|
||||
del self.to_save[task_id]
|
||||
|
||||
self.save()
|
||||
callback(*args, **kwargs)
|
||||
|
||||
def create_delays(self):
|
||||
"""Create the delayed tasks for the persistent tasks.
|
||||
|
||||
Note:
|
||||
This method should be automatically called when Evennia starts.
|
||||
|
||||
"""
|
||||
now = datetime.now()
|
||||
for task_id, (date, callbac, args, kwargs) in self.tasks.items():
|
||||
seconds = (date - now).total_seconds()
|
||||
if seconds < 0:
|
||||
seconds = 0
|
||||
|
||||
task.deferLater(reactor, seconds, self.do_task, task_id)
|
||||
|
||||
|
||||
# Create the soft singleton
|
||||
PERSISTENT_TASKS = PersistentTasks()
|
||||
|
|
@ -919,7 +919,7 @@ def uses_database(name="sqlite3"):
|
|||
return engine == "django.db.backends.%s" % name
|
||||
|
||||
|
||||
_PERSISTENT_TASKS = None
|
||||
_TASK_HANDLER = None
|
||||
|
||||
def delay(timedelay, callback, *args, **kwargs):
|
||||
"""
|
||||
|
|
@ -931,9 +931,9 @@ def delay(timedelay, callback, *args, **kwargs):
|
|||
arguments after `timedelay` seconds.
|
||||
args (any, optional): Will be used as arguments to callback
|
||||
Kwargs:
|
||||
persistent (bool, optional): should make the delay persistent
|
||||
over a reboot or reload
|
||||
any (any): Will be used to call the callback.
|
||||
persistent (bool, optional): should make the delay persistent
|
||||
over a reboot or reload
|
||||
any (any): Will be used to call the callback.
|
||||
|
||||
Returns:
|
||||
deferred (deferred): Will fire fire with callback after
|
||||
|
|
@ -943,6 +943,8 @@ def delay(timedelay, callback, *args, **kwargs):
|
|||
specified here.
|
||||
|
||||
Note:
|
||||
The task handler (`evennia.scripts.taskhandler.TASK_HANDLEr`) will
|
||||
be called for persistent or non-persistent tasks.
|
||||
If persistent is set to True, the callback, its arguments
|
||||
and other keyword arguments will be saved in the database,
|
||||
assuming they can be. The callback will be executed even after
|
||||
|
|
@ -950,19 +952,11 @@ def delay(timedelay, callback, *args, **kwargs):
|
|||
(and server down time).
|
||||
|
||||
"""
|
||||
global _PERSISTENT_TASKS
|
||||
persistent = kwargs.get("persistent", False)
|
||||
if persistent:
|
||||
del kwargs["persistent"]
|
||||
# Do some imports here to avoid circular import and speed things up
|
||||
if _PERSISTENT_TASKS is None:
|
||||
from evennia.utils.persistent import PERSISTENT_TASKS as _PERSISTENT_TASKS
|
||||
task_id = _PERSISTENT_TASKS.add(timedelay, callback, *args, **kwargs)
|
||||
callback = _PERSISTENT_TASKS.do_task
|
||||
args = [task_id]
|
||||
kwargs = {}
|
||||
|
||||
return task.deferLater(reactor, timedelay, callback, *args, **kwargs)
|
||||
global _TASK_HANDLER
|
||||
# Do some imports here to avoid circular import and speed things up
|
||||
if _TASK_HANDLER is None:
|
||||
from evennia.scripts.taskhandler import TASK_HANDLER as _TASK_HANDLER
|
||||
return _TASK_HANDLER.add(timedelay, callback, *args, **kwargs)
|
||||
|
||||
|
||||
_TYPECLASSMODELS = None
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue