Make create_script return None if script set up to immediately fire/stop. Resolves #1663.

evennia/utils/create.py

@@ -229,6 +229,12 @@ def create_script(typeclass=None, key=None, obj=None, account=None, locks=None,
     # at_first_save hook on the typeclass, where the _createdict
     # can be used.
     new_script.save()
+
+    if not new_script.id:
+        # this happens in the case of having a repeating script with `repeats=1` and
+        # `start_delay=False` - the script will run once and immediately stop before save is over.
+        return None
+
     return new_script
 
 

evennia/utils/idmapper/models.py

@@ -397,6 +397,11 @@ class SharedMemoryModel(with_metaclass(SharedMemoryModelBase, Model)):
                 super(SharedMemoryModel, cls).save(*args, **kwargs)
             callFromThread(_save_callback, self, *args, **kwargs)
 
+        if not self.pk:
+            # this can happen if some of the startup methods immediately
+            # delete the object (an example are Scripts that start and die immediately)
+            return
+
         # update field-update hooks and eventual OOB watchers
         new = False
         if "update_fields" in kwargs and kwargs["update_fields"]:
@@ -421,6 +426,7 @@ class SharedMemoryModel(with_metaclass(SharedMemoryModelBase, Model)):
 #            fieldtracker = "_oob_at_%s_postsave" % fieldname
 #            if hasattr(self, fieldtracker):
 #                _GA(self, fieldtracker)(fieldname)
+        pass
 
 
 class WeakSharedMemoryModelBase(SharedMemoryModelBase):

evennia/utils/test_resources.py

@@ -66,85 +66,3 @@ class EvenniaTest(TestCase):
         self.account.delete()
         self.account2.delete()
         super(EvenniaTest, self).tearDown()
-
-
-import unittest
-import inspect
-
-class TestCreateScript(EvenniaTest):
-
-    def test_create_script(self):
-        class TestScriptA(DefaultScript):
-            def at_script_creation(self):
-                self.key = 'test_script'
-                self.interval = 10
-                self.persistent = False
-
-        script = create.create_script(TestScriptA, key='test_script')
-        assert script is not None
-        assert script.interval == 10
-        assert script.key == 'test_script'
-        script.stop()
-
-    @unittest.expectedFailure
-    def test_create_script_w_repeats_equal_1(self):
-        class TestScriptB(DefaultScript):
-            def at_script_creation(self):
-                self.key = 'test_script'
-                self.interval = 10
-                self.repeats = 1
-                self.persistent = False
-
-        script = create.create_script(TestScriptB, key='test_script')
-        assert script is not None
-        assert script.interval == 10
-        assert script.repeats == 1
-        assert script.key == 'test_script'
-        script.stop()
-
-    def test_create_script_w_repeats_equal_1_persisted(self):
-        class TestScriptB1(DefaultScript):
-            def at_script_creation(self):
-                self.key = 'test_script'
-                self.interval = 10
-                self.repeats = 1
-                self.persistent = True
-
-        script = create.create_script(TestScriptB1, key='test_script')
-        assert script is not None
-        assert script.interval == 10
-        assert script.repeats == 1
-        assert script.key == 'test_script'
-        assert self.persistent == True
-        script.stop()
-
-    def test_create_script_w_repeats_equal_2(self):
-        class TestScriptC(DefaultScript):
-            def at_script_creation(self):
-                self.key = 'test_script'
-                self.interval = 10
-                self.repeats = 2
-                self.persistent = False
-
-        script = create.create_script(TestScriptC, key='test_script')
-        assert script is not None
-        assert script.interval == 10
-        assert script.repeats == 2
-        assert script.key == 'test_script'
-        script.stop()
-
-    def test_create_script_w_repeats_equal_1_and_delayed(self):
-        class TestScriptD(DefaultScript):
-            def at_script_creation(self):
-                self.key = 'test_script'
-                self.interval = 10
-                self.start_delay = True
-                self.repeats = 1
-                self.persistent = False
-
-        script = create.create_script(TestScriptD, key='test_script')
-        assert script is not None
-        assert script.interval == 10
-        assert script.repeats == 1
-        assert script.key == 'test_script'
-        script.stop()

evennia/utils/tests/test_create_functions.py

@@ -0,0 +1,79 @@
+"""
+Tests of create functions
+
+"""
+
+from evennia.utils.test_resources import EvenniaTest
+from evennia.scripts.scripts import DefaultScript
+from evennia.utils import create
+
+
+class TestCreateScript(EvenniaTest):
+
+    def test_create_script(self):
+        class TestScriptA(DefaultScript):
+            def at_script_creation(self):
+                self.key = 'test_script'
+                self.interval = 10
+                self.persistent = False
+
+        script = create.create_script(TestScriptA, key='test_script')
+        assert script is not None
+        assert script.interval == 10
+        assert script.key == 'test_script'
+        script.stop()
+
+    def test_create_script_w_repeats_equal_1(self):
+        class TestScriptB(DefaultScript):
+            def at_script_creation(self):
+                self.key = 'test_script'
+                self.interval = 10
+                self.repeats = 1
+                self.persistent = False
+
+        # script is already stopped (interval=1, start_delay=False)
+        script = create.create_script(TestScriptB, key='test_script')
+        assert script is None
+
+    def test_create_script_w_repeats_equal_1_persisted(self):
+        class TestScriptB1(DefaultScript):
+            def at_script_creation(self):
+                self.key = 'test_script'
+                self.interval = 10
+                self.repeats = 1
+                self.persistent = True
+
+        # script is already stopped (interval=1, start_delay=False)
+        script = create.create_script(TestScriptB1, key='test_script')
+        assert script is None
+
+    def test_create_script_w_repeats_equal_2(self):
+        class TestScriptC(DefaultScript):
+            def at_script_creation(self):
+                self.key = 'test_script'
+                self.interval = 10
+                self.repeats = 2
+                self.persistent = False
+
+        script = create.create_script(TestScriptC, key='test_script')
+        assert script is not None
+        assert script.interval == 10
+        assert script.repeats == 2
+        assert script.key == 'test_script'
+        script.stop()
+
+    def test_create_script_w_repeats_equal_1_and_delayed(self):
+        class TestScriptD(DefaultScript):
+            def at_script_creation(self):
+                self.key = 'test_script'
+                self.interval = 10
+                self.start_delay = True
+                self.repeats = 1
+                self.persistent = False
+
+        script = create.create_script(TestScriptD, key='test_script')
+        assert script is not None
+        assert script.interval == 10
+        assert script.repeats == 1
+        assert script.key == 'test_script'
+        script.stop()