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

Tweak top level api

Browse source
This commit is contained in:
Griatch 2020-10-13 09:24:22 +02:00
parent 3cd8c4a0e6
commit 095c3dd652
1 changed files with 23 additions and 29 deletions
Download patch file Download diff file Expand all files Collapse all files

52
evennia/__init__.py
View file

@ -5,7 +5,7 @@ This is the main top-level API for Evennia. You can explore the evennia library
by accessing evennia.<subpackage> directly. From inside the game you can read by accessing evennia.<subpackage> directly. From inside the game you can read
docs of all object by viewing its `__doc__` string, such as through docs of all object by viewing its `__doc__` string, such as through
@py evennia.ObjectDB.__doc__ py evennia.ObjectDB.__doc__
For full functionality you should explore this module via a django- For full functionality you should explore this module via a django-
aware shell. Go to your game directory and use the command aware shell. Go to your game directory and use the command
@ -20,27 +20,13 @@ See www.evennia.com for full documentation.
# docstring header # docstring header
DOCSTRING = """ DOCSTRING = """
|cEvennia|n 'flat' API (use |wevennia.<component>.__doc__|n to read doc-strings Evennia MU* creation system.
and |wdict(evennia.component)|n or
|wevennia.component.__dict__ to see contents) Online manual and API docs are found at http://www.evennia.com.
|cTypeclass-bases:|n |cDatabase models|n:
DefaultAccount DefaultObject AccountDB ObjectDB Flat-API shortcut names:
DefaultGuest DefaultCharacter ChannelDB {}
DefaultRoom ScriptDB """
DefaultChannel DefaultExit Msg
DefaultScript
|cSearch functions:|n |cCommand parents and helpers:|n
search_account search_object default_cmds
search_script search_channel Command InterruptCommand
search_help search_message CmdSet
search_tag managers |cUtilities:|n
|cCreate functions:|n settings lockfuncs
create_account create_object logger gametime
create_script create_channel ansi spawn
create_help_entry create_message contrib managers
|cGlobal handlers:|n set_trace
TICKER_HANDLER TASK_HANDLER EvMenu EvTable
SESSION_HANDLER CHANNEL_HANDLER EvForm EvEditor """
# Delayed loading of properties # Delayed loading of properties
@ -248,10 +234,6 @@ def _init():
from .utils.containers import GLOBAL_SCRIPTS from .utils.containers import GLOBAL_SCRIPTS
from .utils.containers import OPTION_CLASSES from .utils.containers import OPTION_CLASSES
# initialize the doc string
global __doc__
__doc__ = ansi.parse_ansi(DOCSTRING)
# API containers # API containers
class _EvContainer(object): class _EvContainer(object):
@ -414,7 +396,7 @@ def _init():
GLOBAL_SCRIPTS.start() GLOBAL_SCRIPTS.start()
def set_trace(term_size=(140, 40), debugger="auto"): def set_trace(term_size=(140, 80), debugger="auto"):
""" """
Helper function for running a debugger inside the Evennia event loop. Helper function for running a debugger inside the Evennia event loop.
@ -461,9 +443,21 @@ def set_trace(term_size=(140, 40), debugger="auto"):
dbg = pdb.Pdb(stdout=sys.__stdout__) dbg = pdb.Pdb(stdout=sys.__stdout__)
try: try:
# Start debugger, forcing it up one stack frame (otherwise `set_trace` will start debugger # Start debugger, forcing it up one stack frame (otherwise `set_trace`
# this point, not the actual code location) # will start debugger this point, not the actual code location)
dbg.set_trace(sys._getframe().f_back) dbg.set_trace(sys._getframe().f_back)
except Exception: except Exception:
# Stopped at breakpoint. Press 'n' to continue into the code. # Stopped at breakpoint. Press 'n' to continue into the code.
dbg.set_trace() dbg.set_trace()
# initialize the doc string
global __doc__
__doc__ = DOCSTRING.format(
"\n- "
+ "\n- ".join(
f"evennia.{key}"
for key in sorted(globals())
if not key.startswith("_") and key not in ("DOCSTRING",)
)
)