TaskHandler cancel and exists method's created

Created task handler methods to cancel a task and check if a task exists.

Modified unit tests to use these and test methods.
unit test test_delay passes.

evennia/scripts/taskhandler.py

@@ -211,6 +211,56 @@ class TaskHandler(object):
             return False
         return task_id
 
+    def exists(self, task_id):
+        """
+        Test if a task exists.
+
+        Args:
+            task_id (int): an existing task ID.
+
+        Returns:
+            True (bool): if the task exists.
+            False (bool): if the task does not exist.
+
+        Note:
+            Most task handler methods check for existence for you.
+        """
+        if task_id in self.tasks:
+            return True
+        else:
+            return False
+
+
+    def cancel(self, task_id):
+        """
+        Stop a task from automatically executing.
+        This will not remove the task.
+
+        Args:
+            task_id (int): an existing task ID.
+
+        Returns:
+            True (bool): if the removal completed successfully.
+            False (bool): if the task:
+                does not exist,
+                has already run,
+                does not have a deferral instance created for the task.
+            None, if there was a raised exception
+        """
+        if task_id in self.tasks:
+            # 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 d.called:
+                    return False
+                else:  # the callback has not been called yet.
+                    d.cancel()
+                    return True
+            else:  # this task has no deferral
+                return False
+        else:
+            return False
+
     def remove(self, task_id):
         """
         Remove a task without executing it.
@@ -220,18 +270,16 @@ class TaskHandler(object):
             task_id (int): an existing task ID.
 
         Returns:
-            True (bool), if the removal completed successfully.
+            True (bool): if the removal completed successfully or if the a
-            None, if there was a raise error
+            task with the id does not exist.
+            None, if there was a raised exception
 
         """
         d = None
         # delete the task from the tasks dictionary
         if task_id in self.tasks:
             # if the task has not been run, cancel it
-            d = self.get_deferred(task_id)
+            self.cancel(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:

evennia/utils/tests/test_utils.py

@@ -345,9 +345,11 @@ class TestDelay(EvenniaTest):
         self.assertEqual(self.char1.ndb.dummy_var, 'dummy_func ran')
         self.char1.ndb.dummy_var = False
         # test canceling a deferral.
+        # after this the task_id 1 remains used by this canceled but unused task
         task_id = utils.delay(timedelay, dummy_func, self.char1.dbref)
-        deferal_inst = _TASK_HANDLER.get_deferred(task_id)
+        success = _TASK_HANDLER.cancel(task_id)
-        deferal_inst.cancel()
+        self.assertTrue(success)
+        self.assertTrue(_TASK_HANDLER.exists(task_id))
         _TASK_HANDLER.clock.advance(timedelay)  # make time pass
         self.assertEqual(self.char1.ndb.dummy_var, False)
         self.char1.ndb.dummy_var = False
@@ -356,6 +358,7 @@ class TestDelay(EvenniaTest):
         success = _TASK_HANDLER.remove(task_id)
         _TASK_HANDLER.clock.advance(timedelay)  # make time pass
         self.assertEqual(self.char1.ndb.dummy_var, False)
+        self.assertFalse(_TASK_HANDLER.exists(task_id))
         self.char1.ndb.dummy_var = False
         # test removing a canceled active task
         task_id = utils.delay(timedelay, dummy_func, self.char1.dbref)
@@ -364,4 +367,7 @@ class TestDelay(EvenniaTest):
         success = _TASK_HANDLER.remove(task_id)
         _TASK_HANDLER.clock.advance(timedelay)  # make time pass
         self.assertEqual(self.char1.ndb.dummy_var, False)
+        self.assertFalse(_TASK_HANDLER.exists(task_id))
         self.char1.ndb.dummy_var = False
+        # restart condictions
+        # cancel a diferall directly, without calling task handler's cancel