-
Notifications
You must be signed in to change notification settings - Fork 3
/
handler_log.py
185 lines (159 loc) · 7.41 KB
/
handler_log.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
# PythonWars copyright © 2020, 2021 by Paul Penner. All rights reserved.
# In order to use this codebase you must comply with all licenses.
#
# Original Diku Mud copyright © 1990, 1991 by Sebastian Hammer,
# Michael Seifert, Hans Henrik Stærfeldt, Tom Madsen, and Katja Nyboe.
#
# Merc Diku Mud improvements copyright © 1992, 1993 by Michael
# Chastain, Michael Quan, and Mitchell Tse.
#
# ROM 2.4 is copyright 1993-1998 Russ Taylor. ROM has been brought to
# you by the ROM consortium: Russ Taylor (rtaylor@hypercube.org),
# Gabrielle Taylor (gtaylor@hypercube.org), and Brian Moore (zump@rom.org).
#
# Ported to Python by Davion of MudBytes.net using Miniboa
# (https://code.google.com/p/miniboa/).
#
# In order to use any part of this Merc Diku Mud, you must comply with
# both the original Diku license in 'license.doc' as well the Merc
# license in 'license.txt'. In particular, you may not remove either of
# these copyright notices.
#
# Much time and thought has gone into this software, and you are
# benefiting. We hope that you share your changes too. What goes
# around, comes around.
import functools
import inspect
import sys
import comm
import handler_pc
import merc
"""So far this wrapper class will allow debugging of a function as such:
@logger("Debug")
def some_func(stuff)
Once attached, it will safely try the function and print a failure.
It will also send a message to the calling character about a failure,
if there was a calling character.
Will add actual logfile support soon, and build out additional logging templates"""
class GlobalDebugFlag:
"""Enable or disable our global flags"""
@property
def gdfset(self):
return merc.GDF
@gdfset.setter
def gdfset(self, value):
merc.GDF = value
@property
def gdcfset(self):
return merc.GDCF
@gdcfset.setter
def gdcfset(self, value):
merc.GDCF = value
def value_to_str(v):
import interp
if isinstance(v, handler_pc.Pc):
return v.name
elif isinstance(v, interp.CmdType):
return v.cmd_fun
elif isinstance(v, str):
return "".join(["'", v.replace("\n", "\\n"), "'"])
else:
# noinspection PyBroadException
try:
return str(v).replace("\n", "\\n")
except:
return "<ERROR: CANNOT PRINT>"
# noinspection PyUnresolvedReferences
def char_parse_exception(error_object, *args, ch): # Parser for exceptions with a CH entity for extra msging
merc.GDF = False
wrap_call = inspect.getinnerframes(sys.exc_info()[2])
if ch.level == merc.MAX_LEVEL:
ch.send(f"An Exception Occurred:\n{type(error_object)} {str(error_object)}\n\n")
comm.notify(f"Exception: {type(error_object)} {str(error_object)}", merc.CONSOLE_DEBUG)
for call_info in reversed(wrap_call):
local_calls = call_info[0].f_locals
if "_logged__tracer_var_" in local_calls:
continue
if ch.level == merc.MAX_LEVEL:
ch.send(f"--Frame Trace--\nFile: {call_info[1]}\nFunction: {call_info[3]}\nLine: {call_info[2]:,}\nCode: {call_info[4][0].lstrip()}\n")
comm.notify(f"--Frame Trace--nFile: {call_info[1]}\nFunction: {call_info[3]}\nLine: {call_info[2]:,}\nCode: {call_info[4][0].lstrip()}", merc.CONSOLE_DEBUG)
comm.notify("Local Env Variables: ", merc.CONSOLE_DEBUG)
for k, v in local_calls.items():
levtrace = value_to_str(v)
comm.notify(f"{k} : {levtrace}", merc.CONSOLE_DEBUG)
# noinspection PyUnresolvedReferences
def noch_parse_exception(error_object, *args):
merc.GDF = False
wrap_call = inspect.getinnerframes(sys.exc_info()[2])
comm.notify(f"Exception: {type(error_object)} {str(error_object)}", merc.CONSOLE_DEBUG)
for call_info in reversed(wrap_call):
local_calls = call_info[0].f_locals
if "_logged__tracer_var_" in local_calls:
continue
tracestring = "Frame Trace: \nFile: %s \nLine: %d \n ", call_info[1], call_info[2]
tracestring += "Function: %s \nCode: %s ", call_info[3], call_info[4][0].lstrip()
comm.notify(tracestring, merc.CONSOLE_DEBUG)
comm.notify("Local Env Variables: ", merc.CONSOLE_DEBUG)
for k, v in local_calls.items():
levtrace = value_to_str(v)
comm.notify(f"{k} : {levtrace}", merc.CONSOLE_DEBUG)
class Logged(object):
def __init__(self, log_type, ch=None):
"""Init the logger, log_type"""
self.log_type = log_type
self.ch = ch
def __call__(self, func):
"""the class needs to be callable for this to work"""
functools.update_wrapper(self, func)
# Add debug log for any function you wish for TS, provides trace of incident
if self.log_type == "Debug": # Used to wrap any function and does not know about or care about flags
def debug(*args, **kwargs):
if args and isinstance(args[0], handler_pc.Pc):
mch = args[0]
else:
mch = self.ch
"""__tracer_var_ becomes _logger__tracer_var_ in the trace.
This is used to determine if we are within the wrapping frame
or the wrapped frame.
Leave this in place to receive only the wrapped frame trace info
- we dont care about the wrapping frame information."""
__tracer_var_ = 0
try:
return func(*args, **kwargs)
except Exception as err:
if isinstance(mch, handler_pc.Pc):
if mch.level == merc.MAX_LEVEL:
mch.send("Debug has been Enabled\n\n")
char_parse_exception(err, args, ch=mch)
else:
noch_parse_exception(err, args)
return
return debug
if self.log_type == "Interp": # Used with interp and either debug command, or global debug flag
def interp_debug(*args, **kwargs):
if merc.GDF is False and merc.GDCF is False: # Check for global/debug command flags
return func(*args, **kwargs) # if none of the debugs are on, just send the command as normal
if args and isinstance(args[0], handler_pc.Pc):
"""check if there are args, and the args entail a character structure"""
mch = args[0] # If so, lets make a char object so we can send messages as needed
else:
mch = self.ch # If so, lets make a char object so we can send messages as needed
"""__tracer_var_ becomes _logger__tracer_var_ in the trace.
This is used to determine if we are within the wrapping frame
or the wrapped frame.
Leave this in place to receive only the wrapped frame trace info
- we dont care about the wrapping frame information."""
__tracer_var_ = 0
try:
return func(*args, **kwargs)
except Exception as err:
if isinstance(mch, handler_pc.Pc):
mch.send("#RERROR:#n Debug has been enabled.\n")
mch.send("%s\n" % err)
char_parse_exception(err, args, ch=mch)
else:
noch_parse_exception(err, args)
return
return interp_debug
else:
return func