Search is not available for this dataset
identifier
stringlengths
1
155
parameters
stringlengths
2
6.09k
docstring
stringlengths
11
63.4k
docstring_summary
stringlengths
0
63.4k
function
stringlengths
29
99.8k
function_tokens
list
start_point
list
end_point
list
language
stringclasses
1 value
docstring_language
stringlengths
2
7
docstring_language_predictions
stringlengths
18
23
is_langid_reliable
stringclasses
2 values
DefaultObject.move_to
(self, destination, quiet=False, emit_to_obj=None, use_destination=True, to_none=False, move_hooks=True, **kwargs)
Moves this object to a new location. Args: destination (Object): Reference to the object to move to. This can also be an exit object, in which case the destination property is used as destination. quiet (bool): If true, turn off the calling of th...
Moves this object to a new location.
def move_to(self, destination, quiet=False, emit_to_obj=None, use_destination=True, to_none=False, move_hooks=True, **kwargs): """ Moves this object to a new location. Args: destination (Object): Reference to the object to move to. This ...
[ "def", "move_to", "(", "self", ",", "destination", ",", "quiet", "=", "False", ",", "emit_to_obj", "=", "None", ",", "use_destination", "=", "True", ",", "to_none", "=", "False", ",", "move_hooks", "=", "True", ",", "*", "*", "kwargs", ")", ":", "def",...
[ 676, 4 ]
[ 804, 19 ]
python
en
['en', 'error', 'th']
False
DefaultObject.clear_exits
(self)
Destroys all of the exits and any exits pointing to this object as a destination.
Destroys all of the exits and any exits pointing to this object as a destination.
def clear_exits(self): """ Destroys all of the exits and any exits pointing to this object as a destination. """ for out_exit in [exi for exi in ObjectDB.objects.get_contents(self) if exi.db_destination]: out_exit.delete() for in_exit in ObjectDB.objects.filte...
[ "def", "clear_exits", "(", "self", ")", ":", "for", "out_exit", "in", "[", "exi", "for", "exi", "in", "ObjectDB", ".", "objects", ".", "get_contents", "(", "self", ")", "if", "exi", ".", "db_destination", "]", ":", "out_exit", ".", "delete", "(", ")", ...
[ 806, 4 ]
[ 814, 28 ]
python
en
['en', 'error', 'th']
False
DefaultObject.clear_contents
(self)
Moves all objects (accounts/things) to their home location or to default home.
Moves all objects (accounts/things) to their home location or to default home.
def clear_contents(self): """ Moves all objects (accounts/things) to their home location or to default home. """ # Gather up everything that thinks this is its location. default_home_id = int(settings.DEFAULT_HOME.lstrip("#")) try: default_home = Objec...
[ "def", "clear_contents", "(", "self", ")", ":", "# Gather up everything that thinks this is its location.", "default_home_id", "=", "int", "(", "settings", ".", "DEFAULT_HOME", ".", "lstrip", "(", "\"#\"", ")", ")", "try", ":", "default_home", "=", "ObjectDB", ".", ...
[ 816, 4 ]
[ 858, 29 ]
python
en
['en', 'error', 'th']
False
DefaultObject.copy
(self, new_key=None)
Makes an identical copy of this object, identical except for a new dbref in the database. If you want to customize the copy by changing some settings, use ObjectDB.object.copy_object() directly. Args: new_key (string): New key/name of copied object. If new_key is no...
Makes an identical copy of this object, identical except for a new dbref in the database. If you want to customize the copy by changing some settings, use ObjectDB.object.copy_object() directly.
def copy(self, new_key=None): """ Makes an identical copy of this object, identical except for a new dbref in the database. If you want to customize the copy by changing some settings, use ObjectDB.object.copy_object() directly. Args: new_key (string): New ke...
[ "def", "copy", "(", "self", ",", "new_key", "=", "None", ")", ":", "def", "find_clone_key", "(", ")", ":", "\"\"\"\n Append 01, 02 etc to obj.key. Checks next higher number in the\n same location, then adds the next number available\n\n returns the new ...
[ 860, 4 ]
[ 886, 66 ]
python
en
['en', 'error', 'th']
False
DefaultObject.delete
(self)
Deletes this object. Before deletion, this method makes sure to move all contained objects to their respective home locations, as well as clean up all exits to/from the object. Returns: noerror (bool): Returns whether or not the delete completed successfull...
Deletes this object. Before deletion, this method makes sure to move all contained objects to their respective home locations, as well as clean up all exits to/from the object.
def delete(self): """ Deletes this object. Before deletion, this method makes sure to move all contained objects to their respective home locations, as well as clean up all exits to/from the object. Returns: noerror (bool): Returns whether or not the delete complete...
[ "def", "delete", "(", "self", ")", ":", "global", "_ScriptDB", "if", "not", "_ScriptDB", ":", "from", "evennia", ".", "scripts", ".", "models", "import", "ScriptDB", "as", "_ScriptDB", "if", "not", "self", ".", "pk", "or", "not", "self", ".", "at_object_...
[ 888, 4 ]
[ 933, 19 ]
python
en
['en', 'error', 'th']
False
DefaultObject.access
(self, accessing_obj, access_type='read', default=False, no_superuser_bypass=False, **kwargs)
Determines if another object has permission to access this object in whatever way. Args: accessing_obj (Object): Object trying to access this one. access_type (str, optional): Type of access sought. default (bool, optional): What to return if no lock of access_typ...
Determines if another object has permission to access this object in whatever way.
def access(self, accessing_obj, access_type='read', default=False, no_superuser_bypass=False, **kwargs): """ Determines if another object has permission to access this object in whatever way. Args: accessing_obj (Object): Object trying to access this one. access_type...
[ "def", "access", "(", "self", ",", "accessing_obj", ",", "access_type", "=", "'read'", ",", "default", "=", "False", ",", "no_superuser_bypass", "=", "False", ",", "*", "*", "kwargs", ")", ":", "result", "=", "super", "(", "DefaultObject", ",", "self", "...
[ 935, 4 ]
[ 954, 21 ]
python
en
['en', 'error', 'th']
False
DefaultObject.at_first_save
(self)
This is called by the typeclass system whenever an instance of this class is saved for the first time. It is a generic hook for calling the startup hooks for the various game entities. When overloading you generally don't overload this but overload the hooks called by this metho...
This is called by the typeclass system whenever an instance of this class is saved for the first time. It is a generic hook for calling the startup hooks for the various game entities. When overloading you generally don't overload this but overload the hooks called by this metho...
def at_first_save(self): """ This is called by the typeclass system whenever an instance of this class is saved for the first time. It is a generic hook for calling the startup hooks for the various game entities. When overloading you generally don't overload this but ove...
[ "def", "at_first_save", "(", "self", ")", ":", "self", ".", "basetype_setup", "(", ")", "self", ".", "at_object_creation", "(", ")", "if", "hasattr", "(", "self", ",", "\"_createdict\"", ")", ":", "# this will only be set if the utils.create function", "# was used t...
[ 960, 4 ]
[ 1019, 38 ]
python
en
['en', 'error', 'th']
False
DefaultObject.basetype_setup
(self)
This sets up the default properties of an Object, just before the more general at_object_creation. You normally don't need to change this unless you change some fundamental things like names of permission groups.
This sets up the default properties of an Object, just before the more general at_object_creation.
def basetype_setup(self): """ This sets up the default properties of an Object, just before the more general at_object_creation. You normally don't need to change this unless you change some fundamental things like names of permission groups. """ # the default s...
[ "def", "basetype_setup", "(", "self", ")", ":", "# the default security setup fallback for a generic", "# object. Overload in child for a custom setup. Also creation", "# commands may set this (create an item and you should be its", "# controller, for example)", "self", ".", "locks", ".", ...
[ 1023, 4 ]
[ 1046, 40 ]
python
en
['en', 'error', 'th']
False
DefaultObject.basetype_posthook_setup
(self)
Called once, after basetype_setup and at_object_creation. This should generally not be overloaded unless you are redefining how a room/exit/object works. It allows for basetype-like setup after the object is created. An example of this is EXITs, who need to know keys, aliases, l...
Called once, after basetype_setup and at_object_creation. This should generally not be overloaded unless you are redefining how a room/exit/object works. It allows for basetype-like setup after the object is created. An example of this is EXITs, who need to know keys, aliases, l...
def basetype_posthook_setup(self): """ Called once, after basetype_setup and at_object_creation. This should generally not be overloaded unless you are redefining how a room/exit/object works. It allows for basetype-like setup after the object is created. An example of this is ...
[ "def", "basetype_posthook_setup", "(", "self", ")", ":", "pass" ]
[ 1048, 4 ]
[ 1058, 12 ]
python
en
['en', 'error', 'th']
False
DefaultObject.at_object_creation
(self)
Called once, when this object is first created. This is the normal hook to overload for most object types.
Called once, when this object is first created. This is the normal hook to overload for most object types.
def at_object_creation(self): """ Called once, when this object is first created. This is the normal hook to overload for most object types. """ pass
[ "def", "at_object_creation", "(", "self", ")", ":", "pass" ]
[ 1060, 4 ]
[ 1066, 12 ]
python
en
['en', 'error', 'th']
False
DefaultObject.at_object_delete
(self)
Called just before the database object is permanently delete()d from the database. If this method returns False, deletion is aborted.
Called just before the database object is permanently delete()d from the database. If this method returns False, deletion is aborted.
def at_object_delete(self): """ Called just before the database object is permanently delete()d from the database. If this method returns False, deletion is aborted. """ return True
[ "def", "at_object_delete", "(", "self", ")", ":", "return", "True" ]
[ 1068, 4 ]
[ 1075, 19 ]
python
en
['en', 'error', 'th']
False
DefaultObject.at_init
(self)
This is always called whenever this object is initiated -- that is, whenever it its typeclass is cached from memory. This happens on-demand first time the object is used or activated in some way after being created but also after each server restart or reload.
This is always called whenever this object is initiated -- that is, whenever it its typeclass is cached from memory. This happens on-demand first time the object is used or activated in some way after being created but also after each server restart or reload.
def at_init(self): """ This is always called whenever this object is initiated -- that is, whenever it its typeclass is cached from memory. This happens on-demand first time the object is used or activated in some way after being created but also after each server restart...
[ "def", "at_init", "(", "self", ")", ":", "pass" ]
[ 1077, 4 ]
[ 1086, 12 ]
python
en
['en', 'error', 'th']
False
DefaultObject.at_cmdset_get
(self, **kwargs)
Called just before cmdsets on this object are requested by the command handler. If changes need to be done on the fly to the cmdset before passing them on to the cmdhandler, this is the place to do it. This is called also if the object currently have no cmdsets. Kwargs:...
Called just before cmdsets on this object are requested by the command handler. If changes need to be done on the fly to the cmdset before passing them on to the cmdhandler, this is the place to do it. This is called also if the object currently have no cmdsets.
def at_cmdset_get(self, **kwargs): """ Called just before cmdsets on this object are requested by the command handler. If changes need to be done on the fly to the cmdset before passing them on to the cmdhandler, this is the place to do it. This is called also if the object curre...
[ "def", "at_cmdset_get", "(", "self", ",", "*", "*", "kwargs", ")", ":", "pass" ]
[ 1088, 4 ]
[ 1101, 12 ]
python
en
['en', 'error', 'th']
False
DefaultObject.at_pre_puppet
(self, account, session=None, **kwargs)
Called just before an Account connects to this object to puppet it. Args: account (Account): This is the connecting account. session (Session): Session controlling the connection. **kwargs (dict): Arbitrary, optional arguments for users overr...
Called just before an Account connects to this object to puppet it.
def at_pre_puppet(self, account, session=None, **kwargs): """ Called just before an Account connects to this object to puppet it. Args: account (Account): This is the connecting account. session (Session): Session controlling the connection. **kwargs ...
[ "def", "at_pre_puppet", "(", "self", ",", "account", ",", "session", "=", "None", ",", "*", "*", "kwargs", ")", ":", "pass" ]
[ 1103, 4 ]
[ 1115, 12 ]
python
en
['en', 'error', 'th']
False
DefaultObject.at_post_puppet
(self, **kwargs)
Called just after puppeting has been completed and all Account<->Object links have been established. Args: **kwargs (dict): Arbitrary, optional arguments for users overriding the call (unused by default). Note: You can use `self.account` and `sel...
Called just after puppeting has been completed and all Account<->Object links have been established.
def at_post_puppet(self, **kwargs): """ Called just after puppeting has been completed and all Account<->Object links have been established. Args: **kwargs (dict): Arbitrary, optional arguments for users overriding the call (unused by default). Note: ...
[ "def", "at_post_puppet", "(", "self", ",", "*", "*", "kwargs", ")", ":", "self", ".", "account", ".", "db", ".", "_last_puppet", "=", "self" ]
[ 1117, 4 ]
[ 1132, 43 ]
python
en
['en', 'error', 'th']
False
DefaultObject.at_pre_unpuppet
(self, **kwargs)
Called just before beginning to un-connect a puppeting from this Account. Args: **kwargs (dict): Arbitrary, optional arguments for users overriding the call (unused by default). Note: You can use `self.account` and `self.sessions.get()` to get ...
Called just before beginning to un-connect a puppeting from this Account.
def at_pre_unpuppet(self, **kwargs): """ Called just before beginning to un-connect a puppeting from this Account. Args: **kwargs (dict): Arbitrary, optional arguments for users overriding the call (unused by default). Note: You can use `s...
[ "def", "at_pre_unpuppet", "(", "self", ",", "*", "*", "kwargs", ")", ":", "pass" ]
[ 1134, 4 ]
[ 1149, 12 ]
python
en
['en', 'error', 'th']
False
DefaultObject.at_post_unpuppet
(self, account, session=None, **kwargs)
Called just after the Account successfully disconnected from this object, severing all connections. Args: account (Account): The account object that just disconnected from this object. session (Session): Session id controlling the connection that ...
Called just after the Account successfully disconnected from this object, severing all connections.
def at_post_unpuppet(self, account, session=None, **kwargs): """ Called just after the Account successfully disconnected from this object, severing all connections. Args: account (Account): The account object that just disconnected from this object. ...
[ "def", "at_post_unpuppet", "(", "self", ",", "account", ",", "session", "=", "None", ",", "*", "*", "kwargs", ")", ":", "pass" ]
[ 1151, 4 ]
[ 1165, 12 ]
python
en
['en', 'error', 'th']
False
DefaultObject.at_server_reload
(self)
This hook is called whenever the server is shutting down for restart/reboot. If you want to, for example, save non-persistent properties across a restart, this is the place to do it.
This hook is called whenever the server is shutting down for restart/reboot. If you want to, for example, save non-persistent properties across a restart, this is the place to do it.
def at_server_reload(self): """ This hook is called whenever the server is shutting down for restart/reboot. If you want to, for example, save non-persistent properties across a restart, this is the place to do it. """ pass
[ "def", "at_server_reload", "(", "self", ")", ":", "pass" ]
[ 1167, 4 ]
[ 1174, 12 ]
python
en
['en', 'error', 'th']
False
DefaultObject.at_server_shutdown
(self)
This hook is called whenever the server is shutting down fully (i.e. not for a restart).
This hook is called whenever the server is shutting down fully (i.e. not for a restart).
def at_server_shutdown(self): """ This hook is called whenever the server is shutting down fully (i.e. not for a restart). """ pass
[ "def", "at_server_shutdown", "(", "self", ")", ":", "pass" ]
[ 1176, 4 ]
[ 1182, 12 ]
python
en
['en', 'error', 'th']
False
DefaultObject.at_access
(self, result, accessing_obj, access_type, **kwargs)
This is called with the result of an access call, along with any kwargs used for that call. The return of this method does not affect the result of the lock check. It can be used e.g. to customize error messages in a central location or other effects based on the access result. ...
This is called with the result of an access call, along with any kwargs used for that call. The return of this method does not affect the result of the lock check. It can be used e.g. to customize error messages in a central location or other effects based on the access result.
def at_access(self, result, accessing_obj, access_type, **kwargs): """ This is called with the result of an access call, along with any kwargs used for that call. The return of this method does not affect the result of the lock check. It can be used e.g. to customize error messag...
[ "def", "at_access", "(", "self", ",", "result", ",", "accessing_obj", ",", "access_type", ",", "*", "*", "kwargs", ")", ":", "pass" ]
[ 1184, 4 ]
[ 1202, 12 ]
python
en
['en', 'error', 'th']
False
DefaultObject.at_before_move
(self, destination, **kwargs)
Called just before starting to move this object to destination. Args: destination (Object): The object we are moving to **kwargs (dict): Arbitrary, optional arguments for users overriding the call (unused by default). Returns: should...
Called just before starting to move this object to destination.
def at_before_move(self, destination, **kwargs): """ Called just before starting to move this object to destination. Args: destination (Object): The object we are moving to **kwargs (dict): Arbitrary, optional arguments for users overriding the ca...
[ "def", "at_before_move", "(", "self", ",", "destination", ",", "*", "*", "kwargs", ")", ":", "# return has_perm(self, destination, \"can_move\")", "return", "True" ]
[ 1206, 4 ]
[ 1225, 19 ]
python
en
['en', 'error', 'th']
False
DefaultObject.announce_move_from
(self, destination, msg=None, mapping=None, **kwargs)
Called if the move is to be announced. This is called while we are still standing in the old location. Args: destination (Object): The place we are going to. msg (str, optional): a replacement message. mapping (dict, optional): additional mapping obj...
Called if the move is to be announced. This is called while we are still standing in the old location.
def announce_move_from(self, destination, msg=None, mapping=None, **kwargs): """ Called if the move is to be announced. This is called while we are still standing in the old location. Args: destination (Object): The place we are going to. msg (str, option...
[ "def", "announce_move_from", "(", "self", ",", "destination", ",", "msg", "=", "None", ",", "mapping", "=", "None", ",", "*", "*", "kwargs", ")", ":", "if", "not", "self", ".", "location", ":", "return", "if", "msg", ":", "string", "=", "msg", "else"...
[ 1227, 4 ]
[ 1268, 72 ]
python
en
['en', 'error', 'th']
False
DefaultObject.announce_move_to
(self, source_location, msg=None, mapping=None, **kwargs)
Called after the move if the move was not quiet. At this point we are standing in the new location. Args: source_location (Object): The place we came from msg (str, optional): the replacement message if location. mapping (dict, optional): additional mapping ...
Called after the move if the move was not quiet. At this point we are standing in the new location.
def announce_move_to(self, source_location, msg=None, mapping=None, **kwargs): """ Called after the move if the move was not quiet. At this point we are standing in the new location. Args: source_location (Object): The place we came from msg (str, optional): the ...
[ "def", "announce_move_to", "(", "self", ",", "source_location", ",", "msg", "=", "None", ",", "mapping", "=", "None", ",", "*", "*", "kwargs", ")", ":", "if", "not", "source_location", "and", "self", ".", "location", ".", "has_account", ":", "# This was cr...
[ 1270, 4 ]
[ 1324, 75 ]
python
en
['en', 'error', 'th']
False
DefaultObject.at_after_move
(self, source_location, **kwargs)
Called after move has completed, regardless of quiet mode or not. Allows changes to the object due to the location it is now in. Args: source_location (Object): Wwhere we came from. This may be `None`. **kwargs (dict): Arbitrary, optional arguments for users ...
Called after move has completed, regardless of quiet mode or not. Allows changes to the object due to the location it is now in.
def at_after_move(self, source_location, **kwargs): """ Called after move has completed, regardless of quiet mode or not. Allows changes to the object due to the location it is now in. Args: source_location (Object): Wwhere we came from. This may be `None`. ...
[ "def", "at_after_move", "(", "self", ",", "source_location", ",", "*", "*", "kwargs", ")", ":", "pass" ]
[ 1326, 4 ]
[ 1338, 12 ]
python
en
['en', 'error', 'th']
False
DefaultObject.at_object_leave
(self, moved_obj, target_location, **kwargs)
Called just before an object leaves from inside this object Args: moved_obj (Object): The object leaving target_location (Object): Where `moved_obj` is going. **kwargs (dict): Arbitrary, optional arguments for users overriding the call (unused by def...
Called just before an object leaves from inside this object
def at_object_leave(self, moved_obj, target_location, **kwargs): """ Called just before an object leaves from inside this object Args: moved_obj (Object): The object leaving target_location (Object): Where `moved_obj` is going. **kwargs (dict): Arbitrary, opt...
[ "def", "at_object_leave", "(", "self", ",", "moved_obj", ",", "target_location", ",", "*", "*", "kwargs", ")", ":", "pass" ]
[ 1340, 4 ]
[ 1351, 12 ]
python
en
['en', 'error', 'th']
False
DefaultObject.at_object_receive
(self, moved_obj, source_location, **kwargs)
Called after an object has been moved into this object. Args: moved_obj (Object): The object moved into this one source_location (Object): Where `moved_object` came from. Note that this could be `None`. **kwargs (dict): Arbitrary, optional arguments ...
Called after an object has been moved into this object.
def at_object_receive(self, moved_obj, source_location, **kwargs): """ Called after an object has been moved into this object. Args: moved_obj (Object): The object moved into this one source_location (Object): Where `moved_object` came from. Note that thi...
[ "def", "at_object_receive", "(", "self", ",", "moved_obj", ",", "source_location", ",", "*", "*", "kwargs", ")", ":", "pass" ]
[ 1353, 4 ]
[ 1365, 12 ]
python
en
['en', 'error', 'th']
False
DefaultObject.at_traverse
(self, traversing_object, target_location, **kwargs)
This hook is responsible for handling the actual traversal, normally by calling `traversing_object.move_to(target_location)`. It is normally only implemented by Exit objects. If it returns False (usually because `move_to` returned False), `at_after_traverse` below should...
This hook is responsible for handling the actual traversal, normally by calling `traversing_object.move_to(target_location)`. It is normally only implemented by Exit objects. If it returns False (usually because `move_to` returned False), `at_after_traverse` below should...
def at_traverse(self, traversing_object, target_location, **kwargs): """ This hook is responsible for handling the actual traversal, normally by calling `traversing_object.move_to(target_location)`. It is normally only implemented by Exit objects. If it returns False (usually ...
[ "def", "at_traverse", "(", "self", ",", "traversing_object", ",", "target_location", ",", "*", "*", "kwargs", ")", ":", "pass" ]
[ 1367, 4 ]
[ 1384, 12 ]
python
en
['en', 'error', 'th']
False
DefaultObject.at_after_traverse
(self, traversing_object, source_location, **kwargs)
Called just after an object successfully used this object to traverse to another object (i.e. this object is a type of Exit) Args: traversing_object (Object): The object traversing us. source_location (Object): Where `traversing_object` came from. **...
Called just after an object successfully used this object to traverse to another object (i.e. this object is a type of Exit)
def at_after_traverse(self, traversing_object, source_location, **kwargs): """ Called just after an object successfully used this object to traverse to another object (i.e. this object is a type of Exit) Args: traversing_object (Object): The object traversing us. ...
[ "def", "at_after_traverse", "(", "self", ",", "traversing_object", ",", "source_location", ",", "*", "*", "kwargs", ")", ":", "pass" ]
[ 1386, 4 ]
[ 1401, 12 ]
python
en
['en', 'error', 'th']
False
DefaultObject.at_failed_traverse
(self, traversing_object, **kwargs)
This is called if an object fails to traverse this object for some reason. Args: traversing_object (Object): The object that failed traversing us. **kwargs (dict): Arbitrary, optional arguments for users overriding the call (unused by default). ...
This is called if an object fails to traverse this object for some reason.
def at_failed_traverse(self, traversing_object, **kwargs): """ This is called if an object fails to traverse this object for some reason. Args: traversing_object (Object): The object that failed traversing us. **kwargs (dict): Arbitrary, optional arguments for us...
[ "def", "at_failed_traverse", "(", "self", ",", "traversing_object", ",", "*", "*", "kwargs", ")", ":", "pass" ]
[ 1403, 4 ]
[ 1419, 12 ]
python
en
['en', 'error', 'th']
False
DefaultObject.at_msg_receive
(self, text=None, from_obj=None, **kwargs)
This hook is called whenever someone sends a message to this object using the `msg` method. Note that from_obj may be None if the sender did not include itself as an argument to the obj.msg() call - so you have to check for this. . Consider this a pre-processing method...
This hook is called whenever someone sends a message to this object using the `msg` method.
def at_msg_receive(self, text=None, from_obj=None, **kwargs): """ This hook is called whenever someone sends a message to this object using the `msg` method. Note that from_obj may be None if the sender did not include itself as an argument to the obj.msg() call - so you have to...
[ "def", "at_msg_receive", "(", "self", ",", "text", "=", "None", ",", "from_obj", "=", "None", ",", "*", "*", "kwargs", ")", ":", "return", "True" ]
[ 1421, 4 ]
[ 1449, 19 ]
python
en
['en', 'error', 'th']
False
DefaultObject.at_msg_send
(self, text=None, to_obj=None, **kwargs)
This is a hook that is called when *this* object sends a message to another object with `obj.msg(text, to_obj=obj)`. Args: text (str, optional): Text to send. to_obj (any, optional): The object to send to. Kwargs: Keywords passed from msg() ...
This is a hook that is called when *this* object sends a message to another object with `obj.msg(text, to_obj=obj)`.
def at_msg_send(self, text=None, to_obj=None, **kwargs): """ This is a hook that is called when *this* object sends a message to another object with `obj.msg(text, to_obj=obj)`. Args: text (str, optional): Text to send. to_obj (any, optional): The object to send ...
[ "def", "at_msg_send", "(", "self", ",", "text", "=", "None", ",", "to_obj", "=", "None", ",", "*", "*", "kwargs", ")", ":", "pass" ]
[ 1451, 4 ]
[ 1469, 12 ]
python
en
['en', 'error', 'th']
False
DefaultObject.return_appearance
(self, looker, **kwargs)
This formats a description. It is the hook a 'look' command should call. Args: looker (Object): Object doing the looking. **kwargs (dict): Arbitrary, optional arguments for users overriding the call (unused by default).
This formats a description. It is the hook a 'look' command should call.
def return_appearance(self, looker, **kwargs): """ This formats a description. It is the hook a 'look' command should call. Args: looker (Object): Object doing the looking. **kwargs (dict): Arbitrary, optional arguments for users overriding the ca...
[ "def", "return_appearance", "(", "self", ",", "looker", ",", "*", "*", "kwargs", ")", ":", "if", "not", "looker", ":", "return", "\"\"", "# get and identify all objects", "visible", "=", "(", "con", "for", "con", "in", "self", ".", "contents", "if", "con",...
[ 1473, 4 ]
[ 1518, 21 ]
python
en
['en', 'error', 'th']
False
DefaultObject.at_look
(self, target, **kwargs)
Called when this object performs a look. It allows to customize just what this means. It will not itself send any data. Args: target (Object): The target being looked at. This is commonly an object or the current location. It will be checked ...
Called when this object performs a look. It allows to customize just what this means. It will not itself send any data.
def at_look(self, target, **kwargs): """ Called when this object performs a look. It allows to customize just what this means. It will not itself send any data. Args: target (Object): The target being looked at. This is commonly an object or the curre...
[ "def", "at_look", "(", "self", ",", "target", ",", "*", "*", "kwargs", ")", ":", "if", "not", "target", ".", "access", "(", "self", ",", "\"view\"", ")", ":", "try", ":", "return", "\"Could not view '%s'.\"", "%", "target", ".", "get_display_name", "(", ...
[ 1520, 4 ]
[ 1550, 26 ]
python
en
['en', 'error', 'th']
False
DefaultObject.at_desc
(self, looker=None, **kwargs)
This is called whenever someone looks at this object. Args: looker (Object, optional): The object requesting the description. **kwargs (dict): Arbitrary, optional arguments for users overriding the call (unused by default).
This is called whenever someone looks at this object.
def at_desc(self, looker=None, **kwargs): """ This is called whenever someone looks at this object. Args: looker (Object, optional): The object requesting the description. **kwargs (dict): Arbitrary, optional arguments for users overriding the call (unuse...
[ "def", "at_desc", "(", "self", ",", "looker", "=", "None", ",", "*", "*", "kwargs", ")", ":", "pass" ]
[ 1552, 4 ]
[ 1562, 12 ]
python
en
['en', 'error', 'th']
False
DefaultObject.at_before_get
(self, getter, **kwargs)
Called by the default `get` command before this object has been picked up. Args: getter (Object): The object about to get this object. **kwargs (dict): Arbitrary, optional arguments for users overriding the call (unused by default). Returns: ...
Called by the default `get` command before this object has been picked up.
def at_before_get(self, getter, **kwargs): """ Called by the default `get` command before this object has been picked up. Args: getter (Object): The object about to get this object. **kwargs (dict): Arbitrary, optional arguments for users overridi...
[ "def", "at_before_get", "(", "self", ",", "getter", ",", "*", "*", "kwargs", ")", ":", "return", "True" ]
[ 1564, 4 ]
[ 1581, 19 ]
python
en
['en', 'error', 'th']
False
DefaultObject.at_get
(self, getter, **kwargs)
Called by the default `get` command when this object has been picked up. Args: getter (Object): The object getting this object. **kwargs (dict): Arbitrary, optional arguments for users overriding the call (unused by default). Notes: ...
Called by the default `get` command when this object has been picked up.
def at_get(self, getter, **kwargs): """ Called by the default `get` command when this object has been picked up. Args: getter (Object): The object getting this object. **kwargs (dict): Arbitrary, optional arguments for users overriding the call (u...
[ "def", "at_get", "(", "self", ",", "getter", ",", "*", "*", "kwargs", ")", ":", "pass" ]
[ 1583, 4 ]
[ 1598, 12 ]
python
en
['en', 'error', 'th']
False
DefaultObject.at_before_give
(self, giver, getter, **kwargs)
Called by the default `give` command before this object has been given. Args: giver (Object): The object about to give this object. getter (Object): The object about to get this object. **kwargs (dict): Arbitrary, optional arguments for users ...
Called by the default `give` command before this object has been given.
def at_before_give(self, giver, getter, **kwargs): """ Called by the default `give` command before this object has been given. Args: giver (Object): The object about to give this object. getter (Object): The object about to get this object. **kwargs (...
[ "def", "at_before_give", "(", "self", ",", "giver", ",", "getter", ",", "*", "*", "kwargs", ")", ":", "return", "True" ]
[ 1600, 4 ]
[ 1619, 19 ]
python
en
['en', 'error', 'th']
False
DefaultObject.at_give
(self, giver, getter, **kwargs)
Called by the default `give` command when this object has been given. Args: giver (Object): The object giving this object. getter (Object): The object getting this object. **kwargs (dict): Arbitrary, optional arguments for users overriding th...
Called by the default `give` command when this object has been given.
def at_give(self, giver, getter, **kwargs): """ Called by the default `give` command when this object has been given. Args: giver (Object): The object giving this object. getter (Object): The object getting this object. **kwargs (dict): Arbitrary, opt...
[ "def", "at_give", "(", "self", ",", "giver", ",", "getter", ",", "*", "*", "kwargs", ")", ":", "pass" ]
[ 1621, 4 ]
[ 1637, 12 ]
python
en
['en', 'error', 'th']
False
DefaultObject.at_before_drop
(self, dropper, **kwargs)
Called by the default `drop` command before this object has been dropped. Args: dropper (Object): The object which will drop this object. **kwargs (dict): Arbitrary, optional arguments for users overriding the call (unused by default). Returns: ...
Called by the default `drop` command before this object has been dropped.
def at_before_drop(self, dropper, **kwargs): """ Called by the default `drop` command before this object has been dropped. Args: dropper (Object): The object which will drop this object. **kwargs (dict): Arbitrary, optional arguments for users ove...
[ "def", "at_before_drop", "(", "self", ",", "dropper", ",", "*", "*", "kwargs", ")", ":", "return", "True" ]
[ 1639, 4 ]
[ 1657, 19 ]
python
en
['en', 'error', 'th']
False
DefaultObject.at_drop
(self, dropper, **kwargs)
Called by the default `drop` command when this object has been dropped. Args: dropper (Object): The object which just dropped this object. **kwargs (dict): Arbitrary, optional arguments for users overriding the call (unused by default). Notes: ...
Called by the default `drop` command when this object has been dropped.
def at_drop(self, dropper, **kwargs): """ Called by the default `drop` command when this object has been dropped. Args: dropper (Object): The object which just dropped this object. **kwargs (dict): Arbitrary, optional arguments for users overridin...
[ "def", "at_drop", "(", "self", ",", "dropper", ",", "*", "*", "kwargs", ")", ":", "pass" ]
[ 1659, 4 ]
[ 1674, 12 ]
python
en
['en', 'error', 'th']
False
DefaultObject.at_before_say
(self, message, **kwargs)
Before the object says something. This hook is by default used by the 'say' and 'whisper' commands as used by this command it is called before the text is said/whispered and can be used to customize the outgoing text from the object. Returning `None` aborts the command. ...
Before the object says something.
def at_before_say(self, message, **kwargs): """ Before the object says something. This hook is by default used by the 'say' and 'whisper' commands as used by this command it is called before the text is said/whispered and can be used to customize the outgoing text from t...
[ "def", "at_before_say", "(", "self", ",", "message", ",", "*", "*", "kwargs", ")", ":", "return", "message" ]
[ 1676, 4 ]
[ 1698, 22 ]
python
en
['en', 'error', 'th']
False
DefaultObject.at_say
(self, message, msg_self=None, msg_location=None, receivers=None, msg_receivers=None, **kwargs)
Display the actual say (or whisper) of self. This hook should display the actual say/whisper of the object in its location. It should both alert the object (self) and its location that some text is spoken. The overriding of messages or `mapping` allows for simple customizatio...
Display the actual say (or whisper) of self.
def at_say(self, message, msg_self=None, msg_location=None, receivers=None, msg_receivers=None, **kwargs): """ Display the actual say (or whisper) of self. This hook should display the actual say/whisper of the object in its location. It should both alert the object (sel...
[ "def", "at_say", "(", "self", ",", "message", ",", "msg_self", "=", "None", ",", "msg_location", "=", "None", ",", "receivers", "=", "None", ",", "msg_receivers", "=", "None", ",", "*", "*", "kwargs", ")", ":", "msg_type", "=", "'say'", "if", "kwargs",...
[ 1700, 4 ]
[ 1810, 64 ]
python
en
['en', 'error', 'th']
False
DefaultCharacter.basetype_setup
(self)
Setup character-specific security. You should normally not need to overload this, but if you do, make sure to reproduce at least the two last commands in this method (unless you want to fundamentally change how a Character object works).
Setup character-specific security.
def basetype_setup(self): """ Setup character-specific security. You should normally not need to overload this, but if you do, make sure to reproduce at least the two last commands in this method (unless you want to fundamentally change how a Character object works). ...
[ "def", "basetype_setup", "(", "self", ")", ":", "super", "(", "DefaultCharacter", ",", "self", ")", ".", "basetype_setup", "(", ")", "self", ".", "locks", ".", "add", "(", "\";\"", ".", "join", "(", "[", "\"get:false()\"", ",", "# noone can pick up the chara...
[ 1824, 4 ]
[ 1838, 74 ]
python
en
['en', 'error', 'th']
False
DefaultCharacter.at_after_move
(self, source_location, **kwargs)
We make sure to look around after a move.
We make sure to look around after a move.
def at_after_move(self, source_location, **kwargs): """ We make sure to look around after a move. """ if self.location.access(self, "view"): self.msg(self.at_look(self.location))
[ "def", "at_after_move", "(", "self", ",", "source_location", ",", "*", "*", "kwargs", ")", ":", "if", "self", ".", "location", ".", "access", "(", "self", ",", "\"view\"", ")", ":", "self", ".", "msg", "(", "self", ".", "at_look", "(", "self", ".", ...
[ 1840, 4 ]
[ 1846, 49 ]
python
en
['en', 'error', 'th']
False
DefaultCharacter.at_pre_puppet
(self, account, session=None, **kwargs)
Return the character from storage in None location in `at_post_unpuppet`. Args: account (Account): This is the connecting account. session (Session): Session controlling the connection.
Return the character from storage in None location in `at_post_unpuppet`. Args: account (Account): This is the connecting account. session (Session): Session controlling the connection.
def at_pre_puppet(self, account, session=None, **kwargs): """ Return the character from storage in None location in `at_post_unpuppet`. Args: account (Account): This is the connecting account. session (Session): Session controlling the connection. """ if s...
[ "def", "at_pre_puppet", "(", "self", ",", "account", ",", "session", "=", "None", ",", "*", "*", "kwargs", ")", ":", "if", "self", ".", "location", "is", "None", ":", "# Make sure character's location is never None before being puppeted.", "# Return to last location (...
[ 1848, 4 ]
[ 1862, 93 ]
python
en
['en', 'error', 'th']
False
DefaultCharacter.at_post_puppet
(self, **kwargs)
Called just after puppeting has been completed and all Account<->Object links have been established. Args: **kwargs (dict): Arbitrary, optional arguments for users overriding the call (unused by default). Note: You can use `self.account` and `sel...
Called just after puppeting has been completed and all Account<->Object links have been established.
def at_post_puppet(self, **kwargs): """ Called just after puppeting has been completed and all Account<->Object links have been established. Args: **kwargs (dict): Arbitrary, optional arguments for users overriding the call (unused by default). Note: ...
[ "def", "at_post_puppet", "(", "self", ",", "*", "*", "kwargs", ")", ":", "self", ".", "msg", "(", "\"\\nYou become |c%s|n.\\n\"", "%", "self", ".", "name", ")", "self", ".", "msg", "(", "(", "self", ".", "at_look", "(", "self", ".", "location", ")", ...
[ 1864, 4 ]
[ 1884, 74 ]
python
en
['en', 'error', 'th']
False
DefaultCharacter.at_post_unpuppet
(self, account, session=None, **kwargs)
We stove away the character when the account goes ooc/logs off, otherwise the character object will remain in the room also after the account logged off ("headless", so to say). Args: account (Account): The account object that just disconnected from this obj...
We stove away the character when the account goes ooc/logs off, otherwise the character object will remain in the room also after the account logged off ("headless", so to say).
def at_post_unpuppet(self, account, session=None, **kwargs): """ We stove away the character when the account goes ooc/logs off, otherwise the character object will remain in the room also after the account logged off ("headless", so to say). Args: account (Account):...
[ "def", "at_post_unpuppet", "(", "self", ",", "account", ",", "session", "=", "None", ",", "*", "*", "kwargs", ")", ":", "if", "not", "self", ".", "sessions", ".", "count", "(", ")", ":", "# only remove this char from grid if no sessions control it anymore.", "if...
[ 1886, 4 ]
[ 1907, 36 ]
python
en
['en', 'error', 'th']
False
DefaultCharacter.idle_time
(self)
Returns the idle time of the least idle session in seconds. If no sessions are connected it returns nothing.
Returns the idle time of the least idle session in seconds. If no sessions are connected it returns nothing.
def idle_time(self): """ Returns the idle time of the least idle session in seconds. If no sessions are connected it returns nothing. """ idle = [session.cmd_last_visible for session in self.sessions.all()] if idle: return time.time() - float(max(idle)) ...
[ "def", "idle_time", "(", "self", ")", ":", "idle", "=", "[", "session", ".", "cmd_last_visible", "for", "session", "in", "self", ".", "sessions", ".", "all", "(", ")", "]", "if", "idle", ":", "return", "time", ".", "time", "(", ")", "-", "float", "...
[ 1910, 4 ]
[ 1918, 19 ]
python
en
['en', 'error', 'th']
False
DefaultCharacter.connection_time
(self)
Returns the maximum connection time of all connected sessions in seconds. Returns nothing if there are no sessions.
Returns the maximum connection time of all connected sessions in seconds. Returns nothing if there are no sessions.
def connection_time(self): """ Returns the maximum connection time of all connected sessions in seconds. Returns nothing if there are no sessions. """ conn = [session.conn_time for session in self.sessions.all()] if conn: return time.time() - float(min(conn)) ...
[ "def", "connection_time", "(", "self", ")", ":", "conn", "=", "[", "session", ".", "conn_time", "for", "session", "in", "self", ".", "sessions", ".", "all", "(", ")", "]", "if", "conn", ":", "return", "time", ".", "time", "(", ")", "-", "float", "(...
[ 1921, 4 ]
[ 1929, 19 ]
python
en
['en', 'error', 'th']
False
DefaultRoom.basetype_setup
(self)
Simple room setup setting locks to make sure the room cannot be picked up.
Simple room setup setting locks to make sure the room cannot be picked up.
def basetype_setup(self): """ Simple room setup setting locks to make sure the room cannot be picked up. """ super(DefaultRoom, self).basetype_setup() self.locks.add(";".join(["get:false()", "puppet:false()"])) # would be weird to puppe...
[ "def", "basetype_setup", "(", "self", ")", ":", "super", "(", "DefaultRoom", ",", "self", ")", ".", "basetype_setup", "(", ")", "self", ".", "locks", ".", "add", "(", "\";\"", ".", "join", "(", "[", "\"get:false()\"", ",", "\"puppet:false()\"", "]", ")",...
[ 1941, 4 ]
[ 1951, 28 ]
python
en
['en', 'error', 'th']
False
ExitCommand.func
(self)
Default exit traverse if no syscommand is defined.
Default exit traverse if no syscommand is defined.
def func(self): """ Default exit traverse if no syscommand is defined. """ if self.obj.access(self.caller, 'traverse'): # we may traverse the exit. self.obj.at_traverse(self.caller, self.obj.destination) else: # exit is locked if s...
[ "def", "func", "(", "self", ")", ":", "if", "self", ".", "obj", ".", "access", "(", "self", ".", "caller", ",", "'traverse'", ")", ":", "# we may traverse the exit.", "self", ".", "obj", ".", "at_traverse", "(", "self", ".", "caller", ",", "self", ".",...
[ 1966, 4 ]
[ 1981, 56 ]
python
en
['en', 'error', 'th']
False
ExitCommand.get_extra_info
(self, caller, **kwargs)
Shows a bit of information on where the exit leads. Args: caller (Object): The object (usually a character) that entered an ambiguous command. **kwargs (dict): Arbitrary, optional arguments for users overriding the call (unused by default). Returns: ...
Shows a bit of information on where the exit leads.
def get_extra_info(self, caller, **kwargs): """ Shows a bit of information on where the exit leads. Args: caller (Object): The object (usually a character) that entered an ambiguous command. **kwargs (dict): Arbitrary, optional arguments for users overrid...
[ "def", "get_extra_info", "(", "self", ",", "caller", ",", "*", "*", "kwargs", ")", ":", "if", "self", ".", "obj", ".", "destination", ":", "return", "\" (exit to %s)\"", "%", "self", ".", "obj", ".", "destination", ".", "get_display_name", "(", "caller", ...
[ 1983, 4 ]
[ 1998, 62 ]
python
en
['en', 'error', 'th']
False
DefaultExit.create_exit_cmdset
(self, exidbobj)
Helper function for creating an exit command set + command. The command of this cmdset has the same name as the Exit object and allows the exit to react when the account enter the exit's name, triggering the movement between rooms. Args: exidbobj (Object): The Defa...
Helper function for creating an exit command set + command.
def create_exit_cmdset(self, exidbobj): """ Helper function for creating an exit command set + command. The command of this cmdset has the same name as the Exit object and allows the exit to react when the account enter the exit's name, triggering the movement between rooms. ...
[ "def", "create_exit_cmdset", "(", "self", ",", "exidbobj", ")", ":", "# create an exit command. We give the properties here,", "# to always trigger metaclass preparations", "cmd", "=", "self", ".", "exit_command", "(", "key", "=", "exidbobj", ".", "db_key", ".", "strip", ...
[ 2022, 4 ]
[ 2052, 26 ]
python
en
['en', 'error', 'th']
False
DefaultExit.basetype_setup
(self)
Setup exit-security You should normally not need to overload this - if you do make sure you include all the functionality in this method.
Setup exit-security
def basetype_setup(self): """ Setup exit-security You should normally not need to overload this - if you do make sure you include all the functionality in this method. """ super(DefaultExit, self).basetype_setup() # setting default locks (overload these in at_o...
[ "def", "basetype_setup", "(", "self", ")", ":", "super", "(", "DefaultExit", ",", "self", ")", ".", "basetype_setup", "(", ")", "# setting default locks (overload these in at_object_creation()", "self", ".", "locks", ".", "add", "(", "\";\"", ".", "join", "(", "...
[ 2056, 4 ]
[ 2073, 44 ]
python
en
['en', 'error', 'th']
False
DefaultExit.at_cmdset_get
(self, **kwargs)
Called just before cmdsets on this object are requested by the command handler. If changes need to be done on the fly to the cmdset before passing them on to the cmdhandler, this is the place to do it. This is called also if the object currently has no cmdsets. Kwargs: ...
Called just before cmdsets on this object are requested by the command handler. If changes need to be done on the fly to the cmdset before passing them on to the cmdhandler, this is the place to do it. This is called also if the object currently has no cmdsets.
def at_cmdset_get(self, **kwargs): """ Called just before cmdsets on this object are requested by the command handler. If changes need to be done on the fly to the cmdset before passing them on to the cmdhandler, this is the place to do it. This is called also if the object curre...
[ "def", "at_cmdset_get", "(", "self", ",", "*", "*", "kwargs", ")", ":", "if", "\"force_init\"", "in", "kwargs", "or", "not", "self", ".", "cmdset", ".", "has_cmdset", "(", "\"ExitCmdSet\"", ",", "must_be_default", "=", "True", ")", ":", "# we are resetting, ...
[ 2075, 4 ]
[ 2091, 83 ]
python
en
['en', 'error', 'th']
False
DefaultExit.at_init
(self)
This is called when this objects is re-loaded from cache. When that happens, we make sure to remove any old ExitCmdSet cmdset (this most commonly occurs when renaming an existing exit)
This is called when this objects is re-loaded from cache. When that happens, we make sure to remove any old ExitCmdSet cmdset (this most commonly occurs when renaming an existing exit)
def at_init(self): """ This is called when this objects is re-loaded from cache. When that happens, we make sure to remove any old ExitCmdSet cmdset (this most commonly occurs when renaming an existing exit) """ self.cmdset.remove_default()
[ "def", "at_init", "(", "self", ")", ":", "self", ".", "cmdset", ".", "remove_default", "(", ")" ]
[ 2093, 4 ]
[ 2099, 36 ]
python
en
['en', 'error', 'th']
False
DefaultExit.at_traverse
(self, traversing_object, target_location, **kwargs)
This implements the actual traversal. The traverse lock has already been checked (in the Exit command) at this point. Args: traversing_object (Object): Object traversing us. target_location (Object): Where target is going. **kwargs (dict): Arbitrary, optiona...
This implements the actual traversal. The traverse lock has already been checked (in the Exit command) at this point.
def at_traverse(self, traversing_object, target_location, **kwargs): """ This implements the actual traversal. The traverse lock has already been checked (in the Exit command) at this point. Args: traversing_object (Object): Object traversing us. target_location ...
[ "def", "at_traverse", "(", "self", ",", "traversing_object", ",", "target_location", ",", "*", "*", "kwargs", ")", ":", "source_location", "=", "traversing_object", ".", "location", "if", "traversing_object", ".", "move_to", "(", "target_location", ")", ":", "se...
[ 2101, 4 ]
[ 2122, 58 ]
python
en
['en', 'error', 'th']
False
DefaultExit.at_failed_traverse
(self, traversing_object, **kwargs)
Overloads the default hook to implement a simple default error message. Args: traversing_object (Object): The object that failed traversing us. **kwargs (dict): Arbitrary, optional arguments for users overriding the call (unused by default). Notes: ...
Overloads the default hook to implement a simple default error message.
def at_failed_traverse(self, traversing_object, **kwargs): """ Overloads the default hook to implement a simple default error message. Args: traversing_object (Object): The object that failed traversing us. **kwargs (dict): Arbitrary, optional arguments for users ...
[ "def", "at_failed_traverse", "(", "self", ",", "traversing_object", ",", "*", "*", "kwargs", ")", ":", "traversing_object", ".", "msg", "(", "\"You cannot go there.\"", ")" ]
[ 2124, 4 ]
[ 2139, 53 ]
python
en
['en', 'error', 'th']
False
_to_account
(accessing_obj)
Helper function. Makes sure an accessing object is an account object
Helper function. Makes sure an accessing object is an account object
def _to_account(accessing_obj): "Helper function. Makes sure an accessing object is an account object" if utils.inherits_from(accessing_obj, "evennia.objects.objects.DefaultObject"): # an object. Convert to account. accessing_obj = accessing_obj.account return accessing_obj
[ "def", "_to_account", "(", "accessing_obj", ")", ":", "if", "utils", ".", "inherits_from", "(", "accessing_obj", ",", "\"evennia.objects.objects.DefaultObject\"", ")", ":", "# an object. Convert to account.", "accessing_obj", "=", "accessing_obj", ".", "account", "return"...
[ 101, 0 ]
[ 106, 24 ]
python
en
['en', 'en', 'en']
True
true
(*args, **kwargs)
Always returns True.
Always returns True.
def true(*args, **kwargs): "Always returns True." return True
[ "def", "true", "(", "*", "args", ",", "*", "*", "kwargs", ")", ":", "return", "True" ]
[ 111, 0 ]
[ 113, 15 ]
python
en
['en', 'nl', 'en']
True
false
(*args, **kwargs)
Always returns False
Always returns False
def false(*args, **kwargs): "Always returns False" return False
[ "def", "false", "(", "*", "args", ",", "*", "*", "kwargs", ")", ":", "return", "False" ]
[ 120, 0 ]
[ 122, 16 ]
python
en
['en', 'is', 'en']
True
self
(accessing_obj, accessed_obj, *args, **kwargs)
Check if accessing_obj is the same as accessed_obj Usage: self() This can be used to lock specifically only to the same object that the lock is defined on.
Check if accessing_obj is the same as accessed_obj
def self(accessing_obj, accessed_obj, *args, **kwargs): """ Check if accessing_obj is the same as accessed_obj Usage: self() This can be used to lock specifically only to the same object that the lock is defined on. """ return accessing_obj == accessed_obj
[ "def", "self", "(", "accessing_obj", ",", "accessed_obj", ",", "*", "args", ",", "*", "*", "kwargs", ")", ":", "return", "accessing_obj", "==", "accessed_obj" ]
[ 129, 0 ]
[ 139, 40 ]
python
en
['en', 'error', 'th']
False
perm
(accessing_obj, accessed_obj, *args, **kwargs)
The basic permission-checker. Ignores case. Usage: perm(<permission>) where <permission> is the permission accessing_obj must have in order to pass the lock. If the given permission is part of settings.PERMISSION_HIERARCHY, permission is also granted to all ranks higher up in the hier...
The basic permission-checker. Ignores case.
def perm(accessing_obj, accessed_obj, *args, **kwargs): """ The basic permission-checker. Ignores case. Usage: perm(<permission>) where <permission> is the permission accessing_obj must have in order to pass the lock. If the given permission is part of settings.PERMISSION_HIERARCHY, ...
[ "def", "perm", "(", "accessing_obj", ",", "accessed_obj", ",", "*", "args", ",", "*", "*", "kwargs", ")", ":", "# this allows the perm_above lockfunc to make use of this function too", "try", ":", "permission", "=", "args", "[", "0", "]", ".", "lower", "(", ")",...
[ 142, 0 ]
[ 235, 16 ]
python
en
['en', 'error', 'th']
False
perm_above
(accessing_obj, accessed_obj, *args, **kwargs)
Only allow objects with a permission *higher* in the permission hierarchy than the one given. If there is no such higher rank, it's assumed we refer to superuser. If no hierarchy is defined, this function has no meaning and returns False.
Only allow objects with a permission *higher* in the permission hierarchy than the one given. If there is no such higher rank, it's assumed we refer to superuser. If no hierarchy is defined, this function has no meaning and returns False.
def perm_above(accessing_obj, accessed_obj, *args, **kwargs): """ Only allow objects with a permission *higher* in the permission hierarchy than the one given. If there is no such higher rank, it's assumed we refer to superuser. If no hierarchy is defined, this function has no meaning and returns Fa...
[ "def", "perm_above", "(", "accessing_obj", ",", "accessed_obj", ",", "*", "args", ",", "*", "*", "kwargs", ")", ":", "kwargs", "[", "\"_greater_than\"", "]", "=", "True", "return", "perm", "(", "accessing_obj", ",", "accessed_obj", ",", "*", "args", ",", ...
[ 238, 0 ]
[ 246, 61 ]
python
en
['en', 'error', 'th']
False
pperm
(accessing_obj, accessed_obj, *args, **kwargs)
The basic permission-checker only for Account objects. Ignores case. Usage: pperm(<permission>) where <permission> is the permission accessing_obj must have in order to pass the lock. If the given permission is part of _PERMISSION_HIERARCHY, permission is also granted to all ranks high...
The basic permission-checker only for Account objects. Ignores case.
def pperm(accessing_obj, accessed_obj, *args, **kwargs): """ The basic permission-checker only for Account objects. Ignores case. Usage: pperm(<permission>) where <permission> is the permission accessing_obj must have in order to pass the lock. If the given permission is part of _PERMIS...
[ "def", "pperm", "(", "accessing_obj", ",", "accessed_obj", ",", "*", "args", ",", "*", "*", "kwargs", ")", ":", "return", "perm", "(", "_to_account", "(", "accessing_obj", ")", ",", "accessed_obj", ",", "*", "args", ",", "*", "*", "kwargs", ")" ]
[ 249, 0 ]
[ 261, 74 ]
python
en
['en', 'error', 'th']
False
pperm_above
(accessing_obj, accessed_obj, *args, **kwargs)
Only allow Account objects with a permission *higher* in the permission hierarchy than the one given. If there is no such higher rank, it's assumed we refer to superuser. If no hierarchy is defined, this function has no meaning and returns False.
Only allow Account objects with a permission *higher* in the permission hierarchy than the one given. If there is no such higher rank, it's assumed we refer to superuser. If no hierarchy is defined, this function has no meaning and returns False.
def pperm_above(accessing_obj, accessed_obj, *args, **kwargs): """ Only allow Account objects with a permission *higher* in the permission hierarchy than the one given. If there is no such higher rank, it's assumed we refer to superuser. If no hierarchy is defined, this function has no meaning and r...
[ "def", "pperm_above", "(", "accessing_obj", ",", "accessed_obj", ",", "*", "args", ",", "*", "*", "kwargs", ")", ":", "return", "perm_above", "(", "_to_account", "(", "accessing_obj", ")", ",", "accessed_obj", ",", "*", "args", ",", "*", "*", "kwargs", "...
[ 263, 0 ]
[ 270, 80 ]
python
en
['en', 'error', 'th']
False
dbref
(accessing_obj, accessed_obj, *args, **kwargs)
Usage: dbref(3) This lock type checks if the checking object has a particular dbref. Note that this only works for checking objects that are stored in the database (e.g. not for commands)
Usage: dbref(3)
def dbref(accessing_obj, accessed_obj, *args, **kwargs): """ Usage: dbref(3) This lock type checks if the checking object has a particular dbref. Note that this only works for checking objects that are stored in the database (e.g. not for commands) """ if not args: return ...
[ "def", "dbref", "(", "accessing_obj", ",", "accessed_obj", ",", "*", "args", ",", "*", "*", "kwargs", ")", ":", "if", "not", "args", ":", "return", "False", "try", ":", "dbr", "=", "int", "(", "args", "[", "0", "]", ".", "strip", "(", ")", ".", ...
[ 273, 0 ]
[ 291, 16 ]
python
en
['en', 'error', 'th']
False
pdbref
(accessing_obj, accessed_obj, *args, **kwargs)
Same as dbref, but making sure accessing_obj is an account.
Same as dbref, but making sure accessing_obj is an account.
def pdbref(accessing_obj, accessed_obj, *args, **kwargs): """ Same as dbref, but making sure accessing_obj is an account. """ return dbref(_to_account(accessing_obj), accessed_obj, *args, **kwargs)
[ "def", "pdbref", "(", "accessing_obj", ",", "accessed_obj", ",", "*", "args", ",", "*", "*", "kwargs", ")", ":", "return", "dbref", "(", "_to_account", "(", "accessing_obj", ")", ",", "accessed_obj", ",", "*", "args", ",", "*", "*", "kwargs", ")" ]
[ 294, 0 ]
[ 298, 75 ]
python
en
['en', 'error', 'th']
False
id
(accessing_obj, accessed_obj, *args, **kwargs)
Alias to dbref
Alias to dbref
def id(accessing_obj, accessed_obj, *args, **kwargs): "Alias to dbref" return dbref(accessing_obj, accessed_obj, *args, **kwargs)
[ "def", "id", "(", "accessing_obj", ",", "accessed_obj", ",", "*", "args", ",", "*", "*", "kwargs", ")", ":", "return", "dbref", "(", "accessing_obj", ",", "accessed_obj", ",", "*", "args", ",", "*", "*", "kwargs", ")" ]
[ 301, 0 ]
[ 303, 62 ]
python
en
['en', 'sk', 'en']
True
pid
(accessing_obj, accessed_obj, *args, **kwargs)
Alias to dbref, for Accounts
Alias to dbref, for Accounts
def pid(accessing_obj, accessed_obj, *args, **kwargs): "Alias to dbref, for Accounts" return dbref(_to_account(accessing_obj), accessed_obj, *args, **kwargs)
[ "def", "pid", "(", "accessing_obj", ",", "accessed_obj", ",", "*", "args", ",", "*", "*", "kwargs", ")", ":", "return", "dbref", "(", "_to_account", "(", "accessing_obj", ")", ",", "accessed_obj", ",", "*", "args", ",", "*", "*", "kwargs", ")" ]
[ 306, 0 ]
[ 308, 75 ]
python
en
['en', 'en', 'en']
True
attr
(accessing_obj, accessed_obj, *args, **kwargs)
Usage: attr(attrname) attr(attrname, value) attr(attrname, value, compare=type) where compare's type is one of (eq,gt,lt,ge,le,ne) and signifies how the value should be compared with one on accessing_obj (so compare=gt means the accessing_obj must have a value greater than the on...
Usage: attr(attrname) attr(attrname, value) attr(attrname, value, compare=type)
def attr(accessing_obj, accessed_obj, *args, **kwargs): """ Usage: attr(attrname) attr(attrname, value) attr(attrname, value, compare=type) where compare's type is one of (eq,gt,lt,ge,le,ne) and signifies how the value should be compared with one on accessing_obj (so compare=gt me...
[ "def", "attr", "(", "accessing_obj", ",", "accessed_obj", ",", "*", "args", ",", "*", "*", "kwargs", ")", ":", "# deal with arguments", "if", "not", "args", ":", "return", "False", "attrname", "=", "args", "[", "0", "]", ".", "strip", "(", ")", "value"...
[ 321, 0 ]
[ 383, 16 ]
python
en
['en', 'error', 'th']
False
objattr
(accessing_obj, accessed_obj, *args, **kwargs)
Usage: objattr(attrname) objattr(attrname, value) objattr(attrname, value, compare=type) Works like attr, except it looks for an attribute on accessed_obj instead.
Usage: objattr(attrname) objattr(attrname, value) objattr(attrname, value, compare=type)
def objattr(accessing_obj, accessed_obj, *args, **kwargs): """ Usage: objattr(attrname) objattr(attrname, value) objattr(attrname, value, compare=type) Works like attr, except it looks for an attribute on accessed_obj instead. """ return attr(accessed_obj, accessed_obj, *args...
[ "def", "objattr", "(", "accessing_obj", ",", "accessed_obj", ",", "*", "args", ",", "*", "*", "kwargs", ")", ":", "return", "attr", "(", "accessed_obj", ",", "accessed_obj", ",", "*", "args", ",", "*", "*", "kwargs", ")" ]
[ 386, 0 ]
[ 397, 60 ]
python
en
['en', 'error', 'th']
False
locattr
(accessing_obj, accessed_obj, *args, **kwargs)
Usage: locattr(attrname) locattr(attrname, value) locattr(attrname, value, compare=type) Works like attr, except it looks for an attribute on accessing_obj.location, if such an entity exists. if accessing_obj has a property ".obj" (such as is the case for a Command), then access...
Usage: locattr(attrname) locattr(attrname, value) locattr(attrname, value, compare=type)
def locattr(accessing_obj, accessed_obj, *args, **kwargs): """ Usage: locattr(attrname) locattr(attrname, value) locattr(attrname, value, compare=type) Works like attr, except it looks for an attribute on accessing_obj.location, if such an entity exists. if accessing_obj has a pr...
[ "def", "locattr", "(", "accessing_obj", ",", "accessed_obj", ",", "*", "args", ",", "*", "*", "kwargs", ")", ":", "if", "hasattr", "(", "accessing_obj", ",", "\"obj\"", ")", ":", "accessing_obj", "=", "accessing_obj", ".", "obj", "if", "hasattr", "(", "a...
[ 400, 0 ]
[ 418, 16 ]
python
en
['en', 'error', 'th']
False
objlocattr
(accessing_obj, accessed_obj, *args, **kwargs)
Usage: locattr(attrname) locattr(attrname, value) locattr(attrname, value, compare=type) Works like attr, except it looks for an attribute on accessed_obj.location, if such an entity exists. if accessed_obj has a property ".obj" (such as is the case for a Command), then accessin...
Usage: locattr(attrname) locattr(attrname, value) locattr(attrname, value, compare=type)
def objlocattr(accessing_obj, accessed_obj, *args, **kwargs): """ Usage: locattr(attrname) locattr(attrname, value) locattr(attrname, value, compare=type) Works like attr, except it looks for an attribute on accessed_obj.location, if such an entity exists. if accessed_obj has a p...
[ "def", "objlocattr", "(", "accessing_obj", ",", "accessed_obj", ",", "*", "args", ",", "*", "*", "kwargs", ")", ":", "if", "hasattr", "(", "accessed_obj", ",", "\"obj\"", ")", ":", "accessed_obj", "=", "accessed_obj", ".", "obj", "if", "hasattr", "(", "a...
[ 421, 0 ]
[ 439, 16 ]
python
en
['en', 'error', 'th']
False
attr_eq
(accessing_obj, accessed_obj, *args, **kwargs)
Usage: attr_gt(attrname, 54)
Usage: attr_gt(attrname, 54)
def attr_eq(accessing_obj, accessed_obj, *args, **kwargs): """ Usage: attr_gt(attrname, 54) """ return attr(accessing_obj, accessed_obj, *args, **kwargs)
[ "def", "attr_eq", "(", "accessing_obj", ",", "accessed_obj", ",", "*", "args", ",", "*", "*", "kwargs", ")", ":", "return", "attr", "(", "accessing_obj", ",", "accessed_obj", ",", "*", "args", ",", "*", "*", "kwargs", ")" ]
[ 442, 0 ]
[ 447, 61 ]
python
en
['en', 'error', 'th']
False
attr_gt
(accessing_obj, accessed_obj, *args, **kwargs)
Usage: attr_gt(attrname, 54) Only true if access_obj's attribute > the value given.
Usage: attr_gt(attrname, 54)
def attr_gt(accessing_obj, accessed_obj, *args, **kwargs): """ Usage: attr_gt(attrname, 54) Only true if access_obj's attribute > the value given. """ return attr(accessing_obj, accessed_obj, *args, **{'compare': 'gt'})
[ "def", "attr_gt", "(", "accessing_obj", ",", "accessed_obj", ",", "*", "args", ",", "*", "*", "kwargs", ")", ":", "return", "attr", "(", "accessing_obj", ",", "accessed_obj", ",", "*", "args", ",", "*", "*", "{", "'compare'", ":", "'gt'", "}", ")" ]
[ 450, 0 ]
[ 457, 72 ]
python
en
['en', 'error', 'th']
False
attr_ge
(accessing_obj, accessed_obj, *args, **kwargs)
Usage: attr_gt(attrname, 54) Only true if access_obj's attribute >= the value given.
Usage: attr_gt(attrname, 54)
def attr_ge(accessing_obj, accessed_obj, *args, **kwargs): """ Usage: attr_gt(attrname, 54) Only true if access_obj's attribute >= the value given. """ return attr(accessing_obj, accessed_obj, *args, **{'compare': 'ge'})
[ "def", "attr_ge", "(", "accessing_obj", ",", "accessed_obj", ",", "*", "args", ",", "*", "*", "kwargs", ")", ":", "return", "attr", "(", "accessing_obj", ",", "accessed_obj", ",", "*", "args", ",", "*", "*", "{", "'compare'", ":", "'ge'", "}", ")" ]
[ 460, 0 ]
[ 467, 72 ]
python
en
['en', 'error', 'th']
False
attr_lt
(accessing_obj, accessed_obj, *args, **kwargs)
Usage: attr_gt(attrname, 54) Only true if access_obj's attribute < the value given.
Usage: attr_gt(attrname, 54)
def attr_lt(accessing_obj, accessed_obj, *args, **kwargs): """ Usage: attr_gt(attrname, 54) Only true if access_obj's attribute < the value given. """ return attr(accessing_obj, accessed_obj, *args, **{'compare': 'lt'})
[ "def", "attr_lt", "(", "accessing_obj", ",", "accessed_obj", ",", "*", "args", ",", "*", "*", "kwargs", ")", ":", "return", "attr", "(", "accessing_obj", ",", "accessed_obj", ",", "*", "args", ",", "*", "*", "{", "'compare'", ":", "'lt'", "}", ")" ]
[ 470, 0 ]
[ 477, 72 ]
python
en
['en', 'error', 'th']
False
attr_le
(accessing_obj, accessed_obj, *args, **kwargs)
Usage: attr_gt(attrname, 54) Only true if access_obj's attribute <= the value given.
Usage: attr_gt(attrname, 54)
def attr_le(accessing_obj, accessed_obj, *args, **kwargs): """ Usage: attr_gt(attrname, 54) Only true if access_obj's attribute <= the value given. """ return attr(accessing_obj, accessed_obj, *args, **{'compare': 'le'})
[ "def", "attr_le", "(", "accessing_obj", ",", "accessed_obj", ",", "*", "args", ",", "*", "*", "kwargs", ")", ":", "return", "attr", "(", "accessing_obj", ",", "accessed_obj", ",", "*", "args", ",", "*", "*", "{", "'compare'", ":", "'le'", "}", ")" ]
[ 480, 0 ]
[ 487, 72 ]
python
en
['en', 'error', 'th']
False
attr_ne
(accessing_obj, accessed_obj, *args, **kwargs)
Usage: attr_gt(attrname, 54) Only true if access_obj's attribute != the value given.
Usage: attr_gt(attrname, 54)
def attr_ne(accessing_obj, accessed_obj, *args, **kwargs): """ Usage: attr_gt(attrname, 54) Only true if access_obj's attribute != the value given. """ return attr(accessing_obj, accessed_obj, *args, **{'compare': 'ne'})
[ "def", "attr_ne", "(", "accessing_obj", ",", "accessed_obj", ",", "*", "args", ",", "*", "*", "kwargs", ")", ":", "return", "attr", "(", "accessing_obj", ",", "accessed_obj", ",", "*", "args", ",", "*", "*", "{", "'compare'", ":", "'ne'", "}", ")" ]
[ 490, 0 ]
[ 497, 72 ]
python
en
['en', 'error', 'th']
False
tag
(accessing_obj, accessed_obj, *args, **kwargs)
Usage: tag(tagkey) tag(tagkey, category) Only true if accessing_obj has the specified tag and optional category. If accessing_obj has the ".obj" property (such as is the case for a command), then accessing_obj.obj is used instead.
Usage: tag(tagkey) tag(tagkey, category)
def tag(accessing_obj, accessed_obj, *args, **kwargs): """ Usage: tag(tagkey) tag(tagkey, category) Only true if accessing_obj has the specified tag and optional category. If accessing_obj has the ".obj" property (such as is the case for a command), then accessing_obj.obj is use...
[ "def", "tag", "(", "accessing_obj", ",", "accessed_obj", ",", "*", "args", ",", "*", "*", "kwargs", ")", ":", "if", "hasattr", "(", "accessing_obj", ",", "\"obj\"", ")", ":", "accessing_obj", "=", "accessing_obj", ".", "obj", "tagkey", "=", "args", "[", ...
[ 500, 0 ]
[ 515, 66 ]
python
en
['en', 'error', 'th']
False
objtag
(accessing_obj, accessed_obj, *args, **kwargs)
Usage: objtag(tagkey) objtag(tagkey, category) Only true if accessed_obj has the specified tag and optional category.
Usage: objtag(tagkey) objtag(tagkey, category)
def objtag(accessing_obj, accessed_obj, *args, **kwargs): """ Usage: objtag(tagkey) objtag(tagkey, category) Only true if accessed_obj has the specified tag and optional category. """ return bool(accessed_obj.tags.get(*args))
[ "def", "objtag", "(", "accessing_obj", ",", "accessed_obj", ",", "*", "args", ",", "*", "*", "kwargs", ")", ":", "return", "bool", "(", "accessed_obj", ".", "tags", ".", "get", "(", "*", "args", ")", ")" ]
[ 518, 0 ]
[ 527, 45 ]
python
en
['en', 'error', 'th']
False
inside
(accessing_obj, accessed_obj, *args, **kwargs)
Usage: inside() Only true if accessing_obj is "inside" accessed_obj
Usage: inside()
def inside(accessing_obj, accessed_obj, *args, **kwargs): """ Usage: inside() Only true if accessing_obj is "inside" accessed_obj """ return accessing_obj.location == accessed_obj
[ "def", "inside", "(", "accessing_obj", ",", "accessed_obj", ",", "*", "args", ",", "*", "*", "kwargs", ")", ":", "return", "accessing_obj", ".", "location", "==", "accessed_obj" ]
[ 530, 0 ]
[ 537, 49 ]
python
en
['en', 'error', 'th']
False
holds
(accessing_obj, accessed_obj, *args, **kwargs)
Usage: holds() checks if accessed_obj or accessed_obj.obj is held by accessing_obj holds(key/dbref) checks if accessing_obj holds an object with given key/dbref holds(attrname, value) checks if accessing_obj holds an ...
Usage: holds() checks if accessed_obj or accessed_obj.obj is held by accessing_obj holds(key/dbref) checks if accessing_obj holds an object with given key/dbref holds(attrname, value) checks if accessing_obj holds an ...
def holds(accessing_obj, accessed_obj, *args, **kwargs): """ Usage: holds() checks if accessed_obj or accessed_obj.obj is held by accessing_obj holds(key/dbref) checks if accessing_obj holds an object with given key/dbref holds(at...
[ "def", "holds", "(", "accessing_obj", ",", "accessed_obj", ",", "*", "args", ",", "*", "*", "kwargs", ")", ":", "try", ":", "# commands and scripts don't have contents, so we are usually looking", "# for the contents of their .obj property instead (i.e. the object the", "# comm...
[ 540, 0 ]
[ 591, 16 ]
python
en
['en', 'error', 'th']
False
superuser
(*args, **kwargs)
Only accepts an accesing_obj that is superuser (e.g. user #1) Since a superuser would not ever reach this check (superusers bypass the lock entirely), any user who gets this far cannot be a superuser, hence we just return False. :)
Only accepts an accesing_obj that is superuser (e.g. user #1)
def superuser(*args, **kwargs): """ Only accepts an accesing_obj that is superuser (e.g. user #1) Since a superuser would not ever reach this check (superusers bypass the lock entirely), any user who gets this far cannot be a superuser, hence we just return False. :) """ return False
[ "def", "superuser", "(", "*", "args", ",", "*", "*", "kwargs", ")", ":", "return", "False" ]
[ 594, 0 ]
[ 602, 16 ]
python
en
['en', 'error', 'th']
False
has_account
(accessing_obj, accessed_obj, *args, **kwargs)
Only returns true if accessing_obj has_account is true, that is, this is an account-controlled object. It fails on actual accounts! This is a useful lock for traverse-locking Exits to restrain NPC mobiles from moving outside their areas.
Only returns true if accessing_obj has_account is true, that is, this is an account-controlled object. It fails on actual accounts!
def has_account(accessing_obj, accessed_obj, *args, **kwargs): """ Only returns true if accessing_obj has_account is true, that is, this is an account-controlled object. It fails on actual accounts! This is a useful lock for traverse-locking Exits to restrain NPC mobiles from moving outside their a...
[ "def", "has_account", "(", "accessing_obj", ",", "accessed_obj", ",", "*", "args", ",", "*", "*", "kwargs", ")", ":", "return", "hasattr", "(", "accessing_obj", ",", "\"has_account\"", ")", "and", "accessing_obj", ".", "has_account" ]
[ 605, 0 ]
[ 613, 78 ]
python
en
['en', 'error', 'th']
False
serversetting
(accessing_obj, accessed_obj, *args, **kwargs)
Only returns true if the Evennia settings exists, alternatively has a certain value. Usage: serversetting(IRC_ENABLED) serversetting(BASE_SCRIPT_PATH, ['types']) A given True/False or integers will be converted properly. Note that everything will enter this function as strings, so the...
Only returns true if the Evennia settings exists, alternatively has a certain value.
def serversetting(accessing_obj, accessed_obj, *args, **kwargs): """ Only returns true if the Evennia settings exists, alternatively has a certain value. Usage: serversetting(IRC_ENABLED) serversetting(BASE_SCRIPT_PATH, ['types']) A given True/False or integers will be converted proper...
[ "def", "serversetting", "(", "accessing_obj", ",", "accessed_obj", ",", "*", "args", ",", "*", "*", "kwargs", ")", ":", "if", "not", "args", "or", "not", "args", "[", "0", "]", ":", "return", "False", "if", "len", "(", "args", ")", "<", "2", ":", ...
[ 616, 0 ]
[ 645, 16 ]
python
en
['en', 'error', 'th']
False
ButtonTests.test_primary
(self)
Test the standard button
Test the standard button
def test_primary(self): """ Test the standard button """ item = create_content_item(ButtonItem, url='http://example.com', style='btn-primary', title='TEST') self.assertHTMLEqual(render_content_items([item]).html, u'<a href="http://example.com" class="btn btn-primary">TEST</a>')
[ "def", "test_primary", "(", "self", ")", ":", "item", "=", "create_content_item", "(", "ButtonItem", ",", "url", "=", "'http://example.com'", ",", "style", "=", "'btn-primary'", ",", "title", "=", "'TEST'", ")", "self", ".", "assertHTMLEqual", "(", "render_con...
[ 11, 4 ]
[ 16, 129 ]
python
en
['en', 'error', 'th']
False
ButtonTests.test_align_center
(self)
Test the center-align feature.
Test the center-align feature.
def test_align_center(self): """ Test the center-align feature. """ item = create_content_item(ButtonItem, url='http://example.com', style='btn-default', title='TEST2', align='center') self.assertHTMLEqual( render_content_items([item]).html, u'<p class="te...
[ "def", "test_align_center", "(", "self", ")", ":", "item", "=", "create_content_item", "(", "ButtonItem", ",", "url", "=", "'http://example.com'", ",", "style", "=", "'btn-default'", ",", "title", "=", "'TEST2'", ",", "align", "=", "'center'", ")", "self", "...
[ 18, 4 ]
[ 26, 9 ]
python
en
['en', 'error', 'th']
False
canopy_temperature
(setpoints: Setpoints, states: ClimateStates, weather: Weather)
Equation 2.1 / 8.1 [W m-2] cap_canopy * t_Canopy = radiation_flux_PAR_SunCanopy + radiation_flux_NIR_SunCanopy + radiation_flux_PipeCanopy - radiation_flux_CanopyCov_in - radiation_flux_CanopyFlr - radiation_flux_CanopySky - radiation_flux_CanopyThScr - sensible_heat_flu...
Equation 2.1 / 8.1 [W m-2] cap_canopy * t_Canopy = radiation_flux_PAR_SunCanopy + radiation_flux_NIR_SunCanopy + radiation_flux_PipeCanopy - radiation_flux_CanopyCov_in - radiation_flux_CanopyFlr - radiation_flux_CanopySky - radiation_flux_CanopyThScr - sensible_heat_flu...
def canopy_temperature(setpoints: Setpoints, states: ClimateStates, weather: Weather): """ Equation 2.1 / 8.1 [W m-2] cap_canopy * t_Canopy = radiation_flux_PAR_SunCanopy + radiation_flux_NIR_SunCanopy + radiation_flux_PipeCanopy - radiation_flux_CanopyCov_in - radiation_flux_CanopyFlr -...
[ "def", "canopy_temperature", "(", "setpoints", ":", "Setpoints", ",", "states", ":", "ClimateStates", ",", "weather", ":", "Weather", ")", ":", "cap_canopy", "=", "canopy_heat_capacity", "(", "states", ")", "radiation_flux_PAR_SunCanopy", "=", "canopy_PAR_absorbed_fro...
[ 25, 0 ]
[ 60, 56 ]
python
en
['en', 'error', 'th']
False
greenhouse_air_temperature
(setpoints: Setpoints, states: ClimateStates, weather: Weather)
Equation 2.2 / 8.2 [W m-2] cap_Air * t_Air = sensible_heat_flux_CanopyAir + sensible_heat_flux_MechAir + sensible_heat_flux_PipeAir + sensible_heat_flux_PasAir + sensible_heat_flux_BlowAir + radiation_flux_Glob_SunAir - sensible_heat_flux_AirFlr - sensible_heat_flux_AirT...
Equation 2.2 / 8.2 [W m-2] cap_Air * t_Air = sensible_heat_flux_CanopyAir + sensible_heat_flux_MechAir + sensible_heat_flux_PipeAir + sensible_heat_flux_PasAir + sensible_heat_flux_BlowAir + radiation_flux_Glob_SunAir - sensible_heat_flux_AirFlr - sensible_heat_flux_AirT...
def greenhouse_air_temperature(setpoints: Setpoints, states: ClimateStates, weather: Weather): """ Equation 2.2 / 8.2 [W m-2] cap_Air * t_Air = sensible_heat_flux_CanopyAir + sensible_heat_flux_MechAir + sensible_heat_flux_PipeAir + sensible_heat_flux_PasAir + sensible_heat_flux_BlowAir ...
[ "def", "greenhouse_air_temperature", "(", "setpoints", ":", "Setpoints", ",", "states", ":", "ClimateStates", ",", "weather", ":", "Weather", ")", ":", "air_height", "=", "coefs", ".", "Construction", ".", "air_height", "density_air", "=", "air_density", "(", ")...
[ 63, 0 ]
[ 101, 86 ]
python
en
['en', 'error', 'th']
False
floor_temperature
(setpoints: Setpoints, states: ClimateStates, weather: Weather)
Equation 2.3 / 8.3 [W m-2] cap_Flr * t_Floor = sensible_heat_flux_AirFlr + radiation_flux_PAR_SunFlr + radiation_flux_NIR_SunFlr + radiation_flux_CanopyFlr + radiation_flux_PipeFlr - sensible_heat_flux_FlrSo1 - radiation_flux_FlrCov_in - radiation_flux_FlrSky - radia...
Equation 2.3 / 8.3 [W m-2] cap_Flr * t_Floor = sensible_heat_flux_AirFlr + radiation_flux_PAR_SunFlr + radiation_flux_NIR_SunFlr + radiation_flux_CanopyFlr + radiation_flux_PipeFlr - sensible_heat_flux_FlrSo1 - radiation_flux_FlrCov_in - radiation_flux_FlrSky - radia...
def floor_temperature(setpoints: Setpoints, states: ClimateStates, weather: Weather): """ Equation 2.3 / 8.3 [W m-2] cap_Flr * t_Floor = sensible_heat_flux_AirFlr + radiation_flux_PAR_SunFlr + radiation_flux_NIR_SunFlr + radiation_flux_CanopyFlr + radiation_flux_PipeFlr - sensible_heat...
[ "def", "floor_temperature", "(", "setpoints", ":", "Setpoints", ",", "states", ":", "ClimateStates", ",", "weather", ":", "Weather", ")", ":", "floor_thickness", "=", "coefs", ".", "Floor", ".", "floor_thickness", "floor_density", "=", "coefs", ".", "Floor", "...
[ 104, 0 ]
[ 136, 109 ]
python
en
['en', 'error', 'th']
False
soil_temperature
(j: int, states: ClimateStates, weather: Weather)
Equation 2.4 / 8.4 [W m-2] cap_soil_j * t_Soil = sensible_heat_flux_soil_j_minus_soil_j - sensible_heat_flux_soil_j_soil_j_plus 0 is Floor, 6 is SoOut :return: The soil temperature
Equation 2.4 / 8.4 [W m-2] cap_soil_j * t_Soil = sensible_heat_flux_soil_j_minus_soil_j - sensible_heat_flux_soil_j_soil_j_plus 0 is Floor, 6 is SoOut :return: The soil temperature
def soil_temperature(j: int, states: ClimateStates, weather: Weather): # j = 1,2,..,5 """ Equation 2.4 / 8.4 [W m-2] cap_soil_j * t_Soil = sensible_heat_flux_soil_j_minus_soil_j - sensible_heat_flux_soil_j_soil_j_plus 0 is Floor, 6 is SoOut :return: The soil temperature """ h_soil_j_minus ...
[ "def", "soil_temperature", "(", "j", ":", "int", ",", "states", ":", "ClimateStates", ",", "weather", ":", "Weather", ")", ":", "# j = 1,2,..,5", "h_soil_j_minus", "=", "coefs", ".", "Floor", ".", "floor_thickness", "if", "j", "==", "1", "else", "coefs", "...
[ 139, 0 ]
[ 160, 104 ]
python
en
['en', 'error', 'th']
False
thermal_screen_temperature
(setpoints: Setpoints, states: ClimateStates, weather: Weather)
Equation 2.5 / 8.5 [W m-2] cap_ThScr * t_ThScr = sensible_heat_flux_AirThScr + latent_heat_flux_AirThScr + radiation_flux_CanopyThScr + radiation_flux_FlrThScr + radiation_flux_PipeThScr - sensible_heat_flux_ThScrTop - radiation_flux_ThScrCov_...
Equation 2.5 / 8.5 [W m-2] cap_ThScr * t_ThScr = sensible_heat_flux_AirThScr + latent_heat_flux_AirThScr + radiation_flux_CanopyThScr + radiation_flux_FlrThScr + radiation_flux_PipeThScr - sensible_heat_flux_ThScrTop - radiation_flux_ThScrCov_...
def thermal_screen_temperature(setpoints: Setpoints, states: ClimateStates, weather: Weather): """ Equation 2.5 / 8.5 [W m-2] cap_ThScr * t_ThScr = sensible_heat_flux_AirThScr + latent_heat_flux_AirThScr + radiation_flux_CanopyThScr + radiation_flux_FlrThScr + radiation_flu...
[ "def", "thermal_screen_temperature", "(", "setpoints", ":", "Setpoints", ",", "states", ":", "ClimateStates", ",", "weather", ":", "Weather", ")", ":", "thScr_thickness", "=", "coefs", ".", "Thermalscreen", ".", "thScr_thickness", "thScr_density", "=", "coefs", "....
[ 163, 0 ]
[ 191, 51 ]
python
en
['en', 'error', 'th']
False
top_compartment_temperature
(setpoints: Setpoints, states: ClimateStates, weather: Weather)
Equation 2.6 / 8.6 [W m-2] cap_Top * above_thermal_screen_t = sensible_heat_flux_ThScrTop + sensible_heat_flux_AirTop − sensible_heat_flux_TopCov_in − sensible_heat_flux_TopOut + sensible_heat_flux_BlScrTop TODO: need to recheck if top compartment params are the same wi...
Equation 2.6 / 8.6 [W m-2] cap_Top * above_thermal_screen_t = sensible_heat_flux_ThScrTop + sensible_heat_flux_AirTop − sensible_heat_flux_TopCov_in − sensible_heat_flux_TopOut + sensible_heat_flux_BlScrTop TODO: need to recheck if top compartment params are the same wi...
def top_compartment_temperature(setpoints: Setpoints, states: ClimateStates, weather: Weather): """ Equation 2.6 / 8.6 [W m-2] cap_Top * above_thermal_screen_t = sensible_heat_flux_ThScrTop + sensible_heat_flux_AirTop − sensible_heat_flux_TopCov_in − sensible_heat_flux_T...
[ "def", "top_compartment_temperature", "(", "setpoints", ":", "Setpoints", ",", "states", ":", "ClimateStates", ",", "weather", ":", "Weather", ")", ":", "h_Top", "=", "coefs", ".", "Construction", ".", "greenhouse_height", "-", "coefs", ".", "Construction", ".",...
[ 194, 0 ]
[ 215, 111 ]
python
en
['en', 'error', 'th']
False
internal_cover_temperature
(setpoints: Setpoints, states: ClimateStates)
Equation 2.7 / 8.7 [W m-2] cap_Cov_in * t_Cov_internal = sensible_heat_flux_TopCov_in + latent_heat_flux_TopCov_in + radiation_flux_CanopyCov_in + radiation_flux_FlrCov_in + radiation_flux_PipeCov_in + radiation_flux_ThScrCov_in - sensible_heat_flux_C...
Equation 2.7 / 8.7 [W m-2] cap_Cov_in * t_Cov_internal = sensible_heat_flux_TopCov_in + latent_heat_flux_TopCov_in + radiation_flux_CanopyCov_in + radiation_flux_FlrCov_in + radiation_flux_PipeCov_in + radiation_flux_ThScrCov_in - sensible_heat_flux_C...
def internal_cover_temperature(setpoints: Setpoints, states: ClimateStates): """ Equation 2.7 / 8.7 [W m-2] cap_Cov_in * t_Cov_internal = sensible_heat_flux_TopCov_in + latent_heat_flux_TopCov_in + radiation_flux_CanopyCov_in + radiation_flux_FlrCov_in + radiation_flux_PipeCov_...
[ "def", "internal_cover_temperature", "(", "setpoints", ":", "Setpoints", ",", "states", ":", "ClimateStates", ")", ":", "cap_Cov", "=", "lumped_cover_heat_capacity", "(", ")", "cap_Cov_in", "=", "internal_external_canopy_heat_capacity", "(", "cap_Cov", ")", "sensible_he...
[ 218, 0 ]
[ 241, 116 ]
python
en
['en', 'error', 'th']
False
external_cover_temperature
(setpoints: Setpoints, states: ClimateStates, weather: Weather)
Equation 2.8 / 8.8 [W m-2] cap_Cov_e * t_Cov_external = radiation_flux_Glob_SunCov_e + sensible_heat_flux_Cov_in_Cov_e - sensible_heat_flux_Cov_e_Out - radiation_flux_Cov_e_Sky :return: The external cover temperature
Equation 2.8 / 8.8 [W m-2] cap_Cov_e * t_Cov_external = radiation_flux_Glob_SunCov_e + sensible_heat_flux_Cov_in_Cov_e - sensible_heat_flux_Cov_e_Out - radiation_flux_Cov_e_Sky :return: The external cover temperature
def external_cover_temperature(setpoints: Setpoints, states: ClimateStates, weather: Weather): """ Equation 2.8 / 8.8 [W m-2] cap_Cov_e * t_Cov_external = radiation_flux_Glob_SunCov_e + sensible_heat_flux_Cov_in_Cov_e - sensible_heat_flux_Cov_e_Out - radiation_flux_Cov_e_Sky...
[ "def", "external_cover_temperature", "(", "setpoints", ":", "Setpoints", ",", "states", ":", "ClimateStates", ",", "weather", ":", "Weather", ")", ":", "cap_Cov", "=", "lumped_cover_heat_capacity", "(", ")", "cap_Cov_e", "=", "internal_external_canopy_heat_capacity", ...
[ 244, 0 ]
[ 260, 82 ]
python
en
['en', 'error', 'th']
False
heating_pipe_system_surface_temperature
(setpoints: Setpoints, states: ClimateStates, weather: Weather)
Equation 2.9 / 8.9 [W m-2] cap_Pipe * t_Pipe = sensible_heat_flux_BoilPipe + sensible_heat_flux_IndPipe + sensible_heat_flux_GeoPipe - radiation_flux_PipeSky - radiation_flux_PipeCov_in - radiation_flux_PipeCanopy - radiation_flux_PipeFlr - radiation_flux_PipeThSc...
Equation 2.9 / 8.9 [W m-2] cap_Pipe * t_Pipe = sensible_heat_flux_BoilPipe + sensible_heat_flux_IndPipe + sensible_heat_flux_GeoPipe - radiation_flux_PipeSky - radiation_flux_PipeCov_in - radiation_flux_PipeCanopy - radiation_flux_PipeFlr - radiation_flux_PipeThSc...
def heating_pipe_system_surface_temperature(setpoints: Setpoints, states: ClimateStates, weather: Weather): """ Equation 2.9 / 8.9 [W m-2] cap_Pipe * t_Pipe = sensible_heat_flux_BoilPipe + sensible_heat_flux_IndPipe + sensible_heat_flux_GeoPipe - radiation_flux_PipeSky - radiation_fl...
[ "def", "heating_pipe_system_surface_temperature", "(", "setpoints", ":", "Setpoints", ",", "states", ":", "ClimateStates", ",", "weather", ":", "Weather", ")", ":", "cap_Pipe", "=", "heating_pipe_heat_capacity", "(", ")", "U_Boil", "=", "setpoints", ".", "U_Boil", ...
[ 263, 0 ]
[ 299, 76 ]
python
en
['en', 'error', 'th']
False
blackout_screen_temperature
(setpoints: Setpoints, states: ClimateStates, weather: Weather)
Equation 1 [2] [W m-2] cap_BlScr * t_BlScr = sensible_heat_flux_AirBlScr + latent_heat_flux_AirBlScr + radiation_flux_CanopyBlScr + radiation_flux_FlrBlScr + radiation_flux_PipeBlScr - sensible_heat_flux_BlScrTop - radiation_flux_BlScrCov_in - radiation_flux_BlSc...
Equation 1 [2] [W m-2] cap_BlScr * t_BlScr = sensible_heat_flux_AirBlScr + latent_heat_flux_AirBlScr + radiation_flux_CanopyBlScr + radiation_flux_FlrBlScr + radiation_flux_PipeBlScr - sensible_heat_flux_BlScrTop - radiation_flux_BlScrCov_in - radiation_flux_BlSc...
def blackout_screen_temperature(setpoints: Setpoints, states: ClimateStates, weather: Weather): """ Equation 1 [2] [W m-2] cap_BlScr * t_BlScr = sensible_heat_flux_AirBlScr + latent_heat_flux_AirBlScr + radiation_flux_CanopyBlScr + radiation_flux_FlrBlScr + radiation_flux_PipeBlScr -...
[ "def", "blackout_screen_temperature", "(", "setpoints", ":", "Setpoints", ",", "states", ":", "ClimateStates", ",", "weather", ":", "Weather", ")", ":", "cap_BlScr", "=", "remaining_object_heat_capacity", "(", "Coefficients", ".", "Blackoutscreen", ".", "blScr_thickne...
[ 302, 0 ]
[ 328, 49 ]
python
en
['en', 'error', 'th']
False
grow_pipe_temperature
(setpoints: Setpoints, states: ClimateStates)
Equation 1 [2] [W m-2] cap_GroPipe * t_GrowPipe = sensible_heat_flux_BoilGroPipe - radiation_flux_GroPipeCanopy - sensible_heat_flux_GroPipeAir Returns: The grow pipe temperature
Equation 1 [2] [W m-2] cap_GroPipe * t_GrowPipe = sensible_heat_flux_BoilGroPipe - radiation_flux_GroPipeCanopy - sensible_heat_flux_GroPipeAir Returns: The grow pipe temperature
def grow_pipe_temperature(setpoints: Setpoints, states: ClimateStates): """ Equation 1 [2] [W m-2] cap_GroPipe * t_GrowPipe = sensible_heat_flux_BoilGroPipe - radiation_flux_GroPipeCanopy - sensible_heat_flux_GroPipeAir Returns: The grow pipe temperature """ cap_GroPipe = grow_pipe_heat_capacit...
[ "def", "grow_pipe_temperature", "(", "setpoints", ":", "Setpoints", ",", "states", ":", "ClimateStates", ")", ":", "cap_GroPipe", "=", "grow_pipe_heat_capacity", "(", ")", "sensible_heat_flux_BoilGroPipe", "=", "sensible_heat_flux_between_boiler_and_grow_pipe", "(", "setpoi...
[ 331, 0 ]
[ 341, 120 ]
python
en
['en', 'error', 'th']
False