Extended cmdhandler error reporting with a lot - every inlineCallback needs its own internal error reporting in order to catch everything.

evennia/commands/cmdhandler.py

@@ -71,8 +71,39 @@ CMD_CHANNEL = "__send_to_channel_command"
 # (is expected to display the login screen)
 CMD_LOGINSTART = "__unloggedin_look_command"
 
-# custom Exceptions
+# Output strings
 
+_ERROR_UNTRAPPED = "{traceback}\n" \
+                  "Above traceback is from an untrapped error. " \
+                  "Please file a bug report."
+
+_ERROR_CMDSETS = "{traceback}\n" \
+                "Above traceback is from a cmdset merger error. " \
+                "Please file a bug report."
+
+_ERROR_NOCMDSETS = "No command sets found! This is a sign of a critical bug." \
+                  "\nThe error was logged. If disconnecting/reconnecting doesn't" \
+                  "\nsolve the problem, try to contact the server admin through" \
+                  "\nsome other means for assistance."
+
+_ERROR_CMDHANDLER = "{traceback}\n"\
+                   "Above traceback is from a Command handler bug." \
+                   "Please file a bug report with the Evennia project."
+
+
+def _msg_err(receiver, string):
+    """
+    Helper function for returning an error to the caller.
+
+    Args:
+        receiver (Object): object to get the error message
+        string (str): string with a {traceback} format marker inside it.
+
+    """
+    receiver.msg(string.format(traceback=format_exc()))
+
+
+# custom Exceptions
 
 class NoCmdSets(Exception):
     "No cmdsets found. Critical error."
@@ -86,8 +117,10 @@ class ExecSystemCommand(Exception):
         self.syscmd = syscmd
         self.sysarg = sysarg
 
-# Helper function
+class ErrorReported(Exception):
+    "Re-raised when a subsructure already reported the error"
 
+# Helper function
 
 @inlineCallbacks
 def get_and_merge_cmdsets(caller, session, player, obj,
@@ -107,21 +140,28 @@ def get_and_merge_cmdsets(caller, session, player, obj,
 
     Note that this function returns a deferred!
     """
+    try:
         local_obj_cmdsets = [None]
 
         @inlineCallbacks
         def _get_channel_cmdsets(player, player_cmdset):
             "Channel-cmdsets"
             # Create cmdset for all player's available channels
+            try:
                 channel_cmdset = None
                 if not player_cmdset.no_channels:
                     channel_cmdset = yield CHANNELHANDLER.get_cmdset(player)
                 returnValue(channel_cmdset)
+            except Exception:
+                logger.log_trace()
+                _msg_err(caller, _ERROR_CMDSETS)
+                raise ErrorReported
 
         @inlineCallbacks
         def _get_local_obj_cmdsets(obj, obj_cmdset):
             "Object-level cmdsets"
             # Gather cmdsets from location, objects in location or carried
+            try:
                 local_obj_cmdsets = [None]
                 try:
                     location = obj.location
@@ -152,6 +192,11 @@ def get_and_merge_cmdsets(caller, session, player, obj,
                         cset.old_duplicates = cset.duplicates
                         cset.duplicates = True
                 returnValue(local_obj_cmdsets)
+            except Exception:
+                logger.log_trace()
+                _msg_err(caller, _ERROR_CMDSETS)
+                raise ErrorReported
+
 
         @inlineCallbacks
         def _get_cmdset(obj):
@@ -246,7 +291,12 @@ def get_and_merge_cmdsets(caller, session, player, obj,
             cset.duplicates = cset.old_duplicates
         #print "merged set:", cmdset.key
         returnValue(cmdset)
-
+    except ErrorReported:
+        raise
+    except Exception:
+        logger.log_trace()
+        _msg_err(caller, _ERROR_CMDSETS)
+        raise ErrorReported
 
 # Main command-handler function
 
@@ -344,10 +394,9 @@ def cmdhandler(called_by, raw_string, _testing=False, callertype="session", sess
             returnValue(ret)
 
         except Exception:
-            string = "%s\nAbove traceback is from an untrapped error."
+            logger.log_trace()
-            string += " Please file a bug report."
+            _msg_err(caller, _ERROR_UNTRAPPED)
-            logger.log_trace(_(string))
+            raise ErrorReported
-            caller.msg(string % format_exc())
 
     raw_string = to_unicode(raw_string, force_string=True)
 
@@ -449,6 +498,11 @@ def cmdhandler(called_by, raw_string, _testing=False, callertype="session", sess
             ret = yield _run_command(cmd, cmdname, args)
             returnValue(ret)
 
+        except ErrorReported:
+            # this error was already reported, so we
+            # catch it here and don't pass it on.
+            pass
+
         except ExecSystemCommand, exc:
             # Not a normal command: run a system command, if available,
             # or fall back to a return string.
@@ -464,24 +518,15 @@ def cmdhandler(called_by, raw_string, _testing=False, callertype="session", sess
 
         except NoCmdSets:
             # Critical error.
-            string = "No command sets found! This is a sign of a critical bug.\n"
-            string += "The error was logged.\n"
-            string += "If logging out/in doesn't solve the problem, try to "
-            string += "contact the server admin through some other means "
-            string += "for assistance."
-            caller.msg(_(string))
             logger.log_errmsg("No cmdsets found: %s" % caller)
+            caller.msg(_ERROR_NOCMDSETS)
 
         except Exception:
             # We should not end up here. If we do, it's a programming bug.
-            string = "%s\nAbove traceback is from an untrapped error."
+            logger.log_trace()
-            string += " Please file a bug report."
+            _msg_err(caller, _ERROR_UNTRAPPED)
-            logger.log_trace(_(string))
-            caller.msg(string % format_exc())
 
     except Exception:
         # This catches exceptions in cmdhandler exceptions themselves
-        string = "%s\nAbove traceback is from a Command handler bug."
+        logger.log_trace()
-        string += " Please contact an admin and/or file a bug report."
+        _msg_err(caller, _ERROR_CMDHANDLER)
-        logger.log_trace(_(string))
-        caller.msg(string % format_exc())

evennia/contrib/tutorial_world/mob.py

@@ -184,6 +184,7 @@ class Mob(tut_objects.TutorialObject):
         if last_interval:
              # we have a previous subscription, kill this first.
             TICKER_HANDLER.remove(self, last_interval, idstring)
+        self.db.last_ticker_interval = interval
         if not stop:
             # set the new ticker
             TICKER_HANDLER.add(self, interval, idstring, hook_key)