2019-12-02 21:46:54 +00:00
|
|
|
import code
|
|
|
|
import sys
|
2022-01-24 04:07:52 +00:00
|
|
|
import typing as t
|
2022-11-07 18:06:49 +00:00
|
|
|
from contextvars import ContextVar
|
2019-12-02 21:46:54 +00:00
|
|
|
from types import CodeType
|
|
|
|
|
2022-11-07 18:06:49 +00:00
|
|
|
from markupsafe import escape
|
|
|
|
|
2019-12-02 21:46:54 +00:00
|
|
|
from .repr import debug_repr
|
|
|
|
from .repr import dump
|
|
|
|
from .repr import helper
|
|
|
|
|
2022-01-24 04:07:52 +00:00
|
|
|
if t.TYPE_CHECKING:
|
|
|
|
import codeop # noqa: F401
|
2019-12-02 21:46:54 +00:00
|
|
|
|
2022-11-07 18:06:49 +00:00
|
|
|
_stream: ContextVar["HTMLStringO"] = ContextVar("werkzeug.debug.console.stream")
|
|
|
|
_ipy: ContextVar = ContextVar("werkzeug.debug.console.ipy")
|
2019-12-02 21:46:54 +00:00
|
|
|
|
|
|
|
|
2022-01-24 04:07:52 +00:00
|
|
|
class HTMLStringO:
|
2019-12-02 21:46:54 +00:00
|
|
|
"""A StringO version that HTML escapes on write."""
|
|
|
|
|
2022-01-24 04:07:52 +00:00
|
|
|
def __init__(self) -> None:
|
|
|
|
self._buffer: t.List[str] = []
|
2019-12-02 21:46:54 +00:00
|
|
|
|
2022-01-24 04:07:52 +00:00
|
|
|
def isatty(self) -> bool:
|
2019-12-02 21:46:54 +00:00
|
|
|
return False
|
|
|
|
|
2022-01-24 04:07:52 +00:00
|
|
|
def close(self) -> None:
|
2019-12-02 21:46:54 +00:00
|
|
|
pass
|
|
|
|
|
2022-01-24 04:07:52 +00:00
|
|
|
def flush(self) -> None:
|
2019-12-02 21:46:54 +00:00
|
|
|
pass
|
|
|
|
|
2022-01-24 04:07:52 +00:00
|
|
|
def seek(self, n: int, mode: int = 0) -> None:
|
2019-12-02 21:46:54 +00:00
|
|
|
pass
|
|
|
|
|
2022-01-24 04:07:52 +00:00
|
|
|
def readline(self) -> str:
|
2019-12-02 21:46:54 +00:00
|
|
|
if len(self._buffer) == 0:
|
|
|
|
return ""
|
|
|
|
ret = self._buffer[0]
|
|
|
|
del self._buffer[0]
|
|
|
|
return ret
|
|
|
|
|
2022-01-24 04:07:52 +00:00
|
|
|
def reset(self) -> str:
|
2019-12-02 21:46:54 +00:00
|
|
|
val = "".join(self._buffer)
|
|
|
|
del self._buffer[:]
|
|
|
|
return val
|
|
|
|
|
2022-01-24 04:07:52 +00:00
|
|
|
def _write(self, x: str) -> None:
|
2019-12-02 21:46:54 +00:00
|
|
|
if isinstance(x, bytes):
|
|
|
|
x = x.decode("utf-8", "replace")
|
|
|
|
self._buffer.append(x)
|
|
|
|
|
2022-01-24 04:07:52 +00:00
|
|
|
def write(self, x: str) -> None:
|
2019-12-02 21:46:54 +00:00
|
|
|
self._write(escape(x))
|
|
|
|
|
2022-01-24 04:07:52 +00:00
|
|
|
def writelines(self, x: t.Iterable[str]) -> None:
|
2019-12-02 21:46:54 +00:00
|
|
|
self._write(escape("".join(x)))
|
|
|
|
|
|
|
|
|
2022-01-24 04:07:52 +00:00
|
|
|
class ThreadedStream:
|
2019-12-02 21:46:54 +00:00
|
|
|
"""Thread-local wrapper for sys.stdout for the interactive console."""
|
|
|
|
|
|
|
|
@staticmethod
|
2022-01-24 04:07:52 +00:00
|
|
|
def push() -> None:
|
2019-12-02 21:46:54 +00:00
|
|
|
if not isinstance(sys.stdout, ThreadedStream):
|
2022-01-24 04:07:52 +00:00
|
|
|
sys.stdout = t.cast(t.TextIO, ThreadedStream())
|
2022-11-07 18:06:49 +00:00
|
|
|
|
|
|
|
_stream.set(HTMLStringO())
|
2019-12-02 21:46:54 +00:00
|
|
|
|
|
|
|
@staticmethod
|
2022-01-24 04:07:52 +00:00
|
|
|
def fetch() -> str:
|
2019-12-02 21:46:54 +00:00
|
|
|
try:
|
2022-11-07 18:06:49 +00:00
|
|
|
stream = _stream.get()
|
|
|
|
except LookupError:
|
2019-12-02 21:46:54 +00:00
|
|
|
return ""
|
2022-11-07 18:06:49 +00:00
|
|
|
|
|
|
|
return stream.reset()
|
2019-12-02 21:46:54 +00:00
|
|
|
|
|
|
|
@staticmethod
|
2022-01-24 04:07:52 +00:00
|
|
|
def displayhook(obj: object) -> None:
|
2019-12-02 21:46:54 +00:00
|
|
|
try:
|
2022-11-07 18:06:49 +00:00
|
|
|
stream = _stream.get()
|
|
|
|
except LookupError:
|
2022-01-24 04:07:52 +00:00
|
|
|
return _displayhook(obj) # type: ignore
|
2022-11-07 18:06:49 +00:00
|
|
|
|
2019-12-02 21:46:54 +00:00
|
|
|
# stream._write bypasses escaping as debug_repr is
|
|
|
|
# already generating HTML for us.
|
|
|
|
if obj is not None:
|
2022-11-07 18:06:49 +00:00
|
|
|
_ipy.get().locals["_"] = obj
|
2019-12-02 21:46:54 +00:00
|
|
|
stream._write(debug_repr(obj))
|
|
|
|
|
2022-01-24 04:07:52 +00:00
|
|
|
def __setattr__(self, name: str, value: t.Any) -> None:
|
|
|
|
raise AttributeError(f"read only attribute {name}")
|
2019-12-02 21:46:54 +00:00
|
|
|
|
2022-01-24 04:07:52 +00:00
|
|
|
def __dir__(self) -> t.List[str]:
|
2019-12-02 21:46:54 +00:00
|
|
|
return dir(sys.__stdout__)
|
|
|
|
|
2022-01-24 04:07:52 +00:00
|
|
|
def __getattribute__(self, name: str) -> t.Any:
|
2019-12-02 21:46:54 +00:00
|
|
|
try:
|
2022-11-07 18:06:49 +00:00
|
|
|
stream = _stream.get()
|
|
|
|
except LookupError:
|
|
|
|
stream = sys.__stdout__ # type: ignore[assignment]
|
|
|
|
|
2019-12-02 21:46:54 +00:00
|
|
|
return getattr(stream, name)
|
|
|
|
|
2022-01-24 04:07:52 +00:00
|
|
|
def __repr__(self) -> str:
|
2019-12-02 21:46:54 +00:00
|
|
|
return repr(sys.__stdout__)
|
|
|
|
|
|
|
|
|
|
|
|
# add the threaded stream as display hook
|
|
|
|
_displayhook = sys.displayhook
|
|
|
|
sys.displayhook = ThreadedStream.displayhook
|
|
|
|
|
|
|
|
|
2022-01-24 04:07:52 +00:00
|
|
|
class _ConsoleLoader:
|
|
|
|
def __init__(self) -> None:
|
|
|
|
self._storage: t.Dict[int, str] = {}
|
2019-12-02 21:46:54 +00:00
|
|
|
|
2022-01-24 04:07:52 +00:00
|
|
|
def register(self, code: CodeType, source: str) -> None:
|
2019-12-02 21:46:54 +00:00
|
|
|
self._storage[id(code)] = source
|
|
|
|
# register code objects of wrapped functions too.
|
|
|
|
for var in code.co_consts:
|
|
|
|
if isinstance(var, CodeType):
|
|
|
|
self._storage[id(var)] = source
|
|
|
|
|
2022-01-24 04:07:52 +00:00
|
|
|
def get_source_by_code(self, code: CodeType) -> t.Optional[str]:
|
2019-12-02 21:46:54 +00:00
|
|
|
try:
|
|
|
|
return self._storage[id(code)]
|
|
|
|
except KeyError:
|
2022-01-24 04:07:52 +00:00
|
|
|
return None
|
2019-12-02 21:46:54 +00:00
|
|
|
|
|
|
|
|
|
|
|
class _InteractiveConsole(code.InteractiveInterpreter):
|
2022-01-24 04:07:52 +00:00
|
|
|
locals: t.Dict[str, t.Any]
|
|
|
|
|
|
|
|
def __init__(self, globals: t.Dict[str, t.Any], locals: t.Dict[str, t.Any]) -> None:
|
|
|
|
self.loader = _ConsoleLoader()
|
|
|
|
locals = {
|
|
|
|
**globals,
|
|
|
|
**locals,
|
|
|
|
"dump": dump,
|
|
|
|
"help": helper,
|
|
|
|
"__loader__": self.loader,
|
|
|
|
}
|
|
|
|
super().__init__(locals)
|
|
|
|
original_compile = self.compile
|
|
|
|
|
2022-11-07 18:06:49 +00:00
|
|
|
def compile(source: str, filename: str, symbol: str) -> t.Optional[CodeType]:
|
2022-01-24 04:07:52 +00:00
|
|
|
code = original_compile(source, filename, symbol)
|
2022-11-07 18:06:49 +00:00
|
|
|
|
|
|
|
if code is not None:
|
|
|
|
self.loader.register(code, source)
|
|
|
|
|
2022-01-24 04:07:52 +00:00
|
|
|
return code
|
|
|
|
|
2022-11-07 18:06:49 +00:00
|
|
|
self.compile = compile # type: ignore[assignment]
|
2019-12-02 21:46:54 +00:00
|
|
|
self.more = False
|
2022-01-24 04:07:52 +00:00
|
|
|
self.buffer: t.List[str] = []
|
2019-12-02 21:46:54 +00:00
|
|
|
|
2022-01-24 04:07:52 +00:00
|
|
|
def runsource(self, source: str, **kwargs: t.Any) -> str: # type: ignore
|
|
|
|
source = f"{source.rstrip()}\n"
|
2019-12-02 21:46:54 +00:00
|
|
|
ThreadedStream.push()
|
|
|
|
prompt = "... " if self.more else ">>> "
|
|
|
|
try:
|
|
|
|
source_to_eval = "".join(self.buffer + [source])
|
2022-01-24 04:07:52 +00:00
|
|
|
if super().runsource(source_to_eval, "<debugger>", "single"):
|
2019-12-02 21:46:54 +00:00
|
|
|
self.more = True
|
|
|
|
self.buffer.append(source)
|
|
|
|
else:
|
|
|
|
self.more = False
|
|
|
|
del self.buffer[:]
|
|
|
|
finally:
|
|
|
|
output = ThreadedStream.fetch()
|
2022-11-07 18:06:49 +00:00
|
|
|
return f"{prompt}{escape(source)}{output}"
|
2019-12-02 21:46:54 +00:00
|
|
|
|
2022-01-24 04:07:52 +00:00
|
|
|
def runcode(self, code: CodeType) -> None:
|
2019-12-02 21:46:54 +00:00
|
|
|
try:
|
2022-01-24 04:07:52 +00:00
|
|
|
exec(code, self.locals)
|
2019-12-02 21:46:54 +00:00
|
|
|
except Exception:
|
|
|
|
self.showtraceback()
|
|
|
|
|
2022-01-24 04:07:52 +00:00
|
|
|
def showtraceback(self) -> None:
|
2022-11-07 18:06:49 +00:00
|
|
|
from .tbtools import DebugTraceback
|
2019-12-02 21:46:54 +00:00
|
|
|
|
2022-11-07 18:06:49 +00:00
|
|
|
exc = t.cast(BaseException, sys.exc_info()[1])
|
|
|
|
te = DebugTraceback(exc, skip=1)
|
|
|
|
sys.stdout._write(te.render_traceback_html()) # type: ignore
|
2019-12-02 21:46:54 +00:00
|
|
|
|
2022-01-24 04:07:52 +00:00
|
|
|
def showsyntaxerror(self, filename: t.Optional[str] = None) -> None:
|
2022-11-07 18:06:49 +00:00
|
|
|
from .tbtools import DebugTraceback
|
2019-12-02 21:46:54 +00:00
|
|
|
|
2022-11-07 18:06:49 +00:00
|
|
|
exc = t.cast(BaseException, sys.exc_info()[1])
|
|
|
|
te = DebugTraceback(exc, skip=4)
|
|
|
|
sys.stdout._write(te.render_traceback_html()) # type: ignore
|
2019-12-02 21:46:54 +00:00
|
|
|
|
2022-01-24 04:07:52 +00:00
|
|
|
def write(self, data: str) -> None:
|
2019-12-02 21:46:54 +00:00
|
|
|
sys.stdout.write(data)
|
|
|
|
|
|
|
|
|
2022-01-24 04:07:52 +00:00
|
|
|
class Console:
|
2019-12-02 21:46:54 +00:00
|
|
|
"""An interactive console."""
|
|
|
|
|
2022-01-24 04:07:52 +00:00
|
|
|
def __init__(
|
|
|
|
self,
|
|
|
|
globals: t.Optional[t.Dict[str, t.Any]] = None,
|
|
|
|
locals: t.Optional[t.Dict[str, t.Any]] = None,
|
|
|
|
) -> None:
|
2019-12-02 21:46:54 +00:00
|
|
|
if locals is None:
|
|
|
|
locals = {}
|
|
|
|
if globals is None:
|
|
|
|
globals = {}
|
|
|
|
self._ipy = _InteractiveConsole(globals, locals)
|
|
|
|
|
2022-01-24 04:07:52 +00:00
|
|
|
def eval(self, code: str) -> str:
|
2022-11-07 18:06:49 +00:00
|
|
|
_ipy.set(self._ipy)
|
2019-12-02 21:46:54 +00:00
|
|
|
old_sys_stdout = sys.stdout
|
|
|
|
try:
|
|
|
|
return self._ipy.runsource(code)
|
|
|
|
finally:
|
|
|
|
sys.stdout = old_sys_stdout
|