evennia.typeclasses

This sub-package defines the typeclass-system, a way to wrap database access into almost-normal Python classes. Using typeclasses one can work in normal Python while having the luxury of persistent data storage at every turn. ObjectDB, ChannelDB, AccountDB and ScriptDB all inherit from the models in this package. Here is also were the Attribute and Tag models are defined along with their handlers.

• evennia.typeclasses.attributes
  • IAttribute
    • IAttribute.locks
    • IAttribute.key
    • IAttribute.strvalue
    • IAttribute.category
    • IAttribute.model
    • IAttribute.attrtype
    • IAttribute.date_created
    • IAttribute.lock_storage
    • IAttribute.access()
  • InMemoryAttribute
    • InMemoryAttribute.__init__()
    • InMemoryAttribute.value
  • AttributeProperty
    • AttributeProperty.attrhandler_name
    • AttributeProperty.cached_default_name_template
    • AttributeProperty.__init__()
    • AttributeProperty.at_set()
    • AttributeProperty.at_get()
  • NAttributeProperty
    • NAttributeProperty.attrhandler_name
  • Attribute
    • Attribute.db_key
    • Attribute.db_value
    • Attribute.db_strvalue
    • Attribute.db_category
    • Attribute.db_lock_storage
    • Attribute.db_model
    • Attribute.db_attrtype
    • Attribute.db_date_created
    • Attribute.lock_storage
    • Attribute.value
    • Attribute.DoesNotExist
    • Attribute.MultipleObjectsReturned
    • Attribute.accountdb_set
    • Attribute.attrtype
    • Attribute.category
    • Attribute.channeldb_set
    • Attribute.date_created
    • Attribute.get_next_by_db_date_created()
    • Attribute.get_previous_by_db_date_created()
    • Attribute.id
    • Attribute.key
    • Attribute.model
    • Attribute.objectdb_set
    • Attribute.path
    • Attribute.scriptdb_set
    • Attribute.strvalue
    • Attribute.typename
  • IAttributeBackend
    • IAttributeBackend.__init__()
    • IAttributeBackend.query_all()
    • IAttributeBackend.query_key()
    • IAttributeBackend.query_category()
    • IAttributeBackend.get()
    • IAttributeBackend.reset_cache()
    • IAttributeBackend.do_create_attribute()
    • IAttributeBackend.create_attribute()
    • IAttributeBackend.do_update_attribute()
    • IAttributeBackend.do_batch_update_attribute()
    • IAttributeBackend.do_batch_finish()
    • IAttributeBackend.batch_add()
    • IAttributeBackend.do_delete_attribute()
    • IAttributeBackend.delete_attribute()
    • IAttributeBackend.update_attribute()
    • IAttributeBackend.do_batch_delete()
    • IAttributeBackend.clear_attributes()
    • IAttributeBackend.get_all_attributes()
  • InMemoryAttributeBackend
    • InMemoryAttributeBackend.__init__()
    • InMemoryAttributeBackend.query_all()
    • InMemoryAttributeBackend.query_key()
    • InMemoryAttributeBackend.query_category()
    • InMemoryAttributeBackend.do_create_attribute()
    • InMemoryAttributeBackend.do_update_attribute()
    • InMemoryAttributeBackend.do_batch_update_attribute()
    • InMemoryAttributeBackend.do_batch_finish()
    • InMemoryAttributeBackend.do_delete_attribute()
  • ModelAttributeBackend
    • ModelAttributeBackend.__init__()
    • ModelAttributeBackend.query_all()
    • ModelAttributeBackend.query_key()
    • ModelAttributeBackend.query_category()
    • ModelAttributeBackend.do_create_attribute()
    • ModelAttributeBackend.do_update_attribute()
    • ModelAttributeBackend.do_batch_update_attribute()
    • ModelAttributeBackend.do_batch_finish()
    • ModelAttributeBackend.do_delete_attribute()
  • AttributeHandler
    • AttributeHandler.__init__()
    • AttributeHandler.has()
    • AttributeHandler.get()
    • AttributeHandler.add()
    • AttributeHandler.batch_add()
    • AttributeHandler.remove()
    • AttributeHandler.clear()
    • AttributeHandler.all()
    • AttributeHandler.reset_cache()
  • DbHolder
    • DbHolder.__init__()
    • DbHolder.get_all()
    • DbHolder.all
  • NickTemplateInvalid
  • initialize_nick_templates()
  • parse_nick_template()
  • NickHandler
    • NickHandler.__init__()
    • NickHandler.has()
    • NickHandler.get()
    • NickHandler.add()
    • NickHandler.remove()
    • NickHandler.nickreplace()
