Clean up docstring of _batch_create in spawner.

evennia/objects/objects.py

@@ -21,7 +21,8 @@ from evennia.commands.cmdsethandler import CmdSetHandler
 from evennia.commands import cmdhandler
 from evennia.utils import logger
 from evennia.utils.utils import (variable_from_module, lazy_property,
-                                 make_iter, to_unicode, calledby, is_iter)
+                                 make_iter, to_unicode, is_iter)
+from django.utils.translation import ugettext as _
 
 _MULTISESSION_MODE = settings.MULTISESSION_MODE
 
@@ -32,8 +33,6 @@ _AT_SEARCH_RESULT = variable_from_module(*settings.SEARCH_AT_RESULT.rsplit('.',
 # the sessid_max is based on the length of the db_sessid csv field (excluding commas)
 _SESSID_MAX = 16 if _MULTISESSION_MODE in (1, 3) else 1
 
-from django.utils.translation import ugettext as _
-
 
 class ObjectSessionHandler(object):
     """
@@ -816,8 +815,8 @@ class DefaultObject(with_metaclass(TypeclassBase, ObjectDB)):
             """
             key = self.key
             num = 1
-            for _ in (obj for obj in self.location.contents
+            for inum in (obj for obj in self.location.contents
-                      if obj.key.startswith(key) and obj.key.lstrip(key).isdigit()):
+                         if obj.key.startswith(key) and obj.key.lstrip(key).isdigit()):
                 num += 1
             return "%s%03i" % (key, num)
         new_key = new_key or find_clone_key()
@@ -993,7 +992,7 @@ class DefaultObject(with_metaclass(TypeclassBase, ObjectDB)):
             "get:all()",                # pick up object
             "call:true()",              # allow to call commands on this object
             "tell:perm(Admin)",        # allow emits to this object
-            "puppet:pperm(Developer)"])) # lock down puppeting only to staff by default
+            "puppet:pperm(Developer)"]))  # lock down puppeting only to staff by default
 
     def basetype_posthook_setup(self):
         """

evennia/utils/spawner.py

@@ -90,10 +90,6 @@ many traits with a normal *goblin*.
 from __future__ import print_function
 
 import copy
-# TODO
-# sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.dirname(os.path.abspath(__file__)))))
-# os.environ['DJANGO_SETTINGS_MODULE'] = 'game.settings'
-
 from django.conf import settings
 from random import randint
 import evennia
@@ -102,7 +98,9 @@ from evennia.utils.utils import make_iter, all_from_module, dbid_to_obj
 
 _CREATE_OBJECT_KWARGS = ("key", "location", "home", "destination")
 
-_handle_dbref = lambda inp: dbid_to_obj(inp, ObjectDB)
+
+def _handle_dbref(inp):
+    dbid_to_obj(inp, ObjectDB)
 
 
 def _validate_prototype(key, prototype, protparents, visited):
@@ -150,13 +148,35 @@ def _batch_create_object(*objparams):
     so make sure the spawned Typeclass works before using this!
 
     Args:
-        objsparams (any): Each argument should be a tuple of arguments
+        objsparams (tuple): Parameters for the respective creation/add
+            handlers in the following order:
+                - `create_kwargs` (dict): For use as new_obj = `ObjectDB(**create_kwargs)`.
+                - `permissions` (str): Permission string used with `new_obj.batch_add(permission)`.
+                - `lockstring` (str): Lockstring used with `new_obj.locks.add(lockstring)`.
+                - `aliases` (list): A list of alias strings for
+                    adding with `new_object.aliases.batch_add(*aliases)`.
+                - `nattributes` (list): list of tuples `(key, value)` to be loop-added to
+                    add with `new_obj.nattributes.add(*tuple)`.
+                - `attributes` (list): list of tuples `(key, value[,category[,lockstring]])` for
+                    adding with `new_obj.attributes.batch_add(*attributes)`.
+                - `tags` (list): list of tuples `(key, category)` for adding
+                    with `new_obj.tags.batch_add(*tags)`.
+                - `execs` (list): Code strings to execute together with the creation
+                    of each object. They will be executed with `evennia` and `obj`
+                        (the newly created object) available in the namespace. Execution
+                        will happend after all other properties have been assigned and
+                        is intended for calling custom handlers etc.
             for the respective creation/add handlers in the following
-            order: (create, permissions, locks, aliases, nattributes,
+            order: (create_kwargs, permissions, locks, aliases, nattributes,
-            attributes)
+            attributes, tags, execs)
+
     Returns:
         objects (list): A list of created objects
 
+    Notes:
+        The `exec` list will execute arbitrary python code so don't allow this to be availble to
+        unprivileged users!
+
     """
 
     # bulk create all objects in one go
@@ -272,7 +292,7 @@ def spawn(*prototypes, **kwargs):
 
         # the rest are attributes
         simple_attributes = [(key, value) if callable(value) else value
-                                for key, value in prot.items() if not key.startswith("ndb_")]
+                             for key, value in prot.items() if not key.startswith("ndb_")]
         attributes = attributes + simple_attributes
         attributes = [tup for tup in attributes if not tup[0] in _CREATE_OBJECT_KWARGS]