Annikka/evennia
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

TaskHandler.remove() made functional

Browse source 
TaskHandler.remove method now functions. Previous it would have removed the task from the TaskHandler.tasks dictionary, but never canceled the task. Making the "remove a persistent task without executing it" incorrect. Previous there was no method to get a persistent tasks's deferral instance, which was likely why TaskHandler.remove was not used within the module.

Added unit tests to test TaskHandler.remove
This commit is contained in:
davewiththenicehat 2021-04-18 08:51:18 -04:00
parent 97f7806348
commit f3b546bcf6
2 changed files with 34 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

27
evennia/scripts/taskhandler.py
View file

@ -212,22 +212,35 @@ class TaskHandler(object):
return task_id return task_id
def remove(self, task_id): def remove(self, task_id):
"""Remove a persistent task without executing it. """
Remove a task without executing it.
Deletes the instance of the task's deferral.
Args: Args:
task_id (int): an existing task ID. task_id (int): an existing task ID.
Note: Returns:
A non-persistent task doesn't have a task_id, it is not stored True (bool), if the removal completed successfully.
in the TaskHandler. None, if there was a raise error
""" """
d = None
# delete the task from the tasks dictionary
if task_id in self.tasks: if task_id in self.tasks:
del self.tasks[task_id] # if the task has not been run, cancel it
d = self.get_deferred(task_id)
if d: # it is remotely possible for a task to not have a deferral
if not d.called:
d.cancel()
del self.tasks[task_id] # delete the task from the tasks dictionary
# remove the task from the persistent dictionary and ServerConfig
if task_id in self.to_save: if task_id in self.to_save:
del self.to_save[task_id] del self.to_save[task_id]
self.save() # remove from ServerConfig.objects
self.save() # delete the instance of the deferral
if d:
del d
return True
def do_task(self, task_id): def do_task(self, task_id):
"""Execute the task (call its callback). """Execute the task (call its callback).

14
evennia/utils/tests/test_utils.py
View file

@ -351,3 +351,17 @@ class TestDelay(EvenniaTest):
_TASK_HANDLER.clock.advance(timedelay) # make time pass _TASK_HANDLER.clock.advance(timedelay) # make time pass
self.assertEqual(self.char1.ndb.dummy_var, False) self.assertEqual(self.char1.ndb.dummy_var, False)
self.char1.ndb.dummy_var = False self.char1.ndb.dummy_var = False
# test removing an active task
task_id = utils.delay(timedelay, dummy_func, self.char1.dbref)
success = _TASK_HANDLER.remove(task_id)
_TASK_HANDLER.clock.advance(timedelay) # make time pass
self.assertEqual(self.char1.ndb.dummy_var, False)
self.char1.ndb.dummy_var = False
# test removing a canceled active task
task_id = utils.delay(timedelay, dummy_func, self.char1.dbref)
deferal_inst = _TASK_HANDLER.get_deferred(task_id)
deferal_inst.cancel()
success = _TASK_HANDLER.remove(task_id)
_TASK_HANDLER.clock.advance(timedelay) # make time pass
self.assertEqual(self.char1.ndb.dummy_var, False)
self.char1.ndb.dummy_var = False