• evennia.typeclasses.managers
  • TypedObjectManager
    • TypedObjectManager.get_attribute()
    • TypedObjectManager.get_nick()
    • TypedObjectManager.get_by_attribute()
    • TypedObjectManager.get_by_nick()
    • TypedObjectManager.get_tag()
    • TypedObjectManager.get_permission()
    • TypedObjectManager.get_alias()
    • TypedObjectManager.get_by_tag()
    • TypedObjectManager.get_by_permission()
    • TypedObjectManager.get_by_alias()
    • TypedObjectManager.create_tag()
    • TypedObjectManager.dbref()
    • TypedObjectManager.get_id()
    • TypedObjectManager.dbref_search()
    • TypedObjectManager.search_dbref()
    • TypedObjectManager.get_dbref_range()
    • TypedObjectManager.get_typeclass_totals()
    • TypedObjectManager.object_totals()
    • TypedObjectManager.typeclass_search()
  • Attribute
    • Attribute.DoesNotExist
    • Attribute.MultipleObjectsReturned
    • Attribute.accountdb_set
    • Attribute.attrtype
    • Attribute.category
    • Attribute.channeldb_set
    • Attribute.date_created
    • Attribute.db_attrtype
    • Attribute.db_category
    • Attribute.db_date_created
    • Attribute.db_key
    • Attribute.db_lock_storage
    • Attribute.db_model
    • Attribute.db_strvalue
    • Attribute.db_value
    • Attribute.get_next_by_db_date_created()
    • Attribute.get_previous_by_db_date_created()
    • Attribute.id
    • Attribute.key
    • Attribute.lock_storage
    • Attribute.model
    • Attribute.objectdb_set
    • Attribute.path
    • Attribute.scriptdb_set
    • Attribute.strvalue
    • Attribute.typename
    • Attribute.value
  • Cast
    • Cast.__init__()
    • Cast.as_mysql()
    • Cast.as_oracle()
    • Cast.as_postgresql()
    • Cast.as_sql()
    • Cast.as_sqlite()
    • Cast.function
    • Cast.template
  • Count
    • Count.__init__()
    • Count.allow_distinct
    • Count.allows_composite_expressions
    • Count.arity
    • Count.empty_result_set_value
    • Count.function
    • Count.name
    • Count.output_field
    • Count.resolve_expression()
  • ExpressionWrapper
    • ExpressionWrapper.__init__()
    • ExpressionWrapper.allowed_default
    • ExpressionWrapper.as_sql()
    • ExpressionWrapper.deconstruct()
    • ExpressionWrapper.get_group_by_cols()
    • ExpressionWrapper.get_source_expressions()
    • ExpressionWrapper.set_source_expressions()
  • F
    • F.__init__()
    • F.allowed_default
    • F.asc()
    • F.copy()
    • F.deconstruct()
    • F.desc()
    • F.replace_expressions()
    • F.resolve_expression()
  • FloatField
    • FloatField.default_error_messages
    • FloatField.description
    • FloatField.empty_strings_allowed
    • FloatField.formfield()
    • FloatField.get_internal_type()
    • FloatField.get_prep_value()
    • FloatField.to_python()
  • Q
    • Q.AND
    • Q.OR
    • Q.XOR
    • Q.__init__()
    • Q.check()
    • Q.conditional
    • Q.deconstruct()
    • Q.default
    • Q.flatten()
    • Q.identity
    • Q.referenced_base_fields
    • Q.replace_expressions()
    • Q.resolve_expression()
  • Tag
    • Tag.DoesNotExist
    • Tag.MultipleObjectsReturned
    • Tag.accountdb_set
    • Tag.channeldb_set
    • Tag.db_category
    • Tag.db_data
    • Tag.db_key
    • Tag.db_model
    • Tag.db_tagtype
    • Tag.helpentry_set
    • Tag.id
    • Tag.msg_set
    • Tag.objectdb_set
    • Tag.objects
    • Tag.scriptdb_set
  • TypeclassManager
    • TypeclassManager.smart_search()
    • TypeclassManager.get()
    • TypeclassManager.filter()
    • TypeclassManager.all()
    • TypeclassManager.first()
    • TypeclassManager.last()
    • TypeclassManager.count()
    • TypeclassManager.annotate()
    • TypeclassManager.values()
    • TypeclassManager.values_list()
    • TypeclassManager.get_family()
    • TypeclassManager.filter_family()
    • TypeclassManager.all_family()
  • class_from_module()
  • make_iter()
  • variable_from_module()
