diff --git a/evennia/objects/objects.py b/evennia/objects/objects.py index 6fb7e2a527..867ae27c54 100644 --- a/evennia/objects/objects.py +++ b/evennia/objects/objects.py @@ -322,64 +322,65 @@ class DefaultObject(ObjectDB): nofound_string=None, multimatch_string=None): """ - Returns the typeclass of an Object matching a search string/condition + Returns the typeclass of an `Object` matching a search + string/condition Perform a standard object search in the database, handling multiple results and lack thereof gracefully. By default, only - objects in self's current location or inventory is searched. - Note: to find Players, use eg. evennia.player_search. + objects in the current `location` of `self` or its inventory are searched for. Args: searchdata (str or obj): Primary search criterion. Will be matched - against object.key (with object.aliases second) unless - the keyword attribute_name specifies otherwise. - Special strings: - # - search by unique dbref. This is always - a global search. - me,self - self-reference to this object - - - can be used to differentiate - between multiple same-named matches + against `object.key` (with `object.aliases` second) unless + the keyword attribute_name specifies otherwise. + **Special strings:** + - `#`: search by unique dbref. This is always + a global search. + - `me,self`: self-reference to this object + - `-` - can be used to differentiate + between multiple same-named matches global_search (bool): Search all objects globally. This is overruled - by "location" keyword. - use_nicks (bool): Use nickname-replace (nicktype "object") on the - search string + by `location` keyword. + use_nicks (bool): Use nickname-replace (nicktype "object") on `searchdata`. typeclass (str or Typeclass, or list of either): Limit search only - to Objects with this typeclass. May be a list of typeclasses - for a broader search. + to `Objects` with this typeclass. May be a list of typeclasses + for a broader search. location (Object): Specify a location to search, if different from the - self's given location plus its contents. This can also - be a list of locations. + self's given `location` plus its contents. This can also + be a list of locations. attribute_name (str): Define which property to search. If set, no - key+alias search will be performed. This can be used to - search database fields (db_ will be automatically - appended), and if that fails, it will try to return - objects having Attributes with this name and value - equal to searchdata. A special use is to search for - "key" here if you want to do a key-search without - including aliases. + key+alias search will be performed. This can be used + to search database fields (db_ will be automatically + appended), and if that fails, it will try to return + objects having Attributes with this name and value + equal to searchdata. A special use is to search for + "key" here if you want to do a key-search without + including aliases. quiet (bool): don't display default error messages - this tells the - search method that the user wants to handle all errors - themselves. It also changes the return value type, see - below. + search method that the user wants to handle all errors + themselves. It also changes the return value type, see + below. exact (bool): if unset (default) - prefers to match to beginning of - string rather than not matching at all. If set, requires - exact mathing of entire string. + string rather than not matching at all. If set, requires + exact mathing of entire string. candidates (list of objects): this is an optional custom list of objects - to search (filter) between. It is ignored if global_search - is given. If not set, this list will automatically be defined - to include the location, the contents of location and the - caller's contents (inventory). - nofound_string (str): optional custom string for not-found error message - multimatch_string (str): optional custom string for multimatch error header + to search (filter) between. It is ignored if `global_search` + is given. If not set, this list will automatically be defined + to include the location, the contents of location and the + caller's contents (inventory). + nofound_string (str): optional custom string for not-found error message. + multimatch_string (str): optional custom string for multimatch error header. Returns: - match (Object, None or list): will return an Object/None if quiet=False, + match (Object, None or list): will return an Object/None if `quiet=False`, otherwise it will return a list of 0, 1 or more matches. Notes: - If quiet=False, error messages will be handled by settings.SEARCH_AT_RESULT - and echoed automatically (on error, return will be None). If quiet=True, the - error messaging is assumed to be handled by the caller. + To find Players, use eg. `evennia.player_search`. If + `quiet=False`, error messages will be handled by + `settings.SEARCH_AT_RESULT` and echoed automatically (on + error, return will be `None`). If `quiet=True`, the error + messaging is assumed to be handled by the caller. """ is_string = isinstance(searchdata, basestring) diff --git a/evennia/utils/idmapper/__init__.py b/evennia/utils/idmapper/__init__.py index e69de29bb2..dd5f7f439a 100644 --- a/evennia/utils/idmapper/__init__.py +++ b/evennia/utils/idmapper/__init__.py @@ -0,0 +1,3 @@ +""" +The idmapper holds the main database caching mechanism. +"""