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

Updated all sources of evennia/objects/ to google-style as per #709.

Browse source
This commit is contained in:
Griatch 2015-05-27 23:51:19 +02:00
parent 97e04ee710
commit 326c6a131e
2 changed files with 73 additions and 45 deletions
Download patch file Download diff file Expand all files Collapse all files

106
evennia/objects/manager.py
View file

@ -216,7 +216,13 @@ class ObjectDBManager(TypedObjectManager):
""" """
Get all objects that has a location set to this one. Get all objects that has a location set to this one.
excludeobj - one or more object keys to exclude from the match Args:
location (Object): Where to get contents from.
excludeobj (Object or list, optional): One or more objects
to exclude from the match.
Returns:
contents (list): Matching contents, without excludeobj, if given.
""" """
exclude_restriction = Q(pk__in=[_GA(obj, "id") for obj in make_iter(excludeobj)]) if excludeobj else Q() exclude_restriction = Q(pk__in=[_GA(obj, "id") for obj in make_iter(excludeobj)]) if excludeobj else Q()
return self.filter(db_location=location).exclude(exclude_restriction) return self.filter(db_location=location).exclude(exclude_restriction)
@ -225,10 +231,16 @@ class ObjectDBManager(TypedObjectManager):
def get_objs_with_key_or_alias(self, ostring, exact=True, def get_objs_with_key_or_alias(self, ostring, exact=True,
candidates=None, typeclasses=None): candidates=None, typeclasses=None):
""" """
Returns objects based on key or alias match. Will also do fuzzy Args:
matching based on the `utils.string_partial_matching` function. ostring (str): A search criterion.
candidates - list of candidate objects to restrict on exact (bool, optional): Require exact match of ostring
typeclasses - list of typeclass path strings to restrict on (still case-insensitive). If `False`, will do fuzzy matching
using `evennia.utils.utils.string_partial_matching` algorithm.
candidates (list): Only match among these candidates.
typeclasses (list): Only match objects with typeclasses having thess path strings.
Returns:
matches (list): A list of matches of length 0, 1 or more.
""" """
if not isinstance(ostring, basestring): if not isinstance(ostring, basestring):
if hasattr(ostring, "key"): if hasattr(ostring, "key"):
@ -278,36 +290,41 @@ class ObjectDBManager(TypedObjectManager):
candidates=None, candidates=None,
exact=True): exact=True):
""" """
Search as an object globally or in a list of candidates and return Search as an object globally or in a list of candidates and
results. The result is always an Object. Always returns a list. return results. The result is always an Object. Always returns
a list.
Arguments: Args:
searchdata: (str or obj) The entity to match for. This is usually a searchdata (str or Object): The entity to match for. This is
key string but may also be an object itself. By default (if usually a key string but may also be an object itself.
no `attribute_name` is set), this will search `object.key` and By default (if no `attribute_name` is set), this will
`object.aliases` in order. Can also be on the form #dbref, search `object.key` and `object.aliases` in order.
which will (if `exact=True`) be matched against primary key. Can also be on the form #dbref, which will (if
attribute_name: (str): Use this named ObjectAttribute to match `exact=True`) be matched against primary key.
searchdata against, instead of the defaults. If this is attribute_name (str): Use this named Attribute to
the name of a database field (with or without the `db_` prefix), match searchdata against, instead of the defaults. If
that will be matched too. this is the name of a database field (with or without
typeclass (str or TypeClass): restrict matches to objects having this the `db_` prefix), that will be matched too.
typeclass. This will help speed up global searches. typeclass (str or TypeClass): restrict matches to objects
candidates (list obj ObjectDBs): If supplied, search will only be having this typeclass. This will help speed up global
performed among the candidates in this list. A common list searches.
of candidates is the contents of the current location candidates (list): If supplied, search will
searched. only be performed among the candidates in this list. A
exact (bool): Match names/aliases exactly or partially. Partial common list of candidates is the contents of the
matching matches the beginning of words in the names/aliases, current location searched.
using a matching routine to separate multiple matches in exact (bool): Match names/aliases exactly or partially.
names with multiple components (so "bi sw" will match Partial matching matches the beginning of words in the
"Big sword"). Since this is more expensive than exact names/aliases, using a matching routine to separate
matching, it is recommended to be used together with the multiple matches in names with multiple components (so
`objlist` keyword to limit the number of possibilities. This "bi sw" will match "Big sword"). Since this is more
value has no meaning if searching for attributes/properties. expensive than exact matching, it is recommended to be
used together with the `candidates` keyword to limit the
number of possibilities. This value has no meaning if
searching for attributes/properties.
Returns: Returns:
A list of matching objects (or a list with one unique match) matches (list): Matching objects
""" """
def _searcher(searchdata, candidates, typeclass, exact=False): def _searcher(searchdata, candidates, typeclass, exact=False):
""" """
@ -390,12 +407,21 @@ class ObjectDBManager(TypedObjectManager):
will be identical to the original except for the arguments given will be identical to the original except for the arguments given
specifically to this method. specifically to this method.
original_object (obj) - the object to make a copy from. Args:
new_key (str) - name the copy differently from the original. original_object (Object): The object to make a copy from.
new_location (obj) - if not `None`, change the location. new_key (str, optional): Name of the copy, if different
new_home (obj) - if not `None`, change the Home. from the original.
new_aliases (list of strings) - if not `None`, change object aliases. new_location (Object, optional): Alternate location.
new_destination (obj) - if not `None`, change destination. new_home (Object, optional): Change the home location
new_aliases (list, optional): Give alternate object
aliases as a list of strings.
new_destination (Object, optional): Used only by exits.
Returns:
copy (Object or None): The copy of `original_object`,
optionally modified as per the ingoing keyword
arguments. `None` if an error was encountered.
""" """
# get all the object's stats # get all the object's stats
@ -448,8 +474,8 @@ class ObjectDBManager(TypedObjectManager):
def clear_all_sessids(self): def clear_all_sessids(self):
""" """
Clear the db_sessid field of all objects having also the db_player field Clear the db_sessid field of all objects having also the
set. db_player field set.
""" """
self.filter(db_sessid__isnull=False).update(db_sessid=None) self.filter(db_sessid__isnull=False).update(db_sessid=None)

12
evennia/objects/models.py
View file

@ -26,11 +26,10 @@ from evennia.utils.utils import (make_iter, dbref, lazy_property)
class ContentsHandler(object): class ContentsHandler(object):
""" """
Handles and caches the contents of an object Handles and caches the contents of an object to avoid excessive
to avoid excessive lookups (this is done very lookups (this is done very often due to cmdhandler needing to look
often due to cmdhandler needing to look for for object-cmdsets). It is stored on the 'contents_cache' property
object-cmdsets). It is stored on the 'contents_cache' of the ObjectDB.
property of the ObjectDB.
""" """
def __init__(self, obj): def __init__(self, obj):
""" """
@ -286,6 +285,9 @@ class ObjectDB(TypedObject):
the location handler (which updates the contents cache) or the location handler (which updates the contents cache) or
not. not.
Args:
new (bool): Set if this location has not yet been saved before.
""" """
if not hasattr(self, "_safe_contents_update"): if not hasattr(self, "_safe_contents_update"):
# changed/set outside of the location handler # changed/set outside of the location handler