Module Expr Str ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias alias Assign NameStore AttributeLoad NameLoad attr ClassDef bases AttributeLoad NameLoad attr body Expr Str Assign NameStore Call AttributeLoad NameLoad attr Str keyword Num keyword NameLoad keyword Str keyword NameLoad Assign NameStore Call AttributeLoad NameLoad attr Str keyword Num keyword NameLoad keyword Str keyword NameLoad Assign NameStore Call AttributeLoad NameLoad attr Str keyword NameLoad keyword NameLoad keyword Str Assign NameStore Call AttributeLoad NameLoad attr Str keyword Num keyword NameLoad keyword Str keyword NameLoad Assign NameStore Call AttributeLoad NameLoad attr Str keyword Num keyword NameLoad keyword Str keyword NameLoad ClassDef bases NameLoad body Expr Str Assign NameStore Str Assign NameStore TupleLoad TupleLoad Str Str Str Assign NameStore TupleLoad TupleLoad Str Str Str decorator_list FunctionDef arguments args NameParam defaults body Return BinOpMod Str AttributeLoad NameLoad attr decorator_list FunctionDef arguments args NameParam defaults body Return Call NameLoad AttributeLoad NameLoad attr decorator_list decorator_list ClassDef bases NameLoad body Expr Str Assign NameStore Str Assign NameStore NameLoad FunctionDef arguments args NameParam NameParam defaults body Expr Str Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr AttributeLoad NameLoad attr Assign AttributeStore NameLoad attr Call AttributeLoad AttributeLoad AttributeLoad NameLoad attr attr attr Assign AttributeStore NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Assign NameStore Dict BinOpMod Str AttributeLoad NameLoad attr Str AttributeLoad NameLoad attr AttributeLoad NameLoad attr Assign NameStore ListComp AttributeLoad NameLoad attr comprehension NameStore Call AttributeLoad AttributeLoad AttributeLoad Call NameLoad AttributeLoad NameLoad attr AttributeLoad NameLoad attr attr attr attr NameLoad Assign AttributeStore NameLoad attr Call NameLoad GeneratorExp TupleLoad BinOpMod Str TupleLoad Call AttributeLoad Call NameLoad AttributeLoad NameLoad attr attr IfExp AttributeLoad NameLoad attr Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad NameLoad comprehension NameStore NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam defaults NameLoad NameLoad NameLoad body Expr Str If UnaryOpNot NameLoad body Return For NameStore Call NameLoad NameLoad body If UnaryOpNot NameLoad body Continue Assign NameStore Call AttributeLoad Call AttributeLoad NameLoad attr attr Assign NameStore IfExp CompareIsNot NameLoad NameLoad Call AttributeLoad Call AttributeLoad NameLoad attr attr NameLoad Assign NameStore IfExp CompareIsNot NameLoad NameLoad Call NameLoad NameLoad NameLoad Assign NameStore Call AttributeLoad AttributeLoad AttributeLoad AttributeLoad NameLoad attr attr attr attr keyword NameLoad keyword NameLoad keyword NameLoad keyword AttributeLoad NameLoad attr Expr Call AttributeLoad Call NameLoad AttributeLoad NameLoad attr AttributeLoad NameLoad attr attr NameLoad If CompareIs AttributeLoad NameLoad attr NameLoad body Expr Call AttributeLoad NameLoad attr Assign NameStore BinOpMod Str TupleLoad NameLoad NameLoad Assign SubscriptStore AttributeLoad NameLoad attr Index NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam NameParam defaults NameLoad NameLoad NameLoad body Expr Str If BoolOpOr CompareIs AttributeLoad NameLoad attr NameLoad UnaryOpNot NameLoad body Expr Call AttributeLoad NameLoad attr Assign NameStore ListLoad Assign NameStore IfExp CompareIsNot NameLoad NameLoad Call AttributeLoad Call AttributeLoad NameLoad attr attr NameLoad Assign NameStore ListComp IfExp CompareIsNot NameLoad NameLoad BinOpMod Str TupleLoad Call AttributeLoad Call AttributeLoad NameLoad attr attr NameLoad NameLoad comprehension NameStore Call NameLoad NameLoad Assign NameStore ListComp NameLoad comprehension NameStore GeneratorExp Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad comprehension NameStore NameLoad NameLoad Assign NameStore IfExp NameLoad ListComp Call NameLoad AttributeLoad NameLoad attr comprehension NameStore NameLoad NameLoad Return IfExp CompareEq Call NameLoad NameLoad Num SubscriptLoad NameLoad Index Num IfExp NameLoad NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults NameLoad body Expr Str For NameStore Call NameLoad NameLoad body If UnaryOpNot BoolOpOr NameLoad Call AttributeLoad NameLoad attr body Continue Assign NameStore Call AttributeLoad Call AttributeLoad NameLoad attr attr Assign NameStore IfExp CompareIsNot NameLoad NameLoad Call AttributeLoad Call AttributeLoad NameLoad attr attr NameLoad Assign NameStore Call AttributeLoad AttributeLoad AttributeLoad NameLoad attr attr attr keyword NameLoad keyword NameLoad If NameLoad body Expr Call AttributeLoad Call NameLoad AttributeLoad NameLoad attr AttributeLoad NameLoad attr attr SubscriptLoad NameLoad Index Num Expr Call AttributeLoad NameLoad attr decorator_list FunctionDef arguments args NameParam NameParam defaults NameLoad body Expr Str If UnaryOpNot NameLoad body Expr Call AttributeLoad Call NameLoad AttributeLoad NameLoad attr AttributeLoad NameLoad attr attr orelse Expr Call AttributeLoad Call AttributeLoad Call NameLoad AttributeLoad NameLoad attr AttributeLoad NameLoad attr attr keyword NameLoad attr Expr Call AttributeLoad NameLoad attr decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults NameLoad NameLoad body Expr Str If BoolOpOr CompareIs AttributeLoad NameLoad attr NameLoad UnaryOpNot NameLoad body Expr Call AttributeLoad NameLoad attr If NameLoad body Assign NameStore IfExp CompareIsNot NameLoad NameLoad Call AttributeLoad Call AttributeLoad NameLoad attr attr NameLoad Assign NameStore ListComp NameLoad comprehension NameStore Call AttributeLoad AttributeLoad NameLoad attr attr CompareEq AttributeLoad NameLoad attr NameLoad orelse Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr If NameLoad body Assign NameStore Call NameLoad NameLoad keyword Lambda arguments args NameParam defaults AttributeLoad NameLoad attr If NameLoad body Return ListComp TupleLoad Call NameLoad AttributeLoad NameLoad attr Call NameLoad AttributeLoad NameLoad attr comprehension NameStore NameLoad orelse Return ListComp Call NameLoad AttributeLoad NameLoad attr comprehension NameStore NameLoad Return ListLoad decorator_list FunctionDef arguments args NameParam defaults body Return Call AttributeLoad Str attr Call AttributeLoad NameLoad attr decorator_list FunctionDef arguments args NameParam defaults body Return Call AttributeLoad Str attr Call AttributeLoad NameLoad attr decorator_list decorator_list ClassDef bases NameLoad body Expr Str Assign NameStore Str decorator_list ClassDef bases NameLoad body Expr Str Assign NameStore Str decorator_list
N/A N/A 
Tags are entities that are attached to objects in the same way as
Attributes. But contrary to Attributes, which are unique to an
individual object, a single Tag can be attached to any number of
objects at the same time.

