Update game template class doc strings to be more up-to-date. Resolve #3387

evennia/accounts/accounts.py

@@ -16,14 +16,13 @@ import time
 import typing
 from random import getrandbits
 
+import evennia
 from django.conf import settings
 from django.contrib.auth import authenticate, password_validation
 from django.core.exceptions import ImproperlyConfigured, ValidationError
 from django.utils import timezone
 from django.utils.module_loading import import_string
 from django.utils.translation import gettext as _
-
-import evennia
 from evennia.accounts.manager import AccountManager
 from evennia.accounts.models import AccountDB
 from evennia.commands.cmdsethandler import CmdSetHandler
@@ -31,24 +30,17 @@ from evennia.comms.models import ChannelDB
 from evennia.objects.models import ObjectDB
 from evennia.scripts.scripthandler import ScriptHandler
 from evennia.server.models import ServerConfig
-from evennia.server.signals import (
-    SIGNAL_ACCOUNT_POST_CREATE,
-    SIGNAL_ACCOUNT_POST_LOGIN_FAIL,
-    SIGNAL_OBJECT_POST_PUPPET,
-    SIGNAL_OBJECT_POST_UNPUPPET,
-)
+from evennia.server.signals import (SIGNAL_ACCOUNT_POST_CREATE,
+                                    SIGNAL_ACCOUNT_POST_LOGIN_FAIL,
+                                    SIGNAL_OBJECT_POST_PUPPET,
+                                    SIGNAL_OBJECT_POST_UNPUPPET)
 from evennia.server.throttle import Throttle
 from evennia.typeclasses.attributes import ModelAttributeBackend, NickHandler
 from evennia.typeclasses.models import TypeclassBase
 from evennia.utils import class_from_module, create, logger
 from evennia.utils.optionhandler import OptionHandler
-from evennia.utils.utils import (
-    is_iter,
-    lazy_property,
-    make_iter,
-    to_str,
-    variable_from_module,
-)
+from evennia.utils.utils import (is_iter, lazy_property, make_iter, to_str,
+                                 variable_from_module)
 
 __all__ = ("DefaultAccount", "DefaultGuest")
 
@@ -226,7 +218,6 @@ class DefaultAccount(AccountDB, metaclass=TypeclassBase):
      - user (User, read-only) - django User authorization object
      - obj (Object) - game object controlled by account. 'character' can also
                      be used.
-     - sessions (list of Sessions) - sessions connected to this account
      - is_superuser (bool, read-only) - if the connected user is a superuser
 
     * Handlers
@@ -239,18 +230,47 @@ class DefaultAccount(AccountDB, metaclass=TypeclassBase):
      - scripts - script-handler. Add new scripts to object with scripts.add()
      - cmdset - cmdset-handler. Use cmdset.add() to add new cmdsets to object
      - nicks - nick-handler. New nicks with nicks.add().
+     - sessions - session-handler. Use session.get() to see all sessions connected, if any
+     - options - option-handler. Defaults are taken from settings.OPTIONS_ACCOUNT_DEFAULT
+     - characters - handler for listing the account's playable characters
 
-    * Helper methods
+    * Helper methods (check autodocs for full updated listing)
 
      - msg(text=None, from_obj=None, session=None, options=None, **kwargs)
      - execute_cmd(raw_string)
-     - search(ostring, global_search=False, attribute_name=None,
-                      use_nicks=False, location=None,
-                      ignore_errors=False, account=False)
+     - search(searchdata, return_puppet=False, search_object=False, typeclass=None,
+                      nofound_string=None, multimatch_string=None, use_nicks=True,
+                      quiet=False, **kwargs)
      - is_typeclass(typeclass, exact=False)
      - swap_typeclass(new_typeclass, clean_attributes=False, no_default=True)
-     - access(accessing_obj, access_type='read', default=False, no_superuser_bypass=False)
+     - access(accessing_obj, access_type='read', default=False, no_superuser_bypass=False, **kwargs)
      - check_permstring(permstring)
+     - get_cmdsets(caller, current, **kwargs)
+     - get_cmdset_providers()
+     - uses_screenreader(session=None)
+     - get_display_name(looker, **kwargs)
+     - get_extra_display_name_info(looker, **kwargs)
+     - disconnect_session_from_account()
+     - puppet_object(session, obj)
+     - unpuppet_object(session)
+     - unpuppet_all()
+     - get_puppet(session)
+     - get_all_puppets()
+     - is_banned(**kwargs)
+     - get_username_validators(validator_config=settings.AUTH_USERNAME_VALIDATORS)
+     - authenticate(username, password, ip="", **kwargs)
+     - normalize_username(username)
+     - validate_username(username)
+     - validate_password(password, account=None)
+     - set_password(password, **kwargs)
+     - get_character_slots()
+     - get_available_character_slots()
+     - create_character(*args, **kwargs)
+     - create(*args, **kwargs)
+     - delete(*args, **kwargs)
+     - channel_msg(message, channel, senders=None, **kwargs)
+     - idle_time()
+     - connection_time()
 
     * Hook methods
 
@@ -261,15 +281,26 @@ class DefaultAccount(AccountDB, metaclass=TypeclassBase):
        usually handled on the character level:
 
      - at_init()
+     - at_first_save()
      - at_access()
      - at_cmdset_get(**kwargs)
+     - at_password_change(**kwargs)
      - at_first_login()
+     - at_pre_login()
      - at_post_login(session=None)
-     - at_disconnect()
+     - at_failed_login(session, **kwargs)
+     - at_disconnect(reason=None, **kwargs)
+     - at_post_disconnect(**kwargs)
      - at_message_receive()
      - at_message_send()
      - at_server_reload()
      - at_server_shutdown()
+     - at_look(target=None, session=None, **kwargs)
+     - at_post_create_character(character, **kwargs)
+     - at_post_add_character(char)
+     - at_post_remove_character(char)
+     - at_pre_channel_msg(message, channel, senders=None, **kwargs)
+     - at_post_chnnel_msg(message, channel, senders=None, **kwargs)
 
     """