Annikka/evennia
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Some expansion of the search() docstring

Browse source
This commit is contained in:
Griatch 2015-02-10 19:18:23 +01:00
parent d4b92c6e42
commit c38c9e2f38
1 changed files with 49 additions and 52 deletions
Download patch file Download diff file Expand all files Collapse all files

101
evennia/objects/objects.py
View file

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