Tags are used for tagging, obviously, but the data structure is also
used for storing Aliases and Permissions. This module contains the
respective handlers.

 builtins object django.conf settings django.db models evennia.utils.utils to_str make_iter N/A _TYPECLASS_AGGRESSIVE_CACHE N/A settings TYPECLASS_AGGRESSIVE_CACHE Tag N/A N/A models Model N/A N/A 
    Tags are quick markers for objects in-game. An typeobject can have
    any number of tags, stored via its db_tags property.  Tagging
    similar objects will make it easier to quickly locate the group
    later (such as when implementing zones). The main advantage of
    tagging as opposed to using Attributes is speed; a tag is very
    limited in what data it can hold, and the tag key+category is
    indexed for efficient lookup in the database. Tags are shared
    between objects - a new tag is only created if the key+category
    combination did not previously exist, making them unsuitable for
    storing object-related data (for this a full Attribute should be
    used).

    The 'db_data' field is intended as a documentation field for the
    tag itself, such as to document what this tag+category stands for
    and display that in a web interface or similar.

    The main default use for Tags is to implement Aliases for objects.
    this uses the 'aliases' tag category, which is also checked by the
    default search functions of Evennia to allow quick searches by alias.

     N/A db_key N/A N/A models CharField key max_length 255 null True help_text tag identifier db_index True N/A db_category N/A N/A models CharField category max_length 64 null True help_text tag category db_index True N/A db_data N/A N/A models TextField data null True blank True help_text optional data field with extra information. This is not searched for. N/A db_model N/A N/A models CharField model max_length 32 null True help_text database model to Tag db_index True N/A db_tagtype N/A N/A models CharField tagtype max_length 16 null True help_text overall type of Tag db_index True Meta N/A object N/A N/A Define Django meta options N/A verbose_name Tag N/A unique_together N/A N/A db_key db_category db_tagtype N/A index_together N/A N/A db_key db_category db_tagtype N/A __unicode__ N/A N/A self N/A N/A N/A N/A %s N/A self db_key N/A __str__ N/A N/A self N/A N/A N/A N/A str N/A self db_key N/A N/A TagHandler N/A object N/A N/A 
    Generic tag-handler. Accessed via TypedObject.tags.

     N/A _m2m_fieldname db_tags N/A _tagtype None __init__ N/A N/A self obj N/A N/A N/A 
        Tags are stored internally in the TypedObject.db_tags m2m
        field with an tag.db_model based on the obj the taghandler is
        stored on and with a tagtype given by self.handlertype

        Args:
            obj (object): The object on which the handler is set.

         N/A N/A self obj obj N/A N/A self _objid N/A obj id N/A N/A self _model N/A N/A N/A N/A obj __dbclass__ __name__ lower N/A N/A self _cache None N/A _recache N/A N/A self N/A N/A N/A 
        Cache all tags of this object.

         N/A query N/A N/A %s__id N/A self _model tag__db_tagtype N/A self _objid N/A self _tagtype N/A tagobjs N/A N/A conn tag N/A conn N/A N/A N/A N/A N/A getattr N/A self obj N/A self _m2m_fieldname through objects filter query N/A N/A self _cache N/A dict N/A N/A N/A %s-%s N/A N/A N/A N/A to_str N/A tagobj db_key lower N/A N/A tagobj db_category N/A N/A N/A tagobj db_category lower None tagobj N/A tagobj tagobjs N/A add N/A N/A self tag category data N/A None None None N/A N/A 
        Add a new tag to the handler.

        Args:
            tag (str or list): The name of the tag to add. If a list,
                add several Tags.
            category (str, optional): Category of Tag. `None` is the default category.
            data (str, optional): Info text about the tag(s) added.
                This can not be used to store object-unique info but only
                eventual info about the text itself.

        Notes:
            If the tag + category combination matches an already
            existing Tag object, this will be re-used and no new Tag
            will be created.

         N/A N/A tag N/A N/A N/A tagstr N/A make_iter tag N/A N/A N/A tagstr N/A N/A N/A tagstr N/A N/A N/A N/A tagstr strip lower N/A category N/A N/A category None N/A N/A N/A N/A category strip lower None N/A data N/A N/A data None N/A str data None N/A tagobj N/A N/A N/A N/A N/A self obj __class__ objects create_tag key tagstr category category data data tagtype N/A self _tagtype N/A N/A N/A N/A getattr N/A self obj N/A self _m2m_fieldname add tagobj N/A N/A N/A self _cache None N/A N/A N/A N/A self _recache N/A cachestring N/A %s-%s N/A tagstr category N/A N/A N/A self _cache N/A cachestring tagobj N/A get N/A N/A self key default category return_tagobj N/A None None False N/A N/A 
        Get the tag for the given key or list of tags.

        Args:
            key (str or list): The tag or tags to retrieve.
            default (any, optional): The value to return in case of no match.
            category (str, optional): The Tag category to limit the
                request to. Note that `None` is the valid, default
                category.
            return_tagobj (bool, optional): Return the Tag object itself
                instead of a string representation of the Tag.

        Returns:
            tags (str, TagObject or list): The matches, either string
                representations of the tags or the Tag objects themselves
                depending on `return_tagobj`.

         N/A N/A N/A N/A self _cache None N/A _TYPECLASS_AGGRESSIVE_CACHE N/A N/A N/A N/A self _recache N/A ret N/A N/A category N/A N/A category None N/A N/A N/A N/A category strip lower None N/A searchkey N/A N/A N/A key None N/A %s-%s N/A N/A N/A N/A N/A key strip lower category None N/A key N/A make_iter key N/A ret N/A val N/A val N/A N/A N/A N/A self _cache get keystr N/A keystr searchkey val N/A ret N/A return_tagobj N/A N/A to_str N/A tag db_data N/A tag ret ret N/A N/A N/A N/A len ret 1 N/A ret N/A 0 N/A ret ret default N/A remove N/A N/A self key category N/A None N/A N/A 
        Remove a tag from the handler based ond key and category.

        Args:
            key (str or list): The tag or tags to retrieve.
            category (str, optional): The Tag category to limit the
                request to. Note that `None` is the valid, default
                category.

         N/A key N/A make_iter key N/A N/A N/A N/A key N/A N/A key strip N/A N/A N/A tagstr N/A N/A N/A N/A key strip lower N/A category N/A N/A category None N/A N/A N/A N/A category strip lower None N/A tagobj N/A N/A N/A N/A self obj db_tags filter db_key tagstr db_category category N/A tagobj N/A N/A N/A N/A N/A getattr N/A self obj N/A self _m2m_fieldname remove N/A tagobj N/A 0 N/A N/A N/A self _recache N/A clear N/A N/A self category N/A None N/A N/A 
        Remove all tags from the handler.

        Args:
            category (str, optional): The Tag category to limit the
                request to. Note that `None` is the valid, default
                category.

         N/A N/A category N/A N/A N/A N/A N/A getattr N/A self obj N/A self _m2m_fieldname clear N/A N/A N/A N/A N/A N/A N/A getattr N/A self obj N/A self _m2m_fieldname filter db_category category delete N/A N/A N/A self _recache N/A all N/A N/A self category return_key_and_category N/A None False N/A N/A 
        Get all tags in this handler.

        Args:
            category (str, optional): The Tag category to limit the
                request to. Note that `None` is the valid, default
                category.
            return_key_and_category (bool, optional): Return a list of
                tuples `[(key, category), ...]`.

        Returns:
            tags (list): A list of tag keys `[tagkey, tagkey, ...]` or
                a list of tuples `[(key, category), ...]` if
                `return_key_and_category` is set.

         N/A N/A N/A N/A self _cache None N/A _TYPECLASS_AGGRESSIVE_CACHE N/A N/A N/A N/A self _recache N/A category N/A N/A category N/A N/A category None N/A N/A N/A N/A category strip lower None N/A matches N/A tag N/A tag N/A N/A N/A self _cache values N/A N/A tag db_category category N/A N/A matches N/A N/A N/A self _cache values N/A matches N/A N/A matches N/A sorted matches key N/A N/A N/A o N/A N/A o id N/A return_key_and_category N/A N/A N/A N/A N/A to_str N/A p db_key N/A to_str N/A p db_category N/A p matches N/A N/A N/A N/A to_str N/A p db_key N/A p matches N/A N/A N/A __str__ N/A N/A self N/A N/A N/A N/A N/A , join N/A N/A self all N/A __unicode N/A N/A self N/A N/A N/A N/A N/A , join N/A N/A self all N/A N/A AliasHandler N/A TagHandler N/A N/A 
    A handler for the Alias Tag type.

     N/A _tagtype alias N/A PermissionHandler N/A TagHandler N/A N/A 
    A handler for the Permission Tag type.

     N/A _tagtype permission N/A