Add initial `repl_fixture` support B)
It turns out to be fairly useful to allow hooking into a given actor's
entry-and-exit around `.devx._debug._pause/._post_mortem()` calls which
engage the `pdbp.Pdb` REPL (really our `._debug.PdbREPL` but yeah).
Some very handy use cases include,
- swapping out-of-band (config) state that may otherwise halt the
user's app since the actor normally handles kb&mouse input, in thread,
which means that the handler will be blocked while the REPL is in use.
- (remotely) reporting actor-runtime state for monitoring purposes
around crashes or pauses in normal operation.
- allowing for crash-handling to be hard-disabled via
`._state._runtime_vars` say for when you never want a debugger to be
entered in a production instance where you're not-sure-if/don't-want
per-actor `debug_mode: bool` settings to always be unset, say bc
you're still debugging some edge cases that ow you'd normally want to
REPL up.
Impl details,
- add a new optional `._state._runtime_vars['repl_fixture']` field which
for now can be manually set; i saw no reason for a formal API yet
since we want to convert the `dict` to a struct anyway (first).
- augment both `.devx._debug._pause()/._post_mortem()` with a new
optional `repl_fixture: AbstractContextManager[bool]` kwarg which
when provided is `with repl_fixture()` opened around the lowlevel
REPL interaction calls; if the enter-result, an expected `bool`, is
`False` then the interaction is hard-bypassed.
* for the `._pause()` case the `@cm` is opened around the entire body
of the embedded `_enter_repl_sync()` closure (for now) though
ideally longer term this entire routine is factored to be a lot less
"nested" Bp
* in `_post_mortem()` the entire previous body is wrapped similarly
and also now excepts an optional `boxed_maybe_exc: BoxedMaybeException`
only passed in the `open_crash_handler()` caller case.
- when the new runtime-var is overridden, (only manually atm) it is used
instead but only whenever the above `repl_fixture` kwarg is left null.
- add a `BoxedMaybeException.pformat() = __repr__()` which when
a `.value: Exception` is set renders a more "objecty" repr of the exc.
Obviously tests for all this should be coming soon!
repl_fixture
Tyler Goodlet
parent
c93a7d9b24
commit
5e102ec368
|
|
@ -48,8 +48,9 @@ _current_actor: Actor|None = None # type: ignore # noqa
|
|||
_last_actor_terminated: Actor|None = None
|
||||
|
||||
# TODO: mk this a `msgspec.Struct`!
|
||||
# -[ ] type out all fields obvi!
|
||||
# -[ ] (eventually) mk wire-ready for monitoring?
|
||||
_runtime_vars: dict[str, Any] = {
|
||||
'_debug_mode': False,
|
||||
# root of actor-process tree info
|
||||
'_is_root': False, # bool
|
||||
'_root_mailbox': (None, None), # tuple[str|None, str|None]
|
||||
|
|
@ -61,10 +62,14 @@ _runtime_vars: dict[str, Any] = {
|
|||
# registrar info
|
||||
'_registry_addrs': [],
|
||||
|
||||
'_is_infected_aio': False,
|
||||
|
||||
# `debug_mode: bool` settings
|
||||
'_debug_mode': False, # bool
|
||||
'repl_fixture': False, # |AbstractContextManager[bool]
|
||||
# for `tractor.pause_from_sync()` & `breakpoint()` support
|
||||
'use_greenback': False,
|
||||
|
||||
# infected-`asyncio`-mode: `trio` running as guest.
|
||||
'_is_infected_aio': False,
|
||||
}
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -23,6 +23,7 @@ from __future__ import annotations
|
|||
import asyncio
|
||||
import bdb
|
||||
from contextlib import (
|
||||
AbstractContextManager,
|
||||
asynccontextmanager as acm,
|
||||
contextmanager as cm,
|
||||
nullcontext,
|
||||
|
|
@ -1774,6 +1775,13 @@ async def _pause(
|
|||
tuple[Task, PdbREPL],
|
||||
trio.Event
|
||||
] = trio.TASK_STATUS_IGNORED,
|
||||
|
||||
# maybe pre/post REPL entry
|
||||
repl_fixture: (
|
||||
AbstractContextManager[bool]
|
||||
|None
|
||||
) = None,
|
||||
|
||||
**debug_func_kwargs,
|
||||
|
||||
) -> tuple[Task, PdbREPL]|None:
|
||||
|
|
@ -1836,76 +1844,103 @@ async def _pause(
|
|||
debug_func: partial[None],
|
||||
) -> None:
|
||||
__tracebackhide__: bool = hide_tb
|
||||
debug_func_name: str = (
|
||||
debug_func.func.__name__ if debug_func else 'None'
|
||||
)
|
||||
|
||||
# TODO: do we want to support using this **just** for the
|
||||
# locking / common code (prolly to help address #320)?
|
||||
task_status.started((task, repl))
|
||||
try:
|
||||
if debug_func:
|
||||
# block here one (at the appropriate frame *up*) where
|
||||
# ``breakpoint()`` was awaited and begin handling stdio.
|
||||
log.devx(
|
||||
'Entering sync world of the `pdb` REPL for task..\n'
|
||||
f'{repl}\n'
|
||||
f' |_{task}\n'
|
||||
)
|
||||
# TODO, support @acm?
|
||||
# -[ ] what about a return-proto for determining
|
||||
# whether the REPL should be allowed to enage?
|
||||
nonlocal repl_fixture
|
||||
if not (
|
||||
repl_fixture
|
||||
or
|
||||
(rt_repl_fixture := _state._runtime_vars.get('repl_fixture'))
|
||||
):
|
||||
repl_fixture = nullcontext(
|
||||
enter_result=True,
|
||||
)
|
||||
|
||||
# set local task on process-global state to avoid
|
||||
# recurrent entries/requests from the same
|
||||
# actor-local task.
|
||||
DebugStatus.repl_task = task
|
||||
if repl:
|
||||
DebugStatus.repl = repl
|
||||
else:
|
||||
log.error(
|
||||
'No REPl instance set before entering `debug_func`?\n'
|
||||
f'{debug_func}\n'
|
||||
_repl_fixture = repl_fixture or rt_repl_fixture
|
||||
with _repl_fixture(maybe_bxerr=None) as enter_repl:
|
||||
|
||||
# XXX when the fixture doesn't allow it, skip
|
||||
# the crash-handler REPL and raise now!
|
||||
if not enter_repl:
|
||||
log.pdb(
|
||||
f'pdbp-REPL blocked by a `repl_fixture()` which yielded `False` !\n'
|
||||
f'repl_fixture: {repl_fixture}\n'
|
||||
f'rt_repl_fixture: {rt_repl_fixture}\n'
|
||||
)
|
||||
return
|
||||
|
||||
debug_func_name: str = (
|
||||
debug_func.func.__name__ if debug_func else 'None'
|
||||
)
|
||||
|
||||
# TODO: do we want to support using this **just** for the
|
||||
# locking / common code (prolly to help address #320)?
|
||||
task_status.started((task, repl))
|
||||
try:
|
||||
if debug_func:
|
||||
# block here one (at the appropriate frame *up*) where
|
||||
# ``breakpoint()`` was awaited and begin handling stdio.
|
||||
log.devx(
|
||||
'Entering sync world of the `pdb` REPL for task..\n'
|
||||
f'{repl}\n'
|
||||
f' |_{task}\n'
|
||||
)
|
||||
|
||||
# set local task on process-global state to avoid
|
||||
# recurrent entries/requests from the same
|
||||
# actor-local task.
|
||||
DebugStatus.repl_task = task
|
||||
if repl:
|
||||
DebugStatus.repl = repl
|
||||
else:
|
||||
log.error(
|
||||
'No REPl instance set before entering `debug_func`?\n'
|
||||
f'{debug_func}\n'
|
||||
)
|
||||
|
||||
# invoke the low-level REPL activation routine which itself
|
||||
# should call into a `Pdb.set_trace()` of some sort.
|
||||
debug_func(
|
||||
repl=repl,
|
||||
hide_tb=hide_tb,
|
||||
**debug_func_kwargs,
|
||||
)
|
||||
|
||||
# invoke the low-level REPL activation routine which itself
|
||||
# should call into a `Pdb.set_trace()` of some sort.
|
||||
debug_func(
|
||||
repl=repl,
|
||||
hide_tb=hide_tb,
|
||||
**debug_func_kwargs,
|
||||
# TODO: maybe invert this logic and instead
|
||||
# do `assert debug_func is None` when
|
||||
# `called_from_sync`?
|
||||
else:
|
||||
if (
|
||||
called_from_sync
|
||||
and
|
||||
not DebugStatus.is_main_trio_thread()
|
||||
):
|
||||
assert called_from_bg_thread
|
||||
assert DebugStatus.repl_task is not task
|
||||
|
||||
return (task, repl)
|
||||
|
||||
except trio.Cancelled:
|
||||
log.exception(
|
||||
'Cancelled during invoke of internal\n\n'
|
||||
f'`debug_func = {debug_func_name}`\n'
|
||||
)
|
||||
# XXX NOTE: DON'T release lock yet
|
||||
raise
|
||||
|
||||
# TODO: maybe invert this logic and instead
|
||||
# do `assert debug_func is None` when
|
||||
# `called_from_sync`?
|
||||
else:
|
||||
if (
|
||||
called_from_sync
|
||||
and
|
||||
not DebugStatus.is_main_trio_thread()
|
||||
):
|
||||
assert called_from_bg_thread
|
||||
assert DebugStatus.repl_task is not task
|
||||
except BaseException:
|
||||
__tracebackhide__: bool = False
|
||||
log.exception(
|
||||
'Failed to invoke internal\n\n'
|
||||
f'`debug_func = {debug_func_name}`\n'
|
||||
)
|
||||
# NOTE: OW this is ONLY called from the
|
||||
# `.set_continue/next` hooks!
|
||||
DebugStatus.release(cancel_req_task=True)
|
||||
|
||||
return (task, repl)
|
||||
|
||||
except trio.Cancelled:
|
||||
log.exception(
|
||||
'Cancelled during invoke of internal\n\n'
|
||||
f'`debug_func = {debug_func_name}`\n'
|
||||
)
|
||||
# XXX NOTE: DON'T release lock yet
|
||||
raise
|
||||
|
||||
except BaseException:
|
||||
__tracebackhide__: bool = False
|
||||
log.exception(
|
||||
'Failed to invoke internal\n\n'
|
||||
f'`debug_func = {debug_func_name}`\n'
|
||||
)
|
||||
# NOTE: OW this is ONLY called from the
|
||||
# `.set_continue/next` hooks!
|
||||
DebugStatus.release(cancel_req_task=True)
|
||||
|
||||
raise
|
||||
raise
|
||||
|
||||
log.devx(
|
||||
'Entering `._pause()` for requesting task\n'
|
||||
|
|
@ -2899,6 +2934,14 @@ def _post_mortem(
|
|||
shield: bool = False,
|
||||
hide_tb: bool = False,
|
||||
|
||||
# maybe pre/post REPL entry
|
||||
repl_fixture: (
|
||||
AbstractContextManager[bool]
|
||||
|None
|
||||
) = None,
|
||||
|
||||
boxed_maybe_exc: BoxedMaybeException|None = None,
|
||||
|
||||
) -> None:
|
||||
'''
|
||||
Enter the ``pdbpp`` port mortem entrypoint using our custom
|
||||
|
|
@ -2906,55 +2949,81 @@ def _post_mortem(
|
|||
|
||||
'''
|
||||
__tracebackhide__: bool = hide_tb
|
||||
try:
|
||||
actor: tractor.Actor = current_actor()
|
||||
actor_repr: str = str(actor.uid)
|
||||
# ^TODO, instead a nice runtime-info + maddr + uid?
|
||||
# -[ ] impl a `Actor.__repr()__`??
|
||||
# |_ <task>:<thread> @ <actor>
|
||||
# no_runtime: bool = False
|
||||
|
||||
except NoRuntime:
|
||||
actor_repr: str = '<no-actor-runtime?>'
|
||||
# no_runtime: bool = True
|
||||
# TODO, support @acm?
|
||||
# -[ ] what about a return-proto for determining
|
||||
# whether the REPL should be allowed to enage?
|
||||
if not (
|
||||
repl_fixture
|
||||
or
|
||||
(rt_repl_fixture := _state._runtime_vars.get('repl_fixture'))
|
||||
):
|
||||
_repl_fixture = nullcontext(
|
||||
enter_result=True,
|
||||
)
|
||||
else:
|
||||
_repl_fixture = (repl_fixture or rt_repl_fixture)(maybe_bxerr=boxed_maybe_exc)
|
||||
|
||||
try:
|
||||
task_repr: Task = current_task()
|
||||
except RuntimeError:
|
||||
task_repr: str = '<unknown-Task>'
|
||||
with _repl_fixture as enter_repl:
|
||||
|
||||
# TODO: print the actor supervion tree up to the root
|
||||
# here! Bo
|
||||
log.pdb(
|
||||
f'{_crash_msg}\n'
|
||||
f'x>(\n'
|
||||
f' |_ {task_repr} @ {actor_repr}\n'
|
||||
# XXX when the fixture doesn't allow it, skip
|
||||
# the crash-handler REPL and raise now!
|
||||
if not enter_repl:
|
||||
log.pdb(
|
||||
f'pdbp-REPL blocked by a `repl_fixture()` which yielded `False` !\n'
|
||||
f'repl_fixture: {repl_fixture}\n'
|
||||
f'rt_repl_fixture: {rt_repl_fixture}\n'
|
||||
)
|
||||
return
|
||||
|
||||
)
|
||||
try:
|
||||
actor: tractor.Actor = current_actor()
|
||||
actor_repr: str = str(actor.uid)
|
||||
# ^TODO, instead a nice runtime-info + maddr + uid?
|
||||
# -[ ] impl a `Actor.__repr()__`??
|
||||
# |_ <task>:<thread> @ <actor>
|
||||
# no_runtime: bool = False
|
||||
|
||||
# NOTE only replacing this from `pdbp.xpm()` to add the
|
||||
# `end=''` to the print XD
|
||||
print(traceback.format_exc(), end='')
|
||||
except NoRuntime:
|
||||
actor_repr: str = '<no-actor-runtime?>'
|
||||
# no_runtime: bool = True
|
||||
|
||||
caller_frame: FrameType = api_frame.f_back
|
||||
try:
|
||||
task_repr: Task = current_task()
|
||||
except RuntimeError:
|
||||
task_repr: str = '<unknown-Task>'
|
||||
|
||||
# NOTE: see the impl details of followings to understand usage:
|
||||
# - `pdbp.post_mortem()`
|
||||
# - `pdbp.xps()`
|
||||
# - `bdb.interaction()`
|
||||
repl.reset()
|
||||
repl.interaction(
|
||||
frame=caller_frame,
|
||||
# frame=None,
|
||||
traceback=tb,
|
||||
)
|
||||
# XXX NOTE XXX: absolutely required to avoid hangs!
|
||||
# Since we presume the post-mortem was enaged to a task-ending
|
||||
# error, we MUST release the local REPL request so that not other
|
||||
# local task nor the root remains blocked!
|
||||
# if not no_runtime:
|
||||
# DebugStatus.release()
|
||||
DebugStatus.release()
|
||||
# TODO: print the actor supervion tree up to the root
|
||||
# here! Bo
|
||||
log.pdb(
|
||||
f'{_crash_msg}\n'
|
||||
f'x>(\n'
|
||||
f' |_ {task_repr} @ {actor_repr}\n'
|
||||
|
||||
)
|
||||
|
||||
# NOTE only replacing this from `pdbp.xpm()` to add the
|
||||
# `end=''` to the print XD
|
||||
print(traceback.format_exc(), end='')
|
||||
caller_frame: FrameType = api_frame.f_back
|
||||
|
||||
# NOTE: see the impl details of followings to understand usage:
|
||||
# - `pdbp.post_mortem()`
|
||||
# - `pdbp.xps()`
|
||||
# - `bdb.interaction()`
|
||||
repl.reset()
|
||||
repl.interaction(
|
||||
frame=caller_frame,
|
||||
# frame=None,
|
||||
traceback=tb,
|
||||
)
|
||||
# XXX NOTE XXX: absolutely required to avoid hangs!
|
||||
# Since we presume the post-mortem was enaged to a task-ending
|
||||
# error, we MUST release the local REPL request so that not other
|
||||
# local task nor the root remains blocked!
|
||||
# if not no_runtime:
|
||||
# DebugStatus.release()
|
||||
DebugStatus.release()
|
||||
|
||||
|
||||
async def post_mortem(
|
||||
|
|
@ -3210,6 +3279,23 @@ class BoxedMaybeException(Struct):
|
|||
'''
|
||||
value: BaseException|None = None
|
||||
|
||||
def pformat(self) -> str:
|
||||
'''
|
||||
Repr the boxed `.value` error in more-than-string
|
||||
repr form.
|
||||
|
||||
'''
|
||||
if not self.value:
|
||||
return f'<{type(self).__name__}( .value=None )>\n'
|
||||
|
||||
return (
|
||||
f'<{type(self.value).__name__}(\n'
|
||||
f' |_.value = {self.value}\n'
|
||||
f')>\n'
|
||||
)
|
||||
|
||||
__repr__ = pformat
|
||||
|
||||
|
||||
# TODO: better naming and what additionals?
|
||||
# - [ ] optional runtime plugging?
|
||||
|
|
@ -3226,7 +3312,12 @@ def open_crash_handler(
|
|||
KeyboardInterrupt,
|
||||
trio.Cancelled,
|
||||
},
|
||||
tb_hide: bool = True,
|
||||
tb_hide: bool = False,
|
||||
|
||||
repl_fixture: (
|
||||
AbstractContextManager[bool] # pre/post REPL entry
|
||||
|None
|
||||
) = None,
|
||||
):
|
||||
'''
|
||||
Generic "post mortem" crash handler using `pdbp` REPL debugger.
|
||||
|
|
@ -3266,6 +3357,9 @@ def open_crash_handler(
|
|||
repl=mk_pdb(),
|
||||
tb=sys.exc_info()[2],
|
||||
api_frame=inspect.currentframe().f_back,
|
||||
|
||||
repl_fixture=repl_fixture,
|
||||
boxed_maybe_exc=boxed_maybe_exc,
|
||||
)
|
||||
except bdb.BdbQuit:
|
||||
__tracebackhide__: bool = False
|
||||
|
|
@ -3281,7 +3375,7 @@ def open_crash_handler(
|
|||
@cm
|
||||
def maybe_open_crash_handler(
|
||||
pdb: bool|None = None,
|
||||
tb_hide: bool = True,
|
||||
tb_hide: bool = False,
|
||||
|
||||
**kwargs,
|
||||
):
|
||||
|
|
@ -3293,11 +3387,11 @@ def maybe_open_crash_handler(
|
|||
flag is passed the pdb REPL is engaed on any crashes B)
|
||||
|
||||
'''
|
||||
__tracebackhide__: bool = tb_hide
|
||||
|
||||
if pdb is None:
|
||||
pdb: bool = _state.is_debug_mode()
|
||||
|
||||
__tracebackhide__: bool = tb_hide
|
||||
|
||||
rtctx = nullcontext(
|
||||
enter_result=BoxedMaybeException()
|
||||
)
|
||||
|
|
|
|||
Loading…
Reference in New Issue