tractor

Author	SHA1	Message	Date
Tyler Goodlet	a6058d14ae	Use new `._debug._repl_fail_msg` inside `test_pause_from_sync`	2024-06-10 17:57:43 -04:00
Tyler Goodlet	43a8cf4be1	Make big TODO: for `devx._debug` refinements Hopefully would make grok-ing this fairly sophisticated sub-sys possible for any up-and-coming `tractor` hacker XD A lot of internal API and re-org ideas I discovered/realized as part of finishing the `__pld_spec__` and multi-threaded support. Particularly better isolation between root-actor vs subactor task APIs and generally less globally-state-ful stuff like `DebugStatus` and `Lock` method APIs would likely make a lot of the hard to follow edge cases more clear?	2024-06-10 17:46:10 -04:00
Tyler Goodlet	6534a363a5	First proto: multi-threaded synced `pdb`-REPLs Functionally working for multi-threaded (via cpython threads spawned from `to_trio.to_thread.run_sync()`) alongside subactors, tested (for now) only with threads started inside the root actor (which seemed to have the most issues in terms of the impl and special cases..) using the new `tractor.pause_from_sync()` API! Main implementation changes to `.pause_from_sync()` ------ - ------ - from the root actor, we need to ensure bg thread case is handled specially since no IPC is used to request the TTY stdio mutex and `Lock` (API) usage is conducted entirely from a local task or thread; dedicated `Lock` usage for the root-actor already is branched inside `._pause()` and needs similar handling from a root bg-thread: \|_for the special case of a root bg thread we need to `trio`-main-thread schedule a bg task inside a new `_pause_from_bg_root_thread()`. The new task needs to implement most of what was is handled inside `._pause()` manually, mostly because in this root-actor-bg-thread case we have 2 constraints: 1. to enter `PdbREPL.interaction()` from the bg thread directly, 2. the task that `Lock._debug_lock.acquire()`s has to be the same that calls `.release() (a `trio.FIFOLock` constraint) \|_impl deats of this `_pause_from_bg_root_thread()` include: - (for now) calling `._pause()` to acquire the `Lock._debug_lock`. - setting its own `DebugStatus.repl_release`. - calling `.DebugStatus.shield_sigint()` to ensure the root's main thread uses the right handler when the bg one is REPL-ing. - wait manually on the `.repl_release()` to be set by the thread's dedicated `PdbREPL` exit. - manually calling `Lock.release()` from the same task that acquired it. - expect calls to `._pause()` to deliver a `tuple[Task, PdbREPL]` such that we always get the handle both to any newly created REPl instance and the (maybe) the scheduled bg task within which is runs. - add a single `message: str` style to `log.devx()` based on branching style for logging. - ensure both `DebugStatus.repl` and `.repl_task` are set just before calling `._set_trace()` to ensure the correct `Task\|Thread` is set when the REPL is finally entered from sync code. - add a wrapping caller `_sync_pause_from_builtin()` which passes in the new `called_from_builtin=True` to indicate `breakpoint()` caller usage, obvi pass in `api_frame`. Changes to `._pause()` in support of ^ ------ - ------ - `TaskStatus.started()` and return the `tuple[Task, PdbREPL]` to callers / starters. - only call `DebugStatus.shield_sigint()` when no `repl` passed bc some callers (like bg threads) may need to apply it at some specific point themselves. - tweak some asserts for the `debug_func == None` / non-`trio`-thread case. - add a mod-level `_repl_fail_msg: str` to be used when there's an internal `._pause()` failure for testing, easier to pexpect match. - more comprehensive logging for the root-actor branched case to (attempt to) indicate any of the 3 cases: - remote ctx from subactor has the `Lock`, - already existing root task or thread has it or, - some kinda stale `.locked()` situation where the root has the lock but we don't know why. - for root usage, revert to always `await Lock._debug_lock.acquire()`-ing despite `called_from_sync` since `.pause_from_sync()` was reworked to instead handle the special bg thread case in the new `_pause_from_bg_root_thread()` task. - always do `return _enter_repl_sync(debug_func)`. - try to report any `repl_task: Task\|Thread` set by the caller (particularly for the bg thread cases) as being the thread or task `._pause()` was called "on behalf of" Changes to `DebugStatus`/`Lock` in support of ^ ------ - ------ - only call `Lock.release()` from `DebugStatus.set_[quit/continue]()` when called from the main `trio` thread and always call `DebugStatus.release()` after to ensure `.repl_released()` is set after `._debug_lock.release()`. - only call `.repl_release.set()` from `trio` thread otherwise use `.from_thread.run()`. - much more refinements in `Lock.release()` for threading cases: - return `bool` to indicate whether lock was released by caller. - mask (in prep to drop) `_pause()` usage of `Lock.release.force=True)` since forcing a release can't ever avoid the RTE from `trio`.. same task must acquire/release. - don't allow usage from non-`trio`-main-threads, ever; there's no point since the same-task-needs-to-manage-`FIFOLock` constraint. - much more detailed logging using `message`-building-style for all caller (edge) cases. \|_ use a `we_released: bool` to determine failed-to-release edge cases which can happen if called from bg threads, ensure we `log.exception()` on any incorrect usage resulting in release failure. \|_ complain loudly if the release fails and some other task/thread still holds the lock. \|_ be explicit about "who" (which task or thread) the release is "on behalf of" by reading `DebugStatus.repl_task` since the caller isn't the REPL operator in many sync cases. - more or less drop `force` support, as mentioned above. - ensure we unset `._owned_by_root` if the caller is a root task. Other misc ------ - ------ - rename `lock_tty_for_child()` -> `lock_stdio_for_peer()`. - rejig `Lock.repr()` to show lock and event stats. - stage `Lock.stats` and `.owner` methods in prep for doing a singleton instance and `@property`s.	2024-06-10 17:45:52 -04:00
Tyler Goodlet	30d60379c1	Drop thread logging to make `log.pdb()` patts match in test	2024-06-07 22:35:59 -04:00

3 changed files with 559 additions and 222 deletions

									
										9

examples/debugging/sync_bp.py

										View File
									
				@ -1,6 +1,5 @@

				from functools import partial

				import time

				from threading import current_thread

				import trio

				import tractor

				@ -16,17 +15,9 @@ def sync_pause(

				        time.sleep(pre_sleep)

				    if use_builtin:

				        print(

				            f'Entering `breakpoint()` from\n'

				            f'{current_thread()}\n'

				        )

				        breakpoint(hide_tb=hide_tb)

				    else:

				        print(

				            f'Entering `tractor.pause_from_sync()` from\n'

				            f'{current_thread()}@{tractor.current_actor().uid}\n'

				        )

				        tractor.pause_from_sync()

				    if error:

									
										10

tests/test_debugger.py

										View File
									
				@ -12,11 +12,8 @@ TODO:

				"""

				from functools import partial

				import itertools

				# from os import path

				from typing import Optional

				import platform

				import pathlib

				# import sys

				import time

				import pytest

				@ -29,6 +26,7 @@ from pexpect.exceptions import (

				from tractor.devx._debug import (

				    _pause_msg,

				    _crash_msg,

				    _repl_fail_msg,

				)

				from tractor._testing import (

				    examples_dir,

				@ -293,7 +291,7 @@ def do_ctlc(

				    child,

				    count: int = 3,

				    delay: float = 0.1,

				    patt: Optional[str] = None,

				    patt: str|None = None,

				    # expect repl UX to reprint the prompt after every

				    # ctrl-c send.

				@ -1306,7 +1304,7 @@ def test_shield_pause(

				        [

				            _crash_msg,

				            "('cancelled_before_pause'",  # actor name

				            "Failed to engage debugger via `_pause()`",

				            _repl_fail_msg,

				            "trio.Cancelled",

				            "raise Cancelled._create()",

				@ -1324,7 +1322,7 @@ def test_shield_pause(

				        [

				            _crash_msg,

				            "('root'",  # actor name

				            "Failed to engage debugger via `_pause()`",

				            _repl_fail_msg,

				            "trio.Cancelled",

				            "raise Cancelled._create()",

668

tractor/devx/_debug.py

View File

File diff suppressed because it is too large Load Diff

Compare commits

4 Commits

408a74784e ... a6058d14ae

9

examples/debugging/sync_bp.py

View File

10

tests/test_debugger.py

View File

668

tractor/devx/_debug.py

View File

Compare commits

4 Commits 408a74784e ... a6058d14ae

9 examples/debugging/sync_bp.py Unescape Escape View File

10 tests/test_debugger.py Unescape Escape View File

668 tractor/devx/_debug.py View File

4 Commits

408a74784e ... a6058d14ae

9

examples/debugging/sync_bp.py

View File

10

tests/test_debugger.py

View File

668

tractor/devx/_debug.py

View File