• evennia.typeclasses.models
  • TypedObject
    • TypedObject.db_key
    • TypedObject.db_typeclass_path
    • TypedObject.db_date_created
    • TypedObject.db_lock_storage
    • TypedObject.db_attributes
    • TypedObject.db_tags
    • TypedObject.objects
    • TypedObject.set_class_from_typeclass()
    • TypedObject.__init__()
    • TypedObject.init_evennia_properties()
    • TypedObject.attributes
    • TypedObject.locks
    • TypedObject.tags
    • TypedObject.aliases
    • TypedObject.permissions
    • TypedObject.nattributes
    • TypedObject.Meta
      • TypedObject.Meta.abstract
      • TypedObject.Meta.verbose_name
      • TypedObject.Meta.ordering
    • TypedObject.name
    • TypedObject.key
    • TypedObject.date_created
    • TypedObject.dbid
    • TypedObject.dbref
    • TypedObject.at_idmapper_flush()
    • TypedObject.at_init()
    • TypedObject.search()
    • TypedObject.is_typeclass()
    • TypedObject.swap_typeclass()
    • TypedObject.access()
    • TypedObject.check_permstring()
    • TypedObject.delete()
    • TypedObject.db
    • TypedObject.ndb
    • TypedObject.get_display_name()
    • TypedObject.get_extra_info()
    • TypedObject.at_rename()
    • TypedObject.web_get_admin_url()
    • TypedObject.web_get_create_url()
    • TypedObject.get_next_by_db_date_created()
    • TypedObject.get_previous_by_db_date_created()
    • TypedObject.lock_storage
    • TypedObject.path
    • TypedObject.typeclass_path
    • TypedObject.typename
    • TypedObject.web_get_detail_url()
    • TypedObject.web_get_puppet_url()
    • TypedObject.web_get_update_url()
    • TypedObject.web_get_delete_url()
    • TypedObject.get_absolute_url()
  • AliasHandler
  • Attribute
    • Attribute.DoesNotExist
    • Attribute.MultipleObjectsReturned
    • Attribute.accountdb_set
    • Attribute.attrtype
    • Attribute.category
    • Attribute.channeldb_set
    • Attribute.date_created
    • Attribute.db_attrtype
    • Attribute.db_category
    • Attribute.db_date_created
    • Attribute.db_key
    • Attribute.db_lock_storage
    • Attribute.db_model
    • Attribute.db_strvalue
    • Attribute.db_value
    • Attribute.get_next_by_db_date_created()
    • Attribute.get_previous_by_db_date_created()
    • Attribute.id
    • Attribute.key
    • Attribute.lock_storage
    • Attribute.model
    • Attribute.objectdb_set
    • Attribute.path
    • Attribute.scriptdb_set
    • Attribute.strvalue
    • Attribute.typename
    • Attribute.value
  • AttributeHandler
    • AttributeHandler.__init__()
    • AttributeHandler.add()
    • AttributeHandler.all()
    • AttributeHandler.batch_add()
    • AttributeHandler.clear()
    • AttributeHandler.get()
    • AttributeHandler.has()
    • AttributeHandler.remove()
    • AttributeHandler.reset_cache()
  • AttributeProperty
    • AttributeProperty.__init__()
    • AttributeProperty.at_get()
    • AttributeProperty.at_set()
    • AttributeProperty.attrhandler_name
    • AttributeProperty.cached_default_name_template
  • ContentType
    • ContentType.DoesNotExist
    • ContentType.MultipleObjectsReturned
    • ContentType.app_label
    • ContentType.app_labeled_name
    • ContentType.get_all_objects_for_this_type()
    • ContentType.get_object_for_this_type()
    • ContentType.id
    • ContentType.logentry_set
    • ContentType.model
    • ContentType.model_class()
    • ContentType.name
    • ContentType.natural_key()
    • ContentType.objects
    • ContentType.permission_set
  • DbHolder
    • DbHolder.__init__()
    • DbHolder.all
    • DbHolder.get_all()
  • InMemoryAttributeBackend
    • InMemoryAttributeBackend.__init__()
    • InMemoryAttributeBackend.do_batch_finish()
    • InMemoryAttributeBackend.do_batch_update_attribute()
    • InMemoryAttributeBackend.do_create_attribute()
    • InMemoryAttributeBackend.do_delete_attribute()
    • InMemoryAttributeBackend.do_update_attribute()
    • InMemoryAttributeBackend.query_all()
    • InMemoryAttributeBackend.query_category()
    • InMemoryAttributeBackend.query_key()
  • LockHandler
    • LockHandler.__init__()
    • LockHandler.add()
    • LockHandler.all()
    • LockHandler.append()
    • LockHandler.cache_lock_bypass()
    • LockHandler.check()
    • LockHandler.check_lockstring()
    • LockHandler.clear()
    • LockHandler.delete()
    • LockHandler.get()
    • LockHandler.remove()
    • LockHandler.replace()
    • LockHandler.reset()
    • LockHandler.validate()
  • ModelAttributeBackend
    • ModelAttributeBackend.__init__()
    • ModelAttributeBackend.do_batch_finish()
    • ModelAttributeBackend.do_batch_update_attribute()
    • ModelAttributeBackend.do_create_attribute()
    • ModelAttributeBackend.do_delete_attribute()
    • ModelAttributeBackend.do_update_attribute()
    • ModelAttributeBackend.query_all()
    • ModelAttributeBackend.query_category()
    • ModelAttributeBackend.query_key()
  • ModelBase
    • ModelBase.add_to_class()
  • ObjectDoesNotExist
    • ObjectDoesNotExist.silent_variable_failure
  • PermissionHandler
    • PermissionHandler.check()
  • SharedMemoryModel
    • SharedMemoryModel.Meta
      • SharedMemoryModel.Meta.abstract
    • SharedMemoryModel.at_idmapper_flush()
    • SharedMemoryModel.cache_instance()
    • SharedMemoryModel.delete()
    • SharedMemoryModel.flush_cached_instance()
    • SharedMemoryModel.flush_from_cache()
    • SharedMemoryModel.flush_instance_cache()
    • SharedMemoryModel.get_all_cached_instances()
    • SharedMemoryModel.get_cached_instance()
    • SharedMemoryModel.objects
    • SharedMemoryModel.path
    • SharedMemoryModel.save()
    • SharedMemoryModel.typename
  • SharedMemoryModelBase
  • Tag
    • Tag.DoesNotExist
    • Tag.MultipleObjectsReturned
    • Tag.accountdb_set
    • Tag.channeldb_set
    • Tag.db_category
    • Tag.db_data
    • Tag.db_key
    • Tag.db_model
    • Tag.db_tagtype
    • Tag.helpentry_set
    • Tag.id
    • Tag.msg_set
    • Tag.objectdb_set
    • Tag.objects
    • Tag.scriptdb_set
  • TagCategoryProperty
    • TagCategoryProperty.__init__()
    • TagCategoryProperty.taghandler_name
  • TagHandler
    • TagHandler.__init__()
    • TagHandler.add()
    • TagHandler.all()
    • TagHandler.batch_add()
    • TagHandler.batch_remove()
    • TagHandler.clear()
    • TagHandler.get()
    • TagHandler.has()
    • TagHandler.remove()
    • TagHandler.reset_cache()
  • TagProperty
    • TagProperty.__init__()
    • TagProperty.taghandler_name
  • TypeclassBase
  • call_at_first_save()
  • class_from_module()
  • inherits_from()
  • is_iter()
  • lazy_property
    • lazy_property.__init__()
  • log_trace()
  • remove_attributes_on_delete()
  • reverse()
  • slugify()
  • smart_str()
• evennia.typeclasses.tags
  • Tag
    • Tag.db_key
    • Tag.db_category
    • Tag.db_data
    • Tag.db_model
    • Tag.db_tagtype
    • Tag.DoesNotExist
    • Tag.MultipleObjectsReturned
    • Tag.accountdb_set
    • Tag.channeldb_set
    • Tag.helpentry_set
    • Tag.id
    • Tag.msg_set
    • Tag.objectdb_set
    • Tag.objects
    • Tag.scriptdb_set
  • TagProperty
    • TagProperty.taghandler_name
    • TagProperty.__init__()
  • TagCategoryProperty
    • TagCategoryProperty.taghandler_name
    • TagCategoryProperty.__init__()
  • TagHandler
    • TagHandler.__init__()
    • TagHandler.reset_cache()
    • TagHandler.add()
    • TagHandler.has()
    • TagHandler.get()
    • TagHandler.remove()
    • TagHandler.clear()
    • TagHandler.all()
    • TagHandler.batch_add()
    • TagHandler.batch_remove()
  • AliasProperty
    • AliasProperty.taghandler_name
  • AliasHandler
  • PermissionProperty
    • PermissionProperty.taghandler_name
  • PermissionHandler
    • PermissionHandler.check()