Compare commits
150 Commits
main
...
free_threa
Author | SHA1 | Date |
---|---|---|
|
2b02977cf7 | |
|
be2f4f306e | |
|
65ae2dc67c | |
|
4be499fb1f | |
|
7317bb269c | |
|
29db08b370 | |
|
fe5e6e2ab0 | |
|
ae91310b32 | |
|
f86f4ae48d | |
|
b244cf844d | |
|
c0058024c2 | |
|
065104401c | |
|
3201437f4e | |
|
a9da16892d | |
|
1b609113c3 | |
|
4a80cda841 | |
|
131e2ee0a4 | |
|
79ef973058 | |
|
c738492879 | |
|
a931274da6 | |
|
49c61e40c7 | |
|
25f3cf795d | |
|
e2b7924898 | |
|
c559f80f08 | |
|
6a6f55cee0 | |
|
bff32b0ad7 | |
|
b71afdc615 | |
|
2bd8bf16d7 | |
|
1d8230716c | |
|
df8e326e39 | |
|
13dbd1d420 | |
|
b2c415c4f6 | |
|
93f70c63a4 | |
|
8c90521562 | |
|
f23ee3cd22 | |
|
9295af929c | |
|
83f53fd0c5 | |
|
9b3af1fa16 | |
|
f8e4d12494 | |
|
af3c14b250 | |
|
7de7fd0afd | |
|
79888a31a4 | |
|
de16a9ac6f | |
|
4bc443ccae | |
|
bad42734db | |
|
86346c27e8 | |
|
0687f1aaa6 | |
|
a21d9b1e33 | |
|
6c46882545 | |
|
00583b7671 | |
|
78beeebe8f | |
|
333fde39ad | |
|
502c7a1dc6 | |
|
7b05547fcc | |
|
64f56e09b9 | |
|
4185661c2e | |
|
cc7bee683f | |
|
2ed811fa0d | |
|
b06c5bde49 | |
|
f4c5a7e85c | |
|
ee51226480 | |
|
084d750604 | |
|
de7ba6b1f4 | |
|
145c44ce44 | |
|
16dbf8fbca | |
|
0d30b39e58 | |
|
37c798dd43 | |
|
8604c0c988 | |
|
23845c4f83 | |
|
9d67067d62 | |
|
99d3455f57 | |
|
dbdbd96a06 | |
|
68f7614e3e | |
|
659c85a099 | |
|
48b6db5c68 | |
|
029888cee8 | |
|
223d885e22 | |
|
a1f091882e | |
|
e587f0da23 | |
|
5138224625 | |
|
ad72cd629f | |
|
533e69baaf | |
|
fbc9325184 | |
|
3cd222959a | |
|
2ea703cc75 | |
|
112ed27cda | |
|
42cf9e11a4 | |
|
1ccb14455d | |
|
d534f1491b | |
|
0f8b299b4f | |
|
9807318e3d | |
|
b700d90e09 | |
|
6ff3b6c757 | |
|
8bda59c23d | |
|
1628fd1d7b | |
|
5f74ce9a95 | |
|
477343af53 | |
|
c208bcbb1b | |
|
c9e9a3949f | |
|
8fd7d1cec4 | |
|
0cb011e883 | |
|
74df5034c0 | |
|
692bd0edf6 | |
|
c21b9cdf57 | |
|
0e25c16572 | |
|
1d4513eb5d | |
|
3d3a1959ed | |
|
9e812d7793 | |
|
789bb7145b | |
|
b05c5b6c50 | |
|
f6a4a0818f | |
|
a045c78e4d | |
|
c85606075d | |
|
7d200223fa | |
|
4244db2f08 | |
|
52901a8e7d | |
|
eb11235ec8 | |
|
c8d164b211 | |
|
00b5bb777d | |
|
674a33e3b1 | |
|
a49bfddf32 | |
|
e025959d60 | |
|
d0414709f2 | |
|
b958590212 | |
|
8884ed05f0 | |
|
a403958c2c | |
|
009cadf28e | |
|
3cb8f9242d | |
|
544b5bdd9c | |
|
47d66e6c0b | |
|
ddeab1355a | |
|
cb6c10bbe9 | |
|
bf9d7ba074 | |
|
4a8a555bdf | |
|
1762b3eb64 | |
|
486f4a3843 | |
|
d5e0b08787 | |
|
f80a47571a | |
|
9b2161506f | |
|
6b155849b7 | |
|
59c8c7bfe3 | |
|
6ac6fd56c0 | |
|
f799e9ac51 | |
|
9980bb2bd0 | |
|
8de9ab291e | |
|
1a83626f26 | |
|
6b4d08d030 | |
|
7b8b9d6805 | |
|
5afe0a0264 | |
|
eeb9a7d61b |
|
@ -8,70 +8,46 @@ on:
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
# ------ sdist ------
|
|
||||||
|
mypy:
|
||||||
|
name: 'MyPy'
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@v2
|
||||||
|
|
||||||
|
- name: Setup python
|
||||||
|
uses: actions/setup-python@v2
|
||||||
|
with:
|
||||||
|
python-version: '3.11'
|
||||||
|
|
||||||
|
- name: Install dependencies
|
||||||
|
run: pip install -U . --upgrade-strategy eager -r requirements-test.txt
|
||||||
|
|
||||||
|
- name: Run MyPy check
|
||||||
|
run: mypy tractor/ --ignore-missing-imports --show-traceback
|
||||||
|
|
||||||
# test that we can generate a software distribution and install it
|
# test that we can generate a software distribution and install it
|
||||||
# thus avoid missing file issues after packaging.
|
# thus avoid missing file issues after packaging.
|
||||||
#
|
|
||||||
# -[x] produce sdist with uv
|
|
||||||
# ------ - ------
|
|
||||||
sdist-linux:
|
sdist-linux:
|
||||||
name: 'sdist'
|
name: 'sdist'
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v2
|
||||||
|
|
||||||
- name: Install latest uv
|
- name: Setup python
|
||||||
uses: astral-sh/setup-uv@v6
|
uses: actions/setup-python@v2
|
||||||
|
with:
|
||||||
|
python-version: '3.11'
|
||||||
|
|
||||||
- name: Build sdist as tar.gz
|
- name: Build sdist
|
||||||
run: uv build --sdist --python=3.13
|
run: python setup.py sdist --formats=zip
|
||||||
|
|
||||||
- name: Install sdist from .tar.gz
|
- name: Install sdist from .zips
|
||||||
run: python -m pip install dist/*.tar.gz
|
run: python -m pip install dist/*.zip
|
||||||
|
|
||||||
# ------ type-check ------
|
|
||||||
# mypy:
|
|
||||||
# name: 'MyPy'
|
|
||||||
# runs-on: ubuntu-latest
|
|
||||||
|
|
||||||
# steps:
|
|
||||||
# - name: Checkout
|
|
||||||
# uses: actions/checkout@v4
|
|
||||||
|
|
||||||
# - name: Install latest uv
|
|
||||||
# uses: astral-sh/setup-uv@v6
|
|
||||||
|
|
||||||
# # faster due to server caching?
|
|
||||||
# # https://docs.astral.sh/uv/guides/integration/github/#setting-up-python
|
|
||||||
# - name: "Set up Python"
|
|
||||||
# uses: actions/setup-python@v6
|
|
||||||
# with:
|
|
||||||
# python-version-file: "pyproject.toml"
|
|
||||||
|
|
||||||
# # w uv
|
|
||||||
# # - name: Set up Python
|
|
||||||
# # run: uv python install
|
|
||||||
|
|
||||||
# - name: Setup uv venv
|
|
||||||
# run: uv venv .venv --python=3.13
|
|
||||||
|
|
||||||
# - name: Install
|
|
||||||
# run: uv sync --dev
|
|
||||||
|
|
||||||
# # TODO, ty cmd over repo
|
|
||||||
# # - name: type check with ty
|
|
||||||
# # run: ty ./tractor/
|
|
||||||
|
|
||||||
# # - uses: actions/cache@v3
|
|
||||||
# # name: Cache uv virtenv as default .venv
|
|
||||||
# # with:
|
|
||||||
# # path: ./.venv
|
|
||||||
# # key: venv-${{ hashFiles('uv.lock') }}
|
|
||||||
|
|
||||||
# - name: Run MyPy check
|
|
||||||
# run: mypy tractor/ --ignore-missing-imports --show-traceback
|
|
||||||
|
|
||||||
|
|
||||||
testing-linux:
|
testing-linux:
|
||||||
|
@ -83,45 +59,32 @@ jobs:
|
||||||
fail-fast: false
|
fail-fast: false
|
||||||
matrix:
|
matrix:
|
||||||
os: [ubuntu-latest]
|
os: [ubuntu-latest]
|
||||||
python-version: ['3.13']
|
python: ['3.11']
|
||||||
spawn_backend: [
|
spawn_backend: [
|
||||||
'trio',
|
'trio',
|
||||||
# 'mp_spawn',
|
'mp_spawn',
|
||||||
# 'mp_forkserver',
|
'mp_forkserver',
|
||||||
]
|
]
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
|
|
||||||
- uses: actions/checkout@v4
|
- name: Checkout
|
||||||
|
uses: actions/checkout@v2
|
||||||
|
|
||||||
- name: 'Install uv + py-${{ matrix.python-version }}'
|
- name: Setup python
|
||||||
uses: astral-sh/setup-uv@v6
|
uses: actions/setup-python@v2
|
||||||
with:
|
with:
|
||||||
python-version: ${{ matrix.python-version }}
|
python-version: '${{ matrix.python }}'
|
||||||
|
|
||||||
# GH way.. faster?
|
- name: Install dependencies
|
||||||
# - name: setup-python@v6
|
run: pip install -U . -r requirements-test.txt -r requirements-docs.txt --upgrade-strategy eager
|
||||||
# uses: actions/setup-python@v6
|
|
||||||
# with:
|
|
||||||
# python-version: '${{ matrix.python-version }}'
|
|
||||||
|
|
||||||
# consider caching for speedups?
|
- name: List dependencies
|
||||||
# https://docs.astral.sh/uv/guides/integration/github/#caching
|
run: pip list
|
||||||
|
|
||||||
- name: Install the project w uv
|
|
||||||
run: uv sync --all-extras --dev
|
|
||||||
|
|
||||||
# - name: Install dependencies
|
|
||||||
# run: pip install -U . -r requirements-test.txt -r requirements-docs.txt --upgrade-strategy eager
|
|
||||||
|
|
||||||
- name: List deps tree
|
|
||||||
run: uv tree
|
|
||||||
|
|
||||||
- name: Run tests
|
- name: Run tests
|
||||||
run: uv run pytest tests/ --spawn-backend=${{ matrix.spawn_backend }} -rsx
|
run: pytest tests/ --spawn-backend=${{ matrix.spawn_backend }} -rsx
|
||||||
|
|
||||||
# XXX legacy NOTE XXX
|
|
||||||
#
|
|
||||||
# We skip 3.10 on windows for now due to not having any collabs to
|
# We skip 3.10 on windows for now due to not having any collabs to
|
||||||
# debug the CI failures. Anyone wanting to hack and solve them is very
|
# debug the CI failures. Anyone wanting to hack and solve them is very
|
||||||
# welcome, but our primary user base is not using that OS.
|
# welcome, but our primary user base is not using that OS.
|
||||||
|
|
|
@ -689,11 +689,9 @@ channel`_!
|
||||||
.. _msgspec: https://jcristharif.com/msgspec/
|
.. _msgspec: https://jcristharif.com/msgspec/
|
||||||
.. _guest: https://trio.readthedocs.io/en/stable/reference-lowlevel.html?highlight=guest%20mode#using-guest-mode-to-run-trio-on-top-of-other-event-loops
|
.. _guest: https://trio.readthedocs.io/en/stable/reference-lowlevel.html?highlight=guest%20mode#using-guest-mode-to-run-trio-on-top-of-other-event-loops
|
||||||
|
|
||||||
..
|
|
||||||
NOTE, on generating badge links from the UI
|
.. |gh_actions| image:: https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fgoodboy%2Ftractor%2Fbadge&style=popout-square
|
||||||
https://docs.github.com/en/actions/how-tos/monitoring-and-troubleshooting-workflows/monitoring-workflows/adding-a-workflow-status-badge?ref=gitguardian-blog-automated-secrets-detection#using-the-ui
|
:target: https://actions-badge.atrox.dev/goodboy/tractor/goto
|
||||||
.. |gh_actions| image:: https://github.com/goodboy/tractor/actions/workflows/ci.yml/badge.svg?branch=main
|
|
||||||
:target: https://github.com/goodboy/tractor/actions/workflows/ci.yml
|
|
||||||
|
|
||||||
.. |docs| image:: https://readthedocs.org/projects/tractor/badge/?version=latest
|
.. |docs| image:: https://readthedocs.org/projects/tractor/badge/?version=latest
|
||||||
:target: https://tractor.readthedocs.io/en/latest/?badge=latest
|
:target: https://tractor.readthedocs.io/en/latest/?badge=latest
|
||||||
|
|
|
@ -120,6 +120,7 @@ async def main(
|
||||||
break_parent_ipc_after: int|bool = False,
|
break_parent_ipc_after: int|bool = False,
|
||||||
break_child_ipc_after: int|bool = False,
|
break_child_ipc_after: int|bool = False,
|
||||||
pre_close: bool = False,
|
pre_close: bool = False,
|
||||||
|
tpt_proto: str = 'tcp',
|
||||||
|
|
||||||
) -> None:
|
) -> None:
|
||||||
|
|
||||||
|
@ -131,6 +132,7 @@ async def main(
|
||||||
# a hang since it never engages due to broken IPC
|
# a hang since it never engages due to broken IPC
|
||||||
debug_mode=debug_mode,
|
debug_mode=debug_mode,
|
||||||
loglevel=loglevel,
|
loglevel=loglevel,
|
||||||
|
enable_transports=[tpt_proto],
|
||||||
|
|
||||||
) as an,
|
) as an,
|
||||||
):
|
):
|
||||||
|
@ -145,7 +147,8 @@ async def main(
|
||||||
_testing.expect_ctxc(
|
_testing.expect_ctxc(
|
||||||
yay=(
|
yay=(
|
||||||
break_parent_ipc_after
|
break_parent_ipc_after
|
||||||
or break_child_ipc_after
|
or
|
||||||
|
break_child_ipc_after
|
||||||
),
|
),
|
||||||
# TODO: we CAN'T remove this right?
|
# TODO: we CAN'T remove this right?
|
||||||
# since we need the ctxc to bubble up from either
|
# since we need the ctxc to bubble up from either
|
||||||
|
|
|
@ -29,7 +29,7 @@ async def bp_then_error(
|
||||||
to_trio.send_nowait('start')
|
to_trio.send_nowait('start')
|
||||||
|
|
||||||
# NOTE: what happens here inside the hook needs some refinement..
|
# NOTE: what happens here inside the hook needs some refinement..
|
||||||
# => seems like it's still `._debug._set_trace()` but
|
# => seems like it's still `.debug._set_trace()` but
|
||||||
# we set `Lock.local_task_in_debug = 'sync'`, we probably want
|
# we set `Lock.local_task_in_debug = 'sync'`, we probably want
|
||||||
# some further, at least, meta-data about the task/actor in debug
|
# some further, at least, meta-data about the task/actor in debug
|
||||||
# in terms of making it clear it's `asyncio` mucking about.
|
# in terms of making it clear it's `asyncio` mucking about.
|
||||||
|
|
|
@ -5,7 +5,7 @@ import trio
|
||||||
import tractor
|
import tractor
|
||||||
|
|
||||||
# ensure mod-path is correct!
|
# ensure mod-path is correct!
|
||||||
from tractor.devx._debug import (
|
from tractor.devx.debug import (
|
||||||
_sync_pause_from_builtin as _sync_pause_from_builtin,
|
_sync_pause_from_builtin as _sync_pause_from_builtin,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
@ -19,19 +19,22 @@ async def main() -> None:
|
||||||
async with tractor.open_nursery(
|
async with tractor.open_nursery(
|
||||||
debug_mode=True,
|
debug_mode=True,
|
||||||
loglevel='devx',
|
loglevel='devx',
|
||||||
) as an:
|
maybe_enable_greenback=True,
|
||||||
assert an
|
# ^XXX REQUIRED to enable `breakpoint()` support (from sync
|
||||||
|
# fns) and thus required here to avoid an assertion err
|
||||||
|
# on the next line
|
||||||
|
):
|
||||||
assert (
|
assert (
|
||||||
(pybp_var := os.environ['PYTHONBREAKPOINT'])
|
(pybp_var := os.environ['PYTHONBREAKPOINT'])
|
||||||
==
|
==
|
||||||
'tractor.devx._debug._sync_pause_from_builtin'
|
'tractor.devx.debug._sync_pause_from_builtin'
|
||||||
)
|
)
|
||||||
|
|
||||||
# TODO: an assert that verifies the hook has indeed been, hooked
|
# TODO: an assert that verifies the hook has indeed been, hooked
|
||||||
# XD
|
# XD
|
||||||
assert (
|
assert (
|
||||||
(pybp_hook := sys.breakpointhook)
|
(pybp_hook := sys.breakpointhook)
|
||||||
is not tractor.devx._debug._set_trace
|
is not tractor.devx.debug._set_trace
|
||||||
)
|
)
|
||||||
|
|
||||||
print(
|
print(
|
||||||
|
|
|
@ -24,10 +24,9 @@ async def spawn_until(depth=0):
|
||||||
|
|
||||||
|
|
||||||
async def main():
|
async def main():
|
||||||
"""The main ``tractor`` routine.
|
'''
|
||||||
|
The process tree should look as approximately as follows when the
|
||||||
The process tree should look as approximately as follows when the debugger
|
debugger first engages:
|
||||||
first engages:
|
|
||||||
|
|
||||||
python examples/debugging/multi_nested_subactors_bp_forever.py
|
python examples/debugging/multi_nested_subactors_bp_forever.py
|
||||||
├─ python -m tractor._child --uid ('spawner1', '7eab8462 ...)
|
├─ python -m tractor._child --uid ('spawner1', '7eab8462 ...)
|
||||||
|
@ -37,10 +36,11 @@ async def main():
|
||||||
└─ python -m tractor._child --uid ('spawner0', '1d42012b ...)
|
└─ python -m tractor._child --uid ('spawner0', '1d42012b ...)
|
||||||
└─ python -m tractor._child --uid ('name_error', '6c2733b8 ...)
|
└─ python -m tractor._child --uid ('name_error', '6c2733b8 ...)
|
||||||
|
|
||||||
"""
|
'''
|
||||||
async with tractor.open_nursery(
|
async with tractor.open_nursery(
|
||||||
debug_mode=True,
|
debug_mode=True,
|
||||||
loglevel='warning'
|
loglevel='devx',
|
||||||
|
enable_transports=['uds'],
|
||||||
) as n:
|
) as n:
|
||||||
|
|
||||||
# spawn both actors
|
# spawn both actors
|
||||||
|
|
|
@ -37,6 +37,7 @@ async def main(
|
||||||
enable_stack_on_sig=True,
|
enable_stack_on_sig=True,
|
||||||
# maybe_enable_greenback=False,
|
# maybe_enable_greenback=False,
|
||||||
loglevel='devx',
|
loglevel='devx',
|
||||||
|
enable_transports=['uds'],
|
||||||
) as an,
|
) as an,
|
||||||
):
|
):
|
||||||
ptl: tractor.Portal = await an.start_actor(
|
ptl: tractor.Portal = await an.start_actor(
|
||||||
|
|
|
@ -33,8 +33,11 @@ async def just_bp(
|
||||||
|
|
||||||
|
|
||||||
async def main():
|
async def main():
|
||||||
|
|
||||||
async with tractor.open_nursery(
|
async with tractor.open_nursery(
|
||||||
debug_mode=True,
|
debug_mode=True,
|
||||||
|
enable_transports=['uds'],
|
||||||
|
loglevel='devx',
|
||||||
) as n:
|
) as n:
|
||||||
p = await n.start_actor(
|
p = await n.start_actor(
|
||||||
'bp_boi',
|
'bp_boi',
|
||||||
|
|
|
@ -6,7 +6,7 @@ import tractor
|
||||||
|
|
||||||
# TODO: only import these when not running from test harness?
|
# TODO: only import these when not running from test harness?
|
||||||
# can we detect `pexpect` usage maybe?
|
# can we detect `pexpect` usage maybe?
|
||||||
# from tractor.devx._debug import (
|
# from tractor.devx.debug import (
|
||||||
# get_lock,
|
# get_lock,
|
||||||
# get_debug_req,
|
# get_debug_req,
|
||||||
# )
|
# )
|
||||||
|
|
|
@ -0,0 +1,360 @@
|
||||||
|
# tractor: structured concurrent "actors".
|
||||||
|
# Copyright 2018-eternity Tyler Goodlet.
|
||||||
|
|
||||||
|
# This program is free software: you can redistribute it and/or modify
|
||||||
|
# it under the terms of the GNU Affero General Public License as published by
|
||||||
|
# the Free Software Foundation, either version 3 of the License, or
|
||||||
|
# (at your option) any later version.
|
||||||
|
|
||||||
|
# This program is distributed in the hope that it will be useful,
|
||||||
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
# GNU Affero General Public License for more details.
|
||||||
|
|
||||||
|
# You should have received a copy of the GNU Affero General Public License
|
||||||
|
# along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
'''
|
||||||
|
A shm-thread-as-generator-fn-ctx **prototype** in anticipation of
|
||||||
|
free-threading (aka GIL-less threads) in py 3.13+
|
||||||
|
|
||||||
|
Bo
|
||||||
|
|
||||||
|
Main rationale,
|
||||||
|
- binding a bg-thread to a "suspendable fn scope" means avoiding any
|
||||||
|
locking around shm-data-structures and, except for a single
|
||||||
|
`threading.Condition` (or better) for thread-context-switching,
|
||||||
|
enables a "pure-ish" style semantic for inter-thread
|
||||||
|
value-passing-IO between a "parent" and (bg) "child" shm-thread
|
||||||
|
where the only (allowed) data-flow would be via immutable values in
|
||||||
|
a "coroutine-style" using,
|
||||||
|
|
||||||
|
- parent-side:
|
||||||
|
|_ `callee_sent = gen.send(caller_sent)`
|
||||||
|
|
||||||
|
- child-side:
|
||||||
|
|_ `caller_sent = yield callee_sent`
|
||||||
|
|
||||||
|
Related (official) reading,
|
||||||
|
- https://docs.python.org/3/glossary.html#term-free-threading
|
||||||
|
- https://peps.python.org/pep-0703/
|
||||||
|
|_https://peps.python.org/pep-0703/#optimistic-avoiding-locking-in-dict-and-list-accesses
|
||||||
|
|
||||||
|
|
||||||
|
'''
|
||||||
|
from contextlib import (
|
||||||
|
contextmanager as cm,
|
||||||
|
)
|
||||||
|
import inspect
|
||||||
|
# from functools import partial
|
||||||
|
import time
|
||||||
|
import threading
|
||||||
|
from typing import (
|
||||||
|
Any,
|
||||||
|
Generator,
|
||||||
|
)
|
||||||
|
|
||||||
|
import tractor
|
||||||
|
import trio
|
||||||
|
|
||||||
|
|
||||||
|
log = tractor.log.get_console_log(
|
||||||
|
'info',
|
||||||
|
# ^ XXX causes latency with seed>=1e3
|
||||||
|
# 'warning',
|
||||||
|
)
|
||||||
|
_seed: int = int(1e3)
|
||||||
|
|
||||||
|
|
||||||
|
def thread_gen(seed: int):
|
||||||
|
thr = threading.current_thread()
|
||||||
|
log.info(
|
||||||
|
f'thr: {thr.name} @ {thr.ident}\n'
|
||||||
|
f' |_{thr!r}\n'
|
||||||
|
f'\n'
|
||||||
|
f'IN `thread_gen(seed={seed})`\n'
|
||||||
|
f'\n'
|
||||||
|
f'Starting range()-loop\n'
|
||||||
|
)
|
||||||
|
for i in range(seed):
|
||||||
|
log.info(
|
||||||
|
f'yielding i={i}\n'
|
||||||
|
)
|
||||||
|
from_main = yield i
|
||||||
|
log.info(
|
||||||
|
f'(from_main := {from_main}) = yield (i:={i})\n'
|
||||||
|
)
|
||||||
|
# time.sleep(0.0001)
|
||||||
|
|
||||||
|
|
||||||
|
# TODO, how would we get the equiv from a pub trio-API?
|
||||||
|
# -[ ] what about an inter-thread channel much like we have for
|
||||||
|
# `to_asyncio` & guest mode??
|
||||||
|
#
|
||||||
|
# async def spawn_bg_thread_running_gen(fn):
|
||||||
|
# log.info('running trio.to_thread.run_sync()')
|
||||||
|
# await trio.to_thread.run_sync(
|
||||||
|
# partial(
|
||||||
|
# run_gen_in_thread,
|
||||||
|
# fn=fn,
|
||||||
|
# seed=_seed,
|
||||||
|
# )
|
||||||
|
# )
|
||||||
|
|
||||||
|
|
||||||
|
# ?TODO? once correct, wrap this as a @deco-API?
|
||||||
|
# -[ ] @generator_thread or similar?
|
||||||
|
#
|
||||||
|
def run_gen_in_thread(
|
||||||
|
cond: threading.Condition,
|
||||||
|
gen: Generator,
|
||||||
|
# ^NOTE, already closure-bound-in tgt generator-fn-instance which
|
||||||
|
# will be yielded to in the bg-thread!
|
||||||
|
):
|
||||||
|
thr: threading.Thread = threading.current_thread()
|
||||||
|
log.info(
|
||||||
|
f'thr: {thr.name} @ {thr.ident}\n'
|
||||||
|
f' |_{thr!r}\n'
|
||||||
|
f'\n'
|
||||||
|
f'IN `run_gen_in_thread(gen={gen})`\n'
|
||||||
|
f'\n'
|
||||||
|
f'entering gen blocking: {gen!r}\n'
|
||||||
|
)
|
||||||
|
try:
|
||||||
|
log.runtime('locking cond..')
|
||||||
|
with cond:
|
||||||
|
log.runtime('LOCKED cond..')
|
||||||
|
first_yielded = gen.send(None)
|
||||||
|
assert cond.to_yield is None
|
||||||
|
cond.to_yield = first_yielded
|
||||||
|
log.runtime('notifying cond..')
|
||||||
|
cond.notify()
|
||||||
|
log.runtime('waiting cond..')
|
||||||
|
cond.wait()
|
||||||
|
|
||||||
|
while (to_send := cond.to_send) is not None:
|
||||||
|
try:
|
||||||
|
yielded = gen.send(to_send)
|
||||||
|
except StopIteration as siter:
|
||||||
|
# TODO, check for return value?
|
||||||
|
# if (ret := siter.value):
|
||||||
|
# cond.to_return = ret
|
||||||
|
assert siter
|
||||||
|
log.exception(f'{gen} exited')
|
||||||
|
raise
|
||||||
|
|
||||||
|
cond.to_yield = yielded
|
||||||
|
log.runtime('LOOP notifying cond..')
|
||||||
|
cond.notify()
|
||||||
|
log.runtime('LOOP waiting cond..')
|
||||||
|
cond.wait()
|
||||||
|
|
||||||
|
# out = (yield from gen)
|
||||||
|
log.runtime('RELEASE-ing cond..')
|
||||||
|
|
||||||
|
# with cond block-end
|
||||||
|
log.runtime('RELEASE-ed cond..')
|
||||||
|
|
||||||
|
except BaseException:
|
||||||
|
log.exception(f'exited gen: {gen!r}\n')
|
||||||
|
raise
|
||||||
|
|
||||||
|
finally:
|
||||||
|
log.warning(
|
||||||
|
'Exiting bg thread!\n'
|
||||||
|
)
|
||||||
|
# TODO! better then this null setting naivety!
|
||||||
|
# -[ ] maybe an Unresolved or similar like for our `Context`?
|
||||||
|
#
|
||||||
|
# apply sentinel
|
||||||
|
cond.to_yield = None
|
||||||
|
with cond:
|
||||||
|
cond.notify_all()
|
||||||
|
|
||||||
|
@cm
|
||||||
|
def start_in_bg_thread(
|
||||||
|
gen: Generator,
|
||||||
|
|
||||||
|
# ?TODO?, is this useful to pass startup-ctx to the thread?
|
||||||
|
name: str|None = None,
|
||||||
|
**kwargs,
|
||||||
|
|
||||||
|
) -> tuple[
|
||||||
|
threading.Thread,
|
||||||
|
Generator,
|
||||||
|
Any,
|
||||||
|
]:
|
||||||
|
if not inspect.isgenerator(gen):
|
||||||
|
raise ValueError(
|
||||||
|
f'You must pass a `gen: Generator` instance\n'
|
||||||
|
f'gen={gen!r}\n'
|
||||||
|
)
|
||||||
|
|
||||||
|
# ?TODO? wrap this stuff into some kinda
|
||||||
|
# single-entry-inter-thread mem-chan?
|
||||||
|
#
|
||||||
|
cond = threading.Condition()
|
||||||
|
cond.to_send = None
|
||||||
|
cond.to_yield = None
|
||||||
|
cond.to_return = None
|
||||||
|
|
||||||
|
thr = threading.Thread(
|
||||||
|
target=run_gen_in_thread,
|
||||||
|
# args=(), # ?TODO, useful?
|
||||||
|
kwargs={
|
||||||
|
'cond': cond,
|
||||||
|
'gen': gen,
|
||||||
|
} | kwargs,
|
||||||
|
name=name or gen.__name__,
|
||||||
|
)
|
||||||
|
log.info(
|
||||||
|
f'starting bg thread\n'
|
||||||
|
f'>(\n'
|
||||||
|
f'|_{thr!r}\n'
|
||||||
|
)
|
||||||
|
thr.start()
|
||||||
|
|
||||||
|
# TODO, Event or cond.wait() here to sync!?
|
||||||
|
time.sleep(0.01)
|
||||||
|
|
||||||
|
try:
|
||||||
|
log.info(f'locking cond {cond}..')
|
||||||
|
with cond:
|
||||||
|
log.runtime(f'LOCKED cond {cond}..')
|
||||||
|
first_yielded = cond.to_yield
|
||||||
|
log.runtime(f'cond.to_yield: {first_yielded}')
|
||||||
|
|
||||||
|
# delegator shim generator which proxies values from
|
||||||
|
# caller to callee-in-bg-thread
|
||||||
|
def wrapper():
|
||||||
|
|
||||||
|
# !?TODO, minimize # of yields during startup?
|
||||||
|
# -[ ] we can do i in <=1 manual yield pre while-loop no?
|
||||||
|
#
|
||||||
|
first_sent = yield first_yielded
|
||||||
|
cond.to_send = first_sent
|
||||||
|
|
||||||
|
# !TODO, exactly why we need a conditional-emit-sys!
|
||||||
|
log.runtime(
|
||||||
|
f'cond.notify()\n'
|
||||||
|
f'cond.to_send={cond.to_send!r}\n'
|
||||||
|
f'cond.to_yield={cond.to_yield!r}\n'
|
||||||
|
)
|
||||||
|
cond.notify()
|
||||||
|
log.runtime(
|
||||||
|
f'cond.wait()\n'
|
||||||
|
f'cond.to_send={cond.to_send!r}\n'
|
||||||
|
f'cond.to_yield={cond.to_yield!r}\n'
|
||||||
|
)
|
||||||
|
cond.wait()
|
||||||
|
|
||||||
|
to_yield = cond.to_yield
|
||||||
|
log.runtime(
|
||||||
|
f'yielding to caller\n'
|
||||||
|
f'cond.to_send={cond.to_send!r}\n'
|
||||||
|
f'cond.to_yield={cond.to_yield!r}\n'
|
||||||
|
)
|
||||||
|
to_send = yield to_yield
|
||||||
|
log.runtime(
|
||||||
|
f'post-yield to caller\n'
|
||||||
|
f'to_send={to_send!r}\n'
|
||||||
|
f'to_yield={to_yield!r}\n'
|
||||||
|
)
|
||||||
|
|
||||||
|
# !TODO, proper sentinel-to-break type-condition!
|
||||||
|
while to_send is not None:
|
||||||
|
cond.to_send = to_send
|
||||||
|
log.runtime(
|
||||||
|
f'cond.nofity()\n'
|
||||||
|
f'cond.to_send={cond.to_send!r}\n'
|
||||||
|
f'cond.to_yield={cond.to_yield!r}\n'
|
||||||
|
)
|
||||||
|
cond.notify()
|
||||||
|
if cond.to_yield is None:
|
||||||
|
log.runtime(
|
||||||
|
'BREAKING from wrapper-LOOP!\n'
|
||||||
|
)
|
||||||
|
break
|
||||||
|
return
|
||||||
|
|
||||||
|
log.runtime(
|
||||||
|
f'cond.wait()\n'
|
||||||
|
f'cond.to_send={cond.to_send!r}\n'
|
||||||
|
f'cond.to_yield={cond.to_yield!r}\n'
|
||||||
|
)
|
||||||
|
cond.wait()
|
||||||
|
|
||||||
|
log.runtime(
|
||||||
|
f'yielding to caller\n'
|
||||||
|
f'cond.to_send={cond.to_send!r}\n'
|
||||||
|
f'cond.to_yield={cond.to_yield!r}\n'
|
||||||
|
)
|
||||||
|
to_yield = cond.to_yield
|
||||||
|
to_send = yield to_yield
|
||||||
|
log.runtime(
|
||||||
|
f'post-yield to caller\n'
|
||||||
|
f'to_send={to_send!r}\n'
|
||||||
|
f'to_yield={to_yield!r}\n'
|
||||||
|
)
|
||||||
|
|
||||||
|
log.info('creating wrapper..')
|
||||||
|
wrapper_gen = wrapper()
|
||||||
|
log.info(f'first .send(None): {wrapper_gen}\n')
|
||||||
|
first_yielded = wrapper_gen.send(None)
|
||||||
|
log.info(f'first yielded: {first_yielded}\n')
|
||||||
|
|
||||||
|
yield (
|
||||||
|
thr,
|
||||||
|
wrapper_gen,
|
||||||
|
first_yielded,
|
||||||
|
)
|
||||||
|
finally:
|
||||||
|
thr.join()
|
||||||
|
log.info(f'bg thread joined: {thr!r}')
|
||||||
|
|
||||||
|
|
||||||
|
async def main():
|
||||||
|
async with trio.open_nursery() as tn:
|
||||||
|
assert tn
|
||||||
|
|
||||||
|
with (
|
||||||
|
start_in_bg_thread(
|
||||||
|
gen=(
|
||||||
|
_gen:=thread_gen(
|
||||||
|
seed=_seed,
|
||||||
|
)
|
||||||
|
),
|
||||||
|
) as (
|
||||||
|
thr,
|
||||||
|
wrapped_gen,
|
||||||
|
first,
|
||||||
|
),
|
||||||
|
):
|
||||||
|
assert (
|
||||||
|
_gen is not wrapped_gen
|
||||||
|
and
|
||||||
|
wrapped_gen is not None
|
||||||
|
)
|
||||||
|
log.info(
|
||||||
|
'Entering wrapped_gen loop\n'
|
||||||
|
)
|
||||||
|
|
||||||
|
# NOTE, like our `Context.started` value
|
||||||
|
assert first == 0
|
||||||
|
|
||||||
|
# !TODO, proper sentinel-to-break type-condition!
|
||||||
|
yielded = first
|
||||||
|
while yielded is not None:
|
||||||
|
|
||||||
|
# XXX, compute callers new value to send to bg-thread
|
||||||
|
to_send = yielded * yielded
|
||||||
|
|
||||||
|
# send to bg-thread
|
||||||
|
yielded = wrapped_gen.send(to_send)
|
||||||
|
log.info(
|
||||||
|
f'(yielded:={yielded!r}) = wrapped_gen.send((to_send:={to_send!r})'
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == '__main__':
|
||||||
|
trio.run(main)
|
|
@ -61,8 +61,7 @@ dev = [
|
||||||
# `tractor.devx` tooling
|
# `tractor.devx` tooling
|
||||||
"greenback>=1.2.1,<2",
|
"greenback>=1.2.1,<2",
|
||||||
"stackscope>=0.2.2,<0.3",
|
"stackscope>=0.2.2,<0.3",
|
||||||
# ^ requires this?
|
"typing-extensions>=4.13.2", # needed for stackscope
|
||||||
"typing-extensions>=4.14.1",
|
|
||||||
"pyperclip>=1.9.0",
|
"pyperclip>=1.9.0",
|
||||||
"prompt-toolkit>=3.0.50",
|
"prompt-toolkit>=3.0.50",
|
||||||
"xonsh>=0.19.2",
|
"xonsh>=0.19.2",
|
||||||
|
|
|
@ -1,24 +1,27 @@
|
||||||
"""
|
"""
|
||||||
``tractor`` testing!!
|
Top level of the testing suites!
|
||||||
|
|
||||||
"""
|
"""
|
||||||
|
from __future__ import annotations
|
||||||
import sys
|
import sys
|
||||||
import subprocess
|
import subprocess
|
||||||
import os
|
import os
|
||||||
import random
|
|
||||||
import signal
|
import signal
|
||||||
import platform
|
import platform
|
||||||
import time
|
import time
|
||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
import tractor
|
|
||||||
from tractor._testing import (
|
from tractor._testing import (
|
||||||
examples_dir as examples_dir,
|
examples_dir as examples_dir,
|
||||||
tractor_test as tractor_test,
|
tractor_test as tractor_test,
|
||||||
expect_ctxc as expect_ctxc,
|
expect_ctxc as expect_ctxc,
|
||||||
)
|
)
|
||||||
|
|
||||||
# TODO: include wtv plugin(s) we build in `._testing.pytest`?
|
pytest_plugins: list[str] = [
|
||||||
pytest_plugins = ['pytester']
|
'pytester',
|
||||||
|
'tractor._testing.pytest',
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
# Sending signal.SIGINT on subprocess fails on windows. Use CTRL_* alternatives
|
# Sending signal.SIGINT on subprocess fails on windows. Use CTRL_* alternatives
|
||||||
if platform.system() == 'Windows':
|
if platform.system() == 'Windows':
|
||||||
|
@ -30,7 +33,11 @@ else:
|
||||||
_KILL_SIGNAL = signal.SIGKILL
|
_KILL_SIGNAL = signal.SIGKILL
|
||||||
_INT_SIGNAL = signal.SIGINT
|
_INT_SIGNAL = signal.SIGINT
|
||||||
_INT_RETURN_CODE = 1 if sys.version_info < (3, 8) else -signal.SIGINT.value
|
_INT_RETURN_CODE = 1 if sys.version_info < (3, 8) else -signal.SIGINT.value
|
||||||
_PROC_SPAWN_WAIT = 0.6 if sys.version_info < (3, 7) else 0.4
|
_PROC_SPAWN_WAIT = (
|
||||||
|
0.6
|
||||||
|
if sys.version_info < (3, 7)
|
||||||
|
else 0.4
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
no_windows = pytest.mark.skipif(
|
no_windows = pytest.mark.skipif(
|
||||||
|
@ -39,7 +46,12 @@ no_windows = pytest.mark.skipif(
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def pytest_addoption(parser):
|
def pytest_addoption(
|
||||||
|
parser: pytest.Parser,
|
||||||
|
):
|
||||||
|
# ?TODO? should this be exposed from our `._testing.pytest`
|
||||||
|
# plugin or should we make it more explicit with `--tl` for
|
||||||
|
# tractor logging like we do in other client projects?
|
||||||
parser.addoption(
|
parser.addoption(
|
||||||
"--ll",
|
"--ll",
|
||||||
action="store",
|
action="store",
|
||||||
|
@ -47,42 +59,10 @@ def pytest_addoption(parser):
|
||||||
default='ERROR', help="logging level to set when testing"
|
default='ERROR', help="logging level to set when testing"
|
||||||
)
|
)
|
||||||
|
|
||||||
parser.addoption(
|
|
||||||
"--spawn-backend",
|
|
||||||
action="store",
|
|
||||||
dest='spawn_backend',
|
|
||||||
default='trio',
|
|
||||||
help="Processing spawning backend to use for test run",
|
|
||||||
)
|
|
||||||
|
|
||||||
parser.addoption(
|
|
||||||
"--tpdb", "--debug-mode",
|
|
||||||
action="store_true",
|
|
||||||
dest='tractor_debug_mode',
|
|
||||||
# default=False,
|
|
||||||
help=(
|
|
||||||
'Enable a flag that can be used by tests to to set the '
|
|
||||||
'`debug_mode: bool` for engaging the internal '
|
|
||||||
'multi-proc debugger sys.'
|
|
||||||
),
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def pytest_configure(config):
|
|
||||||
backend = config.option.spawn_backend
|
|
||||||
tractor._spawn.try_set_start_method(backend)
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture(scope='session')
|
|
||||||
def debug_mode(request):
|
|
||||||
debug_mode: bool = request.config.option.tractor_debug_mode
|
|
||||||
# if debug_mode:
|
|
||||||
# breakpoint()
|
|
||||||
return debug_mode
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture(scope='session', autouse=True)
|
@pytest.fixture(scope='session', autouse=True)
|
||||||
def loglevel(request):
|
def loglevel(request):
|
||||||
|
import tractor
|
||||||
orig = tractor.log._default_loglevel
|
orig = tractor.log._default_loglevel
|
||||||
level = tractor.log._default_loglevel = request.config.option.loglevel
|
level = tractor.log._default_loglevel = request.config.option.loglevel
|
||||||
tractor.log.get_console_log(level)
|
tractor.log.get_console_log(level)
|
||||||
|
@ -90,106 +70,44 @@ def loglevel(request):
|
||||||
tractor.log._default_loglevel = orig
|
tractor.log._default_loglevel = orig
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture(scope='session')
|
|
||||||
def spawn_backend(request) -> str:
|
|
||||||
return request.config.option.spawn_backend
|
|
||||||
|
|
||||||
|
|
||||||
# @pytest.fixture(scope='function', autouse=True)
|
|
||||||
# def debug_enabled(request) -> str:
|
|
||||||
# from tractor import _state
|
|
||||||
# if _state._runtime_vars['_debug_mode']:
|
|
||||||
# breakpoint()
|
|
||||||
|
|
||||||
_ci_env: bool = os.environ.get('CI', False)
|
_ci_env: bool = os.environ.get('CI', False)
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture(scope='session')
|
@pytest.fixture(scope='session')
|
||||||
def ci_env() -> bool:
|
def ci_env() -> bool:
|
||||||
'''
|
'''
|
||||||
Detect CI envoirment.
|
Detect CI environment.
|
||||||
|
|
||||||
'''
|
'''
|
||||||
return _ci_env
|
return _ci_env
|
||||||
|
|
||||||
|
|
||||||
# TODO: also move this to `._testing` for now?
|
def sig_prog(
|
||||||
# -[ ] possibly generalize and re-use for multi-tree spawning
|
proc: subprocess.Popen,
|
||||||
# along with the new stuff for multi-addrs in distribute_dis
|
sig: int,
|
||||||
# branch?
|
canc_timeout: float = 0.1,
|
||||||
#
|
) -> int:
|
||||||
# choose randomly at import time
|
|
||||||
_reg_addr: tuple[str, int] = (
|
|
||||||
'127.0.0.1',
|
|
||||||
random.randint(1000, 9999),
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture(scope='session')
|
|
||||||
def reg_addr() -> tuple[str, int]:
|
|
||||||
|
|
||||||
# globally override the runtime to the per-test-session-dynamic
|
|
||||||
# addr so that all tests never conflict with any other actor
|
|
||||||
# tree using the default.
|
|
||||||
from tractor import _root
|
|
||||||
_root._default_lo_addrs = [_reg_addr]
|
|
||||||
|
|
||||||
return _reg_addr
|
|
||||||
|
|
||||||
|
|
||||||
def pytest_generate_tests(metafunc):
|
|
||||||
spawn_backend = metafunc.config.option.spawn_backend
|
|
||||||
|
|
||||||
if not spawn_backend:
|
|
||||||
# XXX some weird windows bug with `pytest`?
|
|
||||||
spawn_backend = 'trio'
|
|
||||||
|
|
||||||
# TODO: maybe just use the literal `._spawn.SpawnMethodKey`?
|
|
||||||
assert spawn_backend in (
|
|
||||||
'mp_spawn',
|
|
||||||
'mp_forkserver',
|
|
||||||
'trio',
|
|
||||||
)
|
|
||||||
|
|
||||||
# NOTE: used to be used to dyanmically parametrize tests for when
|
|
||||||
# you just passed --spawn-backend=`mp` on the cli, but now we expect
|
|
||||||
# that cli input to be manually specified, BUT, maybe we'll do
|
|
||||||
# something like this again in the future?
|
|
||||||
if 'start_method' in metafunc.fixturenames:
|
|
||||||
metafunc.parametrize("start_method", [spawn_backend], scope='module')
|
|
||||||
|
|
||||||
|
|
||||||
# TODO: a way to let test scripts (like from `examples/`)
|
|
||||||
# guarantee they won't registry addr collide!
|
|
||||||
# @pytest.fixture
|
|
||||||
# def open_test_runtime(
|
|
||||||
# reg_addr: tuple,
|
|
||||||
# ) -> AsyncContextManager:
|
|
||||||
# return partial(
|
|
||||||
# tractor.open_nursery,
|
|
||||||
# registry_addrs=[reg_addr],
|
|
||||||
# )
|
|
||||||
|
|
||||||
|
|
||||||
def sig_prog(proc, sig):
|
|
||||||
"Kill the actor-process with ``sig``."
|
"Kill the actor-process with ``sig``."
|
||||||
proc.send_signal(sig)
|
proc.send_signal(sig)
|
||||||
time.sleep(0.1)
|
time.sleep(canc_timeout)
|
||||||
if not proc.poll():
|
if not proc.poll():
|
||||||
# TODO: why sometimes does SIGINT not work on teardown?
|
# TODO: why sometimes does SIGINT not work on teardown?
|
||||||
# seems to happen only when trace logging enabled?
|
# seems to happen only when trace logging enabled?
|
||||||
proc.send_signal(_KILL_SIGNAL)
|
proc.send_signal(_KILL_SIGNAL)
|
||||||
ret = proc.wait()
|
ret: int = proc.wait()
|
||||||
assert ret
|
assert ret
|
||||||
|
|
||||||
|
|
||||||
# TODO: factor into @cm and move to `._testing`?
|
# TODO: factor into @cm and move to `._testing`?
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
def daemon(
|
def daemon(
|
||||||
|
debug_mode: bool,
|
||||||
loglevel: str,
|
loglevel: str,
|
||||||
testdir,
|
testdir: pytest.Pytester,
|
||||||
reg_addr: tuple[str, int],
|
reg_addr: tuple[str, int],
|
||||||
):
|
tpt_proto: str,
|
||||||
|
|
||||||
|
) -> subprocess.Popen:
|
||||||
'''
|
'''
|
||||||
Run a daemon root actor as a separate actor-process tree and
|
Run a daemon root actor as a separate actor-process tree and
|
||||||
"remote registrar" for discovery-protocol related tests.
|
"remote registrar" for discovery-protocol related tests.
|
||||||
|
@ -200,28 +118,100 @@ def daemon(
|
||||||
loglevel: str = 'info'
|
loglevel: str = 'info'
|
||||||
|
|
||||||
code: str = (
|
code: str = (
|
||||||
"import tractor; "
|
"import tractor; "
|
||||||
"tractor.run_daemon([], registry_addrs={reg_addrs}, loglevel={ll})"
|
"tractor.run_daemon([], "
|
||||||
|
"registry_addrs={reg_addrs}, "
|
||||||
|
"debug_mode={debug_mode}, "
|
||||||
|
"loglevel={ll})"
|
||||||
).format(
|
).format(
|
||||||
reg_addrs=str([reg_addr]),
|
reg_addrs=str([reg_addr]),
|
||||||
ll="'{}'".format(loglevel) if loglevel else None,
|
ll="'{}'".format(loglevel) if loglevel else None,
|
||||||
|
debug_mode=debug_mode,
|
||||||
)
|
)
|
||||||
cmd: list[str] = [
|
cmd: list[str] = [
|
||||||
sys.executable,
|
sys.executable,
|
||||||
'-c', code,
|
'-c', code,
|
||||||
]
|
]
|
||||||
|
# breakpoint()
|
||||||
kwargs = {}
|
kwargs = {}
|
||||||
if platform.system() == 'Windows':
|
if platform.system() == 'Windows':
|
||||||
# without this, tests hang on windows forever
|
# without this, tests hang on windows forever
|
||||||
kwargs['creationflags'] = subprocess.CREATE_NEW_PROCESS_GROUP
|
kwargs['creationflags'] = subprocess.CREATE_NEW_PROCESS_GROUP
|
||||||
|
|
||||||
proc = testdir.popen(
|
proc: subprocess.Popen = testdir.popen(
|
||||||
cmd,
|
cmd,
|
||||||
stdout=subprocess.PIPE,
|
|
||||||
stderr=subprocess.PIPE,
|
|
||||||
**kwargs,
|
**kwargs,
|
||||||
)
|
)
|
||||||
assert not proc.returncode
|
|
||||||
|
# UDS sockets are **really** fast to bind()/listen()/connect()
|
||||||
|
# so it's often required that we delay a bit more starting
|
||||||
|
# the first actor-tree..
|
||||||
|
if tpt_proto == 'uds':
|
||||||
|
global _PROC_SPAWN_WAIT
|
||||||
|
_PROC_SPAWN_WAIT = 0.6
|
||||||
|
|
||||||
time.sleep(_PROC_SPAWN_WAIT)
|
time.sleep(_PROC_SPAWN_WAIT)
|
||||||
|
|
||||||
|
assert not proc.returncode
|
||||||
yield proc
|
yield proc
|
||||||
sig_prog(proc, _INT_SIGNAL)
|
sig_prog(proc, _INT_SIGNAL)
|
||||||
|
|
||||||
|
# XXX! yeah.. just be reaaal careful with this bc sometimes it
|
||||||
|
# can lock up on the `_io.BufferedReader` and hang..
|
||||||
|
stderr: str = proc.stderr.read().decode()
|
||||||
|
if stderr:
|
||||||
|
print(
|
||||||
|
f'Daemon actor tree produced STDERR:\n'
|
||||||
|
f'{proc.args}\n'
|
||||||
|
f'\n'
|
||||||
|
f'{stderr}\n'
|
||||||
|
)
|
||||||
|
if proc.returncode != -2:
|
||||||
|
raise RuntimeError(
|
||||||
|
'Daemon actor tree failed !?\n'
|
||||||
|
f'{proc.args}\n'
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
# @pytest.fixture(autouse=True)
|
||||||
|
# def shared_last_failed(pytestconfig):
|
||||||
|
# val = pytestconfig.cache.get("example/value", None)
|
||||||
|
# breakpoint()
|
||||||
|
# if val is None:
|
||||||
|
# pytestconfig.cache.set("example/value", val)
|
||||||
|
# return val
|
||||||
|
|
||||||
|
|
||||||
|
# TODO: a way to let test scripts (like from `examples/`)
|
||||||
|
# guarantee they won't `registry_addrs` collide!
|
||||||
|
# -[ ] maybe use some kinda standard `def main()` arg-spec that
|
||||||
|
# we can introspect from a fixture that is called from the test
|
||||||
|
# body?
|
||||||
|
# -[ ] test and figure out typing for below prototype! Bp
|
||||||
|
#
|
||||||
|
# @pytest.fixture
|
||||||
|
# def set_script_runtime_args(
|
||||||
|
# reg_addr: tuple,
|
||||||
|
# ) -> Callable[[...], None]:
|
||||||
|
|
||||||
|
# def import_n_partial_in_args_n_triorun(
|
||||||
|
# script: Path, # under examples?
|
||||||
|
# **runtime_args,
|
||||||
|
# ) -> Callable[[], Any]: # a `partial`-ed equiv of `trio.run()`
|
||||||
|
|
||||||
|
# # NOTE, below is taken from
|
||||||
|
# # `.test_advanced_faults.test_ipc_channel_break_during_stream`
|
||||||
|
# mod: ModuleType = import_path(
|
||||||
|
# examples_dir() / 'advanced_faults'
|
||||||
|
# / 'ipc_failure_during_stream.py',
|
||||||
|
# root=examples_dir(),
|
||||||
|
# consider_namespace_packages=False,
|
||||||
|
# )
|
||||||
|
# return partial(
|
||||||
|
# trio.run,
|
||||||
|
# partial(
|
||||||
|
# mod.main,
|
||||||
|
# **runtime_args,
|
||||||
|
# )
|
||||||
|
# )
|
||||||
|
# return import_n_partial_in_args_n_triorun
|
||||||
|
|
|
@ -2,9 +2,11 @@
|
||||||
`tractor.devx.*` tooling sub-pkg test space.
|
`tractor.devx.*` tooling sub-pkg test space.
|
||||||
|
|
||||||
'''
|
'''
|
||||||
|
from __future__ import annotations
|
||||||
import time
|
import time
|
||||||
from typing import (
|
from typing import (
|
||||||
Callable,
|
Callable,
|
||||||
|
TYPE_CHECKING,
|
||||||
)
|
)
|
||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
|
@ -16,7 +18,7 @@ from pexpect.spawnbase import SpawnBase
|
||||||
from tractor._testing import (
|
from tractor._testing import (
|
||||||
mk_cmd,
|
mk_cmd,
|
||||||
)
|
)
|
||||||
from tractor.devx._debug import (
|
from tractor.devx.debug import (
|
||||||
_pause_msg as _pause_msg,
|
_pause_msg as _pause_msg,
|
||||||
_crash_msg as _crash_msg,
|
_crash_msg as _crash_msg,
|
||||||
_repl_fail_msg as _repl_fail_msg,
|
_repl_fail_msg as _repl_fail_msg,
|
||||||
|
@ -26,14 +28,22 @@ from ..conftest import (
|
||||||
_ci_env,
|
_ci_env,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
if TYPE_CHECKING:
|
||||||
|
from pexpect import pty_spawn
|
||||||
|
|
||||||
|
|
||||||
|
# a fn that sub-instantiates a `pexpect.spawn()`
|
||||||
|
# and returns it.
|
||||||
|
type PexpectSpawner = Callable[[str], pty_spawn.spawn]
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
def spawn(
|
def spawn(
|
||||||
start_method,
|
start_method: str,
|
||||||
testdir: pytest.Pytester,
|
testdir: pytest.Pytester,
|
||||||
reg_addr: tuple[str, int],
|
reg_addr: tuple[str, int],
|
||||||
|
|
||||||
) -> Callable[[str], None]:
|
) -> PexpectSpawner:
|
||||||
'''
|
'''
|
||||||
Use the `pexpect` module shipped via `testdir.spawn()` to
|
Use the `pexpect` module shipped via `testdir.spawn()` to
|
||||||
run an `./examples/..` script by name.
|
run an `./examples/..` script by name.
|
||||||
|
@ -59,7 +69,7 @@ def spawn(
|
||||||
def _spawn(
|
def _spawn(
|
||||||
cmd: str,
|
cmd: str,
|
||||||
**mkcmd_kwargs,
|
**mkcmd_kwargs,
|
||||||
):
|
) -> pty_spawn.spawn:
|
||||||
unset_colors()
|
unset_colors()
|
||||||
return testdir.spawn(
|
return testdir.spawn(
|
||||||
cmd=mk_cmd(
|
cmd=mk_cmd(
|
||||||
|
@ -73,7 +83,7 @@ def spawn(
|
||||||
)
|
)
|
||||||
|
|
||||||
# such that test-dep can pass input script name.
|
# such that test-dep can pass input script name.
|
||||||
return _spawn
|
return _spawn # the `PexpectSpawner`, type alias.
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture(
|
@pytest.fixture(
|
||||||
|
@ -111,7 +121,7 @@ def ctlc(
|
||||||
# XXX: disable pygments highlighting for auto-tests
|
# XXX: disable pygments highlighting for auto-tests
|
||||||
# since some envs (like actions CI) will struggle
|
# since some envs (like actions CI) will struggle
|
||||||
# the the added color-char encoding..
|
# the the added color-char encoding..
|
||||||
from tractor.devx._debug import TractorConfig
|
from tractor.devx.debug import TractorConfig
|
||||||
TractorConfig.use_pygements = False
|
TractorConfig.use_pygements = False
|
||||||
|
|
||||||
yield use_ctlc
|
yield use_ctlc
|
||||||
|
|
|
@ -10,10 +10,14 @@ TODO:
|
||||||
- wonder if any of it'll work on OS X?
|
- wonder if any of it'll work on OS X?
|
||||||
|
|
||||||
"""
|
"""
|
||||||
|
from __future__ import annotations
|
||||||
from functools import partial
|
from functools import partial
|
||||||
import itertools
|
import itertools
|
||||||
import platform
|
import platform
|
||||||
import time
|
import time
|
||||||
|
from typing import (
|
||||||
|
TYPE_CHECKING,
|
||||||
|
)
|
||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
from pexpect.exceptions import (
|
from pexpect.exceptions import (
|
||||||
|
@ -34,6 +38,9 @@ from .conftest import (
|
||||||
assert_before,
|
assert_before,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
if TYPE_CHECKING:
|
||||||
|
from ..conftest import PexpectSpawner
|
||||||
|
|
||||||
# TODO: The next great debugger audit could be done by you!
|
# TODO: The next great debugger audit could be done by you!
|
||||||
# - recurrent entry to breakpoint() from single actor *after* and an
|
# - recurrent entry to breakpoint() from single actor *after* and an
|
||||||
# error in another task?
|
# error in another task?
|
||||||
|
@ -310,7 +317,6 @@ def test_subactor_breakpoint(
|
||||||
|
|
||||||
assert in_prompt_msg(
|
assert in_prompt_msg(
|
||||||
child, [
|
child, [
|
||||||
'MessagingError:',
|
|
||||||
'RemoteActorError:',
|
'RemoteActorError:',
|
||||||
"('breakpoint_forever'",
|
"('breakpoint_forever'",
|
||||||
'bdb.BdbQuit',
|
'bdb.BdbQuit',
|
||||||
|
@ -528,7 +534,7 @@ def test_multi_daemon_subactors(
|
||||||
# now the root actor won't clobber the bp_forever child
|
# now the root actor won't clobber the bp_forever child
|
||||||
# during it's first access to the debug lock, but will instead
|
# during it's first access to the debug lock, but will instead
|
||||||
# wait for the lock to release, by the edge triggered
|
# wait for the lock to release, by the edge triggered
|
||||||
# ``devx._debug.Lock.no_remote_has_tty`` event before sending cancel messages
|
# ``devx.debug.Lock.no_remote_has_tty`` event before sending cancel messages
|
||||||
# (via portals) to its underlings B)
|
# (via portals) to its underlings B)
|
||||||
|
|
||||||
# at some point here there should have been some warning msg from
|
# at some point here there should have been some warning msg from
|
||||||
|
@ -1063,6 +1069,88 @@ def test_shield_pause(
|
||||||
child.expect(EOF)
|
child.expect(EOF)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize(
|
||||||
|
'quit_early', [False, True]
|
||||||
|
)
|
||||||
|
def test_ctxep_pauses_n_maybe_ipc_breaks(
|
||||||
|
spawn: PexpectSpawner,
|
||||||
|
quit_early: bool,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Audit generator embedded `.pause()`es from within a `@context`
|
||||||
|
endpoint with a chan close at the end, requiring that ctl-c is
|
||||||
|
mashed and zombie reaper kills sub with no hangs.
|
||||||
|
|
||||||
|
'''
|
||||||
|
child = spawn('subactor_bp_in_ctx')
|
||||||
|
child.expect(PROMPT)
|
||||||
|
|
||||||
|
# 3 iters for the `gen()` pause-points
|
||||||
|
for i in range(3):
|
||||||
|
assert_before(
|
||||||
|
child,
|
||||||
|
[
|
||||||
|
_pause_msg,
|
||||||
|
"('bp_boi'", # actor name
|
||||||
|
"<Task 'just_bp'", # task name
|
||||||
|
]
|
||||||
|
)
|
||||||
|
if (
|
||||||
|
i == 1
|
||||||
|
and
|
||||||
|
quit_early
|
||||||
|
):
|
||||||
|
child.sendline('q')
|
||||||
|
child.expect(PROMPT)
|
||||||
|
assert_before(
|
||||||
|
child,
|
||||||
|
["tractor._exceptions.RemoteActorError: remote task raised a 'BdbQuit'",
|
||||||
|
"bdb.BdbQuit",
|
||||||
|
"('bp_boi'",
|
||||||
|
]
|
||||||
|
)
|
||||||
|
child.sendline('c')
|
||||||
|
child.expect(EOF)
|
||||||
|
assert_before(
|
||||||
|
child,
|
||||||
|
["tractor._exceptions.RemoteActorError: remote task raised a 'BdbQuit'",
|
||||||
|
"bdb.BdbQuit",
|
||||||
|
"('bp_boi'",
|
||||||
|
]
|
||||||
|
)
|
||||||
|
break # end-of-test
|
||||||
|
|
||||||
|
child.sendline('c')
|
||||||
|
try:
|
||||||
|
child.expect(PROMPT)
|
||||||
|
except TIMEOUT:
|
||||||
|
# no prompt since we hang due to IPC chan purposely
|
||||||
|
# closed so verify we see error reporting as well as
|
||||||
|
# a failed crash-REPL request msg and can CTL-c our way
|
||||||
|
# out.
|
||||||
|
assert_before(
|
||||||
|
child,
|
||||||
|
['peer IPC channel closed abruptly?',
|
||||||
|
'another task closed this fd',
|
||||||
|
'Debug lock request was CANCELLED?',
|
||||||
|
"TransportClosed: 'MsgpackUDSStream' was already closed locally ?",]
|
||||||
|
|
||||||
|
# XXX races on whether these show/hit?
|
||||||
|
# 'Failed to REPl via `_pause()` You called `tractor.pause()` from an already cancelled scope!',
|
||||||
|
# 'AssertionError',
|
||||||
|
)
|
||||||
|
# OSc(ancel) the hanging tree
|
||||||
|
do_ctlc(
|
||||||
|
child=child,
|
||||||
|
expect_prompt=False,
|
||||||
|
)
|
||||||
|
child.expect(EOF)
|
||||||
|
assert_before(
|
||||||
|
child,
|
||||||
|
['KeyboardInterrupt'],
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
# TODO: better error for "non-ideal" usage from the root actor.
|
# TODO: better error for "non-ideal" usage from the root actor.
|
||||||
# -[ ] if called from an async scope emit a message that suggests
|
# -[ ] if called from an async scope emit a message that suggests
|
||||||
# using `await tractor.pause()` instead since it's less overhead
|
# using `await tractor.pause()` instead since it's less overhead
|
||||||
|
|
|
@ -13,9 +13,13 @@ TODO:
|
||||||
when debugging a problem inside the stack vs. in their app.
|
when debugging a problem inside the stack vs. in their app.
|
||||||
|
|
||||||
'''
|
'''
|
||||||
|
from __future__ import annotations
|
||||||
import os
|
import os
|
||||||
import signal
|
import signal
|
||||||
import time
|
import time
|
||||||
|
from typing import (
|
||||||
|
TYPE_CHECKING,
|
||||||
|
)
|
||||||
|
|
||||||
from .conftest import (
|
from .conftest import (
|
||||||
expect,
|
expect,
|
||||||
|
@ -29,9 +33,12 @@ from pexpect.exceptions import (
|
||||||
EOF,
|
EOF,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
if TYPE_CHECKING:
|
||||||
|
from ..conftest import PexpectSpawner
|
||||||
|
|
||||||
|
|
||||||
def test_shield_pause(
|
def test_shield_pause(
|
||||||
spawn,
|
spawn: PexpectSpawner,
|
||||||
):
|
):
|
||||||
'''
|
'''
|
||||||
Verify the `tractor.pause()/.post_mortem()` API works inside an
|
Verify the `tractor.pause()/.post_mortem()` API works inside an
|
||||||
|
@ -109,9 +116,11 @@ def test_shield_pause(
|
||||||
child.pid,
|
child.pid,
|
||||||
signal.SIGINT,
|
signal.SIGINT,
|
||||||
)
|
)
|
||||||
|
from tractor._supervise import _shutdown_msg
|
||||||
expect(
|
expect(
|
||||||
child,
|
child,
|
||||||
'Shutting down actor runtime',
|
# 'Shutting down actor runtime',
|
||||||
|
_shutdown_msg,
|
||||||
timeout=6,
|
timeout=6,
|
||||||
)
|
)
|
||||||
assert_before(
|
assert_before(
|
||||||
|
@ -126,7 +135,7 @@ def test_shield_pause(
|
||||||
|
|
||||||
|
|
||||||
def test_breakpoint_hook_restored(
|
def test_breakpoint_hook_restored(
|
||||||
spawn,
|
spawn: PexpectSpawner,
|
||||||
):
|
):
|
||||||
'''
|
'''
|
||||||
Ensures our actor runtime sets a custom `breakpoint()` hook
|
Ensures our actor runtime sets a custom `breakpoint()` hook
|
||||||
|
@ -140,16 +149,22 @@ def test_breakpoint_hook_restored(
|
||||||
child = spawn('restore_builtin_breakpoint')
|
child = spawn('restore_builtin_breakpoint')
|
||||||
|
|
||||||
child.expect(PROMPT)
|
child.expect(PROMPT)
|
||||||
assert_before(
|
try:
|
||||||
child,
|
assert_before(
|
||||||
[
|
child,
|
||||||
_pause_msg,
|
[
|
||||||
"<Task '__main__.main'",
|
_pause_msg,
|
||||||
"('root'",
|
"<Task '__main__.main'",
|
||||||
"first bp, tractor hook set",
|
"('root'",
|
||||||
]
|
"first bp, tractor hook set",
|
||||||
)
|
]
|
||||||
child.sendline('c')
|
)
|
||||||
|
# XXX if the above raises `AssertionError`, without sending
|
||||||
|
# the final 'continue' cmd to the REPL-active sub-process,
|
||||||
|
# we'll hang waiting for that pexpect instance to terminate..
|
||||||
|
finally:
|
||||||
|
child.sendline('c')
|
||||||
|
|
||||||
child.expect(PROMPT)
|
child.expect(PROMPT)
|
||||||
assert_before(
|
assert_before(
|
||||||
child,
|
child,
|
||||||
|
|
|
@ -0,0 +1,4 @@
|
||||||
|
'''
|
||||||
|
`tractor.ipc` subsystem(s)/unit testing suites.
|
||||||
|
|
||||||
|
'''
|
|
@ -0,0 +1,72 @@
|
||||||
|
'''
|
||||||
|
High-level `.ipc._server` unit tests.
|
||||||
|
|
||||||
|
'''
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
import trio
|
||||||
|
from tractor import (
|
||||||
|
devx,
|
||||||
|
ipc,
|
||||||
|
log,
|
||||||
|
)
|
||||||
|
from tractor._testing.addr import (
|
||||||
|
get_rando_addr,
|
||||||
|
)
|
||||||
|
# TODO, use/check-roundtripping with some of these wrapper types?
|
||||||
|
#
|
||||||
|
# from .._addr import Address
|
||||||
|
# from ._chan import Channel
|
||||||
|
# from ._transport import MsgTransport
|
||||||
|
# from ._uds import UDSAddress
|
||||||
|
# from ._tcp import TCPAddress
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize(
|
||||||
|
'_tpt_proto',
|
||||||
|
['uds', 'tcp']
|
||||||
|
)
|
||||||
|
def test_basic_ipc_server(
|
||||||
|
_tpt_proto: str,
|
||||||
|
debug_mode: bool,
|
||||||
|
loglevel: str,
|
||||||
|
):
|
||||||
|
|
||||||
|
# so we see the socket-listener reporting on console
|
||||||
|
log.get_console_log("INFO")
|
||||||
|
|
||||||
|
rando_addr: tuple = get_rando_addr(
|
||||||
|
tpt_proto=_tpt_proto,
|
||||||
|
)
|
||||||
|
async def main():
|
||||||
|
async with ipc._server.open_ipc_server() as server:
|
||||||
|
|
||||||
|
assert (
|
||||||
|
server._parent_tn
|
||||||
|
and
|
||||||
|
server._parent_tn is server._stream_handler_tn
|
||||||
|
)
|
||||||
|
assert server._no_more_peers.is_set()
|
||||||
|
|
||||||
|
eps: list[ipc._server.Endpoint] = await server.listen_on(
|
||||||
|
accept_addrs=[rando_addr],
|
||||||
|
stream_handler_nursery=None,
|
||||||
|
)
|
||||||
|
assert (
|
||||||
|
len(eps) == 1
|
||||||
|
and
|
||||||
|
(ep := eps[0])._listener
|
||||||
|
and
|
||||||
|
not ep.peer_tpts
|
||||||
|
)
|
||||||
|
|
||||||
|
server._parent_tn.cancel_scope.cancel()
|
||||||
|
|
||||||
|
# !TODO! actually make a bg-task connection from a client
|
||||||
|
# using `ipc._chan._connect_chan()`
|
||||||
|
|
||||||
|
with devx.maybe_open_crash_handler(
|
||||||
|
pdb=debug_mode,
|
||||||
|
):
|
||||||
|
trio.run(main)
|
|
@ -10,6 +10,9 @@ import pytest
|
||||||
from _pytest.pathlib import import_path
|
from _pytest.pathlib import import_path
|
||||||
import trio
|
import trio
|
||||||
import tractor
|
import tractor
|
||||||
|
from tractor import (
|
||||||
|
TransportClosed,
|
||||||
|
)
|
||||||
from tractor._testing import (
|
from tractor._testing import (
|
||||||
examples_dir,
|
examples_dir,
|
||||||
break_ipc,
|
break_ipc,
|
||||||
|
@ -74,6 +77,7 @@ def test_ipc_channel_break_during_stream(
|
||||||
spawn_backend: str,
|
spawn_backend: str,
|
||||||
ipc_break: dict|None,
|
ipc_break: dict|None,
|
||||||
pre_aclose_msgstream: bool,
|
pre_aclose_msgstream: bool,
|
||||||
|
tpt_proto: str,
|
||||||
):
|
):
|
||||||
'''
|
'''
|
||||||
Ensure we can have an IPC channel break its connection during
|
Ensure we can have an IPC channel break its connection during
|
||||||
|
@ -91,7 +95,7 @@ def test_ipc_channel_break_during_stream(
|
||||||
# non-`trio` spawners should never hit the hang condition that
|
# non-`trio` spawners should never hit the hang condition that
|
||||||
# requires the user to do ctl-c to cancel the actor tree.
|
# requires the user to do ctl-c to cancel the actor tree.
|
||||||
# expect_final_exc = trio.ClosedResourceError
|
# expect_final_exc = trio.ClosedResourceError
|
||||||
expect_final_exc = tractor.TransportClosed
|
expect_final_exc = TransportClosed
|
||||||
|
|
||||||
mod: ModuleType = import_path(
|
mod: ModuleType = import_path(
|
||||||
examples_dir() / 'advanced_faults'
|
examples_dir() / 'advanced_faults'
|
||||||
|
@ -104,6 +108,8 @@ def test_ipc_channel_break_during_stream(
|
||||||
# period" wherein the user eventually hits ctl-c to kill the
|
# period" wherein the user eventually hits ctl-c to kill the
|
||||||
# root-actor tree.
|
# root-actor tree.
|
||||||
expect_final_exc: BaseException = KeyboardInterrupt
|
expect_final_exc: BaseException = KeyboardInterrupt
|
||||||
|
expect_final_cause: BaseException|None = None
|
||||||
|
|
||||||
if (
|
if (
|
||||||
# only expect EoC if trans is broken on the child side,
|
# only expect EoC if trans is broken on the child side,
|
||||||
ipc_break['break_child_ipc_after'] is not False
|
ipc_break['break_child_ipc_after'] is not False
|
||||||
|
@ -138,6 +144,9 @@ def test_ipc_channel_break_during_stream(
|
||||||
# a user sending ctl-c by raising a KBI.
|
# a user sending ctl-c by raising a KBI.
|
||||||
if pre_aclose_msgstream:
|
if pre_aclose_msgstream:
|
||||||
expect_final_exc = KeyboardInterrupt
|
expect_final_exc = KeyboardInterrupt
|
||||||
|
if tpt_proto == 'uds':
|
||||||
|
expect_final_exc = TransportClosed
|
||||||
|
expect_final_cause = trio.BrokenResourceError
|
||||||
|
|
||||||
# XXX OLD XXX
|
# XXX OLD XXX
|
||||||
# if child calls `MsgStream.aclose()` then expect EoC.
|
# if child calls `MsgStream.aclose()` then expect EoC.
|
||||||
|
@ -157,6 +166,10 @@ def test_ipc_channel_break_during_stream(
|
||||||
if pre_aclose_msgstream:
|
if pre_aclose_msgstream:
|
||||||
expect_final_exc = KeyboardInterrupt
|
expect_final_exc = KeyboardInterrupt
|
||||||
|
|
||||||
|
if tpt_proto == 'uds':
|
||||||
|
expect_final_exc = TransportClosed
|
||||||
|
expect_final_cause = trio.BrokenResourceError
|
||||||
|
|
||||||
# NOTE when the parent IPC side dies (even if the child does as well
|
# NOTE when the parent IPC side dies (even if the child does as well
|
||||||
# but the child fails BEFORE the parent) we always expect the
|
# but the child fails BEFORE the parent) we always expect the
|
||||||
# IPC layer to raise a closed-resource, NEVER do we expect
|
# IPC layer to raise a closed-resource, NEVER do we expect
|
||||||
|
@ -169,8 +182,8 @@ def test_ipc_channel_break_during_stream(
|
||||||
and
|
and
|
||||||
ipc_break['break_child_ipc_after'] is False
|
ipc_break['break_child_ipc_after'] is False
|
||||||
):
|
):
|
||||||
# expect_final_exc = trio.ClosedResourceError
|
|
||||||
expect_final_exc = tractor.TransportClosed
|
expect_final_exc = tractor.TransportClosed
|
||||||
|
expect_final_cause = trio.ClosedResourceError
|
||||||
|
|
||||||
# BOTH but, PARENT breaks FIRST
|
# BOTH but, PARENT breaks FIRST
|
||||||
elif (
|
elif (
|
||||||
|
@ -181,8 +194,8 @@ def test_ipc_channel_break_during_stream(
|
||||||
ipc_break['break_parent_ipc_after']
|
ipc_break['break_parent_ipc_after']
|
||||||
)
|
)
|
||||||
):
|
):
|
||||||
# expect_final_exc = trio.ClosedResourceError
|
|
||||||
expect_final_exc = tractor.TransportClosed
|
expect_final_exc = tractor.TransportClosed
|
||||||
|
expect_final_cause = trio.ClosedResourceError
|
||||||
|
|
||||||
with pytest.raises(
|
with pytest.raises(
|
||||||
expected_exception=(
|
expected_exception=(
|
||||||
|
@ -198,6 +211,7 @@ def test_ipc_channel_break_during_stream(
|
||||||
start_method=spawn_backend,
|
start_method=spawn_backend,
|
||||||
loglevel=loglevel,
|
loglevel=loglevel,
|
||||||
pre_close=pre_aclose_msgstream,
|
pre_close=pre_aclose_msgstream,
|
||||||
|
tpt_proto=tpt_proto,
|
||||||
**ipc_break,
|
**ipc_break,
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
|
@ -220,10 +234,15 @@ def test_ipc_channel_break_during_stream(
|
||||||
)
|
)
|
||||||
cause: Exception = tc.__cause__
|
cause: Exception = tc.__cause__
|
||||||
assert (
|
assert (
|
||||||
type(cause) is trio.ClosedResourceError
|
# type(cause) is trio.ClosedResourceError
|
||||||
and
|
type(cause) is expect_final_cause
|
||||||
cause.args[0] == 'another task closed this fd'
|
|
||||||
|
# TODO, should we expect a certain exc-message (per
|
||||||
|
# tpt) as well??
|
||||||
|
# and
|
||||||
|
# cause.args[0] == 'another task closed this fd'
|
||||||
)
|
)
|
||||||
|
|
||||||
raise
|
raise
|
||||||
|
|
||||||
# get raw instance from pytest wrapper
|
# get raw instance from pytest wrapper
|
||||||
|
|
|
@ -252,7 +252,7 @@ def test_simple_context(
|
||||||
pass
|
pass
|
||||||
except BaseExceptionGroup as beg:
|
except BaseExceptionGroup as beg:
|
||||||
# XXX: on windows it seems we may have to expect the group error
|
# XXX: on windows it seems we may have to expect the group error
|
||||||
from tractor._exceptions import is_multi_cancelled
|
from tractor.trionics import is_multi_cancelled
|
||||||
assert is_multi_cancelled(beg)
|
assert is_multi_cancelled(beg)
|
||||||
else:
|
else:
|
||||||
trio.run(main)
|
trio.run(main)
|
||||||
|
|
|
@ -7,7 +7,9 @@ import platform
|
||||||
from functools import partial
|
from functools import partial
|
||||||
import itertools
|
import itertools
|
||||||
|
|
||||||
|
import psutil
|
||||||
import pytest
|
import pytest
|
||||||
|
import subprocess
|
||||||
import tractor
|
import tractor
|
||||||
from tractor._testing import tractor_test
|
from tractor._testing import tractor_test
|
||||||
import trio
|
import trio
|
||||||
|
@ -152,13 +154,23 @@ async def unpack_reg(actor_or_portal):
|
||||||
async def spawn_and_check_registry(
|
async def spawn_and_check_registry(
|
||||||
reg_addr: tuple,
|
reg_addr: tuple,
|
||||||
use_signal: bool,
|
use_signal: bool,
|
||||||
|
debug_mode: bool = False,
|
||||||
remote_arbiter: bool = False,
|
remote_arbiter: bool = False,
|
||||||
with_streaming: bool = False,
|
with_streaming: bool = False,
|
||||||
|
maybe_daemon: tuple[
|
||||||
|
subprocess.Popen,
|
||||||
|
psutil.Process,
|
||||||
|
]|None = None,
|
||||||
|
|
||||||
) -> None:
|
) -> None:
|
||||||
|
|
||||||
|
if maybe_daemon:
|
||||||
|
popen, proc = maybe_daemon
|
||||||
|
# breakpoint()
|
||||||
|
|
||||||
async with tractor.open_root_actor(
|
async with tractor.open_root_actor(
|
||||||
registry_addrs=[reg_addr],
|
registry_addrs=[reg_addr],
|
||||||
|
debug_mode=debug_mode,
|
||||||
):
|
):
|
||||||
async with tractor.get_registry(reg_addr) as portal:
|
async with tractor.get_registry(reg_addr) as portal:
|
||||||
# runtime needs to be up to call this
|
# runtime needs to be up to call this
|
||||||
|
@ -176,11 +188,11 @@ async def spawn_and_check_registry(
|
||||||
extra = 2 # local root actor + remote arbiter
|
extra = 2 # local root actor + remote arbiter
|
||||||
|
|
||||||
# ensure current actor is registered
|
# ensure current actor is registered
|
||||||
registry = await get_reg()
|
registry: dict = await get_reg()
|
||||||
assert actor.uid in registry
|
assert actor.uid in registry
|
||||||
|
|
||||||
try:
|
try:
|
||||||
async with tractor.open_nursery() as n:
|
async with tractor.open_nursery() as an:
|
||||||
async with trio.open_nursery(
|
async with trio.open_nursery(
|
||||||
strict_exception_groups=False,
|
strict_exception_groups=False,
|
||||||
) as trion:
|
) as trion:
|
||||||
|
@ -189,17 +201,17 @@ async def spawn_and_check_registry(
|
||||||
for i in range(3):
|
for i in range(3):
|
||||||
name = f'a{i}'
|
name = f'a{i}'
|
||||||
if with_streaming:
|
if with_streaming:
|
||||||
portals[name] = await n.start_actor(
|
portals[name] = await an.start_actor(
|
||||||
name=name, enable_modules=[__name__])
|
name=name, enable_modules=[__name__])
|
||||||
|
|
||||||
else: # no streaming
|
else: # no streaming
|
||||||
portals[name] = await n.run_in_actor(
|
portals[name] = await an.run_in_actor(
|
||||||
trio.sleep_forever, name=name)
|
trio.sleep_forever, name=name)
|
||||||
|
|
||||||
# wait on last actor to come up
|
# wait on last actor to come up
|
||||||
async with tractor.wait_for_actor(name):
|
async with tractor.wait_for_actor(name):
|
||||||
registry = await get_reg()
|
registry = await get_reg()
|
||||||
for uid in n._children:
|
for uid in an._children:
|
||||||
assert uid in registry
|
assert uid in registry
|
||||||
|
|
||||||
assert len(portals) + extra == len(registry)
|
assert len(portals) + extra == len(registry)
|
||||||
|
@ -232,6 +244,7 @@ async def spawn_and_check_registry(
|
||||||
@pytest.mark.parametrize('use_signal', [False, True])
|
@pytest.mark.parametrize('use_signal', [False, True])
|
||||||
@pytest.mark.parametrize('with_streaming', [False, True])
|
@pytest.mark.parametrize('with_streaming', [False, True])
|
||||||
def test_subactors_unregister_on_cancel(
|
def test_subactors_unregister_on_cancel(
|
||||||
|
debug_mode: bool,
|
||||||
start_method,
|
start_method,
|
||||||
use_signal,
|
use_signal,
|
||||||
reg_addr,
|
reg_addr,
|
||||||
|
@ -248,6 +261,7 @@ def test_subactors_unregister_on_cancel(
|
||||||
spawn_and_check_registry,
|
spawn_and_check_registry,
|
||||||
reg_addr,
|
reg_addr,
|
||||||
use_signal,
|
use_signal,
|
||||||
|
debug_mode=debug_mode,
|
||||||
remote_arbiter=False,
|
remote_arbiter=False,
|
||||||
with_streaming=with_streaming,
|
with_streaming=with_streaming,
|
||||||
),
|
),
|
||||||
|
@ -257,7 +271,8 @@ def test_subactors_unregister_on_cancel(
|
||||||
@pytest.mark.parametrize('use_signal', [False, True])
|
@pytest.mark.parametrize('use_signal', [False, True])
|
||||||
@pytest.mark.parametrize('with_streaming', [False, True])
|
@pytest.mark.parametrize('with_streaming', [False, True])
|
||||||
def test_subactors_unregister_on_cancel_remote_daemon(
|
def test_subactors_unregister_on_cancel_remote_daemon(
|
||||||
daemon,
|
daemon: subprocess.Popen,
|
||||||
|
debug_mode: bool,
|
||||||
start_method,
|
start_method,
|
||||||
use_signal,
|
use_signal,
|
||||||
reg_addr,
|
reg_addr,
|
||||||
|
@ -273,8 +288,13 @@ def test_subactors_unregister_on_cancel_remote_daemon(
|
||||||
spawn_and_check_registry,
|
spawn_and_check_registry,
|
||||||
reg_addr,
|
reg_addr,
|
||||||
use_signal,
|
use_signal,
|
||||||
|
debug_mode=debug_mode,
|
||||||
remote_arbiter=True,
|
remote_arbiter=True,
|
||||||
with_streaming=with_streaming,
|
with_streaming=with_streaming,
|
||||||
|
maybe_daemon=(
|
||||||
|
daemon,
|
||||||
|
psutil.Process(daemon.pid)
|
||||||
|
),
|
||||||
),
|
),
|
||||||
)
|
)
|
||||||
|
|
||||||
|
@ -373,7 +393,7 @@ def test_close_channel_explicit(
|
||||||
|
|
||||||
@pytest.mark.parametrize('use_signal', [False, True])
|
@pytest.mark.parametrize('use_signal', [False, True])
|
||||||
def test_close_channel_explicit_remote_arbiter(
|
def test_close_channel_explicit_remote_arbiter(
|
||||||
daemon,
|
daemon: subprocess.Popen,
|
||||||
start_method,
|
start_method,
|
||||||
use_signal,
|
use_signal,
|
||||||
reg_addr,
|
reg_addr,
|
||||||
|
|
|
@ -889,7 +889,7 @@ async def manage_file(
|
||||||
|
|
||||||
# NOTE: turns out you don't even need to sched an aio task
|
# NOTE: turns out you don't even need to sched an aio task
|
||||||
# since the original issue, even though seemingly was due to
|
# since the original issue, even though seemingly was due to
|
||||||
# the guest-run being abandoned + a `._debug.pause()` inside
|
# the guest-run being abandoned + a `.debug.pause()` inside
|
||||||
# `._runtime._async_main()` (which was originally trying to
|
# `._runtime._async_main()` (which was originally trying to
|
||||||
# debug the `.lifetime_stack` not closing), IS NOT actually
|
# debug the `.lifetime_stack` not closing), IS NOT actually
|
||||||
# the core issue?
|
# the core issue?
|
||||||
|
@ -1101,7 +1101,7 @@ def test_sigint_closes_lifetime_stack(
|
||||||
# => completed using `.bestow_portal(task)` inside
|
# => completed using `.bestow_portal(task)` inside
|
||||||
# `.to_asyncio._run_asyncio_task()` right?
|
# `.to_asyncio._run_asyncio_task()` right?
|
||||||
# -[ ] translation func to get from `asyncio` task calling to
|
# -[ ] translation func to get from `asyncio` task calling to
|
||||||
# `._debug.wait_for_parent_stdin_hijack()` which does root
|
# `.debug.wait_for_parent_stdin_hijack()` which does root
|
||||||
# call to do TTY locking.
|
# call to do TTY locking.
|
||||||
#
|
#
|
||||||
def test_sync_breakpoint():
|
def test_sync_breakpoint():
|
||||||
|
|
|
@ -410,7 +410,6 @@ def test_peer_canceller(
|
||||||
'''
|
'''
|
||||||
async def main():
|
async def main():
|
||||||
async with tractor.open_nursery(
|
async with tractor.open_nursery(
|
||||||
# NOTE: to halt the peer tasks on ctxc, uncomment this.
|
|
||||||
debug_mode=debug_mode,
|
debug_mode=debug_mode,
|
||||||
) as an:
|
) as an:
|
||||||
canceller: Portal = await an.start_actor(
|
canceller: Portal = await an.start_actor(
|
||||||
|
|
|
@ -0,0 +1,237 @@
|
||||||
|
'''
|
||||||
|
Special case testing for issues not (dis)covered in the primary
|
||||||
|
`Context` related functional/scenario suites.
|
||||||
|
|
||||||
|
**NOTE: this mod is a WIP** space for handling
|
||||||
|
odd/rare/undiscovered/not-yet-revealed faults which either
|
||||||
|
loudly (ideal case) breakl our supervision protocol
|
||||||
|
or (worst case) result in distributed sys hangs.
|
||||||
|
|
||||||
|
Suites here further try to clarify (if [partially] ill-defined) and
|
||||||
|
verify our edge case semantics for inter-actor-relayed-exceptions
|
||||||
|
including,
|
||||||
|
|
||||||
|
- lowlevel: what remote obj-data is interchanged for IPC and what is
|
||||||
|
native-obj form is expected from unpacking in the the new
|
||||||
|
mem-domain.
|
||||||
|
|
||||||
|
- which kinds of `RemoteActorError` (and its derivs) are expected by which
|
||||||
|
(types of) peers (parent, child, sibling, etc) with what
|
||||||
|
particular meta-data set such as,
|
||||||
|
|
||||||
|
- `.src_uid`: the original (maybe) peer who raised.
|
||||||
|
- `.relay_uid`: the next-hop-peer who sent it.
|
||||||
|
- `.relay_path`: the sequence of peer actor hops.
|
||||||
|
- `.is_inception`: a predicate that denotes multi-hop remote errors.
|
||||||
|
|
||||||
|
- when should `ExceptionGroup`s be relayed from a particular
|
||||||
|
remote endpoint, they should never be caused by implicit `._rpc`
|
||||||
|
nursery machinery!
|
||||||
|
|
||||||
|
- various special `trio` edge cases around its cancellation semantics
|
||||||
|
and how we (currently) leverage `trio.Cancelled` as a signal for
|
||||||
|
whether a `Context` task should raise `ContextCancelled` (ctx).
|
||||||
|
|
||||||
|
'''
|
||||||
|
import pytest
|
||||||
|
import trio
|
||||||
|
import tractor
|
||||||
|
from tractor import ( # typing
|
||||||
|
ActorNursery,
|
||||||
|
Portal,
|
||||||
|
Context,
|
||||||
|
ContextCancelled,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@tractor.context
|
||||||
|
async def sleep_n_chkpt_in_finally(
|
||||||
|
ctx: Context,
|
||||||
|
sleep_n_raise: bool,
|
||||||
|
|
||||||
|
chld_raise_delay: float,
|
||||||
|
chld_finally_delay: float,
|
||||||
|
|
||||||
|
rent_cancels: bool,
|
||||||
|
rent_ctxc_delay: float,
|
||||||
|
|
||||||
|
expect_exc: str|None = None,
|
||||||
|
|
||||||
|
) -> None:
|
||||||
|
'''
|
||||||
|
Sync, open a tn, then wait for cancel, run a chkpt inside
|
||||||
|
the user's `finally:` teardown.
|
||||||
|
|
||||||
|
This covers a footgun case that `trio` core doesn't seem to care about
|
||||||
|
wherein an exc can be masked by a `trio.Cancelled` raised inside a tn emedded
|
||||||
|
`finally:`.
|
||||||
|
|
||||||
|
Also see `test_trioisms::test_acm_embedded_nursery_propagates_enter_err`
|
||||||
|
for the down and gritty details.
|
||||||
|
|
||||||
|
Since a `@context` endpoint fn can also contain code like this,
|
||||||
|
**and** bc we currently have no easy way other then
|
||||||
|
`trio.Cancelled` to signal cancellation on each side of an IPC `Context`,
|
||||||
|
the footgun issue can compound itself as demonstrated in this suite..
|
||||||
|
|
||||||
|
Here are some edge cases codified with our WIP "sclang" syntax
|
||||||
|
(note the parent(rent)/child(chld) naming here is just
|
||||||
|
pragmatism, generally these most of these cases can occurr
|
||||||
|
regardless of the distributed-task's supervision hiearchy),
|
||||||
|
|
||||||
|
- rent c)=> chld.raises-then-taskc-in-finally
|
||||||
|
|_ chld's body raises an `exc: BaseException`.
|
||||||
|
_ in its `finally:` block it runs a chkpoint
|
||||||
|
which raises a taskc (`trio.Cancelled`) which
|
||||||
|
masks `exc` instead raising taskc up to the first tn.
|
||||||
|
_ the embedded/chld tn captures the masking taskc and then
|
||||||
|
raises it up to the ._rpc-ep-tn instead of `exc`.
|
||||||
|
_ the rent thinks the child ctxc-ed instead of errored..
|
||||||
|
|
||||||
|
'''
|
||||||
|
await ctx.started()
|
||||||
|
|
||||||
|
if expect_exc:
|
||||||
|
expect_exc: BaseException = tractor._exceptions.get_err_type(
|
||||||
|
type_name=expect_exc,
|
||||||
|
)
|
||||||
|
|
||||||
|
berr: BaseException|None = None
|
||||||
|
try:
|
||||||
|
if not sleep_n_raise:
|
||||||
|
await trio.sleep_forever()
|
||||||
|
elif sleep_n_raise:
|
||||||
|
|
||||||
|
# XXX this sleep is less then the sleep the parent
|
||||||
|
# does before calling `ctx.cancel()`
|
||||||
|
await trio.sleep(chld_raise_delay)
|
||||||
|
|
||||||
|
# XXX this will be masked by a taskc raised in
|
||||||
|
# the `finally:` if this fn doesn't terminate
|
||||||
|
# before any ctxc-req arrives AND a checkpoint is hit
|
||||||
|
# in that `finally:`.
|
||||||
|
raise RuntimeError('my app krurshed..')
|
||||||
|
|
||||||
|
except BaseException as _berr:
|
||||||
|
berr = _berr
|
||||||
|
|
||||||
|
# TODO: it'd sure be nice to be able to inject our own
|
||||||
|
# `ContextCancelled` here instead of of `trio.Cancelled`
|
||||||
|
# so that our runtime can expect it and this "user code"
|
||||||
|
# would be able to tell the diff between a generic trio
|
||||||
|
# cancel and a tractor runtime-IPC cancel.
|
||||||
|
if expect_exc:
|
||||||
|
if not isinstance(
|
||||||
|
berr,
|
||||||
|
expect_exc,
|
||||||
|
):
|
||||||
|
raise ValueError(
|
||||||
|
f'Unexpected exc type ??\n'
|
||||||
|
f'{berr!r}\n'
|
||||||
|
f'\n'
|
||||||
|
f'Expected a {expect_exc!r}\n'
|
||||||
|
)
|
||||||
|
|
||||||
|
raise berr
|
||||||
|
|
||||||
|
# simulate what user code might try even though
|
||||||
|
# it's a known boo-boo..
|
||||||
|
finally:
|
||||||
|
# maybe wait for rent ctxc to arrive
|
||||||
|
with trio.CancelScope(shield=True):
|
||||||
|
await trio.sleep(chld_finally_delay)
|
||||||
|
|
||||||
|
# !!XXX this will raise `trio.Cancelled` which
|
||||||
|
# will mask the RTE from above!!!
|
||||||
|
#
|
||||||
|
# YES, it's the same case as our extant
|
||||||
|
# `test_trioisms::test_acm_embedded_nursery_propagates_enter_err`
|
||||||
|
try:
|
||||||
|
await trio.lowlevel.checkpoint()
|
||||||
|
except trio.Cancelled as taskc:
|
||||||
|
if (scope_err := taskc.__context__):
|
||||||
|
print(
|
||||||
|
f'XXX MASKED REMOTE ERROR XXX\n'
|
||||||
|
f'ENDPOINT exception -> {scope_err!r}\n'
|
||||||
|
f'will be masked by -> {taskc!r}\n'
|
||||||
|
)
|
||||||
|
# await tractor.pause(shield=True)
|
||||||
|
|
||||||
|
raise taskc
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize(
|
||||||
|
'chld_callspec',
|
||||||
|
[
|
||||||
|
dict(
|
||||||
|
sleep_n_raise=None,
|
||||||
|
chld_raise_delay=0.1,
|
||||||
|
chld_finally_delay=0.1,
|
||||||
|
expect_exc='Cancelled',
|
||||||
|
rent_cancels=True,
|
||||||
|
rent_ctxc_delay=0.1,
|
||||||
|
),
|
||||||
|
dict(
|
||||||
|
sleep_n_raise='RuntimeError',
|
||||||
|
chld_raise_delay=0.1,
|
||||||
|
chld_finally_delay=1,
|
||||||
|
expect_exc='RuntimeError',
|
||||||
|
rent_cancels=False,
|
||||||
|
rent_ctxc_delay=0.1,
|
||||||
|
),
|
||||||
|
],
|
||||||
|
ids=lambda item: f'chld_callspec={item!r}'
|
||||||
|
)
|
||||||
|
def test_unmasked_remote_exc(
|
||||||
|
debug_mode: bool,
|
||||||
|
chld_callspec: dict,
|
||||||
|
tpt_proto: str,
|
||||||
|
):
|
||||||
|
expect_exc_str: str|None = chld_callspec['sleep_n_raise']
|
||||||
|
rent_ctxc_delay: float|None = chld_callspec['rent_ctxc_delay']
|
||||||
|
async def main():
|
||||||
|
an: ActorNursery
|
||||||
|
async with tractor.open_nursery(
|
||||||
|
debug_mode=debug_mode,
|
||||||
|
enable_transports=[tpt_proto],
|
||||||
|
) as an:
|
||||||
|
ptl: Portal = await an.start_actor(
|
||||||
|
'cancellee',
|
||||||
|
enable_modules=[__name__],
|
||||||
|
)
|
||||||
|
ctx: Context
|
||||||
|
async with (
|
||||||
|
ptl.open_context(
|
||||||
|
sleep_n_chkpt_in_finally,
|
||||||
|
**chld_callspec,
|
||||||
|
) as (ctx, sent),
|
||||||
|
):
|
||||||
|
assert not sent
|
||||||
|
await trio.sleep(rent_ctxc_delay)
|
||||||
|
await ctx.cancel()
|
||||||
|
|
||||||
|
# recv error or result from chld
|
||||||
|
ctxc: ContextCancelled = await ctx.wait_for_result()
|
||||||
|
assert (
|
||||||
|
ctxc is ctx.outcome
|
||||||
|
and
|
||||||
|
isinstance(ctxc, ContextCancelled)
|
||||||
|
)
|
||||||
|
|
||||||
|
# always graceful terminate the sub in non-error cases
|
||||||
|
await an.cancel()
|
||||||
|
|
||||||
|
if expect_exc_str:
|
||||||
|
expect_exc: BaseException = tractor._exceptions.get_err_type(
|
||||||
|
type_name=expect_exc_str,
|
||||||
|
)
|
||||||
|
with pytest.raises(
|
||||||
|
expected_exception=tractor.RemoteActorError,
|
||||||
|
) as excinfo:
|
||||||
|
trio.run(main)
|
||||||
|
|
||||||
|
rae = excinfo.value
|
||||||
|
assert expect_exc == rae.boxed_type
|
||||||
|
|
||||||
|
else:
|
||||||
|
trio.run(main)
|
|
@ -100,16 +100,29 @@ async def streamer(
|
||||||
@acm
|
@acm
|
||||||
async def open_stream() -> Awaitable[tractor.MsgStream]:
|
async def open_stream() -> Awaitable[tractor.MsgStream]:
|
||||||
|
|
||||||
async with tractor.open_nursery() as tn:
|
try:
|
||||||
portal = await tn.start_actor('streamer', enable_modules=[__name__])
|
async with tractor.open_nursery() as an:
|
||||||
async with (
|
portal = await an.start_actor(
|
||||||
portal.open_context(streamer) as (ctx, first),
|
'streamer',
|
||||||
ctx.open_stream() as stream,
|
enable_modules=[__name__],
|
||||||
):
|
)
|
||||||
yield stream
|
async with (
|
||||||
|
portal.open_context(streamer) as (ctx, first),
|
||||||
|
ctx.open_stream() as stream,
|
||||||
|
):
|
||||||
|
yield stream
|
||||||
|
|
||||||
await portal.cancel_actor()
|
print('Cancelling streamer')
|
||||||
print('CANCELLED STREAMER')
|
await portal.cancel_actor()
|
||||||
|
print('Cancelled streamer')
|
||||||
|
|
||||||
|
except Exception as err:
|
||||||
|
print(
|
||||||
|
f'`open_stream()` errored?\n'
|
||||||
|
f'{err!r}\n'
|
||||||
|
)
|
||||||
|
await tractor.pause(shield=True)
|
||||||
|
raise err
|
||||||
|
|
||||||
|
|
||||||
@acm
|
@acm
|
||||||
|
@ -132,19 +145,28 @@ async def maybe_open_stream(taskname: str):
|
||||||
yield stream
|
yield stream
|
||||||
|
|
||||||
|
|
||||||
def test_open_local_sub_to_stream():
|
def test_open_local_sub_to_stream(
|
||||||
|
debug_mode: bool,
|
||||||
|
):
|
||||||
'''
|
'''
|
||||||
Verify a single inter-actor stream can can be fanned-out shared to
|
Verify a single inter-actor stream can can be fanned-out shared to
|
||||||
N local tasks using ``trionics.maybe_open_context():``.
|
N local tasks using `trionics.maybe_open_context()`.
|
||||||
|
|
||||||
'''
|
'''
|
||||||
timeout: float = 3.6 if platform.system() != "Windows" else 10
|
timeout: float = 3.6
|
||||||
|
if platform.system() == "Windows":
|
||||||
|
timeout: float = 10
|
||||||
|
|
||||||
|
if debug_mode:
|
||||||
|
timeout = 999
|
||||||
|
|
||||||
async def main():
|
async def main():
|
||||||
|
|
||||||
full = list(range(1000))
|
full = list(range(1000))
|
||||||
|
|
||||||
async def get_sub_and_pull(taskname: str):
|
async def get_sub_and_pull(taskname: str):
|
||||||
|
|
||||||
|
stream: tractor.MsgStream
|
||||||
async with (
|
async with (
|
||||||
maybe_open_stream(taskname) as stream,
|
maybe_open_stream(taskname) as stream,
|
||||||
):
|
):
|
||||||
|
@ -165,17 +187,27 @@ def test_open_local_sub_to_stream():
|
||||||
assert set(seq).issubset(set(full))
|
assert set(seq).issubset(set(full))
|
||||||
print(f'{taskname} finished')
|
print(f'{taskname} finished')
|
||||||
|
|
||||||
with trio.fail_after(timeout):
|
with trio.fail_after(timeout) as cs:
|
||||||
# TODO: turns out this isn't multi-task entrant XD
|
# TODO: turns out this isn't multi-task entrant XD
|
||||||
# We probably need an indepotent entry semantic?
|
# We probably need an indepotent entry semantic?
|
||||||
async with tractor.open_root_actor():
|
async with tractor.open_root_actor(
|
||||||
|
debug_mode=debug_mode,
|
||||||
|
):
|
||||||
async with (
|
async with (
|
||||||
trio.open_nursery() as nurse,
|
trio.open_nursery() as tn,
|
||||||
):
|
):
|
||||||
for i in range(10):
|
for i in range(10):
|
||||||
nurse.start_soon(get_sub_and_pull, f'task_{i}')
|
tn.start_soon(
|
||||||
|
get_sub_and_pull,
|
||||||
|
f'task_{i}',
|
||||||
|
)
|
||||||
await trio.sleep(0.001)
|
await trio.sleep(0.001)
|
||||||
|
|
||||||
print('all consumer tasks finished')
|
print('all consumer tasks finished')
|
||||||
|
|
||||||
|
if cs.cancelled_caught:
|
||||||
|
pytest.fail(
|
||||||
|
'Should NOT time out in `open_root_actor()` ?'
|
||||||
|
)
|
||||||
|
|
||||||
trio.run(main)
|
trio.run(main)
|
||||||
|
|
|
@ -83,3 +83,26 @@ def test_implicit_root_via_first_nursery(
|
||||||
assert tractor.current_actor().aid.name == 'root'
|
assert tractor.current_actor().aid.name == 'root'
|
||||||
|
|
||||||
trio.run(main)
|
trio.run(main)
|
||||||
|
|
||||||
|
|
||||||
|
def test_runtime_vars_unset(
|
||||||
|
reg_addr: tuple,
|
||||||
|
debug_mode: bool
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Ensure any `._state._runtime_vars` are restored to default values
|
||||||
|
after the root actor-runtime exits!
|
||||||
|
|
||||||
|
'''
|
||||||
|
assert not tractor._state._runtime_vars['_debug_mode']
|
||||||
|
async def main():
|
||||||
|
assert not tractor._state._runtime_vars['_debug_mode']
|
||||||
|
async with tractor.open_nursery(
|
||||||
|
debug_mode=True,
|
||||||
|
):
|
||||||
|
assert tractor._state._runtime_vars['_debug_mode']
|
||||||
|
|
||||||
|
# after runtime closure, should be reverted!
|
||||||
|
assert not tractor._state._runtime_vars['_debug_mode']
|
||||||
|
|
||||||
|
trio.run(main)
|
||||||
|
|
|
@ -112,55 +112,11 @@ def test_acm_embedded_nursery_propagates_enter_err(
|
||||||
'''
|
'''
|
||||||
import tractor
|
import tractor
|
||||||
|
|
||||||
@acm
|
|
||||||
async def maybe_raise_from_masking_exc(
|
|
||||||
tn: trio.Nursery,
|
|
||||||
unmask_from: BaseException|None = trio.Cancelled
|
|
||||||
|
|
||||||
# TODO, maybe offer a collection?
|
|
||||||
# unmask_from: set[BaseException] = {
|
|
||||||
# trio.Cancelled,
|
|
||||||
# },
|
|
||||||
):
|
|
||||||
if not unmask_from:
|
|
||||||
yield
|
|
||||||
return
|
|
||||||
|
|
||||||
try:
|
|
||||||
yield
|
|
||||||
except* unmask_from as be_eg:
|
|
||||||
|
|
||||||
# TODO, if we offer `unmask_from: set`
|
|
||||||
# for masker_exc_type in unmask_from:
|
|
||||||
|
|
||||||
matches, rest = be_eg.split(unmask_from)
|
|
||||||
if not matches:
|
|
||||||
raise
|
|
||||||
|
|
||||||
for exc_match in be_eg.exceptions:
|
|
||||||
if (
|
|
||||||
(exc_ctx := exc_match.__context__)
|
|
||||||
and
|
|
||||||
type(exc_ctx) not in {
|
|
||||||
# trio.Cancelled, # always by default?
|
|
||||||
unmask_from,
|
|
||||||
}
|
|
||||||
):
|
|
||||||
exc_ctx.add_note(
|
|
||||||
f'\n'
|
|
||||||
f'WARNING: the above error was masked by a {unmask_from!r} !?!\n'
|
|
||||||
f'Are you always cancelling? Say from a `finally:` ?\n\n'
|
|
||||||
|
|
||||||
f'{tn!r}'
|
|
||||||
)
|
|
||||||
raise exc_ctx from exc_match
|
|
||||||
|
|
||||||
|
|
||||||
@acm
|
@acm
|
||||||
async def wraps_tn_that_always_cancels():
|
async def wraps_tn_that_always_cancels():
|
||||||
async with (
|
async with (
|
||||||
trio.open_nursery() as tn,
|
trio.open_nursery() as tn,
|
||||||
maybe_raise_from_masking_exc(
|
tractor.trionics.maybe_raise_from_masking_exc(
|
||||||
tn=tn,
|
tn=tn,
|
||||||
unmask_from=(
|
unmask_from=(
|
||||||
trio.Cancelled
|
trio.Cancelled
|
||||||
|
@ -180,7 +136,8 @@ def test_acm_embedded_nursery_propagates_enter_err(
|
||||||
with tractor.devx.maybe_open_crash_handler(
|
with tractor.devx.maybe_open_crash_handler(
|
||||||
pdb=debug_mode,
|
pdb=debug_mode,
|
||||||
) as bxerr:
|
) as bxerr:
|
||||||
assert not bxerr.value
|
if bxerr:
|
||||||
|
assert not bxerr.value
|
||||||
|
|
||||||
async with (
|
async with (
|
||||||
wraps_tn_that_always_cancels() as tn,
|
wraps_tn_that_always_cancels() as tn,
|
||||||
|
@ -201,3 +158,60 @@ def test_acm_embedded_nursery_propagates_enter_err(
|
||||||
assert_eg, rest_eg = eg.split(AssertionError)
|
assert_eg, rest_eg = eg.split(AssertionError)
|
||||||
|
|
||||||
assert len(assert_eg.exceptions) == 1
|
assert len(assert_eg.exceptions) == 1
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
def test_gatherctxs_with_memchan_breaks_multicancelled(
|
||||||
|
debug_mode: bool,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Demo how a using an `async with sndchan` inside a `.trionics.gather_contexts()` task
|
||||||
|
will break a strict-eg-tn's multi-cancelled absorption..
|
||||||
|
|
||||||
|
'''
|
||||||
|
from tractor import (
|
||||||
|
trionics,
|
||||||
|
)
|
||||||
|
|
||||||
|
@acm
|
||||||
|
async def open_memchan() -> trio.abc.ReceiveChannel:
|
||||||
|
|
||||||
|
task: trio.Task = trio.lowlevel.current_task()
|
||||||
|
print(
|
||||||
|
f'Opening {task!r}\n'
|
||||||
|
)
|
||||||
|
|
||||||
|
# 1 to force eager sending
|
||||||
|
send, recv = trio.open_memory_channel(16)
|
||||||
|
|
||||||
|
try:
|
||||||
|
async with send:
|
||||||
|
yield recv
|
||||||
|
finally:
|
||||||
|
print(
|
||||||
|
f'Closed {task!r}\n'
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
async def main():
|
||||||
|
async with (
|
||||||
|
# XXX should ensure ONLY the KBI
|
||||||
|
# is relayed upward
|
||||||
|
trionics.collapse_eg(),
|
||||||
|
trio.open_nursery(
|
||||||
|
# strict_exception_groups=False,
|
||||||
|
), # as tn,
|
||||||
|
|
||||||
|
trionics.gather_contexts([
|
||||||
|
open_memchan(),
|
||||||
|
open_memchan(),
|
||||||
|
]) as recv_chans,
|
||||||
|
):
|
||||||
|
assert len(recv_chans) == 2
|
||||||
|
|
||||||
|
await trio.sleep(1)
|
||||||
|
raise KeyboardInterrupt
|
||||||
|
# tn.cancel_scope.cancel()
|
||||||
|
|
||||||
|
with pytest.raises(KeyboardInterrupt):
|
||||||
|
trio.run(main)
|
||||||
|
|
|
@ -101,6 +101,9 @@ from ._state import (
|
||||||
debug_mode,
|
debug_mode,
|
||||||
_ctxvar_Context,
|
_ctxvar_Context,
|
||||||
)
|
)
|
||||||
|
from .trionics import (
|
||||||
|
collapse_eg,
|
||||||
|
)
|
||||||
# ------ - ------
|
# ------ - ------
|
||||||
if TYPE_CHECKING:
|
if TYPE_CHECKING:
|
||||||
from ._portal import Portal
|
from ._portal import Portal
|
||||||
|
@ -292,7 +295,7 @@ class Context:
|
||||||
# - `._runtime._invoke()` will check this flag before engaging
|
# - `._runtime._invoke()` will check this flag before engaging
|
||||||
# the crash handler REPL in such cases where the "callee"
|
# the crash handler REPL in such cases where the "callee"
|
||||||
# raises the cancellation,
|
# raises the cancellation,
|
||||||
# - `.devx._debug.lock_stdio_for_peer()` will set it to `False` if
|
# - `.devx.debug.lock_stdio_for_peer()` will set it to `False` if
|
||||||
# the global tty-lock has been configured to filter out some
|
# the global tty-lock has been configured to filter out some
|
||||||
# actors from being able to acquire the debugger lock.
|
# actors from being able to acquire the debugger lock.
|
||||||
_enter_debugger_on_cancel: bool = True
|
_enter_debugger_on_cancel: bool = True
|
||||||
|
@ -740,6 +743,8 @@ class Context:
|
||||||
# cancelled, NOT their reported canceller. IOW in the
|
# cancelled, NOT their reported canceller. IOW in the
|
||||||
# latter case we're cancelled by someone else getting
|
# latter case we're cancelled by someone else getting
|
||||||
# cancelled.
|
# cancelled.
|
||||||
|
#
|
||||||
|
# !TODO, switching to `Actor.aid` here!
|
||||||
if (canc := error.canceller) == self._actor.uid:
|
if (canc := error.canceller) == self._actor.uid:
|
||||||
whom: str = 'us'
|
whom: str = 'us'
|
||||||
self._canceller = canc
|
self._canceller = canc
|
||||||
|
@ -940,7 +945,7 @@ class Context:
|
||||||
self.cancel_called = True
|
self.cancel_called = True
|
||||||
|
|
||||||
header: str = (
|
header: str = (
|
||||||
f'Cancelling ctx from {side.upper()}-side\n'
|
f'Cancelling ctx from {side!r}-side\n'
|
||||||
)
|
)
|
||||||
reminfo: str = (
|
reminfo: str = (
|
||||||
# ' =>\n'
|
# ' =>\n'
|
||||||
|
@ -948,7 +953,7 @@ class Context:
|
||||||
f'\n'
|
f'\n'
|
||||||
f'c)=> {self.chan.uid}\n'
|
f'c)=> {self.chan.uid}\n'
|
||||||
f' |_[{self.dst_maddr}\n'
|
f' |_[{self.dst_maddr}\n'
|
||||||
f' >>{self.repr_rpc}\n'
|
f' >> {self.repr_rpc}\n'
|
||||||
# f' >> {self._nsf}() -> {codec}[dict]:\n\n'
|
# f' >> {self._nsf}() -> {codec}[dict]:\n\n'
|
||||||
# TODO: pull msg-type from spec re #320
|
# TODO: pull msg-type from spec re #320
|
||||||
)
|
)
|
||||||
|
@ -1251,8 +1256,8 @@ class Context:
|
||||||
|
|
||||||
# ?XXX, should already be set in `._deliver_msg()` right?
|
# ?XXX, should already be set in `._deliver_msg()` right?
|
||||||
if self._outcome_msg is not Unresolved:
|
if self._outcome_msg is not Unresolved:
|
||||||
# from .devx import _debug
|
# from .devx import debug
|
||||||
# await _debug.pause()
|
# await debug.pause()
|
||||||
assert self._outcome_msg is outcome_msg
|
assert self._outcome_msg is outcome_msg
|
||||||
else:
|
else:
|
||||||
self._outcome_msg = outcome_msg
|
self._outcome_msg = outcome_msg
|
||||||
|
@ -2023,10 +2028,8 @@ async def open_context_from_portal(
|
||||||
ctxc_from_callee: ContextCancelled|None = None
|
ctxc_from_callee: ContextCancelled|None = None
|
||||||
try:
|
try:
|
||||||
async with (
|
async with (
|
||||||
trio.open_nursery(
|
collapse_eg(),
|
||||||
strict_exception_groups=False,
|
trio.open_nursery() as tn,
|
||||||
) as tn,
|
|
||||||
|
|
||||||
msgops.maybe_limit_plds(
|
msgops.maybe_limit_plds(
|
||||||
ctx=ctx,
|
ctx=ctx,
|
||||||
spec=ctx_meta.get('pld_spec'),
|
spec=ctx_meta.get('pld_spec'),
|
||||||
|
@ -2187,7 +2190,7 @@ async def open_context_from_portal(
|
||||||
# debugging the tractor-runtime itself using it's
|
# debugging the tractor-runtime itself using it's
|
||||||
# own `.devx.` tooling!
|
# own `.devx.` tooling!
|
||||||
#
|
#
|
||||||
# await _debug.pause()
|
# await debug.pause()
|
||||||
|
|
||||||
# CASE 2: context was cancelled by local task calling
|
# CASE 2: context was cancelled by local task calling
|
||||||
# `.cancel()`, we don't raise and the exit block should
|
# `.cancel()`, we don't raise and the exit block should
|
||||||
|
@ -2254,7 +2257,7 @@ async def open_context_from_portal(
|
||||||
# NOTE: `Context.cancel()` is conversely NEVER CALLED in
|
# NOTE: `Context.cancel()` is conversely NEVER CALLED in
|
||||||
# the `ContextCancelled` "self cancellation absorbed" case
|
# the `ContextCancelled` "self cancellation absorbed" case
|
||||||
# handled in the block above ^^^ !!
|
# handled in the block above ^^^ !!
|
||||||
# await _debug.pause()
|
# await debug.pause()
|
||||||
# log.cancel(
|
# log.cancel(
|
||||||
match scope_err:
|
match scope_err:
|
||||||
case trio.Cancelled:
|
case trio.Cancelled:
|
||||||
|
@ -2269,11 +2272,11 @@ async def open_context_from_portal(
|
||||||
)
|
)
|
||||||
|
|
||||||
if debug_mode():
|
if debug_mode():
|
||||||
# async with _debug.acquire_debug_lock(portal.actor.uid):
|
# async with debug.acquire_debug_lock(portal.actor.uid):
|
||||||
# pass
|
# pass
|
||||||
# TODO: factor ^ into below for non-root cases?
|
# TODO: factor ^ into below for non-root cases?
|
||||||
#
|
#
|
||||||
from .devx._debug import maybe_wait_for_debugger
|
from .devx.debug import maybe_wait_for_debugger
|
||||||
was_acquired: bool = await maybe_wait_for_debugger(
|
was_acquired: bool = await maybe_wait_for_debugger(
|
||||||
# header_msg=(
|
# header_msg=(
|
||||||
# 'Delaying `ctx.cancel()` until debug lock '
|
# 'Delaying `ctx.cancel()` until debug lock '
|
||||||
|
@ -2336,8 +2339,8 @@ async def open_context_from_portal(
|
||||||
raise
|
raise
|
||||||
|
|
||||||
# yes this worx!
|
# yes this worx!
|
||||||
# from .devx import _debug
|
# from .devx import debug
|
||||||
# await _debug.pause()
|
# await debug.pause()
|
||||||
|
|
||||||
# an exception type boxed in a `RemoteActorError`
|
# an exception type boxed in a `RemoteActorError`
|
||||||
# is returned (meaning it was obvi not raised)
|
# is returned (meaning it was obvi not raised)
|
||||||
|
@ -2372,7 +2375,7 @@ async def open_context_from_portal(
|
||||||
# where the root is waiting on the lock to clear but the
|
# where the root is waiting on the lock to clear but the
|
||||||
# child has already cleared it and clobbered IPC.
|
# child has already cleared it and clobbered IPC.
|
||||||
if debug_mode():
|
if debug_mode():
|
||||||
from .devx._debug import maybe_wait_for_debugger
|
from .devx.debug import maybe_wait_for_debugger
|
||||||
await maybe_wait_for_debugger()
|
await maybe_wait_for_debugger()
|
||||||
|
|
||||||
# though it should be impossible for any tasks
|
# though it should be impossible for any tasks
|
||||||
|
|
|
@ -28,7 +28,10 @@ from typing import (
|
||||||
from contextlib import asynccontextmanager as acm
|
from contextlib import asynccontextmanager as acm
|
||||||
|
|
||||||
from tractor.log import get_logger
|
from tractor.log import get_logger
|
||||||
from .trionics import gather_contexts
|
from .trionics import (
|
||||||
|
gather_contexts,
|
||||||
|
collapse_eg,
|
||||||
|
)
|
||||||
from .ipc import _connect_chan, Channel
|
from .ipc import _connect_chan, Channel
|
||||||
from ._addr import (
|
from ._addr import (
|
||||||
UnwrappedAddress,
|
UnwrappedAddress,
|
||||||
|
@ -48,6 +51,7 @@ from ._state import (
|
||||||
|
|
||||||
if TYPE_CHECKING:
|
if TYPE_CHECKING:
|
||||||
from ._runtime import Actor
|
from ._runtime import Actor
|
||||||
|
from .ipc._server import IPCServer
|
||||||
|
|
||||||
|
|
||||||
log = get_logger(__name__)
|
log = get_logger(__name__)
|
||||||
|
@ -79,7 +83,7 @@ async def get_registry(
|
||||||
)
|
)
|
||||||
else:
|
else:
|
||||||
# TODO: try to look pre-existing connection from
|
# TODO: try to look pre-existing connection from
|
||||||
# `Server._peers` and use it instead?
|
# `IPCServer._peers` and use it instead?
|
||||||
async with (
|
async with (
|
||||||
_connect_chan(addr) as chan,
|
_connect_chan(addr) as chan,
|
||||||
open_portal(chan) as regstr_ptl,
|
open_portal(chan) as regstr_ptl,
|
||||||
|
@ -87,7 +91,6 @@ async def get_registry(
|
||||||
yield regstr_ptl
|
yield regstr_ptl
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@acm
|
@acm
|
||||||
async def get_root(
|
async def get_root(
|
||||||
**kwargs,
|
**kwargs,
|
||||||
|
@ -111,23 +114,18 @@ def get_peer_by_name(
|
||||||
) -> list[Channel]|None: # at least 1
|
) -> list[Channel]|None: # at least 1
|
||||||
'''
|
'''
|
||||||
Scan for an existing connection (set) to a named actor
|
Scan for an existing connection (set) to a named actor
|
||||||
and return any channels from `Server._peers: dict`.
|
and return any channels from `IPCServer._peers: dict`.
|
||||||
|
|
||||||
This is an optimization method over querying the registrar for
|
This is an optimization method over querying the registrar for
|
||||||
the same info.
|
the same info.
|
||||||
|
|
||||||
'''
|
'''
|
||||||
actor: Actor = current_actor()
|
actor: Actor = current_actor()
|
||||||
to_scan: dict[tuple, list[Channel]] = actor.ipc_server._peers.copy()
|
server: IPCServer = actor.ipc_server
|
||||||
|
to_scan: dict[tuple, list[Channel]] = server._peers.copy()
|
||||||
# TODO: is this ever needed? creates a duplicate channel on actor._peers
|
pchan: Channel|None = actor._parent_chan
|
||||||
# when multiple find_actor calls are made to same actor from a single ctx
|
if pchan:
|
||||||
# which causes actor exit to hang waiting forever on
|
to_scan[pchan.uid].append(pchan)
|
||||||
# `actor._no_more_peers.wait()` in `_runtime.async_main`
|
|
||||||
|
|
||||||
# pchan: Channel|None = actor._parent_chan
|
|
||||||
# if pchan and pchan.uid not in to_scan:
|
|
||||||
# to_scan[pchan.uid].append(pchan)
|
|
||||||
|
|
||||||
for aid, chans in to_scan.items():
|
for aid, chans in to_scan.items():
|
||||||
_, peer_name = aid
|
_, peer_name = aid
|
||||||
|
@ -253,9 +251,12 @@ async def find_actor(
|
||||||
for addr in registry_addrs
|
for addr in registry_addrs
|
||||||
)
|
)
|
||||||
portals: list[Portal]
|
portals: list[Portal]
|
||||||
async with gather_contexts(
|
async with (
|
||||||
mngrs=maybe_portals,
|
collapse_eg(),
|
||||||
) as portals:
|
gather_contexts(
|
||||||
|
mngrs=maybe_portals,
|
||||||
|
) as portals,
|
||||||
|
):
|
||||||
# log.runtime(
|
# log.runtime(
|
||||||
# 'Gathered portals:\n'
|
# 'Gathered portals:\n'
|
||||||
# f'{portals}'
|
# f'{portals}'
|
||||||
|
|
|
@ -21,8 +21,7 @@ Sub-process entry points.
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
from functools import partial
|
from functools import partial
|
||||||
import multiprocessing as mp
|
import multiprocessing as mp
|
||||||
import os
|
# import os
|
||||||
import textwrap
|
|
||||||
from typing import (
|
from typing import (
|
||||||
Any,
|
Any,
|
||||||
TYPE_CHECKING,
|
TYPE_CHECKING,
|
||||||
|
@ -35,7 +34,11 @@ from .log import (
|
||||||
get_logger,
|
get_logger,
|
||||||
)
|
)
|
||||||
from . import _state
|
from . import _state
|
||||||
from .devx import _debug
|
from .devx import (
|
||||||
|
_frame_stack,
|
||||||
|
pformat,
|
||||||
|
)
|
||||||
|
# from .msg import pretty_struct
|
||||||
from .to_asyncio import run_as_asyncio_guest
|
from .to_asyncio import run_as_asyncio_guest
|
||||||
from ._addr import UnwrappedAddress
|
from ._addr import UnwrappedAddress
|
||||||
from ._runtime import (
|
from ._runtime import (
|
||||||
|
@ -103,107 +106,6 @@ def _mp_main(
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
# TODO: move this func to some kinda `.devx._conc_lang.py` eventually
|
|
||||||
# as we work out our multi-domain state-flow-syntax!
|
|
||||||
def nest_from_op(
|
|
||||||
input_op: str,
|
|
||||||
#
|
|
||||||
# ?TODO? an idea for a syntax to the state of concurrent systems
|
|
||||||
# as a "3-domain" (execution, scope, storage) model and using
|
|
||||||
# a minimal ascii/utf-8 operator-set.
|
|
||||||
#
|
|
||||||
# try not to take any of this seriously yet XD
|
|
||||||
#
|
|
||||||
# > is a "play operator" indicating (CPU bound)
|
|
||||||
# exec/work/ops required at the "lowest level computing"
|
|
||||||
#
|
|
||||||
# execution primititves (tasks, threads, actors..) denote their
|
|
||||||
# lifetime with '(' and ')' since parentheses normally are used
|
|
||||||
# in many langs to denote function calls.
|
|
||||||
#
|
|
||||||
# starting = (
|
|
||||||
# >( opening/starting; beginning of the thread-of-exec (toe?)
|
|
||||||
# (> opened/started, (finished spawning toe)
|
|
||||||
# |_<Task: blah blah..> repr of toe, in py these look like <objs>
|
|
||||||
#
|
|
||||||
# >) closing/exiting/stopping,
|
|
||||||
# )> closed/exited/stopped,
|
|
||||||
# |_<Task: blah blah..>
|
|
||||||
# [OR <), )< ?? ]
|
|
||||||
#
|
|
||||||
# ending = )
|
|
||||||
# >c) cancelling to close/exit
|
|
||||||
# c)> cancelled (caused close), OR?
|
|
||||||
# |_<Actor: ..>
|
|
||||||
# OR maybe "<c)" which better indicates the cancel being
|
|
||||||
# "delivered/returned" / returned" to LHS?
|
|
||||||
#
|
|
||||||
# >x) erroring to eventuall exit
|
|
||||||
# x)> errored and terminated
|
|
||||||
# |_<Actor: ...>
|
|
||||||
#
|
|
||||||
# scopes: supers/nurseries, IPC-ctxs, sessions, perms, etc.
|
|
||||||
# >{ opening
|
|
||||||
# {> opened
|
|
||||||
# }> closed
|
|
||||||
# >} closing
|
|
||||||
#
|
|
||||||
# storage: like queues, shm-buffers, files, etc..
|
|
||||||
# >[ opening
|
|
||||||
# [> opened
|
|
||||||
# |_<FileObj: ..>
|
|
||||||
#
|
|
||||||
# >] closing
|
|
||||||
# ]> closed
|
|
||||||
|
|
||||||
# IPC ops: channels, transports, msging
|
|
||||||
# => req msg
|
|
||||||
# <= resp msg
|
|
||||||
# <=> 2-way streaming (of msgs)
|
|
||||||
# <- recv 1 msg
|
|
||||||
# -> send 1 msg
|
|
||||||
#
|
|
||||||
# TODO: still not sure on R/L-HS approach..?
|
|
||||||
# =>( send-req to exec start (task, actor, thread..)
|
|
||||||
# (<= recv-req to ^
|
|
||||||
#
|
|
||||||
# (<= recv-req ^
|
|
||||||
# <=( recv-resp opened remote exec primitive
|
|
||||||
# <=) recv-resp closed
|
|
||||||
#
|
|
||||||
# )<=c req to stop due to cancel
|
|
||||||
# c=>) req to stop due to cancel
|
|
||||||
#
|
|
||||||
# =>{ recv-req to open
|
|
||||||
# <={ send-status that it closed
|
|
||||||
|
|
||||||
tree_str: str,
|
|
||||||
|
|
||||||
# NOTE: so move back-from-the-left of the `input_op` by
|
|
||||||
# this amount.
|
|
||||||
back_from_op: int = 0,
|
|
||||||
) -> str:
|
|
||||||
'''
|
|
||||||
Depth-increment the input (presumably hierarchy/supervision)
|
|
||||||
input "tree string" below the provided `input_op` execution
|
|
||||||
operator, so injecting a `"\n|_{input_op}\n"`and indenting the
|
|
||||||
`tree_str` to nest content aligned with the ops last char.
|
|
||||||
|
|
||||||
'''
|
|
||||||
return (
|
|
||||||
f'{input_op}\n'
|
|
||||||
+
|
|
||||||
textwrap.indent(
|
|
||||||
tree_str,
|
|
||||||
prefix=(
|
|
||||||
len(input_op)
|
|
||||||
-
|
|
||||||
(back_from_op + 1)
|
|
||||||
) * ' ',
|
|
||||||
)
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def _trio_main(
|
def _trio_main(
|
||||||
actor: Actor,
|
actor: Actor,
|
||||||
*,
|
*,
|
||||||
|
@ -215,7 +117,7 @@ def _trio_main(
|
||||||
Entry point for a `trio_run_in_process` subactor.
|
Entry point for a `trio_run_in_process` subactor.
|
||||||
|
|
||||||
'''
|
'''
|
||||||
_debug.hide_runtime_frames()
|
_frame_stack.hide_runtime_frames()
|
||||||
|
|
||||||
_state._current_actor = actor
|
_state._current_actor = actor
|
||||||
trio_main = partial(
|
trio_main = partial(
|
||||||
|
@ -226,30 +128,23 @@ def _trio_main(
|
||||||
|
|
||||||
if actor.loglevel is not None:
|
if actor.loglevel is not None:
|
||||||
get_console_log(actor.loglevel)
|
get_console_log(actor.loglevel)
|
||||||
actor_info: str = (
|
|
||||||
f'|_{actor}\n'
|
|
||||||
f' uid: {actor.uid}\n'
|
|
||||||
f' pid: {os.getpid()}\n'
|
|
||||||
f' parent_addr: {parent_addr}\n'
|
|
||||||
f' loglevel: {actor.loglevel}\n'
|
|
||||||
)
|
|
||||||
log.info(
|
log.info(
|
||||||
'Starting new `trio` subactor:\n'
|
f'Starting `trio` subactor from parent @ '
|
||||||
|
f'{parent_addr}\n'
|
||||||
+
|
+
|
||||||
nest_from_op(
|
pformat.nest_from_op(
|
||||||
input_op='>(', # see syntax ideas above
|
input_op='>(', # see syntax ideas above
|
||||||
tree_str=actor_info,
|
text=f'{actor}',
|
||||||
back_from_op=2, # since "complete"
|
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
logmeth = log.info
|
logmeth = log.info
|
||||||
exit_status: str = (
|
exit_status: str = (
|
||||||
'Subactor exited\n'
|
'Subactor exited\n'
|
||||||
+
|
+
|
||||||
nest_from_op(
|
pformat.nest_from_op(
|
||||||
input_op=')>', # like a "closed-to-play"-icon from super perspective
|
input_op=')>', # like a "closed-to-play"-icon from super perspective
|
||||||
tree_str=actor_info,
|
text=f'{actor}',
|
||||||
back_from_op=1,
|
nest_indent=1,
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
try:
|
try:
|
||||||
|
@ -264,9 +159,9 @@ def _trio_main(
|
||||||
exit_status: str = (
|
exit_status: str = (
|
||||||
'Actor received KBI (aka an OS-cancel)\n'
|
'Actor received KBI (aka an OS-cancel)\n'
|
||||||
+
|
+
|
||||||
nest_from_op(
|
pformat.nest_from_op(
|
||||||
input_op='c)>', # closed due to cancel (see above)
|
input_op='c)>', # closed due to cancel (see above)
|
||||||
tree_str=actor_info,
|
text=f'{actor}',
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
except BaseException as err:
|
except BaseException as err:
|
||||||
|
@ -274,9 +169,9 @@ def _trio_main(
|
||||||
exit_status: str = (
|
exit_status: str = (
|
||||||
'Main actor task exited due to crash?\n'
|
'Main actor task exited due to crash?\n'
|
||||||
+
|
+
|
||||||
nest_from_op(
|
pformat.nest_from_op(
|
||||||
input_op='x)>', # closed by error
|
input_op='x)>', # closed by error
|
||||||
tree_str=actor_info,
|
text=f'{actor}',
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
# NOTE since we raise a tb will already be shown on the
|
# NOTE since we raise a tb will already be shown on the
|
||||||
|
|
|
@ -1246,55 +1246,6 @@ def unpack_error(
|
||||||
return exc
|
return exc
|
||||||
|
|
||||||
|
|
||||||
def is_multi_cancelled(
|
|
||||||
exc: BaseException|BaseExceptionGroup,
|
|
||||||
|
|
||||||
ignore_nested: set[BaseException] = set(),
|
|
||||||
|
|
||||||
) -> bool|BaseExceptionGroup:
|
|
||||||
'''
|
|
||||||
Predicate to determine if an `BaseExceptionGroup` only contains
|
|
||||||
some (maybe nested) set of sub-grouped exceptions (like only
|
|
||||||
`trio.Cancelled`s which get swallowed silently by default) and is
|
|
||||||
thus the result of "gracefully cancelling" a collection of
|
|
||||||
sub-tasks (or other conc primitives) and receiving a "cancelled
|
|
||||||
ACK" from each after termination.
|
|
||||||
|
|
||||||
Docs:
|
|
||||||
----
|
|
||||||
- https://docs.python.org/3/library/exceptions.html#exception-groups
|
|
||||||
- https://docs.python.org/3/library/exceptions.html#BaseExceptionGroup.subgroup
|
|
||||||
|
|
||||||
'''
|
|
||||||
|
|
||||||
if (
|
|
||||||
not ignore_nested
|
|
||||||
or
|
|
||||||
trio.Cancelled in ignore_nested
|
|
||||||
# XXX always count-in `trio`'s native signal
|
|
||||||
):
|
|
||||||
ignore_nested.update({trio.Cancelled})
|
|
||||||
|
|
||||||
if isinstance(exc, BaseExceptionGroup):
|
|
||||||
matched_exc: BaseExceptionGroup|None = exc.subgroup(
|
|
||||||
tuple(ignore_nested),
|
|
||||||
|
|
||||||
# TODO, complain about why not allowed XD
|
|
||||||
# condition=tuple(ignore_nested),
|
|
||||||
)
|
|
||||||
if matched_exc is not None:
|
|
||||||
return matched_exc
|
|
||||||
|
|
||||||
# NOTE, IFF no excs types match (throughout the error-tree)
|
|
||||||
# -> return `False`, OW return the matched sub-eg.
|
|
||||||
#
|
|
||||||
# IOW, for the inverse of ^ for the purpose of
|
|
||||||
# maybe-enter-REPL--logic: "only debug when the err-tree contains
|
|
||||||
# at least one exc-type NOT in `ignore_nested`" ; i.e. the case where
|
|
||||||
# we fallthrough and return `False` here.
|
|
||||||
return False
|
|
||||||
|
|
||||||
|
|
||||||
def _raise_from_unexpected_msg(
|
def _raise_from_unexpected_msg(
|
||||||
ctx: Context,
|
ctx: Context,
|
||||||
msg: MsgType,
|
msg: MsgType,
|
||||||
|
|
|
@ -39,7 +39,10 @@ import warnings
|
||||||
|
|
||||||
import trio
|
import trio
|
||||||
|
|
||||||
from .trionics import maybe_open_nursery
|
from .trionics import (
|
||||||
|
maybe_open_nursery,
|
||||||
|
collapse_eg,
|
||||||
|
)
|
||||||
from ._state import (
|
from ._state import (
|
||||||
current_actor,
|
current_actor,
|
||||||
)
|
)
|
||||||
|
@ -115,6 +118,10 @@ class Portal:
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def chan(self) -> Channel:
|
def chan(self) -> Channel:
|
||||||
|
'''
|
||||||
|
Ref to this ctx's underlying `tractor.ipc.Channel`.
|
||||||
|
|
||||||
|
'''
|
||||||
return self._chan
|
return self._chan
|
||||||
|
|
||||||
@property
|
@property
|
||||||
|
@ -174,10 +181,17 @@ class Portal:
|
||||||
|
|
||||||
# not expecting a "main" result
|
# not expecting a "main" result
|
||||||
if self._expect_result_ctx is None:
|
if self._expect_result_ctx is None:
|
||||||
|
peer_id: str = f'{self.channel.aid.reprol()!r}'
|
||||||
log.warning(
|
log.warning(
|
||||||
f"Portal for {self.channel.aid} not expecting a final"
|
f'Portal to peer {peer_id} will not deliver a final result?\n'
|
||||||
" result?\nresult() should only be called if subactor"
|
f'\n'
|
||||||
" was spawned with `ActorNursery.run_in_actor()`")
|
f'Context.result() can only be called by the parent of '
|
||||||
|
f'a sub-actor when it was spawned with '
|
||||||
|
f'`ActorNursery.run_in_actor()`'
|
||||||
|
f'\n'
|
||||||
|
f'Further this `ActorNursery`-method-API will deprecated in the'
|
||||||
|
f'near fututre!\n'
|
||||||
|
)
|
||||||
return NoResult
|
return NoResult
|
||||||
|
|
||||||
# expecting a "main" result
|
# expecting a "main" result
|
||||||
|
@ -210,6 +224,7 @@ class Portal:
|
||||||
typname: str = type(self).__name__
|
typname: str = type(self).__name__
|
||||||
log.warning(
|
log.warning(
|
||||||
f'`{typname}.result()` is DEPRECATED!\n'
|
f'`{typname}.result()` is DEPRECATED!\n'
|
||||||
|
f'\n'
|
||||||
f'Use `{typname}.wait_for_result()` instead!\n'
|
f'Use `{typname}.wait_for_result()` instead!\n'
|
||||||
)
|
)
|
||||||
return await self.wait_for_result(
|
return await self.wait_for_result(
|
||||||
|
@ -221,8 +236,10 @@ class Portal:
|
||||||
# terminate all locally running async generator
|
# terminate all locally running async generator
|
||||||
# IPC calls
|
# IPC calls
|
||||||
if self._streams:
|
if self._streams:
|
||||||
log.cancel(
|
peer_id: str = f'{self.channel.aid.reprol()!r}'
|
||||||
f"Cancelling all streams with {self.channel.aid}")
|
report: str = (
|
||||||
|
f'Cancelling all msg-streams with {peer_id}\n'
|
||||||
|
)
|
||||||
for stream in self._streams.copy():
|
for stream in self._streams.copy():
|
||||||
try:
|
try:
|
||||||
await stream.aclose()
|
await stream.aclose()
|
||||||
|
@ -231,10 +248,18 @@ class Portal:
|
||||||
# (unless of course at some point down the road we
|
# (unless of course at some point down the road we
|
||||||
# won't expect this to always be the case or need to
|
# won't expect this to always be the case or need to
|
||||||
# detect it for respawning purposes?)
|
# detect it for respawning purposes?)
|
||||||
log.debug(f"{stream} was already closed.")
|
report += (
|
||||||
|
f'->) {stream!r} already closed\n'
|
||||||
|
)
|
||||||
|
|
||||||
|
log.cancel(report)
|
||||||
|
|
||||||
async def aclose(self):
|
async def aclose(self):
|
||||||
log.debug(f"Closing {self}")
|
log.debug(
|
||||||
|
f'Closing portal\n'
|
||||||
|
f'>}}\n'
|
||||||
|
f'|_{self}\n'
|
||||||
|
)
|
||||||
# TODO: once we move to implementing our own `ReceiveChannel`
|
# TODO: once we move to implementing our own `ReceiveChannel`
|
||||||
# (including remote task cancellation inside its `.aclose()`)
|
# (including remote task cancellation inside its `.aclose()`)
|
||||||
# we'll need to .aclose all those channels here
|
# we'll need to .aclose all those channels here
|
||||||
|
@ -260,19 +285,18 @@ class Portal:
|
||||||
__runtimeframe__: int = 1 # noqa
|
__runtimeframe__: int = 1 # noqa
|
||||||
|
|
||||||
chan: Channel = self.channel
|
chan: Channel = self.channel
|
||||||
|
peer_id: str = f'{self.channel.aid.reprol()!r}'
|
||||||
if not chan.connected():
|
if not chan.connected():
|
||||||
log.runtime(
|
log.runtime(
|
||||||
'This channel is already closed, skipping cancel request..'
|
'Peer {peer_id} is already disconnected\n'
|
||||||
|
'-> skipping cancel request..\n'
|
||||||
)
|
)
|
||||||
return False
|
return False
|
||||||
|
|
||||||
reminfo: str = (
|
|
||||||
f'c)=> {self.channel.aid}\n'
|
|
||||||
f' |_{chan}\n'
|
|
||||||
)
|
|
||||||
log.cancel(
|
log.cancel(
|
||||||
f'Requesting actor-runtime cancel for peer\n\n'
|
f'Sending actor-runtime-cancel-req to peer\n'
|
||||||
f'{reminfo}'
|
f'\n'
|
||||||
|
f'c)=> {peer_id}\n'
|
||||||
)
|
)
|
||||||
|
|
||||||
# XXX the one spot we set it?
|
# XXX the one spot we set it?
|
||||||
|
@ -297,8 +321,9 @@ class Portal:
|
||||||
# may timeout and we never get an ack (obvi racy)
|
# may timeout and we never get an ack (obvi racy)
|
||||||
# but that doesn't mean it wasn't cancelled.
|
# but that doesn't mean it wasn't cancelled.
|
||||||
log.debug(
|
log.debug(
|
||||||
'May have failed to cancel peer?\n'
|
f'May have failed to cancel peer?\n'
|
||||||
f'{reminfo}'
|
f'\n'
|
||||||
|
f'c)=?> {peer_id}\n'
|
||||||
)
|
)
|
||||||
|
|
||||||
# if we get here some weird cancellation case happened
|
# if we get here some weird cancellation case happened
|
||||||
|
@ -316,22 +341,22 @@ class Portal:
|
||||||
|
|
||||||
TransportClosed,
|
TransportClosed,
|
||||||
) as tpt_err:
|
) as tpt_err:
|
||||||
report: str = (
|
ipc_borked_report: str = (
|
||||||
f'IPC chan for actor already closed or broken?\n\n'
|
f'IPC for actor already closed/broken?\n\n'
|
||||||
f'{self.channel.aid}\n'
|
f'\n'
|
||||||
f' |_{self.channel}\n'
|
f'c)=x> {peer_id}\n'
|
||||||
)
|
)
|
||||||
match tpt_err:
|
match tpt_err:
|
||||||
case TransportClosed():
|
case TransportClosed():
|
||||||
log.debug(report)
|
log.debug(ipc_borked_report)
|
||||||
case _:
|
case _:
|
||||||
report += (
|
ipc_borked_report += (
|
||||||
f'\n'
|
f'\n'
|
||||||
f'Unhandled low-level transport-closed/error during\n'
|
f'Unhandled low-level transport-closed/error during\n'
|
||||||
f'Portal.cancel_actor()` request?\n'
|
f'Portal.cancel_actor()` request?\n'
|
||||||
f'<{type(tpt_err).__name__}( {tpt_err} )>\n'
|
f'<{type(tpt_err).__name__}( {tpt_err} )>\n'
|
||||||
)
|
)
|
||||||
log.warning(report)
|
log.warning(ipc_borked_report)
|
||||||
|
|
||||||
return False
|
return False
|
||||||
|
|
||||||
|
@ -488,10 +513,13 @@ class Portal:
|
||||||
with trio.CancelScope(shield=True):
|
with trio.CancelScope(shield=True):
|
||||||
await ctx.cancel()
|
await ctx.cancel()
|
||||||
|
|
||||||
except trio.ClosedResourceError:
|
except trio.ClosedResourceError as cre:
|
||||||
# if the far end terminates before we send a cancel the
|
# if the far end terminates before we send a cancel the
|
||||||
# underlying transport-channel may already be closed.
|
# underlying transport-channel may already be closed.
|
||||||
log.cancel(f'Context {ctx} was already closed?')
|
log.cancel(
|
||||||
|
f'Context.cancel() -> {cre!r}\n'
|
||||||
|
f'cid: {ctx.cid!r} already closed?\n'
|
||||||
|
)
|
||||||
|
|
||||||
# XXX: should this always be done?
|
# XXX: should this always be done?
|
||||||
# await recv_chan.aclose()
|
# await recv_chan.aclose()
|
||||||
|
@ -558,14 +586,13 @@ async def open_portal(
|
||||||
assert actor
|
assert actor
|
||||||
was_connected: bool = False
|
was_connected: bool = False
|
||||||
|
|
||||||
async with maybe_open_nursery(
|
async with (
|
||||||
tn,
|
collapse_eg(),
|
||||||
shield=shield,
|
maybe_open_nursery(
|
||||||
strict_exception_groups=False,
|
tn,
|
||||||
# ^XXX^ TODO? soo roll our own then ??
|
shield=shield,
|
||||||
# -> since we kinda want the "if only one `.exception` then
|
) as tn,
|
||||||
# just raise that" interface?
|
):
|
||||||
) as tn:
|
|
||||||
|
|
||||||
if not channel.connected():
|
if not channel.connected():
|
||||||
await channel.connect()
|
await channel.connect()
|
||||||
|
|
188
tractor/_root.py
188
tractor/_root.py
|
@ -37,14 +37,12 @@ import warnings
|
||||||
|
|
||||||
import trio
|
import trio
|
||||||
|
|
||||||
from ._runtime import (
|
from . import _runtime
|
||||||
Actor,
|
from .devx import (
|
||||||
Arbiter,
|
debug,
|
||||||
# TODO: rename and make a non-actor subtype?
|
_frame_stack,
|
||||||
# Arbiter as Registry,
|
pformat as _pformat,
|
||||||
async_main,
|
|
||||||
)
|
)
|
||||||
from .devx import _debug
|
|
||||||
from . import _spawn
|
from . import _spawn
|
||||||
from . import _state
|
from . import _state
|
||||||
from . import log
|
from . import log
|
||||||
|
@ -58,16 +56,19 @@ from ._addr import (
|
||||||
mk_uuid,
|
mk_uuid,
|
||||||
wrap_address,
|
wrap_address,
|
||||||
)
|
)
|
||||||
|
from .trionics import (
|
||||||
|
is_multi_cancelled,
|
||||||
|
collapse_eg,
|
||||||
|
)
|
||||||
from ._exceptions import (
|
from ._exceptions import (
|
||||||
RuntimeFailure,
|
RuntimeFailure,
|
||||||
is_multi_cancelled,
|
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
logger = log.get_logger('tractor')
|
logger = log.get_logger('tractor')
|
||||||
|
|
||||||
|
|
||||||
# TODO: stick this in a `@acm` defined in `devx._debug`?
|
# TODO: stick this in a `@acm` defined in `devx.debug`?
|
||||||
# -[ ] also maybe consider making this a `wrapt`-deco to
|
# -[ ] also maybe consider making this a `wrapt`-deco to
|
||||||
# save an indent level?
|
# save an indent level?
|
||||||
#
|
#
|
||||||
|
@ -89,7 +90,7 @@ async def maybe_block_bp(
|
||||||
debug_mode
|
debug_mode
|
||||||
and maybe_enable_greenback
|
and maybe_enable_greenback
|
||||||
and (
|
and (
|
||||||
maybe_mod := await _debug.maybe_init_greenback(
|
maybe_mod := await debug.maybe_init_greenback(
|
||||||
raise_not_found=False,
|
raise_not_found=False,
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
|
@ -99,7 +100,7 @@ async def maybe_block_bp(
|
||||||
'Enabling `tractor.pause_from_sync()` support!\n'
|
'Enabling `tractor.pause_from_sync()` support!\n'
|
||||||
)
|
)
|
||||||
os.environ['PYTHONBREAKPOINT'] = (
|
os.environ['PYTHONBREAKPOINT'] = (
|
||||||
'tractor.devx._debug._sync_pause_from_builtin'
|
'tractor.devx.debug._sync_pause_from_builtin'
|
||||||
)
|
)
|
||||||
_state._runtime_vars['use_greenback'] = True
|
_state._runtime_vars['use_greenback'] = True
|
||||||
bp_blocked = False
|
bp_blocked = False
|
||||||
|
@ -163,7 +164,9 @@ async def open_root_actor(
|
||||||
|
|
||||||
# enables the multi-process debugger support
|
# enables the multi-process debugger support
|
||||||
debug_mode: bool = False,
|
debug_mode: bool = False,
|
||||||
maybe_enable_greenback: bool = True, # `.pause_from_sync()/breakpoint()` support
|
maybe_enable_greenback: bool = False, # `.pause_from_sync()/breakpoint()` support
|
||||||
|
# ^XXX NOTE^ the perf implications of use,
|
||||||
|
# https://greenback.readthedocs.io/en/latest/principle.html#performance
|
||||||
enable_stack_on_sig: bool = False,
|
enable_stack_on_sig: bool = False,
|
||||||
|
|
||||||
# internal logging
|
# internal logging
|
||||||
|
@ -178,7 +181,7 @@ async def open_root_actor(
|
||||||
|
|
||||||
hide_tb: bool = True,
|
hide_tb: bool = True,
|
||||||
|
|
||||||
# XXX, proxied directly to `.devx._debug._maybe_enter_pm()`
|
# XXX, proxied directly to `.devx.debug._maybe_enter_pm()`
|
||||||
# for REPL-entry logic.
|
# for REPL-entry logic.
|
||||||
debug_filter: Callable[
|
debug_filter: Callable[
|
||||||
[BaseException|BaseExceptionGroup],
|
[BaseException|BaseExceptionGroup],
|
||||||
|
@ -189,13 +192,19 @@ async def open_root_actor(
|
||||||
# read-only state to sublayers?
|
# read-only state to sublayers?
|
||||||
# extra_rt_vars: dict|None = None,
|
# extra_rt_vars: dict|None = None,
|
||||||
|
|
||||||
) -> Actor:
|
) -> _runtime.Actor:
|
||||||
'''
|
'''
|
||||||
Runtime init entry point for ``tractor``.
|
Initialize the `tractor` runtime by starting a "root actor" in
|
||||||
|
a parent-most Python process.
|
||||||
|
|
||||||
|
All (disjoint) actor-process-trees-as-programs are created via
|
||||||
|
this entrypoint.
|
||||||
|
|
||||||
'''
|
'''
|
||||||
# XXX NEVER allow nested actor-trees!
|
# XXX NEVER allow nested actor-trees!
|
||||||
if already_actor := _state.current_actor(err_on_no_runtime=False):
|
if already_actor := _state.current_actor(
|
||||||
|
err_on_no_runtime=False,
|
||||||
|
):
|
||||||
rtvs: dict[str, Any] = _state._runtime_vars
|
rtvs: dict[str, Any] = _state._runtime_vars
|
||||||
root_mailbox: list[str, int] = rtvs['_root_mailbox']
|
root_mailbox: list[str, int] = rtvs['_root_mailbox']
|
||||||
registry_addrs: list[list[str, int]] = rtvs['_registry_addrs']
|
registry_addrs: list[list[str, int]] = rtvs['_registry_addrs']
|
||||||
|
@ -228,12 +237,12 @@ async def open_root_actor(
|
||||||
f'enable_transports={enable_transports!r}\n'
|
f'enable_transports={enable_transports!r}\n'
|
||||||
)
|
)
|
||||||
|
|
||||||
_debug.hide_runtime_frames()
|
_frame_stack.hide_runtime_frames()
|
||||||
__tracebackhide__: bool = hide_tb
|
__tracebackhide__: bool = hide_tb
|
||||||
|
|
||||||
# attempt to retreive ``trio``'s sigint handler and stash it
|
# attempt to retreive ``trio``'s sigint handler and stash it
|
||||||
# on our debugger lock state.
|
# on our debugger lock state.
|
||||||
_debug.DebugStatus._trio_handler = signal.getsignal(signal.SIGINT)
|
debug.DebugStatus._trio_handler = signal.getsignal(signal.SIGINT)
|
||||||
|
|
||||||
# mark top most level process as root actor
|
# mark top most level process as root actor
|
||||||
_state._runtime_vars['_is_root'] = True
|
_state._runtime_vars['_is_root'] = True
|
||||||
|
@ -265,14 +274,20 @@ async def open_root_actor(
|
||||||
DeprecationWarning,
|
DeprecationWarning,
|
||||||
stacklevel=2,
|
stacklevel=2,
|
||||||
)
|
)
|
||||||
registry_addrs = [arbiter_addr]
|
uw_reg_addrs = [arbiter_addr]
|
||||||
|
|
||||||
if not registry_addrs:
|
uw_reg_addrs = registry_addrs
|
||||||
registry_addrs: list[UnwrappedAddress] = default_lo_addrs(
|
if not uw_reg_addrs:
|
||||||
|
uw_reg_addrs: list[UnwrappedAddress] = default_lo_addrs(
|
||||||
enable_transports
|
enable_transports
|
||||||
)
|
)
|
||||||
|
|
||||||
assert registry_addrs
|
# must exist by now since all below code is dependent
|
||||||
|
assert uw_reg_addrs
|
||||||
|
registry_addrs: list[Address] = [
|
||||||
|
wrap_address(uw_addr)
|
||||||
|
for uw_addr in uw_reg_addrs
|
||||||
|
]
|
||||||
|
|
||||||
loglevel = (
|
loglevel = (
|
||||||
loglevel
|
loglevel
|
||||||
|
@ -281,13 +296,14 @@ async def open_root_actor(
|
||||||
|
|
||||||
if (
|
if (
|
||||||
debug_mode
|
debug_mode
|
||||||
and _spawn._spawn_method == 'trio'
|
and
|
||||||
|
_spawn._spawn_method == 'trio'
|
||||||
):
|
):
|
||||||
_state._runtime_vars['_debug_mode'] = True
|
_state._runtime_vars['_debug_mode'] = True
|
||||||
|
|
||||||
# expose internal debug module to every actor allowing for
|
# expose internal debug module to every actor allowing for
|
||||||
# use of ``await tractor.pause()``
|
# use of ``await tractor.pause()``
|
||||||
enable_modules.append('tractor.devx._debug')
|
enable_modules.append('tractor.devx.debug._tty_lock')
|
||||||
|
|
||||||
# if debug mode get's enabled *at least* use that level of
|
# if debug mode get's enabled *at least* use that level of
|
||||||
# logging for some informative console prompts.
|
# logging for some informative console prompts.
|
||||||
|
@ -320,10 +336,10 @@ async def open_root_actor(
|
||||||
enable_stack_on_sig()
|
enable_stack_on_sig()
|
||||||
|
|
||||||
# closed into below ping task-func
|
# closed into below ping task-func
|
||||||
ponged_addrs: list[UnwrappedAddress] = []
|
ponged_addrs: list[Address] = []
|
||||||
|
|
||||||
async def ping_tpt_socket(
|
async def ping_tpt_socket(
|
||||||
addr: UnwrappedAddress,
|
addr: Address,
|
||||||
timeout: float = 1,
|
timeout: float = 1,
|
||||||
) -> None:
|
) -> None:
|
||||||
'''
|
'''
|
||||||
|
@ -343,17 +359,22 @@ async def open_root_actor(
|
||||||
# be better to eventually have a "discovery" protocol
|
# be better to eventually have a "discovery" protocol
|
||||||
# with basic handshake instead?
|
# with basic handshake instead?
|
||||||
with trio.move_on_after(timeout):
|
with trio.move_on_after(timeout):
|
||||||
async with _connect_chan(addr):
|
async with _connect_chan(addr.unwrap()):
|
||||||
ponged_addrs.append(addr)
|
ponged_addrs.append(addr)
|
||||||
|
|
||||||
except OSError:
|
except OSError:
|
||||||
# TODO: make this a "discovery" log level?
|
# ?TODO, make this a "discovery" log level?
|
||||||
logger.info(
|
logger.info(
|
||||||
f'No actor registry found @ {addr}\n'
|
f'No root-actor registry found @ {addr!r}\n'
|
||||||
)
|
)
|
||||||
|
|
||||||
|
# !TODO, this is basically just another (abstract)
|
||||||
|
# happy-eyeballs, so we should try for formalize it somewhere
|
||||||
|
# in a `.[_]discovery` ya?
|
||||||
|
#
|
||||||
async with trio.open_nursery() as tn:
|
async with trio.open_nursery() as tn:
|
||||||
for addr in registry_addrs:
|
for uw_addr in uw_reg_addrs:
|
||||||
|
addr: Address = wrap_address(uw_addr)
|
||||||
tn.start_soon(
|
tn.start_soon(
|
||||||
ping_tpt_socket,
|
ping_tpt_socket,
|
||||||
addr,
|
addr,
|
||||||
|
@ -375,31 +396,35 @@ async def open_root_actor(
|
||||||
f'Registry(s) seem(s) to exist @ {ponged_addrs}'
|
f'Registry(s) seem(s) to exist @ {ponged_addrs}'
|
||||||
)
|
)
|
||||||
|
|
||||||
actor = Actor(
|
actor = _runtime.Actor(
|
||||||
name=name or 'anonymous',
|
name=name or 'anonymous',
|
||||||
uuid=mk_uuid(),
|
uuid=mk_uuid(),
|
||||||
registry_addrs=ponged_addrs,
|
registry_addrs=ponged_addrs,
|
||||||
loglevel=loglevel,
|
loglevel=loglevel,
|
||||||
enable_modules=enable_modules,
|
enable_modules=enable_modules,
|
||||||
)
|
)
|
||||||
# DO NOT use the registry_addrs as the transport server
|
# **DO NOT** use the registry_addrs as the
|
||||||
# addrs for this new non-registar, root-actor.
|
# ipc-transport-server's bind-addrs as this is
|
||||||
|
# a new NON-registrar, ROOT-actor.
|
||||||
|
#
|
||||||
|
# XXX INSTEAD, bind random addrs using the same tpt
|
||||||
|
# proto.
|
||||||
for addr in ponged_addrs:
|
for addr in ponged_addrs:
|
||||||
waddr: Address = wrap_address(addr)
|
|
||||||
trans_bind_addrs.append(
|
trans_bind_addrs.append(
|
||||||
waddr.get_random(bindspace=waddr.bindspace)
|
addr.get_random(
|
||||||
|
bindspace=addr.bindspace,
|
||||||
|
)
|
||||||
)
|
)
|
||||||
|
|
||||||
# Start this local actor as the "registrar", aka a regular
|
# Start this local actor as the "registrar", aka a regular
|
||||||
# actor who manages the local registry of "mailboxes" of
|
# actor who manages the local registry of "mailboxes" of
|
||||||
# other process-tree-local sub-actors.
|
# other process-tree-local sub-actors.
|
||||||
else:
|
else:
|
||||||
|
|
||||||
# NOTE that if the current actor IS THE REGISTAR, the
|
# NOTE that if the current actor IS THE REGISTAR, the
|
||||||
# following init steps are taken:
|
# following init steps are taken:
|
||||||
# - the tranport layer server is bound to each addr
|
# - the tranport layer server is bound to each addr
|
||||||
# pair defined in provided registry_addrs, or the default.
|
# pair defined in provided registry_addrs, or the default.
|
||||||
trans_bind_addrs = registry_addrs
|
trans_bind_addrs = uw_reg_addrs
|
||||||
|
|
||||||
# - it is normally desirable for any registrar to stay up
|
# - it is normally desirable for any registrar to stay up
|
||||||
# indefinitely until either all registered (child/sub)
|
# indefinitely until either all registered (child/sub)
|
||||||
|
@ -410,7 +435,8 @@ async def open_root_actor(
|
||||||
# https://github.com/goodboy/tractor/pull/348
|
# https://github.com/goodboy/tractor/pull/348
|
||||||
# https://github.com/goodboy/tractor/issues/296
|
# https://github.com/goodboy/tractor/issues/296
|
||||||
|
|
||||||
actor = Arbiter(
|
# TODO: rename as `RootActor` or is that even necessary?
|
||||||
|
actor = _runtime.Arbiter(
|
||||||
name=name or 'registrar',
|
name=name or 'registrar',
|
||||||
uuid=mk_uuid(),
|
uuid=mk_uuid(),
|
||||||
registry_addrs=registry_addrs,
|
registry_addrs=registry_addrs,
|
||||||
|
@ -422,6 +448,16 @@ async def open_root_actor(
|
||||||
# `.trio.run()`.
|
# `.trio.run()`.
|
||||||
actor._infected_aio = _state._runtime_vars['_is_infected_aio']
|
actor._infected_aio = _state._runtime_vars['_is_infected_aio']
|
||||||
|
|
||||||
|
# NOTE, only set the loopback addr for the
|
||||||
|
# process-tree-global "root" mailbox since all sub-actors
|
||||||
|
# should be able to speak to their root actor over that
|
||||||
|
# channel.
|
||||||
|
raddrs: list[Address] = _state._runtime_vars['_root_addrs']
|
||||||
|
raddrs.extend(trans_bind_addrs)
|
||||||
|
# TODO, remove once we have also removed all usage;
|
||||||
|
# eventually all (root-)registry apis should expect > 1 addr.
|
||||||
|
_state._runtime_vars['_root_mailbox'] = raddrs[0]
|
||||||
|
|
||||||
# Start up main task set via core actor-runtime nurseries.
|
# Start up main task set via core actor-runtime nurseries.
|
||||||
try:
|
try:
|
||||||
# assign process-local actor
|
# assign process-local actor
|
||||||
|
@ -429,21 +465,27 @@ async def open_root_actor(
|
||||||
|
|
||||||
# start local channel-server and fake the portal API
|
# start local channel-server and fake the portal API
|
||||||
# NOTE: this won't block since we provide the nursery
|
# NOTE: this won't block since we provide the nursery
|
||||||
ml_addrs_str: str = '\n'.join(
|
report: str = f'Starting actor-runtime for {actor.aid.reprol()!r}\n'
|
||||||
f'@{addr}' for addr in trans_bind_addrs
|
if reg_addrs := actor.registry_addrs:
|
||||||
)
|
report += (
|
||||||
logger.info(
|
'-> Opening new registry @ '
|
||||||
f'Starting local {actor.uid} on the following transport addrs:\n'
|
+
|
||||||
f'{ml_addrs_str}'
|
'\n'.join(
|
||||||
)
|
f'@{addr}' for addr in reg_addrs
|
||||||
|
)
|
||||||
|
)
|
||||||
|
logger.info(f'{report}\n')
|
||||||
|
|
||||||
# start the actor runtime in a new task
|
# start runtime in a bg sub-task, yield to caller.
|
||||||
async with trio.open_nursery(
|
async with (
|
||||||
strict_exception_groups=False,
|
collapse_eg(),
|
||||||
# ^XXX^ TODO? instead unpack any RAE as per "loose" style?
|
trio.open_nursery() as root_tn,
|
||||||
) as nursery:
|
|
||||||
|
|
||||||
# ``_runtime.async_main()`` creates an internal nursery
|
# XXX, finally-footgun below?
|
||||||
|
# -> see note on why shielding.
|
||||||
|
# maybe_raise_from_masking_exc(),
|
||||||
|
):
|
||||||
|
# `_runtime.async_main()` creates an internal nursery
|
||||||
# and blocks here until any underlying actor(-process)
|
# and blocks here until any underlying actor(-process)
|
||||||
# tree has terminated thereby conducting so called
|
# tree has terminated thereby conducting so called
|
||||||
# "end-to-end" structured concurrency throughout an
|
# "end-to-end" structured concurrency throughout an
|
||||||
|
@ -451,9 +493,9 @@ async def open_root_actor(
|
||||||
# "actor runtime" primitives are SC-compat and thus all
|
# "actor runtime" primitives are SC-compat and thus all
|
||||||
# transitively spawned actors/processes must be as
|
# transitively spawned actors/processes must be as
|
||||||
# well.
|
# well.
|
||||||
await nursery.start(
|
await root_tn.start(
|
||||||
partial(
|
partial(
|
||||||
async_main,
|
_runtime.async_main,
|
||||||
actor,
|
actor,
|
||||||
accept_addrs=trans_bind_addrs,
|
accept_addrs=trans_bind_addrs,
|
||||||
parent_addr=None
|
parent_addr=None
|
||||||
|
@ -469,7 +511,7 @@ async def open_root_actor(
|
||||||
# TODO, in beginning to handle the subsubactor with
|
# TODO, in beginning to handle the subsubactor with
|
||||||
# crashed grandparent cases..
|
# crashed grandparent cases..
|
||||||
#
|
#
|
||||||
# was_locked: bool = await _debug.maybe_wait_for_debugger(
|
# was_locked: bool = await debug.maybe_wait_for_debugger(
|
||||||
# child_in_debug=True,
|
# child_in_debug=True,
|
||||||
# )
|
# )
|
||||||
# XXX NOTE XXX see equiv note inside
|
# XXX NOTE XXX see equiv note inside
|
||||||
|
@ -477,7 +519,7 @@ async def open_root_actor(
|
||||||
# non-root or root-that-opened-this-mahually case we
|
# non-root or root-that-opened-this-mahually case we
|
||||||
# wait for the local actor-nursery to exit before
|
# wait for the local actor-nursery to exit before
|
||||||
# exiting the transport channel handler.
|
# exiting the transport channel handler.
|
||||||
entered: bool = await _debug._maybe_enter_pm(
|
entered: bool = await debug._maybe_enter_pm(
|
||||||
err,
|
err,
|
||||||
api_frame=inspect.currentframe(),
|
api_frame=inspect.currentframe(),
|
||||||
debug_filter=debug_filter,
|
debug_filter=debug_filter,
|
||||||
|
@ -510,19 +552,43 @@ async def open_root_actor(
|
||||||
# for an in nurseries:
|
# for an in nurseries:
|
||||||
# tempn.start_soon(an.exited.wait)
|
# tempn.start_soon(an.exited.wait)
|
||||||
|
|
||||||
|
op_nested_actor_repr: str = _pformat.nest_from_op(
|
||||||
|
input_op='>) ',
|
||||||
|
text=actor.pformat(),
|
||||||
|
nest_prefix='|_',
|
||||||
|
)
|
||||||
logger.info(
|
logger.info(
|
||||||
f'Closing down root actor\n'
|
f'Closing down root actor\n'
|
||||||
f'>)\n'
|
f'{op_nested_actor_repr}'
|
||||||
f'|_{actor}\n'
|
|
||||||
)
|
)
|
||||||
await actor.cancel(None) # self cancel
|
# XXX, THIS IS A *finally-footgun*!
|
||||||
|
# -> though already shields iternally it can
|
||||||
|
# taskc here and mask underlying errors raised in
|
||||||
|
# the try-block above?
|
||||||
|
with trio.CancelScope(shield=True):
|
||||||
|
await actor.cancel(None) # self cancel
|
||||||
finally:
|
finally:
|
||||||
|
# revert all process-global runtime state
|
||||||
|
if (
|
||||||
|
debug_mode
|
||||||
|
and
|
||||||
|
_spawn._spawn_method == 'trio'
|
||||||
|
):
|
||||||
|
_state._runtime_vars['_debug_mode'] = False
|
||||||
|
|
||||||
_state._current_actor = None
|
_state._current_actor = None
|
||||||
_state._last_actor_terminated = actor
|
_state._last_actor_terminated = actor
|
||||||
logger.runtime(
|
|
||||||
|
sclang_repr: str = _pformat.nest_from_op(
|
||||||
|
input_op=')>',
|
||||||
|
text=actor.pformat(),
|
||||||
|
nest_prefix='|_',
|
||||||
|
nest_indent=1,
|
||||||
|
)
|
||||||
|
|
||||||
|
logger.info(
|
||||||
f'Root actor terminated\n'
|
f'Root actor terminated\n'
|
||||||
f')>\n'
|
f'{sclang_repr}'
|
||||||
f' |_{actor}\n'
|
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
|
233
tractor/_rpc.py
233
tractor/_rpc.py
|
@ -37,6 +37,7 @@ import warnings
|
||||||
|
|
||||||
import trio
|
import trio
|
||||||
from trio import (
|
from trio import (
|
||||||
|
Cancelled,
|
||||||
CancelScope,
|
CancelScope,
|
||||||
Nursery,
|
Nursery,
|
||||||
TaskStatus,
|
TaskStatus,
|
||||||
|
@ -52,13 +53,18 @@ from ._exceptions import (
|
||||||
ModuleNotExposed,
|
ModuleNotExposed,
|
||||||
MsgTypeError,
|
MsgTypeError,
|
||||||
TransportClosed,
|
TransportClosed,
|
||||||
is_multi_cancelled,
|
|
||||||
pack_error,
|
pack_error,
|
||||||
unpack_error,
|
unpack_error,
|
||||||
)
|
)
|
||||||
|
from .trionics import (
|
||||||
|
collapse_eg,
|
||||||
|
is_multi_cancelled,
|
||||||
|
maybe_raise_from_masking_exc,
|
||||||
|
)
|
||||||
from .devx import (
|
from .devx import (
|
||||||
_debug,
|
debug,
|
||||||
add_div,
|
add_div,
|
||||||
|
pformat as _pformat,
|
||||||
)
|
)
|
||||||
from . import _state
|
from . import _state
|
||||||
from .log import get_logger
|
from .log import get_logger
|
||||||
|
@ -67,7 +73,7 @@ from .msg import (
|
||||||
MsgCodec,
|
MsgCodec,
|
||||||
PayloadT,
|
PayloadT,
|
||||||
NamespacePath,
|
NamespacePath,
|
||||||
# pretty_struct,
|
pretty_struct,
|
||||||
_ops as msgops,
|
_ops as msgops,
|
||||||
)
|
)
|
||||||
from tractor.msg.types import (
|
from tractor.msg.types import (
|
||||||
|
@ -215,11 +221,18 @@ async def _invoke_non_context(
|
||||||
task_status.started(ctx)
|
task_status.started(ctx)
|
||||||
result = await coro
|
result = await coro
|
||||||
fname: str = func.__name__
|
fname: str = func.__name__
|
||||||
|
|
||||||
|
op_nested_task: str = _pformat.nest_from_op(
|
||||||
|
input_op=f')> cid: {ctx.cid!r}',
|
||||||
|
text=f'{ctx._task}',
|
||||||
|
nest_indent=1, # under >
|
||||||
|
)
|
||||||
log.runtime(
|
log.runtime(
|
||||||
'RPC complete:\n'
|
f'RPC task complete\n'
|
||||||
f'task: {ctx._task}\n'
|
f'\n'
|
||||||
f'|_cid={ctx.cid}\n'
|
f'{op_nested_task}\n'
|
||||||
f'|_{fname}() -> {pformat(result)}\n'
|
f'\n'
|
||||||
|
f')> {fname}() -> {pformat(result)}\n'
|
||||||
)
|
)
|
||||||
|
|
||||||
# NOTE: only send result if we know IPC isn't down
|
# NOTE: only send result if we know IPC isn't down
|
||||||
|
@ -250,7 +263,7 @@ async def _errors_relayed_via_ipc(
|
||||||
ctx: Context,
|
ctx: Context,
|
||||||
is_rpc: bool,
|
is_rpc: bool,
|
||||||
|
|
||||||
hide_tb: bool = False,
|
hide_tb: bool = True,
|
||||||
debug_kbis: bool = False,
|
debug_kbis: bool = False,
|
||||||
task_status: TaskStatus[
|
task_status: TaskStatus[
|
||||||
Context | BaseException
|
Context | BaseException
|
||||||
|
@ -266,7 +279,7 @@ async def _errors_relayed_via_ipc(
|
||||||
|
|
||||||
# TODO: a debug nursery when in debug mode!
|
# TODO: a debug nursery when in debug mode!
|
||||||
# async with maybe_open_debugger_nursery() as debug_tn:
|
# async with maybe_open_debugger_nursery() as debug_tn:
|
||||||
# => see matching comment in side `._debug._pause()`
|
# => see matching comment in side `.debug._pause()`
|
||||||
rpc_err: BaseException|None = None
|
rpc_err: BaseException|None = None
|
||||||
try:
|
try:
|
||||||
yield # run RPC invoke body
|
yield # run RPC invoke body
|
||||||
|
@ -318,7 +331,7 @@ async def _errors_relayed_via_ipc(
|
||||||
'RPC task crashed, attempting to enter debugger\n'
|
'RPC task crashed, attempting to enter debugger\n'
|
||||||
f'|_{ctx}'
|
f'|_{ctx}'
|
||||||
)
|
)
|
||||||
entered_debug = await _debug._maybe_enter_pm(
|
entered_debug = await debug._maybe_enter_pm(
|
||||||
err,
|
err,
|
||||||
api_frame=inspect.currentframe(),
|
api_frame=inspect.currentframe(),
|
||||||
)
|
)
|
||||||
|
@ -375,9 +388,9 @@ async def _errors_relayed_via_ipc(
|
||||||
# they can be individually ccancelled.
|
# they can be individually ccancelled.
|
||||||
finally:
|
finally:
|
||||||
|
|
||||||
# if the error is not from user code and instead a failure
|
# if the error is not from user code and instead a failure of
|
||||||
# of a runtime RPC or transport failure we do prolly want to
|
# an internal-runtime-RPC or IPC-connection, we do (prolly) want
|
||||||
# show this frame
|
# to show this frame!
|
||||||
if (
|
if (
|
||||||
rpc_err
|
rpc_err
|
||||||
and (
|
and (
|
||||||
|
@ -462,7 +475,7 @@ async def _invoke(
|
||||||
):
|
):
|
||||||
# XXX for .pause_from_sync()` usage we need to make sure
|
# XXX for .pause_from_sync()` usage we need to make sure
|
||||||
# `greenback` is boostrapped in the subactor!
|
# `greenback` is boostrapped in the subactor!
|
||||||
await _debug.maybe_init_greenback()
|
await debug.maybe_init_greenback()
|
||||||
|
|
||||||
# TODO: possibly a specially formatted traceback
|
# TODO: possibly a specially formatted traceback
|
||||||
# (not sure what typing is for this..)?
|
# (not sure what typing is for this..)?
|
||||||
|
@ -616,32 +629,40 @@ async def _invoke(
|
||||||
# -> the below scope is never exposed to the
|
# -> the below scope is never exposed to the
|
||||||
# `@context` marked RPC function.
|
# `@context` marked RPC function.
|
||||||
# - `._portal` is never set.
|
# - `._portal` is never set.
|
||||||
|
scope_err: BaseException|None = None
|
||||||
try:
|
try:
|
||||||
tn: trio.Nursery
|
# TODO: better `trionics` primitive/tooling usage here!
|
||||||
|
# -[ ] should would be nice to have our `TaskMngr`
|
||||||
|
# nursery here!
|
||||||
|
# -[ ] payload value checking like we do with
|
||||||
|
# `.started()` such that the debbuger can engage
|
||||||
|
# here in the child task instead of waiting for the
|
||||||
|
# parent to crash with it's own MTE..
|
||||||
|
#
|
||||||
|
tn: Nursery
|
||||||
rpc_ctx_cs: CancelScope
|
rpc_ctx_cs: CancelScope
|
||||||
async with (
|
async with (
|
||||||
trio.open_nursery(
|
collapse_eg(),
|
||||||
strict_exception_groups=False,
|
trio.open_nursery() as tn,
|
||||||
# ^XXX^ TODO? instead unpack any RAE as per "loose" style?
|
|
||||||
|
|
||||||
) as tn,
|
|
||||||
msgops.maybe_limit_plds(
|
msgops.maybe_limit_plds(
|
||||||
ctx=ctx,
|
ctx=ctx,
|
||||||
spec=ctx_meta.get('pld_spec'),
|
spec=ctx_meta.get('pld_spec'),
|
||||||
dec_hook=ctx_meta.get('dec_hook'),
|
dec_hook=ctx_meta.get('dec_hook'),
|
||||||
),
|
),
|
||||||
|
|
||||||
|
# XXX NOTE, this being the "most embedded"
|
||||||
|
# scope ensures unasking of the `await coro` below
|
||||||
|
# *should* never be interfered with!!
|
||||||
|
maybe_raise_from_masking_exc(
|
||||||
|
tn=tn,
|
||||||
|
unmask_from=Cancelled,
|
||||||
|
) as _mbme, # maybe boxed masked exc
|
||||||
):
|
):
|
||||||
ctx._scope_nursery = tn
|
ctx._scope_nursery = tn
|
||||||
rpc_ctx_cs = ctx._scope = tn.cancel_scope
|
rpc_ctx_cs = ctx._scope = tn.cancel_scope
|
||||||
task_status.started(ctx)
|
task_status.started(ctx)
|
||||||
|
|
||||||
# TODO: better `trionics` tooling:
|
# invoke user endpoint fn.
|
||||||
# -[ ] should would be nice to have our `TaskMngr`
|
|
||||||
# nursery here!
|
|
||||||
# -[ ] payload value checking like we do with
|
|
||||||
# `.started()` such that the debbuger can engage
|
|
||||||
# here in the child task instead of waiting for the
|
|
||||||
# parent to crash with it's own MTE..
|
|
||||||
res: Any|PayloadT = await coro
|
res: Any|PayloadT = await coro
|
||||||
return_msg: Return|CancelAck = return_msg_type(
|
return_msg: Return|CancelAck = return_msg_type(
|
||||||
cid=cid,
|
cid=cid,
|
||||||
|
@ -651,7 +672,8 @@ async def _invoke(
|
||||||
ctx._result = res
|
ctx._result = res
|
||||||
log.runtime(
|
log.runtime(
|
||||||
f'Sending result msg and exiting {ctx.side!r}\n'
|
f'Sending result msg and exiting {ctx.side!r}\n'
|
||||||
f'{return_msg}\n'
|
f'\n'
|
||||||
|
f'{pretty_struct.pformat(return_msg)}\n'
|
||||||
)
|
)
|
||||||
await chan.send(return_msg)
|
await chan.send(return_msg)
|
||||||
|
|
||||||
|
@ -743,43 +765,52 @@ async def _invoke(
|
||||||
BaseExceptionGroup,
|
BaseExceptionGroup,
|
||||||
BaseException,
|
BaseException,
|
||||||
trio.Cancelled,
|
trio.Cancelled,
|
||||||
|
) as _scope_err:
|
||||||
) as scope_error:
|
scope_err = _scope_err
|
||||||
if (
|
if (
|
||||||
isinstance(scope_error, RuntimeError)
|
isinstance(scope_err, RuntimeError)
|
||||||
and scope_error.args
|
and
|
||||||
and 'Cancel scope stack corrupted' in scope_error.args[0]
|
scope_err.args
|
||||||
|
and
|
||||||
|
'Cancel scope stack corrupted' in scope_err.args[0]
|
||||||
):
|
):
|
||||||
log.exception('Cancel scope stack corrupted!?\n')
|
log.exception('Cancel scope stack corrupted!?\n')
|
||||||
# _debug.mk_pdb().set_trace()
|
# debug.mk_pdb().set_trace()
|
||||||
|
|
||||||
# always set this (child) side's exception as the
|
# always set this (child) side's exception as the
|
||||||
# local error on the context
|
# local error on the context
|
||||||
ctx._local_error: BaseException = scope_error
|
ctx._local_error: BaseException = scope_err
|
||||||
# ^-TODO-^ question,
|
# ^-TODO-^ question,
|
||||||
# does this matter other then for
|
# does this matter other then for
|
||||||
# consistentcy/testing?
|
# consistentcy/testing?
|
||||||
# |_ no user code should be in this scope at this point
|
# |_ no user code should be in this scope at this point
|
||||||
# AND we already set this in the block below?
|
# AND we already set this in the block below?
|
||||||
|
|
||||||
# if a remote error was set then likely the
|
# XXX if a remote error was set then likely the
|
||||||
# exception group was raised due to that, so
|
# exc group was raised due to that, so
|
||||||
# and we instead raise that error immediately!
|
# and we instead raise that error immediately!
|
||||||
ctx.maybe_raise()
|
maybe_re: (
|
||||||
|
ContextCancelled|RemoteActorError
|
||||||
|
) = ctx.maybe_raise()
|
||||||
|
if maybe_re:
|
||||||
|
log.cancel(
|
||||||
|
f'Suppressing remote-exc from peer,\n'
|
||||||
|
f'{maybe_re!r}\n'
|
||||||
|
)
|
||||||
|
|
||||||
# maybe TODO: pack in come kinda
|
# maybe TODO: pack in come kinda
|
||||||
# `trio.Cancelled.__traceback__` here so they can be
|
# `trio.Cancelled.__traceback__` here so they can be
|
||||||
# unwrapped and displayed on the caller side? no se..
|
# unwrapped and displayed on the caller side? no se..
|
||||||
raise
|
raise scope_err
|
||||||
|
|
||||||
# `@context` entrypoint task bookeeping.
|
# `@context` entrypoint task bookeeping.
|
||||||
# i.e. only pop the context tracking if used ;)
|
# i.e. only pop the context tracking if used ;)
|
||||||
finally:
|
finally:
|
||||||
assert chan.uid
|
assert chan.aid
|
||||||
|
|
||||||
# don't pop the local context until we know the
|
# don't pop the local context until we know the
|
||||||
# associated child isn't in debug any more
|
# associated child isn't in debug any more
|
||||||
await _debug.maybe_wait_for_debugger()
|
await debug.maybe_wait_for_debugger()
|
||||||
ctx: Context = actor._contexts.pop((
|
ctx: Context = actor._contexts.pop((
|
||||||
chan.uid,
|
chan.uid,
|
||||||
cid,
|
cid,
|
||||||
|
@ -802,16 +833,19 @@ async def _invoke(
|
||||||
descr_str += (
|
descr_str += (
|
||||||
f'\n{merr!r}\n' # needed?
|
f'\n{merr!r}\n' # needed?
|
||||||
f'{tb_str}\n'
|
f'{tb_str}\n'
|
||||||
|
f'\n'
|
||||||
|
f'scope_error:\n'
|
||||||
|
f'{scope_err!r}\n'
|
||||||
)
|
)
|
||||||
else:
|
else:
|
||||||
descr_str += f'\n{merr!r}\n'
|
descr_str += f'\n{merr!r}\n'
|
||||||
else:
|
else:
|
||||||
descr_str += f'\nand final result {ctx.outcome!r}\n'
|
descr_str += f'\nwith final result {ctx.outcome!r}\n'
|
||||||
|
|
||||||
logmeth(
|
logmeth(
|
||||||
message
|
f'{message}\n'
|
||||||
+
|
f'\n'
|
||||||
descr_str
|
f'{descr_str}\n'
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@ -978,12 +1012,10 @@ async def process_messages(
|
||||||
cid=cid,
|
cid=cid,
|
||||||
kwargs=kwargs,
|
kwargs=kwargs,
|
||||||
):
|
):
|
||||||
kwargs |= {'req_chan': chan}
|
|
||||||
|
|
||||||
# XXX NOTE XXX don't start entire actor
|
# XXX NOTE XXX don't start entire actor
|
||||||
# runtime cancellation if this actor is
|
# runtime cancellation if this actor is
|
||||||
# currently in debug mode!
|
# currently in debug mode!
|
||||||
pdb_complete: trio.Event|None = _debug.DebugStatus.repl_release
|
pdb_complete: trio.Event|None = debug.DebugStatus.repl_release
|
||||||
if pdb_complete:
|
if pdb_complete:
|
||||||
await pdb_complete.wait()
|
await pdb_complete.wait()
|
||||||
|
|
||||||
|
@ -998,14 +1030,14 @@ async def process_messages(
|
||||||
cid,
|
cid,
|
||||||
chan,
|
chan,
|
||||||
actor.cancel,
|
actor.cancel,
|
||||||
kwargs,
|
kwargs | {'req_chan': chan},
|
||||||
is_rpc=False,
|
is_rpc=False,
|
||||||
return_msg_type=CancelAck,
|
return_msg_type=CancelAck,
|
||||||
)
|
)
|
||||||
|
|
||||||
log.runtime(
|
log.runtime(
|
||||||
'Cancelling IPC transport msg-loop with peer:\n'
|
'Cancelling RPC-msg-loop with peer\n'
|
||||||
f'|_{chan}\n'
|
f'->c}} {chan.aid.reprol()}@[{chan.maddr}]\n'
|
||||||
)
|
)
|
||||||
loop_cs.cancel()
|
loop_cs.cancel()
|
||||||
break
|
break
|
||||||
|
@ -1018,7 +1050,7 @@ async def process_messages(
|
||||||
):
|
):
|
||||||
target_cid: str = kwargs['cid']
|
target_cid: str = kwargs['cid']
|
||||||
kwargs |= {
|
kwargs |= {
|
||||||
'requesting_uid': chan.uid,
|
'requesting_aid': chan.aid,
|
||||||
'ipc_msg': msg,
|
'ipc_msg': msg,
|
||||||
|
|
||||||
# XXX NOTE! ONLY the rpc-task-owning
|
# XXX NOTE! ONLY the rpc-task-owning
|
||||||
|
@ -1054,21 +1086,34 @@ async def process_messages(
|
||||||
ns=ns,
|
ns=ns,
|
||||||
func=funcname,
|
func=funcname,
|
||||||
kwargs=kwargs, # type-spec this? see `msg.types`
|
kwargs=kwargs, # type-spec this? see `msg.types`
|
||||||
uid=actorid,
|
uid=actor_uuid,
|
||||||
):
|
):
|
||||||
|
if actor_uuid != chan.aid.uid:
|
||||||
|
raise RuntimeError(
|
||||||
|
f'IPC <Start> msg <-> chan.aid mismatch!?\n'
|
||||||
|
f'Channel.aid = {chan.aid!r}\n'
|
||||||
|
f'Start.uid = {actor_uuid!r}\n'
|
||||||
|
)
|
||||||
|
# await debug.pause()
|
||||||
|
op_repr: str = 'Start <=) '
|
||||||
|
req_repr: str = _pformat.nest_from_op(
|
||||||
|
input_op=op_repr,
|
||||||
|
op_suffix='',
|
||||||
|
nest_prefix='',
|
||||||
|
text=f'{chan}',
|
||||||
|
|
||||||
|
nest_indent=len(op_repr)-1,
|
||||||
|
rm_from_first_ln='<',
|
||||||
|
# ^XXX, subtract -1 to account for
|
||||||
|
# <Channel
|
||||||
|
# ^_chevron to be stripped
|
||||||
|
)
|
||||||
start_status: str = (
|
start_status: str = (
|
||||||
'Handling RPC `Start` request\n'
|
'Handling RPC request\n'
|
||||||
f'<= peer: {actorid}\n\n'
|
f'{req_repr}\n'
|
||||||
f' |_{chan}\n'
|
f'\n'
|
||||||
f' |_cid: {cid}\n\n'
|
f'->{{ ipc-context-id: {cid!r}\n'
|
||||||
# f' |_{ns}.{funcname}({kwargs})\n'
|
f'->{{ nsp for fn: `{ns}.{funcname}({kwargs})`\n'
|
||||||
f'>> {actor.uid}\n'
|
|
||||||
f' |_{actor}\n'
|
|
||||||
f' -> nsp: `{ns}.{funcname}({kwargs})`\n'
|
|
||||||
|
|
||||||
# f' |_{ns}.{funcname}({kwargs})\n\n'
|
|
||||||
|
|
||||||
# f'{pretty_struct.pformat(msg)}\n'
|
|
||||||
)
|
)
|
||||||
|
|
||||||
# runtime-internal endpoint: `Actor.<funcname>`
|
# runtime-internal endpoint: `Actor.<funcname>`
|
||||||
|
@ -1097,10 +1142,6 @@ async def process_messages(
|
||||||
await chan.send(err_msg)
|
await chan.send(err_msg)
|
||||||
continue
|
continue
|
||||||
|
|
||||||
start_status += (
|
|
||||||
f' -> func: {func}\n'
|
|
||||||
)
|
|
||||||
|
|
||||||
# schedule a task for the requested RPC function
|
# schedule a task for the requested RPC function
|
||||||
# in the actor's main "service nursery".
|
# in the actor's main "service nursery".
|
||||||
#
|
#
|
||||||
|
@ -1108,7 +1149,7 @@ async def process_messages(
|
||||||
# supervision isolation? would avoid having to
|
# supervision isolation? would avoid having to
|
||||||
# manage RPC tasks individually in `._rpc_tasks`
|
# manage RPC tasks individually in `._rpc_tasks`
|
||||||
# table?
|
# table?
|
||||||
start_status += ' -> scheduling new task..\n'
|
start_status += '->( scheduling new task..\n'
|
||||||
log.runtime(start_status)
|
log.runtime(start_status)
|
||||||
try:
|
try:
|
||||||
ctx: Context = await actor._service_n.start(
|
ctx: Context = await actor._service_n.start(
|
||||||
|
@ -1192,12 +1233,24 @@ async def process_messages(
|
||||||
# END-OF `async for`:
|
# END-OF `async for`:
|
||||||
# IPC disconnected via `trio.EndOfChannel`, likely
|
# IPC disconnected via `trio.EndOfChannel`, likely
|
||||||
# due to a (graceful) `Channel.aclose()`.
|
# due to a (graceful) `Channel.aclose()`.
|
||||||
|
|
||||||
|
chan_op_repr: str = '<=x] '
|
||||||
|
chan_repr: str = _pformat.nest_from_op(
|
||||||
|
input_op=chan_op_repr,
|
||||||
|
op_suffix='',
|
||||||
|
nest_prefix='',
|
||||||
|
text=chan.pformat(),
|
||||||
|
nest_indent=len(chan_op_repr)-1,
|
||||||
|
rm_from_first_ln='<',
|
||||||
|
)
|
||||||
log.runtime(
|
log.runtime(
|
||||||
f'channel for {chan.uid} disconnected, cancelling RPC tasks\n'
|
f'IPC channel disconnected\n'
|
||||||
f'|_{chan}\n'
|
f'{chan_repr}\n'
|
||||||
|
f'\n'
|
||||||
|
f'->c) cancelling RPC tasks.\n'
|
||||||
)
|
)
|
||||||
await actor.cancel_rpc_tasks(
|
await actor.cancel_rpc_tasks(
|
||||||
req_uid=actor.uid,
|
req_aid=actor.aid,
|
||||||
# a "self cancel" in terms of the lifetime of the
|
# a "self cancel" in terms of the lifetime of the
|
||||||
# IPC connection which is presumed to be the
|
# IPC connection which is presumed to be the
|
||||||
# source of any requests for spawned tasks.
|
# source of any requests for spawned tasks.
|
||||||
|
@ -1269,13 +1322,37 @@ async def process_messages(
|
||||||
finally:
|
finally:
|
||||||
# msg debugging for when he machinery is brokey
|
# msg debugging for when he machinery is brokey
|
||||||
if msg is None:
|
if msg is None:
|
||||||
message: str = 'Exiting IPC msg loop without receiving a msg?'
|
message: str = 'Exiting RPC-loop without receiving a msg?'
|
||||||
else:
|
else:
|
||||||
|
task_op_repr: str = ')>'
|
||||||
|
task: trio.Task = trio.lowlevel.current_task()
|
||||||
|
|
||||||
|
# maybe add cancelled opt prefix
|
||||||
|
if task._cancel_status.effectively_cancelled:
|
||||||
|
task_op_repr = 'c' + task_op_repr
|
||||||
|
|
||||||
|
task_repr: str = _pformat.nest_from_op(
|
||||||
|
input_op=task_op_repr,
|
||||||
|
text=f'{task!r}',
|
||||||
|
nest_indent=1,
|
||||||
|
)
|
||||||
|
# chan_op_repr: str = '<=} '
|
||||||
|
# chan_repr: str = _pformat.nest_from_op(
|
||||||
|
# input_op=chan_op_repr,
|
||||||
|
# op_suffix='',
|
||||||
|
# nest_prefix='',
|
||||||
|
# text=chan.pformat(),
|
||||||
|
# nest_indent=len(chan_op_repr)-1,
|
||||||
|
# rm_from_first_ln='<',
|
||||||
|
# )
|
||||||
message: str = (
|
message: str = (
|
||||||
'Exiting IPC msg loop with final msg\n\n'
|
f'Exiting RPC-loop with final msg\n'
|
||||||
f'<= peer: {chan.uid}\n'
|
f'\n'
|
||||||
f' |_{chan}\n\n'
|
# f'{chan_repr}\n'
|
||||||
# f'{pretty_struct.pformat(msg)}'
|
f'{task_repr}\n'
|
||||||
|
f'\n'
|
||||||
|
f'{pretty_struct.pformat(msg)}'
|
||||||
|
f'\n'
|
||||||
)
|
)
|
||||||
|
|
||||||
log.runtime(message)
|
log.runtime(message)
|
||||||
|
|
|
@ -55,6 +55,7 @@ from typing import (
|
||||||
TYPE_CHECKING,
|
TYPE_CHECKING,
|
||||||
)
|
)
|
||||||
import uuid
|
import uuid
|
||||||
|
import textwrap
|
||||||
from types import ModuleType
|
from types import ModuleType
|
||||||
import warnings
|
import warnings
|
||||||
|
|
||||||
|
@ -73,6 +74,9 @@ from tractor.msg import (
|
||||||
pretty_struct,
|
pretty_struct,
|
||||||
types as msgtypes,
|
types as msgtypes,
|
||||||
)
|
)
|
||||||
|
from .trionics import (
|
||||||
|
collapse_eg,
|
||||||
|
)
|
||||||
from .ipc import (
|
from .ipc import (
|
||||||
Channel,
|
Channel,
|
||||||
# IPCServer, # causes cycles atm..
|
# IPCServer, # causes cycles atm..
|
||||||
|
@ -97,7 +101,10 @@ from ._exceptions import (
|
||||||
MsgTypeError,
|
MsgTypeError,
|
||||||
unpack_error,
|
unpack_error,
|
||||||
)
|
)
|
||||||
from .devx import _debug
|
from .devx import (
|
||||||
|
debug,
|
||||||
|
pformat as _pformat
|
||||||
|
)
|
||||||
from ._discovery import get_registry
|
from ._discovery import get_registry
|
||||||
from ._portal import Portal
|
from ._portal import Portal
|
||||||
from . import _state
|
from . import _state
|
||||||
|
@ -206,7 +213,7 @@ class Actor:
|
||||||
*,
|
*,
|
||||||
enable_modules: list[str] = [],
|
enable_modules: list[str] = [],
|
||||||
loglevel: str|None = None,
|
loglevel: str|None = None,
|
||||||
registry_addrs: list[UnwrappedAddress]|None = None,
|
registry_addrs: list[Address]|None = None,
|
||||||
spawn_method: str|None = None,
|
spawn_method: str|None = None,
|
||||||
|
|
||||||
# TODO: remove!
|
# TODO: remove!
|
||||||
|
@ -227,7 +234,7 @@ class Actor:
|
||||||
|
|
||||||
# state
|
# state
|
||||||
self._cancel_complete = trio.Event()
|
self._cancel_complete = trio.Event()
|
||||||
self._cancel_called_by_remote: tuple[str, tuple]|None = None
|
self._cancel_called_by: tuple[str, tuple]|None = None
|
||||||
self._cancel_called: bool = False
|
self._cancel_called: bool = False
|
||||||
|
|
||||||
# retreive and store parent `__main__` data which
|
# retreive and store parent `__main__` data which
|
||||||
|
@ -237,7 +244,7 @@ class Actor:
|
||||||
# TODO? only add this when `is_debug_mode() == True` no?
|
# TODO? only add this when `is_debug_mode() == True` no?
|
||||||
# always include debugging tools module
|
# always include debugging tools module
|
||||||
if _state.is_root_process():
|
if _state.is_root_process():
|
||||||
enable_modules.append('tractor.devx._debug')
|
enable_modules.append('tractor.devx.debug._tty_lock')
|
||||||
|
|
||||||
self.enable_modules: dict[str, str] = get_mod_nsps2fps(
|
self.enable_modules: dict[str, str] = get_mod_nsps2fps(
|
||||||
mod_ns_paths=enable_modules,
|
mod_ns_paths=enable_modules,
|
||||||
|
@ -249,11 +256,12 @@ class Actor:
|
||||||
if arbiter_addr is not None:
|
if arbiter_addr is not None:
|
||||||
warnings.warn(
|
warnings.warn(
|
||||||
'`Actor(arbiter_addr=<blah>)` is now deprecated.\n'
|
'`Actor(arbiter_addr=<blah>)` is now deprecated.\n'
|
||||||
'Use `registry_addrs: list[tuple]` instead.',
|
'Use `registry_addrs: list[Address]` instead.',
|
||||||
DeprecationWarning,
|
DeprecationWarning,
|
||||||
stacklevel=2,
|
stacklevel=2,
|
||||||
)
|
)
|
||||||
registry_addrs: list[UnwrappedAddress] = [arbiter_addr]
|
|
||||||
|
registry_addrs: list[Address] = [wrap_address(arbiter_addr)]
|
||||||
|
|
||||||
# marked by the process spawning backend at startup
|
# marked by the process spawning backend at startup
|
||||||
# will be None for the parent most process started manually
|
# will be None for the parent most process started manually
|
||||||
|
@ -292,8 +300,10 @@ class Actor:
|
||||||
# input via the validator.
|
# input via the validator.
|
||||||
self._reg_addrs: list[UnwrappedAddress] = []
|
self._reg_addrs: list[UnwrappedAddress] = []
|
||||||
if registry_addrs:
|
if registry_addrs:
|
||||||
self.reg_addrs: list[UnwrappedAddress] = registry_addrs
|
_state._runtime_vars['_registry_addrs'] = self.reg_addrs = [
|
||||||
_state._runtime_vars['_registry_addrs'] = registry_addrs
|
addr.unwrap()
|
||||||
|
for addr in registry_addrs
|
||||||
|
]
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def aid(self) -> msgtypes.Aid:
|
def aid(self) -> msgtypes.Aid:
|
||||||
|
@ -339,46 +349,125 @@ class Actor:
|
||||||
def pid(self) -> int:
|
def pid(self) -> int:
|
||||||
return self._aid.pid
|
return self._aid.pid
|
||||||
|
|
||||||
def pformat(self) -> str:
|
@property
|
||||||
ds: str = '='
|
def repr_state(self) -> str:
|
||||||
parent_uid: tuple|None = None
|
if self.cancel_complete:
|
||||||
if rent_chan := self._parent_chan:
|
return 'cancelled'
|
||||||
parent_uid = rent_chan.uid
|
|
||||||
|
elif canceller := self.cancel_caller:
|
||||||
|
return f' and cancel-called by {canceller}'
|
||||||
|
|
||||||
|
else:
|
||||||
|
return 'running'
|
||||||
|
|
||||||
|
def pformat(
|
||||||
|
self,
|
||||||
|
ds: str = ': ',
|
||||||
|
indent: int = 0,
|
||||||
|
privates: bool = False,
|
||||||
|
) -> str:
|
||||||
|
|
||||||
|
fmtstr: str = f'|_id: {self.aid.reprol()!r}\n'
|
||||||
|
if privates:
|
||||||
|
aid_nest_prefix: str = '|_aid='
|
||||||
|
aid_field_repr: str = _pformat.nest_from_op(
|
||||||
|
input_op='',
|
||||||
|
text=pretty_struct.pformat(
|
||||||
|
struct=self.aid,
|
||||||
|
field_indent=2,
|
||||||
|
),
|
||||||
|
op_suffix='',
|
||||||
|
nest_prefix=aid_nest_prefix,
|
||||||
|
nest_indent=0,
|
||||||
|
)
|
||||||
|
fmtstr: str = f'{aid_field_repr}'
|
||||||
|
|
||||||
|
if rent_chan := self._parent_chan:
|
||||||
|
fmtstr += (
|
||||||
|
f"|_parent{ds}{rent_chan.aid.reprol()}\n"
|
||||||
|
)
|
||||||
|
|
||||||
peers: list = []
|
|
||||||
server: _server.IPCServer = self.ipc_server
|
server: _server.IPCServer = self.ipc_server
|
||||||
if server:
|
if server:
|
||||||
peers: list[tuple] = list(server._peer_connected)
|
if privates:
|
||||||
|
server_repr: str = self._ipc_server.pformat(
|
||||||
|
privates=privates,
|
||||||
|
)
|
||||||
|
# create field ln as a key-header indented under
|
||||||
|
# and up to the section's key prefix.
|
||||||
|
# ^XXX if we were to indent `repr(Server)` to
|
||||||
|
# '<key>: '
|
||||||
|
# _here_^
|
||||||
|
server_repr: str = _pformat.nest_from_op(
|
||||||
|
input_op='', # nest as sub-obj
|
||||||
|
op_suffix='',
|
||||||
|
text=server_repr,
|
||||||
|
)
|
||||||
|
fmtstr += (
|
||||||
|
f"{server_repr}"
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
fmtstr += (
|
||||||
|
f'|_ipc: {server.repr_state!r}\n'
|
||||||
|
)
|
||||||
|
|
||||||
fmtstr: str = (
|
fmtstr += (
|
||||||
f' |_id: {self.aid!r}\n'
|
f'|_rpc: {len(self._rpc_tasks)} active tasks\n'
|
||||||
# f" aid{ds}{self.aid!r}\n"
|
|
||||||
f" parent{ds}{parent_uid}\n"
|
|
||||||
f'\n'
|
|
||||||
f' |_ipc: {len(peers)!r} connected peers\n'
|
|
||||||
f" peers{ds}{peers!r}\n"
|
|
||||||
f" ipc_server{ds}{self._ipc_server}\n"
|
|
||||||
f'\n'
|
|
||||||
f' |_rpc: {len(self._rpc_tasks)} tasks\n'
|
|
||||||
f" ctxs{ds}{len(self._contexts)}\n"
|
|
||||||
f'\n'
|
|
||||||
f' |_runtime: ._task{ds}{self._task!r}\n'
|
|
||||||
f' _spawn_method{ds}{self._spawn_method}\n'
|
|
||||||
f' _actoruid2nursery{ds}{self._actoruid2nursery}\n'
|
|
||||||
f' _forkserver_info{ds}{self._forkserver_info}\n'
|
|
||||||
f'\n'
|
|
||||||
f' |_state: "TODO: .repr_state()"\n'
|
|
||||||
f' _cancel_complete{ds}{self._cancel_complete}\n'
|
|
||||||
f' _cancel_called_by_remote{ds}{self._cancel_called_by_remote}\n'
|
|
||||||
f' _cancel_called{ds}{self._cancel_called}\n'
|
|
||||||
)
|
)
|
||||||
return (
|
|
||||||
'<Actor(\n'
|
# TODO, actually fix the .repr_state impl/output?
|
||||||
+
|
# append ipc-ctx state summary
|
||||||
fmtstr
|
# ctxs: dict = self._contexts
|
||||||
+
|
# if ctxs:
|
||||||
')>\n'
|
# ctx_states: dict[str, int] = {}
|
||||||
|
# for ctx in self._contexts.values():
|
||||||
|
# ctx_state: str = ctx.repr_state
|
||||||
|
# cnt = ctx_states.setdefault(ctx_state, 0)
|
||||||
|
# ctx_states[ctx_state] = cnt + 1
|
||||||
|
|
||||||
|
# fmtstr += (
|
||||||
|
# f" ctxs{ds}{ctx_states}\n"
|
||||||
|
# )
|
||||||
|
|
||||||
|
# runtime-state
|
||||||
|
task_name: str = '<dne>'
|
||||||
|
if task := self._task:
|
||||||
|
task_name: str = task.name
|
||||||
|
fmtstr += (
|
||||||
|
# TODO, this just like ctx?
|
||||||
|
f'|_state: {self.repr_state!r}\n'
|
||||||
|
f' task: {task_name}\n'
|
||||||
|
f' loglevel: {self.loglevel!r}\n'
|
||||||
|
f' subactors_spawned: {len(self._actoruid2nursery)}\n'
|
||||||
)
|
)
|
||||||
|
if not _state.is_root_process():
|
||||||
|
fmtstr += f' spawn_method: {self._spawn_method!r}\n'
|
||||||
|
|
||||||
|
if privates:
|
||||||
|
fmtstr += (
|
||||||
|
# f' actoruid2nursery{ds}{self._actoruid2nursery}\n'
|
||||||
|
f' cancel_complete{ds}{self._cancel_complete}\n'
|
||||||
|
f' cancel_called_by_remote{ds}{self._cancel_called_by}\n'
|
||||||
|
f' cancel_called{ds}{self._cancel_called}\n'
|
||||||
|
)
|
||||||
|
|
||||||
|
if fmtstr:
|
||||||
|
fmtstr: str = textwrap.indent(
|
||||||
|
text=fmtstr,
|
||||||
|
prefix=' '*(1 + indent),
|
||||||
|
)
|
||||||
|
|
||||||
|
_repr: str = (
|
||||||
|
f'<{type(self).__name__}(\n'
|
||||||
|
f'{fmtstr}'
|
||||||
|
f')>\n'
|
||||||
|
)
|
||||||
|
if indent:
|
||||||
|
_repr: str = textwrap.indent(
|
||||||
|
text=_repr,
|
||||||
|
prefix=' '*indent,
|
||||||
|
)
|
||||||
|
return _repr
|
||||||
|
|
||||||
__repr__ = pformat
|
__repr__ = pformat
|
||||||
|
|
||||||
|
@ -386,7 +475,11 @@ class Actor:
|
||||||
def reg_addrs(self) -> list[UnwrappedAddress]:
|
def reg_addrs(self) -> list[UnwrappedAddress]:
|
||||||
'''
|
'''
|
||||||
List of (socket) addresses for all known (and contactable)
|
List of (socket) addresses for all known (and contactable)
|
||||||
registry actors.
|
registry-service actors in "unwrapped" (i.e. IPC interchange
|
||||||
|
wire-compat) form.
|
||||||
|
|
||||||
|
If you are looking for the "wrapped" address form, use
|
||||||
|
`.registry_addrs` instead.
|
||||||
|
|
||||||
'''
|
'''
|
||||||
return self._reg_addrs
|
return self._reg_addrs
|
||||||
|
@ -405,8 +498,14 @@ class Actor:
|
||||||
|
|
||||||
self._reg_addrs = addrs
|
self._reg_addrs = addrs
|
||||||
|
|
||||||
|
@property
|
||||||
|
def registry_addrs(self) -> list[Address]:
|
||||||
|
return [wrap_address(uw_addr)
|
||||||
|
for uw_addr in self.reg_addrs]
|
||||||
|
|
||||||
def load_modules(
|
def load_modules(
|
||||||
self,
|
self,
|
||||||
|
|
||||||
) -> None:
|
) -> None:
|
||||||
'''
|
'''
|
||||||
Load explicitly enabled python modules from local fs after
|
Load explicitly enabled python modules from local fs after
|
||||||
|
@ -496,11 +595,11 @@ class Actor:
|
||||||
queue.
|
queue.
|
||||||
|
|
||||||
'''
|
'''
|
||||||
uid: tuple[str, str] = chan.uid
|
aid: msgtypes.Aid = chan.aid
|
||||||
assert uid, f"`chan.uid` can't be {uid}"
|
assert aid, f"`chan.aid` can't be {aid}"
|
||||||
try:
|
try:
|
||||||
ctx: Context = self._contexts[(
|
ctx: Context = self._contexts[(
|
||||||
uid,
|
aid.uid,
|
||||||
cid,
|
cid,
|
||||||
|
|
||||||
# TODO: how to determine this tho?
|
# TODO: how to determine this tho?
|
||||||
|
@ -511,7 +610,7 @@ class Actor:
|
||||||
'Ignoring invalid IPC msg!?\n'
|
'Ignoring invalid IPC msg!?\n'
|
||||||
f'Ctx seems to not/no-longer exist??\n'
|
f'Ctx seems to not/no-longer exist??\n'
|
||||||
f'\n'
|
f'\n'
|
||||||
f'<=? {uid}\n'
|
f'<=? {aid.reprol()!r}\n'
|
||||||
f' |_{pretty_struct.pformat(msg)}\n'
|
f' |_{pretty_struct.pformat(msg)}\n'
|
||||||
)
|
)
|
||||||
match msg:
|
match msg:
|
||||||
|
@ -560,6 +659,7 @@ class Actor:
|
||||||
msging session's lifetime.
|
msging session's lifetime.
|
||||||
|
|
||||||
'''
|
'''
|
||||||
|
# ?TODO, use Aid here as well?
|
||||||
actor_uid = chan.uid
|
actor_uid = chan.uid
|
||||||
assert actor_uid
|
assert actor_uid
|
||||||
try:
|
try:
|
||||||
|
@ -908,6 +1008,22 @@ class Actor:
|
||||||
None, # self cancel all rpc tasks
|
None, # self cancel all rpc tasks
|
||||||
)
|
)
|
||||||
|
|
||||||
|
@property
|
||||||
|
def cancel_complete(self) -> bool:
|
||||||
|
return self._cancel_complete.is_set()
|
||||||
|
|
||||||
|
@property
|
||||||
|
def cancel_called(self) -> bool:
|
||||||
|
'''
|
||||||
|
Was this actor requested to cancel by a remote peer actor.
|
||||||
|
|
||||||
|
'''
|
||||||
|
return self._cancel_called_by is not None
|
||||||
|
|
||||||
|
@property
|
||||||
|
def cancel_caller(self) -> msgtypes.Aid|None:
|
||||||
|
return self._cancel_called_by
|
||||||
|
|
||||||
async def cancel(
|
async def cancel(
|
||||||
self,
|
self,
|
||||||
|
|
||||||
|
@ -932,20 +1048,18 @@ class Actor:
|
||||||
|
|
||||||
'''
|
'''
|
||||||
(
|
(
|
||||||
requesting_uid,
|
requesting_aid, # Aid
|
||||||
requester_type,
|
requester_type, # str
|
||||||
req_chan,
|
req_chan,
|
||||||
log_meth,
|
log_meth,
|
||||||
) = (
|
) = (
|
||||||
req_chan.uid,
|
req_chan.aid,
|
||||||
'peer',
|
'peer',
|
||||||
req_chan,
|
req_chan,
|
||||||
log.cancel,
|
log.cancel,
|
||||||
|
|
||||||
) if req_chan else (
|
) if req_chan else (
|
||||||
|
|
||||||
# a self cancel of ALL rpc tasks
|
# a self cancel of ALL rpc tasks
|
||||||
self.uid,
|
self.aid,
|
||||||
'self',
|
'self',
|
||||||
self,
|
self,
|
||||||
log.runtime,
|
log.runtime,
|
||||||
|
@ -953,14 +1067,14 @@ class Actor:
|
||||||
# TODO: just use the new `Context.repr_rpc: str` (and
|
# TODO: just use the new `Context.repr_rpc: str` (and
|
||||||
# other) repr fields instead of doing this all manual..
|
# other) repr fields instead of doing this all manual..
|
||||||
msg: str = (
|
msg: str = (
|
||||||
f'Actor-runtime cancel request from {requester_type}\n\n'
|
f'Actor-runtime cancel request from {requester_type!r}\n'
|
||||||
f'<=c) {requesting_uid}\n'
|
|
||||||
f' |_{self}\n'
|
|
||||||
f'\n'
|
f'\n'
|
||||||
|
f'<=c)\n'
|
||||||
|
f'{self}'
|
||||||
)
|
)
|
||||||
|
|
||||||
# TODO: what happens here when we self-cancel tho?
|
# TODO: what happens here when we self-cancel tho?
|
||||||
self._cancel_called_by_remote: tuple = requesting_uid
|
self._cancel_called_by: tuple = requesting_aid
|
||||||
self._cancel_called = True
|
self._cancel_called = True
|
||||||
|
|
||||||
# cancel all ongoing rpc tasks
|
# cancel all ongoing rpc tasks
|
||||||
|
@ -968,7 +1082,7 @@ class Actor:
|
||||||
|
|
||||||
# kill any debugger request task to avoid deadlock
|
# kill any debugger request task to avoid deadlock
|
||||||
# with the root actor in this tree
|
# with the root actor in this tree
|
||||||
debug_req = _debug.DebugStatus
|
debug_req = debug.DebugStatus
|
||||||
lock_req_ctx: Context = debug_req.req_ctx
|
lock_req_ctx: Context = debug_req.req_ctx
|
||||||
if (
|
if (
|
||||||
lock_req_ctx
|
lock_req_ctx
|
||||||
|
@ -978,7 +1092,7 @@ class Actor:
|
||||||
msg += (
|
msg += (
|
||||||
f'\n'
|
f'\n'
|
||||||
f'-> Cancelling active debugger request..\n'
|
f'-> Cancelling active debugger request..\n'
|
||||||
f'|_{_debug.Lock.repr()}\n\n'
|
f'|_{debug.Lock.repr()}\n\n'
|
||||||
f'|_{lock_req_ctx}\n\n'
|
f'|_{lock_req_ctx}\n\n'
|
||||||
)
|
)
|
||||||
# lock_req_ctx._scope.cancel()
|
# lock_req_ctx._scope.cancel()
|
||||||
|
@ -988,7 +1102,7 @@ class Actor:
|
||||||
|
|
||||||
# self-cancel **all** ongoing RPC tasks
|
# self-cancel **all** ongoing RPC tasks
|
||||||
await self.cancel_rpc_tasks(
|
await self.cancel_rpc_tasks(
|
||||||
req_uid=requesting_uid,
|
req_aid=requesting_aid,
|
||||||
parent_chan=None,
|
parent_chan=None,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
@ -1017,7 +1131,7 @@ class Actor:
|
||||||
self,
|
self,
|
||||||
cid: str,
|
cid: str,
|
||||||
parent_chan: Channel,
|
parent_chan: Channel,
|
||||||
requesting_uid: tuple[str, str]|None,
|
requesting_aid: msgtypes.Aid|None,
|
||||||
|
|
||||||
ipc_msg: dict|None|bool = False,
|
ipc_msg: dict|None|bool = False,
|
||||||
|
|
||||||
|
@ -1055,7 +1169,7 @@ class Actor:
|
||||||
log.runtime(
|
log.runtime(
|
||||||
'Cancel request for invalid RPC task.\n'
|
'Cancel request for invalid RPC task.\n'
|
||||||
'The task likely already completed or was never started!\n\n'
|
'The task likely already completed or was never started!\n\n'
|
||||||
f'<= canceller: {requesting_uid}\n'
|
f'<= canceller: {requesting_aid}\n'
|
||||||
f'=> {cid}@{parent_chan.uid}\n'
|
f'=> {cid}@{parent_chan.uid}\n'
|
||||||
f' |_{parent_chan}\n'
|
f' |_{parent_chan}\n'
|
||||||
)
|
)
|
||||||
|
@ -1063,9 +1177,12 @@ class Actor:
|
||||||
|
|
||||||
log.cancel(
|
log.cancel(
|
||||||
'Rxed cancel request for RPC task\n'
|
'Rxed cancel request for RPC task\n'
|
||||||
f'<=c) {requesting_uid}\n'
|
f'{ctx._task!r} <=c) {requesting_aid}\n'
|
||||||
f' |_{ctx._task}\n'
|
f'|_>> {ctx.repr_rpc}\n'
|
||||||
f' >> {ctx.repr_rpc}\n'
|
|
||||||
|
# f'|_{ctx._task}\n'
|
||||||
|
# f' >> {ctx.repr_rpc}\n'
|
||||||
|
|
||||||
# f'=> {ctx._task}\n'
|
# f'=> {ctx._task}\n'
|
||||||
# f' >> Actor._cancel_task() => {ctx._task}\n'
|
# f' >> Actor._cancel_task() => {ctx._task}\n'
|
||||||
# f' |_ {ctx._task}\n\n'
|
# f' |_ {ctx._task}\n\n'
|
||||||
|
@ -1086,9 +1203,9 @@ class Actor:
|
||||||
)
|
)
|
||||||
if (
|
if (
|
||||||
ctx._canceller is None
|
ctx._canceller is None
|
||||||
and requesting_uid
|
and requesting_aid
|
||||||
):
|
):
|
||||||
ctx._canceller: tuple = requesting_uid
|
ctx._canceller: tuple = requesting_aid.uid
|
||||||
|
|
||||||
# TODO: pack the RPC `{'cmd': <blah>}` msg into a ctxc and
|
# TODO: pack the RPC `{'cmd': <blah>}` msg into a ctxc and
|
||||||
# then raise and pack it here?
|
# then raise and pack it here?
|
||||||
|
@ -1114,7 +1231,7 @@ class Actor:
|
||||||
|
|
||||||
# wait for _invoke to mark the task complete
|
# wait for _invoke to mark the task complete
|
||||||
flow_info: str = (
|
flow_info: str = (
|
||||||
f'<= canceller: {requesting_uid}\n'
|
f'<= canceller: {requesting_aid}\n'
|
||||||
f'=> ipc-parent: {parent_chan}\n'
|
f'=> ipc-parent: {parent_chan}\n'
|
||||||
f'|_{ctx}\n'
|
f'|_{ctx}\n'
|
||||||
)
|
)
|
||||||
|
@ -1131,7 +1248,7 @@ class Actor:
|
||||||
|
|
||||||
async def cancel_rpc_tasks(
|
async def cancel_rpc_tasks(
|
||||||
self,
|
self,
|
||||||
req_uid: tuple[str, str],
|
req_aid: msgtypes.Aid,
|
||||||
|
|
||||||
# NOTE: when None is passed we cancel **all** rpc
|
# NOTE: when None is passed we cancel **all** rpc
|
||||||
# tasks running in this actor!
|
# tasks running in this actor!
|
||||||
|
@ -1148,7 +1265,7 @@ class Actor:
|
||||||
if not tasks:
|
if not tasks:
|
||||||
log.runtime(
|
log.runtime(
|
||||||
'Actor has no cancellable RPC tasks?\n'
|
'Actor has no cancellable RPC tasks?\n'
|
||||||
f'<= canceller: {req_uid}\n'
|
f'<= canceller: {req_aid.reprol()}\n'
|
||||||
)
|
)
|
||||||
return
|
return
|
||||||
|
|
||||||
|
@ -1188,7 +1305,7 @@ class Actor:
|
||||||
)
|
)
|
||||||
log.cancel(
|
log.cancel(
|
||||||
f'Cancelling {descr} RPC tasks\n\n'
|
f'Cancelling {descr} RPC tasks\n\n'
|
||||||
f'<=c) {req_uid} [canceller]\n'
|
f'<=c) {req_aid} [canceller]\n'
|
||||||
f'{rent_chan_repr}'
|
f'{rent_chan_repr}'
|
||||||
f'c)=> {self.uid} [cancellee]\n'
|
f'c)=> {self.uid} [cancellee]\n'
|
||||||
f' |_{self} [with {len(tasks)} tasks]\n'
|
f' |_{self} [with {len(tasks)} tasks]\n'
|
||||||
|
@ -1216,7 +1333,7 @@ class Actor:
|
||||||
await self._cancel_task(
|
await self._cancel_task(
|
||||||
cid,
|
cid,
|
||||||
task_caller_chan,
|
task_caller_chan,
|
||||||
requesting_uid=req_uid,
|
requesting_aid=req_aid,
|
||||||
)
|
)
|
||||||
|
|
||||||
if tasks:
|
if tasks:
|
||||||
|
@ -1261,7 +1378,7 @@ class Actor:
|
||||||
Return all IPC channels to the actor with provided `uid`.
|
Return all IPC channels to the actor with provided `uid`.
|
||||||
|
|
||||||
'''
|
'''
|
||||||
return self._peers[uid]
|
return self._ipc_server._peers[uid]
|
||||||
|
|
||||||
def is_infected_aio(self) -> bool:
|
def is_infected_aio(self) -> bool:
|
||||||
'''
|
'''
|
||||||
|
@ -1308,7 +1425,7 @@ async def async_main(
|
||||||
|
|
||||||
# attempt to retreive ``trio``'s sigint handler and stash it
|
# attempt to retreive ``trio``'s sigint handler and stash it
|
||||||
# on our debugger state.
|
# on our debugger state.
|
||||||
_debug.DebugStatus._trio_handler = signal.getsignal(signal.SIGINT)
|
debug.DebugStatus._trio_handler = signal.getsignal(signal.SIGINT)
|
||||||
|
|
||||||
is_registered: bool = False
|
is_registered: bool = False
|
||||||
try:
|
try:
|
||||||
|
@ -1316,6 +1433,8 @@ async def async_main(
|
||||||
# establish primary connection with immediate parent
|
# establish primary connection with immediate parent
|
||||||
actor._parent_chan: Channel|None = None
|
actor._parent_chan: Channel|None = None
|
||||||
|
|
||||||
|
# is this a sub-actor?
|
||||||
|
# get runtime info from parent.
|
||||||
if parent_addr is not None:
|
if parent_addr is not None:
|
||||||
(
|
(
|
||||||
actor._parent_chan,
|
actor._parent_chan,
|
||||||
|
@ -1350,18 +1469,18 @@ async def async_main(
|
||||||
# parent is kept alive as a resilient service until
|
# parent is kept alive as a resilient service until
|
||||||
# cancellation steps have (mostly) occurred in
|
# cancellation steps have (mostly) occurred in
|
||||||
# a deterministic way.
|
# a deterministic way.
|
||||||
async with trio.open_nursery(
|
root_tn: trio.Nursery
|
||||||
strict_exception_groups=False,
|
async with (
|
||||||
) as root_nursery:
|
collapse_eg(),
|
||||||
actor._root_n = root_nursery
|
trio.open_nursery() as root_tn,
|
||||||
|
):
|
||||||
|
actor._root_n = root_tn
|
||||||
assert actor._root_n
|
assert actor._root_n
|
||||||
|
|
||||||
ipc_server: _server.IPCServer
|
ipc_server: _server.IPCServer
|
||||||
async with (
|
async with (
|
||||||
trio.open_nursery(
|
collapse_eg(),
|
||||||
strict_exception_groups=False,
|
trio.open_nursery() as service_nursery,
|
||||||
) as service_nursery,
|
|
||||||
|
|
||||||
_server.open_ipc_server(
|
_server.open_ipc_server(
|
||||||
parent_tn=service_nursery,
|
parent_tn=service_nursery,
|
||||||
stream_handler_tn=service_nursery,
|
stream_handler_tn=service_nursery,
|
||||||
|
@ -1401,7 +1520,7 @@ async def async_main(
|
||||||
# try:
|
# try:
|
||||||
# actor.load_modules()
|
# actor.load_modules()
|
||||||
# except ModuleNotFoundError as err:
|
# except ModuleNotFoundError as err:
|
||||||
# _debug.pause_from_sync()
|
# debug.pause_from_sync()
|
||||||
# import pdbp; pdbp.set_trace()
|
# import pdbp; pdbp.set_trace()
|
||||||
# raise
|
# raise
|
||||||
|
|
||||||
|
@ -1412,9 +1531,6 @@ async def async_main(
|
||||||
|
|
||||||
# TODO: why is this not with the root nursery?
|
# TODO: why is this not with the root nursery?
|
||||||
try:
|
try:
|
||||||
log.runtime(
|
|
||||||
'Booting IPC server'
|
|
||||||
)
|
|
||||||
eps: list = await ipc_server.listen_on(
|
eps: list = await ipc_server.listen_on(
|
||||||
accept_addrs=accept_addrs,
|
accept_addrs=accept_addrs,
|
||||||
stream_handler_nursery=service_nursery,
|
stream_handler_nursery=service_nursery,
|
||||||
|
@ -1433,7 +1549,7 @@ async def async_main(
|
||||||
# tranport address bind errors - normally it's
|
# tranport address bind errors - normally it's
|
||||||
# something silly like the wrong socket-address
|
# something silly like the wrong socket-address
|
||||||
# passed via a config or CLI Bo
|
# passed via a config or CLI Bo
|
||||||
entered_debug: bool = await _debug._maybe_enter_pm(
|
entered_debug: bool = await debug._maybe_enter_pm(
|
||||||
oserr,
|
oserr,
|
||||||
)
|
)
|
||||||
if not entered_debug:
|
if not entered_debug:
|
||||||
|
@ -1446,18 +1562,6 @@ async def async_main(
|
||||||
# TODO, just read direct from ipc_server?
|
# TODO, just read direct from ipc_server?
|
||||||
accept_addrs: list[UnwrappedAddress] = actor.accept_addrs
|
accept_addrs: list[UnwrappedAddress] = actor.accept_addrs
|
||||||
|
|
||||||
# NOTE: only set the loopback addr for the
|
|
||||||
# process-tree-global "root" mailbox since
|
|
||||||
# all sub-actors should be able to speak to
|
|
||||||
# their root actor over that channel.
|
|
||||||
if _state._runtime_vars['_is_root']:
|
|
||||||
raddrs: list[Address] = _state._runtime_vars['_root_addrs']
|
|
||||||
for addr in accept_addrs:
|
|
||||||
waddr: Address = wrap_address(addr)
|
|
||||||
raddrs.append(addr)
|
|
||||||
else:
|
|
||||||
_state._runtime_vars['_root_mailbox'] = raddrs[0]
|
|
||||||
|
|
||||||
# Register with the arbiter if we're told its addr
|
# Register with the arbiter if we're told its addr
|
||||||
log.runtime(
|
log.runtime(
|
||||||
f'Registering `{actor.name}` => {pformat(accept_addrs)}\n'
|
f'Registering `{actor.name}` => {pformat(accept_addrs)}\n'
|
||||||
|
@ -1473,8 +1577,9 @@ async def async_main(
|
||||||
waddr = wrap_address(addr)
|
waddr = wrap_address(addr)
|
||||||
assert waddr.is_valid
|
assert waddr.is_valid
|
||||||
except AssertionError:
|
except AssertionError:
|
||||||
await _debug.pause()
|
await debug.pause()
|
||||||
|
|
||||||
|
# !TODO, get rid of the local-portal crap XD
|
||||||
async with get_registry(addr) as reg_portal:
|
async with get_registry(addr) as reg_portal:
|
||||||
for accept_addr in accept_addrs:
|
for accept_addr in accept_addrs:
|
||||||
accept_addr = wrap_address(accept_addr)
|
accept_addr = wrap_address(accept_addr)
|
||||||
|
@ -1499,7 +1604,7 @@ async def async_main(
|
||||||
# start processing parent requests until our channel
|
# start processing parent requests until our channel
|
||||||
# server is 100% up and running.
|
# server is 100% up and running.
|
||||||
if actor._parent_chan:
|
if actor._parent_chan:
|
||||||
await root_nursery.start(
|
await root_tn.start(
|
||||||
partial(
|
partial(
|
||||||
_rpc.process_messages,
|
_rpc.process_messages,
|
||||||
chan=actor._parent_chan,
|
chan=actor._parent_chan,
|
||||||
|
@ -1511,8 +1616,9 @@ async def async_main(
|
||||||
# 'Blocking on service nursery to exit..\n'
|
# 'Blocking on service nursery to exit..\n'
|
||||||
)
|
)
|
||||||
log.runtime(
|
log.runtime(
|
||||||
"Service nursery complete\n"
|
'Service nursery complete\n'
|
||||||
"Waiting on root nursery to complete"
|
'\n'
|
||||||
|
'->} waiting on root nursery to complete..\n'
|
||||||
)
|
)
|
||||||
|
|
||||||
# Blocks here as expected until the root nursery is
|
# Blocks here as expected until the root nursery is
|
||||||
|
@ -1567,6 +1673,7 @@ async def async_main(
|
||||||
finally:
|
finally:
|
||||||
teardown_report: str = (
|
teardown_report: str = (
|
||||||
'Main actor-runtime task completed\n'
|
'Main actor-runtime task completed\n'
|
||||||
|
'\n'
|
||||||
)
|
)
|
||||||
|
|
||||||
# ?TODO? should this be in `._entry`/`._root` mods instead?
|
# ?TODO? should this be in `._entry`/`._root` mods instead?
|
||||||
|
@ -1590,7 +1697,7 @@ async def async_main(
|
||||||
# prevents any `infected_aio` actor from continuing
|
# prevents any `infected_aio` actor from continuing
|
||||||
# and any callbacks in the `ls` here WILL NOT be
|
# and any callbacks in the `ls` here WILL NOT be
|
||||||
# called!!
|
# called!!
|
||||||
# await _debug.pause(shield=True)
|
# await debug.pause(shield=True)
|
||||||
|
|
||||||
ls.close()
|
ls.close()
|
||||||
|
|
||||||
|
@ -1603,12 +1710,13 @@ async def async_main(
|
||||||
#
|
#
|
||||||
# if actor.name == 'brokerd.ib':
|
# if actor.name == 'brokerd.ib':
|
||||||
# with CancelScope(shield=True):
|
# with CancelScope(shield=True):
|
||||||
# await _debug.breakpoint()
|
# await debug.breakpoint()
|
||||||
|
|
||||||
# Unregister actor from the registry-sys / registrar.
|
# Unregister actor from the registry-sys / registrar.
|
||||||
if (
|
if (
|
||||||
is_registered
|
is_registered
|
||||||
and not actor.is_registrar
|
and
|
||||||
|
not actor.is_registrar
|
||||||
):
|
):
|
||||||
failed: bool = False
|
failed: bool = False
|
||||||
for addr in actor.reg_addrs:
|
for addr in actor.reg_addrs:
|
||||||
|
@ -1643,7 +1751,8 @@ async def async_main(
|
||||||
ipc_server.has_peers(check_chans=True)
|
ipc_server.has_peers(check_chans=True)
|
||||||
):
|
):
|
||||||
teardown_report += (
|
teardown_report += (
|
||||||
f'-> Waiting for remaining peers {ipc_server._peers} to clear..\n'
|
f'-> Waiting for remaining peers to clear..\n'
|
||||||
|
f' {pformat(ipc_server._peers)}'
|
||||||
)
|
)
|
||||||
log.runtime(teardown_report)
|
log.runtime(teardown_report)
|
||||||
await ipc_server.wait_for_no_more_peers(
|
await ipc_server.wait_for_no_more_peers(
|
||||||
|
@ -1651,15 +1760,23 @@ async def async_main(
|
||||||
)
|
)
|
||||||
|
|
||||||
teardown_report += (
|
teardown_report += (
|
||||||
'-> All peer channels are complete\n'
|
'-]> all peer channels are complete.\n'
|
||||||
)
|
)
|
||||||
|
|
||||||
|
# op_nested_actor_repr: str = _pformat.nest_from_op(
|
||||||
|
# input_op=')>',
|
||||||
|
# text=actor.pformat(),
|
||||||
|
# nest_prefix='|_',
|
||||||
|
# nest_indent=1, # under >
|
||||||
|
# )
|
||||||
teardown_report += (
|
teardown_report += (
|
||||||
'Actor runtime exiting\n'
|
'-)> actor runtime main task exit.\n'
|
||||||
f'>)\n'
|
# f'{op_nested_actor_repr}'
|
||||||
f'|_{actor}\n'
|
|
||||||
)
|
)
|
||||||
log.info(teardown_report)
|
# if _state._runtime_vars['_is_root']:
|
||||||
|
# log.info(teardown_report)
|
||||||
|
# else:
|
||||||
|
log.runtime(teardown_report)
|
||||||
|
|
||||||
|
|
||||||
# TODO: rename to `Registry` and move to `.discovery._registry`!
|
# TODO: rename to `Registry` and move to `.discovery._registry`!
|
||||||
|
@ -1792,7 +1909,7 @@ class Arbiter(Actor):
|
||||||
waddr: Address = wrap_address(addr)
|
waddr: Address = wrap_address(addr)
|
||||||
if not waddr.is_valid:
|
if not waddr.is_valid:
|
||||||
# should never be 0-dynamic-os-alloc
|
# should never be 0-dynamic-os-alloc
|
||||||
await _debug.pause()
|
await debug.pause()
|
||||||
|
|
||||||
self._registry[uid] = addr
|
self._registry[uid] = addr
|
||||||
|
|
||||||
|
|
|
@ -34,9 +34,9 @@ from typing import (
|
||||||
import trio
|
import trio
|
||||||
from trio import TaskStatus
|
from trio import TaskStatus
|
||||||
|
|
||||||
from .devx._debug import (
|
from .devx import (
|
||||||
maybe_wait_for_debugger,
|
debug,
|
||||||
acquire_debug_lock,
|
pformat as _pformat
|
||||||
)
|
)
|
||||||
from tractor._state import (
|
from tractor._state import (
|
||||||
current_actor,
|
current_actor,
|
||||||
|
@ -51,14 +51,17 @@ from tractor._portal import Portal
|
||||||
from tractor._runtime import Actor
|
from tractor._runtime import Actor
|
||||||
from tractor._entry import _mp_main
|
from tractor._entry import _mp_main
|
||||||
from tractor._exceptions import ActorFailure
|
from tractor._exceptions import ActorFailure
|
||||||
from tractor.msg.types import (
|
from tractor.msg import (
|
||||||
Aid,
|
types as msgtypes,
|
||||||
SpawnSpec,
|
pretty_struct,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
if TYPE_CHECKING:
|
if TYPE_CHECKING:
|
||||||
from ipc import IPCServer
|
from ipc import (
|
||||||
|
_server,
|
||||||
|
Channel,
|
||||||
|
)
|
||||||
from ._supervise import ActorNursery
|
from ._supervise import ActorNursery
|
||||||
ProcessType = TypeVar('ProcessType', mp.Process, trio.Process)
|
ProcessType = TypeVar('ProcessType', mp.Process, trio.Process)
|
||||||
|
|
||||||
|
@ -328,20 +331,21 @@ async def soft_kill(
|
||||||
see `.hard_kill()`).
|
see `.hard_kill()`).
|
||||||
|
|
||||||
'''
|
'''
|
||||||
peer_aid: Aid = portal.channel.aid
|
chan: Channel = portal.channel
|
||||||
|
peer_aid: msgtypes.Aid = chan.aid
|
||||||
try:
|
try:
|
||||||
log.cancel(
|
log.cancel(
|
||||||
f'Soft killing sub-actor via portal request\n'
|
f'Soft killing sub-actor via portal request\n'
|
||||||
f'\n'
|
f'\n'
|
||||||
f'(c=> {peer_aid}\n'
|
f'c)=> {peer_aid.reprol()}@[{chan.maddr}]\n'
|
||||||
f' |_{proc}\n'
|
f' |_{proc}\n'
|
||||||
)
|
)
|
||||||
# wait on sub-proc to signal termination
|
# wait on sub-proc to signal termination
|
||||||
await wait_func(proc)
|
await wait_func(proc)
|
||||||
|
|
||||||
except trio.Cancelled:
|
except trio.Cancelled:
|
||||||
with trio.CancelScope(shield=True):
|
with trio.CancelScope(shield=True):
|
||||||
await maybe_wait_for_debugger(
|
await debug.maybe_wait_for_debugger(
|
||||||
child_in_debug=_runtime_vars.get(
|
child_in_debug=_runtime_vars.get(
|
||||||
'_debug_mode', False
|
'_debug_mode', False
|
||||||
),
|
),
|
||||||
|
@ -465,7 +469,7 @@ async def trio_proc(
|
||||||
"--uid",
|
"--uid",
|
||||||
# TODO, how to pass this over "wire" encodings like
|
# TODO, how to pass this over "wire" encodings like
|
||||||
# cmdline args?
|
# cmdline args?
|
||||||
# -[ ] maybe we can add an `Aid.min_tuple()` ?
|
# -[ ] maybe we can add an `msgtypes.Aid.min_tuple()` ?
|
||||||
str(subactor.uid),
|
str(subactor.uid),
|
||||||
# Address the child must connect to on startup
|
# Address the child must connect to on startup
|
||||||
"--parent_addr",
|
"--parent_addr",
|
||||||
|
@ -483,13 +487,14 @@ async def trio_proc(
|
||||||
|
|
||||||
cancelled_during_spawn: bool = False
|
cancelled_during_spawn: bool = False
|
||||||
proc: trio.Process|None = None
|
proc: trio.Process|None = None
|
||||||
ipc_server: IPCServer = actor_nursery._actor.ipc_server
|
ipc_server: _server.Server = actor_nursery._actor.ipc_server
|
||||||
try:
|
try:
|
||||||
try:
|
try:
|
||||||
proc: trio.Process = await trio.lowlevel.open_process(spawn_cmd, **proc_kwargs)
|
proc: trio.Process = await trio.lowlevel.open_process(spawn_cmd, **proc_kwargs)
|
||||||
log.runtime(
|
log.runtime(
|
||||||
'Started new child\n'
|
f'Started new child subproc\n'
|
||||||
f'|_{proc}\n'
|
f'(>\n'
|
||||||
|
f' |_{proc}\n'
|
||||||
)
|
)
|
||||||
|
|
||||||
# wait for actor to spawn and connect back to us
|
# wait for actor to spawn and connect back to us
|
||||||
|
@ -507,10 +512,10 @@ async def trio_proc(
|
||||||
with trio.CancelScope(shield=True):
|
with trio.CancelScope(shield=True):
|
||||||
# don't clobber an ongoing pdb
|
# don't clobber an ongoing pdb
|
||||||
if is_root_process():
|
if is_root_process():
|
||||||
await maybe_wait_for_debugger()
|
await debug.maybe_wait_for_debugger()
|
||||||
|
|
||||||
elif proc is not None:
|
elif proc is not None:
|
||||||
async with acquire_debug_lock(subactor.uid):
|
async with debug.acquire_debug_lock(subactor.uid):
|
||||||
# soft wait on the proc to terminate
|
# soft wait on the proc to terminate
|
||||||
with trio.move_on_after(0.5):
|
with trio.move_on_after(0.5):
|
||||||
await proc.wait()
|
await proc.wait()
|
||||||
|
@ -528,14 +533,19 @@ async def trio_proc(
|
||||||
|
|
||||||
# send a "spawning specification" which configures the
|
# send a "spawning specification" which configures the
|
||||||
# initial runtime state of the child.
|
# initial runtime state of the child.
|
||||||
sspec = SpawnSpec(
|
sspec = msgtypes.SpawnSpec(
|
||||||
_parent_main_data=subactor._parent_main_data,
|
_parent_main_data=subactor._parent_main_data,
|
||||||
enable_modules=subactor.enable_modules,
|
enable_modules=subactor.enable_modules,
|
||||||
reg_addrs=subactor.reg_addrs,
|
reg_addrs=subactor.reg_addrs,
|
||||||
bind_addrs=bind_addrs,
|
bind_addrs=bind_addrs,
|
||||||
_runtime_vars=_runtime_vars,
|
_runtime_vars=_runtime_vars,
|
||||||
)
|
)
|
||||||
log.runtime(f'Sending spawn spec: {str(sspec)}')
|
log.runtime(
|
||||||
|
f'Sending spawn spec to child\n'
|
||||||
|
f'{{}}=> {chan.aid.reprol()!r}\n'
|
||||||
|
f'\n'
|
||||||
|
f'{pretty_struct.pformat(sspec)}\n'
|
||||||
|
)
|
||||||
await chan.send(sspec)
|
await chan.send(sspec)
|
||||||
|
|
||||||
# track subactor in current nursery
|
# track subactor in current nursery
|
||||||
|
@ -563,7 +573,7 @@ async def trio_proc(
|
||||||
# condition.
|
# condition.
|
||||||
await soft_kill(
|
await soft_kill(
|
||||||
proc,
|
proc,
|
||||||
trio.Process.wait,
|
trio.Process.wait, # XXX, uses `pidfd_open()` below.
|
||||||
portal
|
portal
|
||||||
)
|
)
|
||||||
|
|
||||||
|
@ -571,8 +581,7 @@ async def trio_proc(
|
||||||
# tandem if not done already
|
# tandem if not done already
|
||||||
log.cancel(
|
log.cancel(
|
||||||
'Cancelling portal result reaper task\n'
|
'Cancelling portal result reaper task\n'
|
||||||
f'>c)\n'
|
f'c)> {subactor.aid.reprol()!r}\n'
|
||||||
f' |_{subactor.uid}\n'
|
|
||||||
)
|
)
|
||||||
nursery.cancel_scope.cancel()
|
nursery.cancel_scope.cancel()
|
||||||
|
|
||||||
|
@ -581,21 +590,24 @@ async def trio_proc(
|
||||||
# allowed! Do this **after** cancellation/teardown to avoid
|
# allowed! Do this **after** cancellation/teardown to avoid
|
||||||
# killing the process too early.
|
# killing the process too early.
|
||||||
if proc:
|
if proc:
|
||||||
|
reap_repr: str = _pformat.nest_from_op(
|
||||||
|
input_op='>x)',
|
||||||
|
text=subactor.pformat(),
|
||||||
|
)
|
||||||
log.cancel(
|
log.cancel(
|
||||||
f'Hard reap sequence starting for subactor\n'
|
f'Hard reap sequence starting for subactor\n'
|
||||||
f'>x)\n'
|
f'{reap_repr}'
|
||||||
f' |_{subactor}@{subactor.uid}\n'
|
|
||||||
)
|
)
|
||||||
|
|
||||||
with trio.CancelScope(shield=True):
|
with trio.CancelScope(shield=True):
|
||||||
# don't clobber an ongoing pdb
|
# don't clobber an ongoing pdb
|
||||||
if cancelled_during_spawn:
|
if cancelled_during_spawn:
|
||||||
# Try again to avoid TTY clobbering.
|
# Try again to avoid TTY clobbering.
|
||||||
async with acquire_debug_lock(subactor.uid):
|
async with debug.acquire_debug_lock(subactor.uid):
|
||||||
with trio.move_on_after(0.5):
|
with trio.move_on_after(0.5):
|
||||||
await proc.wait()
|
await proc.wait()
|
||||||
|
|
||||||
await maybe_wait_for_debugger(
|
await debug.maybe_wait_for_debugger(
|
||||||
child_in_debug=_runtime_vars.get(
|
child_in_debug=_runtime_vars.get(
|
||||||
'_debug_mode', False
|
'_debug_mode', False
|
||||||
),
|
),
|
||||||
|
@ -624,7 +636,7 @@ async def trio_proc(
|
||||||
# acquire the lock and get notified of who has it,
|
# acquire the lock and get notified of who has it,
|
||||||
# check that uid against our known children?
|
# check that uid against our known children?
|
||||||
# this_uid: tuple[str, str] = current_actor().uid
|
# this_uid: tuple[str, str] = current_actor().uid
|
||||||
# await acquire_debug_lock(this_uid)
|
# await debug.acquire_debug_lock(this_uid)
|
||||||
|
|
||||||
if proc.poll() is None:
|
if proc.poll() is None:
|
||||||
log.cancel(f"Attempting to hard kill {proc}")
|
log.cancel(f"Attempting to hard kill {proc}")
|
||||||
|
@ -727,7 +739,7 @@ async def mp_proc(
|
||||||
|
|
||||||
log.runtime(f"Started {proc}")
|
log.runtime(f"Started {proc}")
|
||||||
|
|
||||||
ipc_server: IPCServer = actor_nursery._actor.ipc_server
|
ipc_server: _server.Server = actor_nursery._actor.ipc_server
|
||||||
try:
|
try:
|
||||||
# wait for actor to spawn and connect back to us
|
# wait for actor to spawn and connect back to us
|
||||||
# channel should have handshake completed by the
|
# channel should have handshake completed by the
|
||||||
|
|
|
@ -48,8 +48,9 @@ _current_actor: Actor|None = None # type: ignore # noqa
|
||||||
_last_actor_terminated: Actor|None = None
|
_last_actor_terminated: Actor|None = None
|
||||||
|
|
||||||
# TODO: mk this a `msgspec.Struct`!
|
# TODO: mk this a `msgspec.Struct`!
|
||||||
|
# -[ ] type out all fields obvi!
|
||||||
|
# -[ ] (eventually) mk wire-ready for monitoring?
|
||||||
_runtime_vars: dict[str, Any] = {
|
_runtime_vars: dict[str, Any] = {
|
||||||
'_debug_mode': False,
|
|
||||||
# root of actor-process tree info
|
# root of actor-process tree info
|
||||||
'_is_root': False, # bool
|
'_is_root': False, # bool
|
||||||
'_root_mailbox': (None, None), # tuple[str|None, str|None]
|
'_root_mailbox': (None, None), # tuple[str|None, str|None]
|
||||||
|
@ -61,10 +62,14 @@ _runtime_vars: dict[str, Any] = {
|
||||||
# registrar info
|
# registrar info
|
||||||
'_registry_addrs': [],
|
'_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
|
# for `tractor.pause_from_sync()` & `breakpoint()` support
|
||||||
'use_greenback': False,
|
'use_greenback': False,
|
||||||
|
|
||||||
|
# infected-`asyncio`-mode: `trio` running as guest.
|
||||||
|
'_is_infected_aio': False,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -426,8 +426,8 @@ class MsgStream(trio.abc.Channel):
|
||||||
self._closed = re
|
self._closed = re
|
||||||
|
|
||||||
# if caught_eoc:
|
# if caught_eoc:
|
||||||
# # from .devx import _debug
|
# # from .devx import debug
|
||||||
# # await _debug.pause()
|
# # await debug.pause()
|
||||||
# with trio.CancelScope(shield=True):
|
# with trio.CancelScope(shield=True):
|
||||||
# await rx_chan.aclose()
|
# await rx_chan.aclose()
|
||||||
|
|
||||||
|
|
|
@ -21,7 +21,6 @@
|
||||||
from contextlib import asynccontextmanager as acm
|
from contextlib import asynccontextmanager as acm
|
||||||
from functools import partial
|
from functools import partial
|
||||||
import inspect
|
import inspect
|
||||||
from pprint import pformat
|
|
||||||
from typing import (
|
from typing import (
|
||||||
TYPE_CHECKING,
|
TYPE_CHECKING,
|
||||||
)
|
)
|
||||||
|
@ -31,7 +30,10 @@ import warnings
|
||||||
import trio
|
import trio
|
||||||
|
|
||||||
|
|
||||||
from .devx._debug import maybe_wait_for_debugger
|
from .devx import (
|
||||||
|
debug,
|
||||||
|
pformat as _pformat,
|
||||||
|
)
|
||||||
from ._addr import (
|
from ._addr import (
|
||||||
UnwrappedAddress,
|
UnwrappedAddress,
|
||||||
mk_uuid,
|
mk_uuid,
|
||||||
|
@ -40,8 +42,11 @@ from ._state import current_actor, is_main_process
|
||||||
from .log import get_logger, get_loglevel
|
from .log import get_logger, get_loglevel
|
||||||
from ._runtime import Actor
|
from ._runtime import Actor
|
||||||
from ._portal import Portal
|
from ._portal import Portal
|
||||||
from ._exceptions import (
|
from .trionics import (
|
||||||
is_multi_cancelled,
|
is_multi_cancelled,
|
||||||
|
collapse_eg,
|
||||||
|
)
|
||||||
|
from ._exceptions import (
|
||||||
ContextCancelled,
|
ContextCancelled,
|
||||||
)
|
)
|
||||||
from ._root import (
|
from ._root import (
|
||||||
|
@ -197,7 +202,7 @@ class ActorNursery:
|
||||||
loglevel=loglevel,
|
loglevel=loglevel,
|
||||||
|
|
||||||
# verbatim relay this actor's registrar addresses
|
# verbatim relay this actor's registrar addresses
|
||||||
registry_addrs=current_actor().reg_addrs,
|
registry_addrs=current_actor().registry_addrs,
|
||||||
)
|
)
|
||||||
parent_addr: UnwrappedAddress = self._actor.accept_addr
|
parent_addr: UnwrappedAddress = self._actor.accept_addr
|
||||||
assert parent_addr
|
assert parent_addr
|
||||||
|
@ -322,9 +327,10 @@ class ActorNursery:
|
||||||
server: IPCServer = self._actor.ipc_server
|
server: IPCServer = self._actor.ipc_server
|
||||||
|
|
||||||
with trio.move_on_after(3) as cs:
|
with trio.move_on_after(3) as cs:
|
||||||
async with trio.open_nursery(
|
async with (
|
||||||
strict_exception_groups=False,
|
collapse_eg(),
|
||||||
) as tn:
|
trio.open_nursery() as tn,
|
||||||
|
):
|
||||||
|
|
||||||
subactor: Actor
|
subactor: Actor
|
||||||
proc: trio.Process
|
proc: trio.Process
|
||||||
|
@ -417,10 +423,10 @@ async def _open_and_supervise_one_cancels_all_nursery(
|
||||||
# `ActorNursery.start_actor()`).
|
# `ActorNursery.start_actor()`).
|
||||||
|
|
||||||
# errors from this daemon actor nursery bubble up to caller
|
# errors from this daemon actor nursery bubble up to caller
|
||||||
async with trio.open_nursery(
|
async with (
|
||||||
strict_exception_groups=False,
|
collapse_eg(),
|
||||||
# ^XXX^ TODO? instead unpack any RAE as per "loose" style?
|
trio.open_nursery() as da_nursery,
|
||||||
) as da_nursery:
|
):
|
||||||
try:
|
try:
|
||||||
# This is the inner level "run in actor" nursery. It is
|
# This is the inner level "run in actor" nursery. It is
|
||||||
# awaited first since actors spawned in this way (using
|
# awaited first since actors spawned in this way (using
|
||||||
|
@ -430,11 +436,10 @@ async def _open_and_supervise_one_cancels_all_nursery(
|
||||||
# immediately raised for handling by a supervisor strategy.
|
# immediately raised for handling by a supervisor strategy.
|
||||||
# As such if the strategy propagates any error(s) upwards
|
# As such if the strategy propagates any error(s) upwards
|
||||||
# the above "daemon actor" nursery will be notified.
|
# the above "daemon actor" nursery will be notified.
|
||||||
async with trio.open_nursery(
|
async with (
|
||||||
strict_exception_groups=False,
|
collapse_eg(),
|
||||||
# ^XXX^ TODO? instead unpack any RAE as per "loose" style?
|
trio.open_nursery() as ria_nursery,
|
||||||
) as ria_nursery:
|
):
|
||||||
|
|
||||||
an = ActorNursery(
|
an = ActorNursery(
|
||||||
actor,
|
actor,
|
||||||
ria_nursery,
|
ria_nursery,
|
||||||
|
@ -451,7 +456,7 @@ async def _open_and_supervise_one_cancels_all_nursery(
|
||||||
# the "hard join phase".
|
# the "hard join phase".
|
||||||
log.runtime(
|
log.runtime(
|
||||||
'Waiting on subactors to complete:\n'
|
'Waiting on subactors to complete:\n'
|
||||||
f'{pformat(an._children)}\n'
|
f'>}} {len(an._children)}\n'
|
||||||
)
|
)
|
||||||
an._join_procs.set()
|
an._join_procs.set()
|
||||||
|
|
||||||
|
@ -465,7 +470,7 @@ async def _open_and_supervise_one_cancels_all_nursery(
|
||||||
# will make the pdb repl unusable.
|
# will make the pdb repl unusable.
|
||||||
# Instead try to wait for pdb to be released before
|
# Instead try to wait for pdb to be released before
|
||||||
# tearing down.
|
# tearing down.
|
||||||
await maybe_wait_for_debugger(
|
await debug.maybe_wait_for_debugger(
|
||||||
child_in_debug=an._at_least_one_child_in_debug
|
child_in_debug=an._at_least_one_child_in_debug
|
||||||
)
|
)
|
||||||
|
|
||||||
|
@ -541,7 +546,7 @@ async def _open_and_supervise_one_cancels_all_nursery(
|
||||||
|
|
||||||
# XXX: yet another guard before allowing the cancel
|
# XXX: yet another guard before allowing the cancel
|
||||||
# sequence in case a (single) child is in debug.
|
# sequence in case a (single) child is in debug.
|
||||||
await maybe_wait_for_debugger(
|
await debug.maybe_wait_for_debugger(
|
||||||
child_in_debug=an._at_least_one_child_in_debug
|
child_in_debug=an._at_least_one_child_in_debug
|
||||||
)
|
)
|
||||||
|
|
||||||
|
@ -590,9 +595,14 @@ async def _open_and_supervise_one_cancels_all_nursery(
|
||||||
# final exit
|
# final exit
|
||||||
|
|
||||||
|
|
||||||
@acm
|
_shutdown_msg: str = (
|
||||||
|
'Actor-runtime-shutdown'
|
||||||
|
)
|
||||||
|
|
||||||
# @api_frame
|
# @api_frame
|
||||||
|
@acm
|
||||||
async def open_nursery(
|
async def open_nursery(
|
||||||
|
*, # named params only!
|
||||||
hide_tb: bool = True,
|
hide_tb: bool = True,
|
||||||
**kwargs,
|
**kwargs,
|
||||||
# ^TODO, paramspec for `open_root_actor()`
|
# ^TODO, paramspec for `open_root_actor()`
|
||||||
|
@ -677,17 +687,26 @@ async def open_nursery(
|
||||||
):
|
):
|
||||||
__tracebackhide__: bool = False
|
__tracebackhide__: bool = False
|
||||||
|
|
||||||
msg: str = (
|
|
||||||
'Actor-nursery exited\n'
|
op_nested_an_repr: str = _pformat.nest_from_op(
|
||||||
f'|_{an}\n'
|
input_op=')>',
|
||||||
|
text=f'{an}',
|
||||||
|
# nest_prefix='|_',
|
||||||
|
nest_indent=1, # under >
|
||||||
)
|
)
|
||||||
|
an_msg: str = (
|
||||||
|
f'Actor-nursery exited\n'
|
||||||
|
f'{op_nested_an_repr}\n'
|
||||||
|
)
|
||||||
|
# keep noise low during std operation.
|
||||||
|
log.runtime(an_msg)
|
||||||
|
|
||||||
if implicit_runtime:
|
if implicit_runtime:
|
||||||
# shutdown runtime if it was started and report noisly
|
# shutdown runtime if it was started and report noisly
|
||||||
# that we're did so.
|
# that we're did so.
|
||||||
msg += '=> Shutting down actor runtime <=\n'
|
msg: str = (
|
||||||
|
'\n'
|
||||||
|
'\n'
|
||||||
|
f'{_shutdown_msg} )>\n'
|
||||||
|
)
|
||||||
log.info(msg)
|
log.info(msg)
|
||||||
|
|
||||||
else:
|
|
||||||
# keep noise low during std operation.
|
|
||||||
log.runtime(msg)
|
|
||||||
|
|
|
@ -26,7 +26,7 @@ import os
|
||||||
import pathlib
|
import pathlib
|
||||||
|
|
||||||
import tractor
|
import tractor
|
||||||
from tractor.devx._debug import (
|
from tractor.devx.debug import (
|
||||||
BoxedMaybeException,
|
BoxedMaybeException,
|
||||||
)
|
)
|
||||||
from .pytest import (
|
from .pytest import (
|
||||||
|
@ -37,6 +37,9 @@ from .fault_simulation import (
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
# TODO, use dulwhich for this instead?
|
||||||
|
# -> we're going to likely need it (or something similar)
|
||||||
|
# for supporting hot-coad reload feats eventually anyway!
|
||||||
def repodir() -> pathlib.Path:
|
def repodir() -> pathlib.Path:
|
||||||
'''
|
'''
|
||||||
Return the abspath to the repo directory.
|
Return the abspath to the repo directory.
|
||||||
|
|
|
@ -0,0 +1,70 @@
|
||||||
|
# tractor: structured concurrent "actors".
|
||||||
|
# Copyright 2018-eternity Tyler Goodlet.
|
||||||
|
|
||||||
|
# This program is free software: you can redistribute it and/or modify
|
||||||
|
# it under the terms of the GNU Affero General Public License as published by
|
||||||
|
# the Free Software Foundation, either version 3 of the License, or
|
||||||
|
# (at your option) any later version.
|
||||||
|
|
||||||
|
# This program is distributed in the hope that it will be useful,
|
||||||
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
# GNU Affero General Public License for more details.
|
||||||
|
|
||||||
|
# You should have received a copy of the GNU Affero General Public License
|
||||||
|
# along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
'''
|
||||||
|
Random IPC addr generation for isolating
|
||||||
|
the discovery space between test sessions.
|
||||||
|
|
||||||
|
Might be eventually useful to expose as a util set from
|
||||||
|
our `tractor.discovery` subsys?
|
||||||
|
|
||||||
|
'''
|
||||||
|
import random
|
||||||
|
from typing import (
|
||||||
|
Type,
|
||||||
|
)
|
||||||
|
from tractor import (
|
||||||
|
_addr,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def get_rando_addr(
|
||||||
|
tpt_proto: str,
|
||||||
|
*,
|
||||||
|
|
||||||
|
# choose random port at import time
|
||||||
|
_rando_port: str = random.randint(1000, 9999)
|
||||||
|
|
||||||
|
) -> tuple[str, str|int]:
|
||||||
|
'''
|
||||||
|
Used to globally override the runtime to the
|
||||||
|
per-test-session-dynamic addr so that all tests never conflict
|
||||||
|
with any other actor tree using the default.
|
||||||
|
|
||||||
|
'''
|
||||||
|
addr_type: Type[_addr.Addres] = _addr._address_types[tpt_proto]
|
||||||
|
def_reg_addr: tuple[str, int] = _addr._default_lo_addrs[tpt_proto]
|
||||||
|
|
||||||
|
# this is the "unwrapped" form expected to be passed to
|
||||||
|
# `.open_root_actor()` by test body.
|
||||||
|
testrun_reg_addr: tuple[str, int|str]
|
||||||
|
match tpt_proto:
|
||||||
|
case 'tcp':
|
||||||
|
testrun_reg_addr = (
|
||||||
|
addr_type.def_bindspace,
|
||||||
|
_rando_port,
|
||||||
|
)
|
||||||
|
|
||||||
|
# NOTE, file-name uniqueness (no-collisions) will be based on
|
||||||
|
# the runtime-directory and root (pytest-proc's) pid.
|
||||||
|
case 'uds':
|
||||||
|
testrun_reg_addr = addr_type.get_random().unwrap()
|
||||||
|
|
||||||
|
# XXX, as sanity it should never the same as the default for the
|
||||||
|
# host-singleton registry actor.
|
||||||
|
assert def_reg_addr != testrun_reg_addr
|
||||||
|
|
||||||
|
return testrun_reg_addr
|
|
@ -26,29 +26,46 @@ from functools import (
|
||||||
import inspect
|
import inspect
|
||||||
import platform
|
import platform
|
||||||
|
|
||||||
|
import pytest
|
||||||
import tractor
|
import tractor
|
||||||
import trio
|
import trio
|
||||||
|
|
||||||
|
|
||||||
def tractor_test(fn):
|
def tractor_test(fn):
|
||||||
'''
|
'''
|
||||||
Decorator for async test funcs to present them as "native"
|
Decorator for async test fns to decorator-wrap them as "native"
|
||||||
looking sync funcs runnable by `pytest` using `trio.run()`.
|
looking sync funcs runnable by `pytest` and auto invoked with
|
||||||
|
`trio.run()` (much like the `pytest-trio` plugin's approach).
|
||||||
|
|
||||||
Use:
|
Further the test fn body will be invoked AFTER booting the actor
|
||||||
|
runtime, i.e. from inside a `tractor.open_root_actor()` block AND
|
||||||
|
with various runtime and tooling parameters implicitly passed as
|
||||||
|
requested by by the test session's config; see immediately below.
|
||||||
|
|
||||||
@tractor_test
|
Basic deco use:
|
||||||
async def test_whatever():
|
---------------
|
||||||
await ...
|
|
||||||
|
|
||||||
If fixtures:
|
@tractor_test
|
||||||
|
async def test_whatever():
|
||||||
|
await ...
|
||||||
|
|
||||||
- ``reg_addr`` (a socket addr tuple where arbiter is listening)
|
|
||||||
- ``loglevel`` (logging level passed to tractor internals)
|
|
||||||
- ``start_method`` (subprocess spawning backend)
|
|
||||||
|
|
||||||
are defined in the `pytest` fixture space they will be automatically
|
Runtime config via special fixtures:
|
||||||
injected to tests declaring these funcargs.
|
------------------------------------
|
||||||
|
If any of the following fixture are requested by the wrapped test
|
||||||
|
fn (via normal func-args declaration),
|
||||||
|
|
||||||
|
- `reg_addr` (a socket addr tuple where arbiter is listening)
|
||||||
|
- `loglevel` (logging level passed to tractor internals)
|
||||||
|
- `start_method` (subprocess spawning backend)
|
||||||
|
|
||||||
|
(TODO support)
|
||||||
|
- `tpt_proto` (IPC transport protocol key)
|
||||||
|
|
||||||
|
they will be automatically injected to each test as normally
|
||||||
|
expected as well as passed to the initial
|
||||||
|
`tractor.open_root_actor()` funcargs.
|
||||||
|
|
||||||
'''
|
'''
|
||||||
@wraps(fn)
|
@wraps(fn)
|
||||||
def wrapper(
|
def wrapper(
|
||||||
|
@ -111,3 +128,164 @@ def tractor_test(fn):
|
||||||
return trio.run(main)
|
return trio.run(main)
|
||||||
|
|
||||||
return wrapper
|
return wrapper
|
||||||
|
|
||||||
|
|
||||||
|
def pytest_addoption(
|
||||||
|
parser: pytest.Parser,
|
||||||
|
):
|
||||||
|
# parser.addoption(
|
||||||
|
# "--ll",
|
||||||
|
# action="store",
|
||||||
|
# dest='loglevel',
|
||||||
|
# default='ERROR', help="logging level to set when testing"
|
||||||
|
# )
|
||||||
|
|
||||||
|
parser.addoption(
|
||||||
|
"--spawn-backend",
|
||||||
|
action="store",
|
||||||
|
dest='spawn_backend',
|
||||||
|
default='trio',
|
||||||
|
help="Processing spawning backend to use for test run",
|
||||||
|
)
|
||||||
|
|
||||||
|
parser.addoption(
|
||||||
|
"--tpdb",
|
||||||
|
"--debug-mode",
|
||||||
|
action="store_true",
|
||||||
|
dest='tractor_debug_mode',
|
||||||
|
# default=False,
|
||||||
|
help=(
|
||||||
|
'Enable a flag that can be used by tests to to set the '
|
||||||
|
'`debug_mode: bool` for engaging the internal '
|
||||||
|
'multi-proc debugger sys.'
|
||||||
|
),
|
||||||
|
)
|
||||||
|
|
||||||
|
# provide which IPC transport protocols opting-in test suites
|
||||||
|
# should accumulatively run against.
|
||||||
|
parser.addoption(
|
||||||
|
"--tpt-proto",
|
||||||
|
nargs='+', # accumulate-multiple-args
|
||||||
|
action="store",
|
||||||
|
dest='tpt_protos',
|
||||||
|
default=['tcp'],
|
||||||
|
help="Transport protocol to use under the `tractor.ipc.Channel`",
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def pytest_configure(config):
|
||||||
|
backend = config.option.spawn_backend
|
||||||
|
tractor._spawn.try_set_start_method(backend)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture(scope='session')
|
||||||
|
def debug_mode(request) -> bool:
|
||||||
|
'''
|
||||||
|
Flag state for whether `--tpdb` (for `tractor`-py-debugger)
|
||||||
|
was passed to the test run.
|
||||||
|
|
||||||
|
Normally tests should pass this directly to `.open_root_actor()`
|
||||||
|
to allow the user to opt into suite-wide crash handling.
|
||||||
|
|
||||||
|
'''
|
||||||
|
debug_mode: bool = request.config.option.tractor_debug_mode
|
||||||
|
return debug_mode
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture(scope='session')
|
||||||
|
def spawn_backend(request) -> str:
|
||||||
|
return request.config.option.spawn_backend
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture(scope='session')
|
||||||
|
def tpt_protos(request) -> list[str]:
|
||||||
|
|
||||||
|
# allow quoting on CLI
|
||||||
|
proto_keys: list[str] = [
|
||||||
|
proto_key.replace('"', '').replace("'", "")
|
||||||
|
for proto_key in request.config.option.tpt_protos
|
||||||
|
]
|
||||||
|
|
||||||
|
# ?TODO, eventually support multiple protos per test-sesh?
|
||||||
|
if len(proto_keys) > 1:
|
||||||
|
pytest.fail(
|
||||||
|
'We only support one `--tpt-proto <key>` atm!\n'
|
||||||
|
)
|
||||||
|
|
||||||
|
# XXX ensure we support the protocol by name via lookup!
|
||||||
|
for proto_key in proto_keys:
|
||||||
|
addr_type = tractor._addr._address_types[proto_key]
|
||||||
|
assert addr_type.proto_key == proto_key
|
||||||
|
|
||||||
|
yield proto_keys
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture(
|
||||||
|
scope='session',
|
||||||
|
autouse=True,
|
||||||
|
)
|
||||||
|
def tpt_proto(
|
||||||
|
tpt_protos: list[str],
|
||||||
|
) -> str:
|
||||||
|
proto_key: str = tpt_protos[0]
|
||||||
|
|
||||||
|
from tractor import _state
|
||||||
|
if _state._def_tpt_proto != proto_key:
|
||||||
|
_state._def_tpt_proto = proto_key
|
||||||
|
|
||||||
|
yield proto_key
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture(scope='session')
|
||||||
|
def reg_addr(
|
||||||
|
tpt_proto: str,
|
||||||
|
) -> tuple[str, int|str]:
|
||||||
|
'''
|
||||||
|
Deliver a test-sesh unique registry address such
|
||||||
|
that each run's (tests which use this fixture) will
|
||||||
|
have no conflicts/cross-talk when running simultaneously
|
||||||
|
nor will interfere with other live `tractor` apps active
|
||||||
|
on the same network-host (namespace).
|
||||||
|
|
||||||
|
'''
|
||||||
|
from tractor._testing.addr import get_rando_addr
|
||||||
|
return get_rando_addr(
|
||||||
|
tpt_proto=tpt_proto,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def pytest_generate_tests(
|
||||||
|
metafunc: pytest.Metafunc,
|
||||||
|
):
|
||||||
|
spawn_backend: str = metafunc.config.option.spawn_backend
|
||||||
|
|
||||||
|
if not spawn_backend:
|
||||||
|
# XXX some weird windows bug with `pytest`?
|
||||||
|
spawn_backend = 'trio'
|
||||||
|
|
||||||
|
# TODO: maybe just use the literal `._spawn.SpawnMethodKey`?
|
||||||
|
assert spawn_backend in (
|
||||||
|
'mp_spawn',
|
||||||
|
'mp_forkserver',
|
||||||
|
'trio',
|
||||||
|
)
|
||||||
|
|
||||||
|
# NOTE: used-to-be-used-to dyanmically parametrize tests for when
|
||||||
|
# you just passed --spawn-backend=`mp` on the cli, but now we expect
|
||||||
|
# that cli input to be manually specified, BUT, maybe we'll do
|
||||||
|
# something like this again in the future?
|
||||||
|
if 'start_method' in metafunc.fixturenames:
|
||||||
|
metafunc.parametrize(
|
||||||
|
"start_method",
|
||||||
|
[spawn_backend],
|
||||||
|
scope='module',
|
||||||
|
)
|
||||||
|
|
||||||
|
# TODO, parametrize any `tpt_proto: str` declaring tests!
|
||||||
|
# proto_tpts: list[str] = metafunc.config.option.proto_tpts
|
||||||
|
# if 'tpt_proto' in metafunc.fixturenames:
|
||||||
|
# metafunc.parametrize(
|
||||||
|
# 'tpt_proto',
|
||||||
|
# proto_tpts, # TODO, double check this list usage!
|
||||||
|
# scope='module',
|
||||||
|
# )
|
||||||
|
|
|
@ -20,7 +20,7 @@ Runtime "developer experience" utils and addons to aid our
|
||||||
and working with/on the actor runtime.
|
and working with/on the actor runtime.
|
||||||
|
|
||||||
"""
|
"""
|
||||||
from ._debug import (
|
from .debug import (
|
||||||
maybe_wait_for_debugger as maybe_wait_for_debugger,
|
maybe_wait_for_debugger as maybe_wait_for_debugger,
|
||||||
acquire_debug_lock as acquire_debug_lock,
|
acquire_debug_lock as acquire_debug_lock,
|
||||||
breakpoint as breakpoint,
|
breakpoint as breakpoint,
|
||||||
|
|
File diff suppressed because it is too large
Load Diff
|
@ -20,13 +20,18 @@ as it pertains to improving the grok-ability of our runtime!
|
||||||
|
|
||||||
'''
|
'''
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
from contextlib import (
|
||||||
|
_GeneratorContextManager,
|
||||||
|
_AsyncGeneratorContextManager,
|
||||||
|
)
|
||||||
from functools import partial
|
from functools import partial
|
||||||
import inspect
|
import inspect
|
||||||
|
import textwrap
|
||||||
from types import (
|
from types import (
|
||||||
FrameType,
|
FrameType,
|
||||||
FunctionType,
|
FunctionType,
|
||||||
MethodType,
|
MethodType,
|
||||||
# CodeType,
|
CodeType,
|
||||||
)
|
)
|
||||||
from typing import (
|
from typing import (
|
||||||
Any,
|
Any,
|
||||||
|
@ -34,6 +39,9 @@ from typing import (
|
||||||
Type,
|
Type,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
import pdbp
|
||||||
|
from tractor.log import get_logger
|
||||||
|
import trio
|
||||||
from tractor.msg import (
|
from tractor.msg import (
|
||||||
pretty_struct,
|
pretty_struct,
|
||||||
NamespacePath,
|
NamespacePath,
|
||||||
|
@ -41,6 +49,8 @@ from tractor.msg import (
|
||||||
import wrapt
|
import wrapt
|
||||||
|
|
||||||
|
|
||||||
|
log = get_logger(__name__)
|
||||||
|
|
||||||
# TODO: yeah, i don't love this and we should prolly just
|
# TODO: yeah, i don't love this and we should prolly just
|
||||||
# write a decorator that actually keeps a stupid ref to the func
|
# write a decorator that actually keeps a stupid ref to the func
|
||||||
# obj..
|
# obj..
|
||||||
|
@ -301,3 +311,70 @@ def api_frame(
|
||||||
# error_set: set[BaseException],
|
# error_set: set[BaseException],
|
||||||
# ) -> TracebackType:
|
# ) -> TracebackType:
|
||||||
# ...
|
# ...
|
||||||
|
|
||||||
|
|
||||||
|
def hide_runtime_frames() -> dict[FunctionType, CodeType]:
|
||||||
|
'''
|
||||||
|
Hide call-stack frames for various std-lib and `trio`-API primitives
|
||||||
|
such that the tracebacks presented from our runtime are as minimized
|
||||||
|
as possible, particularly from inside a `PdbREPL`.
|
||||||
|
|
||||||
|
'''
|
||||||
|
# XXX HACKZONE XXX
|
||||||
|
# hide exit stack frames on nurseries and cancel-scopes!
|
||||||
|
# |_ so avoid seeing it when the `pdbp` REPL is first engaged from
|
||||||
|
# inside a `trio.open_nursery()` scope (with no line after it
|
||||||
|
# in before the block end??).
|
||||||
|
#
|
||||||
|
# TODO: FINALLY got this workin originally with
|
||||||
|
# `@pdbp.hideframe` around the `wrapper()` def embedded inside
|
||||||
|
# `_ki_protection_decoratior()`.. which is in the module:
|
||||||
|
# /home/goodboy/.virtualenvs/tractor311/lib/python3.11/site-packages/trio/_core/_ki.py
|
||||||
|
#
|
||||||
|
# -[ ] make an issue and patch for `trio` core? maybe linked
|
||||||
|
# to the long outstanding `pdb` one below?
|
||||||
|
# |_ it's funny that there's frame hiding throughout `._run.py`
|
||||||
|
# but not where it matters on the below exit funcs..
|
||||||
|
#
|
||||||
|
# -[ ] provide a patchset for the lonstanding
|
||||||
|
# |_ https://github.com/python-trio/trio/issues/1155
|
||||||
|
#
|
||||||
|
# -[ ] make a linked issue to ^ and propose allowing all the
|
||||||
|
# `._core._run` code to have their `__tracebackhide__` value
|
||||||
|
# configurable by a `RunVar` to allow getting scheduler frames
|
||||||
|
# if desired through configuration?
|
||||||
|
#
|
||||||
|
# -[ ] maybe dig into the core `pdb` issue why the extra frame is shown
|
||||||
|
# at all?
|
||||||
|
#
|
||||||
|
funcs: list[FunctionType] = [
|
||||||
|
trio._core._run.NurseryManager.__aexit__,
|
||||||
|
trio._core._run.CancelScope.__exit__,
|
||||||
|
_GeneratorContextManager.__exit__,
|
||||||
|
_AsyncGeneratorContextManager.__aexit__,
|
||||||
|
_AsyncGeneratorContextManager.__aenter__,
|
||||||
|
trio.Event.wait,
|
||||||
|
]
|
||||||
|
func_list_str: str = textwrap.indent(
|
||||||
|
"\n".join(f.__qualname__ for f in funcs),
|
||||||
|
prefix=' |_ ',
|
||||||
|
)
|
||||||
|
log.devx(
|
||||||
|
'Hiding the following runtime frames by default:\n'
|
||||||
|
f'{func_list_str}\n'
|
||||||
|
)
|
||||||
|
|
||||||
|
codes: dict[FunctionType, CodeType] = {}
|
||||||
|
for ref in funcs:
|
||||||
|
# stash a pre-modified version of each ref's code-obj
|
||||||
|
# so it can be reverted later if needed.
|
||||||
|
codes[ref] = ref.__code__
|
||||||
|
pdbp.hideframe(ref)
|
||||||
|
#
|
||||||
|
# pdbp.hideframe(trio._core._run.NurseryManager.__aexit__)
|
||||||
|
# pdbp.hideframe(trio._core._run.CancelScope.__exit__)
|
||||||
|
# pdbp.hideframe(_GeneratorContextManager.__exit__)
|
||||||
|
# pdbp.hideframe(_AsyncGeneratorContextManager.__aexit__)
|
||||||
|
# pdbp.hideframe(_AsyncGeneratorContextManager.__aenter__)
|
||||||
|
# pdbp.hideframe(trio.Event.wait)
|
||||||
|
return codes
|
||||||
|
|
|
@ -49,7 +49,7 @@ from tractor import (
|
||||||
_state,
|
_state,
|
||||||
log as logmod,
|
log as logmod,
|
||||||
)
|
)
|
||||||
from tractor.devx import _debug
|
from tractor.devx import debug
|
||||||
|
|
||||||
log = logmod.get_logger(__name__)
|
log = logmod.get_logger(__name__)
|
||||||
|
|
||||||
|
@ -82,7 +82,7 @@ def dump_task_tree() -> None:
|
||||||
if (
|
if (
|
||||||
current_sigint_handler
|
current_sigint_handler
|
||||||
is not
|
is not
|
||||||
_debug.DebugStatus._trio_handler
|
debug.DebugStatus._trio_handler
|
||||||
):
|
):
|
||||||
sigint_handler_report: str = (
|
sigint_handler_report: str = (
|
||||||
'The default `trio` SIGINT handler was replaced?!'
|
'The default `trio` SIGINT handler was replaced?!'
|
||||||
|
@ -238,7 +238,8 @@ def enable_stack_on_sig(
|
||||||
import stackscope
|
import stackscope
|
||||||
except ImportError:
|
except ImportError:
|
||||||
log.error(
|
log.error(
|
||||||
'`stackscope` not installed for use in debug mode!'
|
'`stackscope` not installed for use in debug mode!\n'
|
||||||
|
'`Ignoring {enable_stack_on_sig!r} call!\n'
|
||||||
)
|
)
|
||||||
return None
|
return None
|
||||||
|
|
||||||
|
|
|
@ -0,0 +1,100 @@
|
||||||
|
# tractor: structured concurrent "actors".
|
||||||
|
# Copyright 2018-eternity Tyler Goodlet.
|
||||||
|
|
||||||
|
# This program is free software: you can redistribute it and/or
|
||||||
|
# modify it under the terms of the GNU Affero General Public License
|
||||||
|
# as published by the Free Software Foundation, either version 3 of
|
||||||
|
# the License, or (at your option) any later version.
|
||||||
|
|
||||||
|
# This program is distributed in the hope that it will be useful, but
|
||||||
|
# WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||||
|
# Affero General Public License for more details.
|
||||||
|
|
||||||
|
# You should have received a copy of the GNU Affero General Public
|
||||||
|
# License along with this program. If not, see
|
||||||
|
# <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
'''
|
||||||
|
Multi-actor debugging for da peeps!
|
||||||
|
|
||||||
|
'''
|
||||||
|
from __future__ import annotations
|
||||||
|
from tractor.log import get_logger
|
||||||
|
from ._repl import (
|
||||||
|
PdbREPL as PdbREPL,
|
||||||
|
mk_pdb as mk_pdb,
|
||||||
|
TractorConfig as TractorConfig,
|
||||||
|
)
|
||||||
|
from ._tty_lock import (
|
||||||
|
DebugStatus as DebugStatus,
|
||||||
|
DebugStateError as DebugStateError,
|
||||||
|
)
|
||||||
|
from ._trace import (
|
||||||
|
Lock as Lock,
|
||||||
|
_pause_msg as _pause_msg,
|
||||||
|
_repl_fail_msg as _repl_fail_msg,
|
||||||
|
_set_trace as _set_trace,
|
||||||
|
_sync_pause_from_builtin as _sync_pause_from_builtin,
|
||||||
|
breakpoint as breakpoint,
|
||||||
|
maybe_init_greenback as maybe_init_greenback,
|
||||||
|
maybe_import_greenback as maybe_import_greenback,
|
||||||
|
pause as pause,
|
||||||
|
pause_from_sync as pause_from_sync,
|
||||||
|
)
|
||||||
|
from ._post_mortem import (
|
||||||
|
BoxedMaybeException as BoxedMaybeException,
|
||||||
|
maybe_open_crash_handler as maybe_open_crash_handler,
|
||||||
|
open_crash_handler as open_crash_handler,
|
||||||
|
post_mortem as post_mortem,
|
||||||
|
_crash_msg as _crash_msg,
|
||||||
|
_maybe_enter_pm as _maybe_enter_pm,
|
||||||
|
)
|
||||||
|
from ._sync import (
|
||||||
|
maybe_wait_for_debugger as maybe_wait_for_debugger,
|
||||||
|
acquire_debug_lock as acquire_debug_lock,
|
||||||
|
)
|
||||||
|
from ._sigint import (
|
||||||
|
sigint_shield as sigint_shield,
|
||||||
|
_ctlc_ignore_header as _ctlc_ignore_header
|
||||||
|
)
|
||||||
|
|
||||||
|
log = get_logger(__name__)
|
||||||
|
|
||||||
|
# ----------------
|
||||||
|
# XXX PKG TODO XXX
|
||||||
|
# ----------------
|
||||||
|
# refine the internal impl and APIs!
|
||||||
|
#
|
||||||
|
# -[ ] rework `._pause()` and it's branch-cases for root vs.
|
||||||
|
# subactor:
|
||||||
|
# -[ ] `._pause_from_root()` + `_pause_from_subactor()`?
|
||||||
|
# -[ ] do the de-factor based on bg-thread usage in
|
||||||
|
# `.pause_from_sync()` & `_pause_from_bg_root_thread()`.
|
||||||
|
# -[ ] drop `debug_func == None` case which is confusing af..
|
||||||
|
# -[ ] factor out `_enter_repl_sync()` into a util func for calling
|
||||||
|
# the `_set_trace()` / `_post_mortem()` APIs?
|
||||||
|
#
|
||||||
|
# -[ ] figure out if we need `acquire_debug_lock()` and/or re-implement
|
||||||
|
# it as part of the `.pause_from_sync()` rework per above?
|
||||||
|
#
|
||||||
|
# -[ ] pair the `._pause_from_subactor()` impl with a "debug nursery"
|
||||||
|
# that's dynamically allocated inside the `._rpc` task thus
|
||||||
|
# avoiding the `._service_n.start()` usage for the IPC request?
|
||||||
|
# -[ ] see the TODO inside `._rpc._errors_relayed_via_ipc()`
|
||||||
|
#
|
||||||
|
# -[ ] impl a `open_debug_request()` which encaps all
|
||||||
|
# `request_root_stdio_lock()` task scheduling deats
|
||||||
|
# + `DebugStatus` state mgmt; which should prolly be re-branded as
|
||||||
|
# a `DebugRequest` type anyway AND with suppoort for bg-thread
|
||||||
|
# (from root actor) usage?
|
||||||
|
#
|
||||||
|
# -[ ] handle the `xonsh` case for bg-root-threads in the SIGINT
|
||||||
|
# handler!
|
||||||
|
# -[ ] do we need to do the same for subactors?
|
||||||
|
# -[ ] make the failing tests finally pass XD
|
||||||
|
#
|
||||||
|
# -[ ] simplify `maybe_wait_for_debugger()` to be a root-task only
|
||||||
|
# API?
|
||||||
|
# -[ ] currently it's implemented as that so might as well make it
|
||||||
|
# formal?
|
|
@ -0,0 +1,410 @@
|
||||||
|
# tractor: structured concurrent "actors".
|
||||||
|
# Copyright 2018-eternity Tyler Goodlet.
|
||||||
|
|
||||||
|
# This program is free software: you can redistribute it and/or
|
||||||
|
# modify it under the terms of the GNU Affero General Public License
|
||||||
|
# as published by the Free Software Foundation, either version 3 of
|
||||||
|
# the License, or (at your option) any later version.
|
||||||
|
|
||||||
|
# This program is distributed in the hope that it will be useful, but
|
||||||
|
# WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||||
|
# Affero General Public License for more details.
|
||||||
|
|
||||||
|
# You should have received a copy of the GNU Affero General Public
|
||||||
|
# License along with this program. If not, see
|
||||||
|
# <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
'''
|
||||||
|
Post-mortem debugging APIs and surrounding machinery for both
|
||||||
|
sync and async contexts.
|
||||||
|
|
||||||
|
Generally we maintain the same semantics a `pdb.post.mortem()` but
|
||||||
|
with actor-tree-wide sync/cooperation around any (sub)actor's use of
|
||||||
|
the root's TTY.
|
||||||
|
|
||||||
|
'''
|
||||||
|
from __future__ import annotations
|
||||||
|
import bdb
|
||||||
|
from contextlib import (
|
||||||
|
AbstractContextManager,
|
||||||
|
contextmanager as cm,
|
||||||
|
nullcontext,
|
||||||
|
)
|
||||||
|
from functools import (
|
||||||
|
partial,
|
||||||
|
)
|
||||||
|
import inspect
|
||||||
|
import sys
|
||||||
|
import traceback
|
||||||
|
from typing import (
|
||||||
|
Callable,
|
||||||
|
Sequence,
|
||||||
|
Type,
|
||||||
|
TYPE_CHECKING,
|
||||||
|
)
|
||||||
|
from types import (
|
||||||
|
TracebackType,
|
||||||
|
FrameType,
|
||||||
|
)
|
||||||
|
|
||||||
|
from msgspec import Struct
|
||||||
|
import trio
|
||||||
|
from tractor._exceptions import (
|
||||||
|
NoRuntime,
|
||||||
|
)
|
||||||
|
from tractor import _state
|
||||||
|
from tractor._state import (
|
||||||
|
current_actor,
|
||||||
|
debug_mode,
|
||||||
|
)
|
||||||
|
from tractor.log import get_logger
|
||||||
|
from tractor.trionics import (
|
||||||
|
is_multi_cancelled,
|
||||||
|
)
|
||||||
|
from ._trace import (
|
||||||
|
_pause,
|
||||||
|
)
|
||||||
|
from ._tty_lock import (
|
||||||
|
DebugStatus,
|
||||||
|
)
|
||||||
|
from ._repl import (
|
||||||
|
PdbREPL,
|
||||||
|
mk_pdb,
|
||||||
|
TractorConfig as TractorConfig,
|
||||||
|
)
|
||||||
|
|
||||||
|
if TYPE_CHECKING:
|
||||||
|
from trio.lowlevel import Task
|
||||||
|
from tractor._runtime import (
|
||||||
|
Actor,
|
||||||
|
)
|
||||||
|
|
||||||
|
_crash_msg: str = (
|
||||||
|
'Opening a pdb REPL in crashed actor'
|
||||||
|
)
|
||||||
|
|
||||||
|
log = get_logger(__package__)
|
||||||
|
|
||||||
|
|
||||||
|
class BoxedMaybeException(Struct):
|
||||||
|
'''
|
||||||
|
Box a maybe-exception for post-crash introspection usage
|
||||||
|
from the body of a `open_crash_handler()` scope.
|
||||||
|
|
||||||
|
'''
|
||||||
|
value: BaseException|None = None
|
||||||
|
|
||||||
|
# handler can suppress crashes dynamically
|
||||||
|
raise_on_exit: bool|Sequence[Type[BaseException]] = True
|
||||||
|
|
||||||
|
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 )>'
|
||||||
|
|
||||||
|
return (
|
||||||
|
f'<{type(self.value).__name__}(\n'
|
||||||
|
f' |_.value = {self.value}\n'
|
||||||
|
f')>\n'
|
||||||
|
)
|
||||||
|
|
||||||
|
__repr__ = pformat
|
||||||
|
|
||||||
|
|
||||||
|
def _post_mortem(
|
||||||
|
repl: PdbREPL, # normally passed by `_pause()`
|
||||||
|
|
||||||
|
# XXX all `partial`-ed in by `post_mortem()` below!
|
||||||
|
tb: TracebackType,
|
||||||
|
api_frame: FrameType,
|
||||||
|
|
||||||
|
shield: bool = False,
|
||||||
|
hide_tb: bool = True,
|
||||||
|
|
||||||
|
# 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
|
||||||
|
debugger instance.
|
||||||
|
|
||||||
|
'''
|
||||||
|
__tracebackhide__: bool = hide_tb
|
||||||
|
|
||||||
|
# maybe enter any user fixture
|
||||||
|
enter_repl: bool = DebugStatus.maybe_enter_repl_fixture(
|
||||||
|
repl=repl,
|
||||||
|
repl_fixture=repl_fixture,
|
||||||
|
boxed_maybe_exc=boxed_maybe_exc,
|
||||||
|
)
|
||||||
|
if not enter_repl:
|
||||||
|
return
|
||||||
|
try:
|
||||||
|
actor: Actor = current_actor()
|
||||||
|
actor_repr: str = str(actor.uid)
|
||||||
|
# ^TODO, instead a nice runtime-info + maddr + uid?
|
||||||
|
# -[ ] impl a `Actor.__repr()__`??
|
||||||
|
# |_ <task>:<thread> @ <actor>
|
||||||
|
|
||||||
|
except NoRuntime:
|
||||||
|
actor_repr: str = '<no-actor-runtime?>'
|
||||||
|
|
||||||
|
try:
|
||||||
|
task_repr: Task = trio.lowlevel.current_task()
|
||||||
|
except RuntimeError:
|
||||||
|
task_repr: str = '<unknown-Task>'
|
||||||
|
|
||||||
|
# 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 NOTE(s) on `pdbp.xpm()` version..
|
||||||
|
#
|
||||||
|
# - seems to lose the up-stack tb-info?
|
||||||
|
# - currently we're (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 these in the lib to
|
||||||
|
# understand usage:
|
||||||
|
# - `pdbp.post_mortem()`
|
||||||
|
# - `pdbp.xps()`
|
||||||
|
# - `bdb.interaction()`
|
||||||
|
repl.reset()
|
||||||
|
repl.interaction(
|
||||||
|
frame=caller_frame,
|
||||||
|
# frame=None,
|
||||||
|
traceback=tb,
|
||||||
|
)
|
||||||
|
|
||||||
|
# XXX NOTE XXX: this is abs 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!
|
||||||
|
DebugStatus.release()
|
||||||
|
|
||||||
|
|
||||||
|
async def post_mortem(
|
||||||
|
*,
|
||||||
|
tb: TracebackType|None = None,
|
||||||
|
api_frame: FrameType|None = None,
|
||||||
|
hide_tb: bool = False,
|
||||||
|
|
||||||
|
# TODO: support shield here just like in `pause()`?
|
||||||
|
# shield: bool = False,
|
||||||
|
|
||||||
|
**_pause_kwargs,
|
||||||
|
|
||||||
|
) -> None:
|
||||||
|
'''
|
||||||
|
Our builtin async equivalient of `pdb.post_mortem()` which can be
|
||||||
|
used inside exception handlers.
|
||||||
|
|
||||||
|
It's also used for the crash handler when `debug_mode == True` ;)
|
||||||
|
|
||||||
|
'''
|
||||||
|
__tracebackhide__: bool = hide_tb
|
||||||
|
|
||||||
|
tb: TracebackType = tb or sys.exc_info()[2]
|
||||||
|
|
||||||
|
# TODO: do upward stack scan for highest @api_frame and
|
||||||
|
# use its parent frame as the expected user-app code
|
||||||
|
# interact point.
|
||||||
|
api_frame: FrameType = api_frame or inspect.currentframe()
|
||||||
|
|
||||||
|
# TODO, move to submod `._pausing` or ._api? _trace
|
||||||
|
await _pause(
|
||||||
|
debug_func=partial(
|
||||||
|
_post_mortem,
|
||||||
|
api_frame=api_frame,
|
||||||
|
tb=tb,
|
||||||
|
),
|
||||||
|
hide_tb=hide_tb,
|
||||||
|
**_pause_kwargs
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
async def _maybe_enter_pm(
|
||||||
|
err: BaseException,
|
||||||
|
*,
|
||||||
|
tb: TracebackType|None = None,
|
||||||
|
api_frame: FrameType|None = None,
|
||||||
|
hide_tb: bool = False,
|
||||||
|
|
||||||
|
# only enter debugger REPL when returns `True`
|
||||||
|
debug_filter: Callable[
|
||||||
|
[BaseException|BaseExceptionGroup],
|
||||||
|
bool,
|
||||||
|
] = lambda err: not is_multi_cancelled(err),
|
||||||
|
**_pause_kws,
|
||||||
|
):
|
||||||
|
if (
|
||||||
|
debug_mode()
|
||||||
|
|
||||||
|
# NOTE: don't enter debug mode recursively after quitting pdb
|
||||||
|
# Iow, don't re-enter the repl if the `quit` command was issued
|
||||||
|
# by the user.
|
||||||
|
and not isinstance(err, bdb.BdbQuit)
|
||||||
|
|
||||||
|
# XXX: if the error is the likely result of runtime-wide
|
||||||
|
# cancellation, we don't want to enter the debugger since
|
||||||
|
# there's races between when the parent actor has killed all
|
||||||
|
# comms and when the child tries to contact said parent to
|
||||||
|
# acquire the tty lock.
|
||||||
|
|
||||||
|
# Really we just want to mostly avoid catching KBIs here so there
|
||||||
|
# might be a simpler check we can do?
|
||||||
|
and
|
||||||
|
debug_filter(err)
|
||||||
|
):
|
||||||
|
api_frame: FrameType = api_frame or inspect.currentframe()
|
||||||
|
tb: TracebackType = tb or sys.exc_info()[2]
|
||||||
|
await post_mortem(
|
||||||
|
api_frame=api_frame,
|
||||||
|
tb=tb,
|
||||||
|
**_pause_kws,
|
||||||
|
)
|
||||||
|
return True
|
||||||
|
|
||||||
|
else:
|
||||||
|
return False
|
||||||
|
|
||||||
|
|
||||||
|
# TODO: better naming and what additionals?
|
||||||
|
# - [ ] optional runtime plugging?
|
||||||
|
# - [ ] detection for sync vs. async code?
|
||||||
|
# - [ ] specialized REPL entry when in distributed mode?
|
||||||
|
# -[x] hide tb by def
|
||||||
|
# - [x] allow ignoring kbi Bo
|
||||||
|
@cm
|
||||||
|
def open_crash_handler(
|
||||||
|
catch: set[BaseException] = {
|
||||||
|
BaseException,
|
||||||
|
},
|
||||||
|
ignore: set[BaseException] = {
|
||||||
|
KeyboardInterrupt,
|
||||||
|
trio.Cancelled,
|
||||||
|
},
|
||||||
|
hide_tb: bool = True,
|
||||||
|
|
||||||
|
repl_fixture: (
|
||||||
|
AbstractContextManager[bool] # pre/post REPL entry
|
||||||
|
|None
|
||||||
|
) = None,
|
||||||
|
raise_on_exit: bool|Sequence[Type[BaseException]] = True,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Generic "post mortem" crash handler using `pdbp` REPL debugger.
|
||||||
|
|
||||||
|
We expose this as a CLI framework addon to both `click` and
|
||||||
|
`typer` users so they can quickly wrap cmd endpoints which get
|
||||||
|
automatically wrapped to use the runtime's `debug_mode: bool`
|
||||||
|
AND `pdbp.pm()` around any code that is PRE-runtime entry
|
||||||
|
- any sync code which runs BEFORE the main call to
|
||||||
|
`trio.run()`.
|
||||||
|
|
||||||
|
'''
|
||||||
|
__tracebackhide__: bool = hide_tb
|
||||||
|
|
||||||
|
# TODO, yield a `outcome.Error`-like boxed type?
|
||||||
|
# -[~] use `outcome.Value/Error` X-> frozen!
|
||||||
|
# -[x] write our own..?
|
||||||
|
# -[ ] consider just wtv is used by `pytest.raises()`?
|
||||||
|
#
|
||||||
|
boxed_maybe_exc = BoxedMaybeException(
|
||||||
|
raise_on_exit=raise_on_exit,
|
||||||
|
)
|
||||||
|
err: BaseException
|
||||||
|
try:
|
||||||
|
yield boxed_maybe_exc
|
||||||
|
except tuple(catch) as err:
|
||||||
|
boxed_maybe_exc.value = err
|
||||||
|
if (
|
||||||
|
type(err) not in ignore
|
||||||
|
and
|
||||||
|
not is_multi_cancelled(
|
||||||
|
err,
|
||||||
|
ignore_nested=ignore
|
||||||
|
)
|
||||||
|
):
|
||||||
|
try:
|
||||||
|
# use our re-impl-ed version of `pdbp.xpm()`
|
||||||
|
_post_mortem(
|
||||||
|
repl=mk_pdb(),
|
||||||
|
tb=sys.exc_info()[2],
|
||||||
|
api_frame=inspect.currentframe().f_back,
|
||||||
|
hide_tb=hide_tb,
|
||||||
|
|
||||||
|
repl_fixture=repl_fixture,
|
||||||
|
boxed_maybe_exc=boxed_maybe_exc,
|
||||||
|
)
|
||||||
|
except bdb.BdbQuit:
|
||||||
|
__tracebackhide__: bool = False
|
||||||
|
raise err
|
||||||
|
|
||||||
|
if (
|
||||||
|
raise_on_exit is True
|
||||||
|
or (
|
||||||
|
raise_on_exit is not False
|
||||||
|
and (
|
||||||
|
set(raise_on_exit)
|
||||||
|
and
|
||||||
|
type(err) in raise_on_exit
|
||||||
|
)
|
||||||
|
)
|
||||||
|
and
|
||||||
|
boxed_maybe_exc.raise_on_exit == raise_on_exit
|
||||||
|
):
|
||||||
|
raise err
|
||||||
|
|
||||||
|
|
||||||
|
@cm
|
||||||
|
def maybe_open_crash_handler(
|
||||||
|
pdb: bool|None = None,
|
||||||
|
hide_tb: bool = True,
|
||||||
|
|
||||||
|
**kwargs,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Same as `open_crash_handler()` but with bool input flag
|
||||||
|
to allow conditional handling.
|
||||||
|
|
||||||
|
Normally this is used with CLI endpoints such that if the --pdb
|
||||||
|
flag is passed the pdb REPL is engaed on any crashes B)
|
||||||
|
|
||||||
|
'''
|
||||||
|
__tracebackhide__: bool = hide_tb
|
||||||
|
|
||||||
|
if pdb is None:
|
||||||
|
pdb: bool = _state.is_debug_mode()
|
||||||
|
|
||||||
|
rtctx = nullcontext(
|
||||||
|
enter_result=BoxedMaybeException()
|
||||||
|
)
|
||||||
|
if pdb:
|
||||||
|
rtctx = open_crash_handler(
|
||||||
|
hide_tb=hide_tb,
|
||||||
|
**kwargs,
|
||||||
|
)
|
||||||
|
|
||||||
|
with rtctx as boxed_maybe_exc:
|
||||||
|
yield boxed_maybe_exc
|
|
@ -0,0 +1,207 @@
|
||||||
|
# tractor: structured concurrent "actors".
|
||||||
|
# Copyright 2018-eternity Tyler Goodlet.
|
||||||
|
|
||||||
|
# This program is free software: you can redistribute it and/or
|
||||||
|
# modify it under the terms of the GNU Affero General Public License
|
||||||
|
# as published by the Free Software Foundation, either version 3 of
|
||||||
|
# the License, or (at your option) any later version.
|
||||||
|
|
||||||
|
# This program is distributed in the hope that it will be useful, but
|
||||||
|
# WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||||
|
# Affero General Public License for more details.
|
||||||
|
|
||||||
|
# You should have received a copy of the GNU Affero General Public
|
||||||
|
# License along with this program. If not, see
|
||||||
|
# <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
'''
|
||||||
|
`pdpp.Pdb` extentions/customization and other delegate usage.
|
||||||
|
|
||||||
|
'''
|
||||||
|
from functools import (
|
||||||
|
cached_property,
|
||||||
|
)
|
||||||
|
import os
|
||||||
|
|
||||||
|
import pdbp
|
||||||
|
from tractor._state import (
|
||||||
|
is_root_process,
|
||||||
|
)
|
||||||
|
|
||||||
|
from ._tty_lock import (
|
||||||
|
Lock,
|
||||||
|
DebugStatus,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class TractorConfig(pdbp.DefaultConfig):
|
||||||
|
'''
|
||||||
|
Custom `pdbp` config which tries to use the best tradeoff
|
||||||
|
between pretty and minimal.
|
||||||
|
|
||||||
|
'''
|
||||||
|
use_pygments: bool = True
|
||||||
|
sticky_by_default: bool = False
|
||||||
|
enable_hidden_frames: bool = True
|
||||||
|
|
||||||
|
# much thanks @mdmintz for the hot tip!
|
||||||
|
# fixes line spacing issue when resizing terminal B)
|
||||||
|
truncate_long_lines: bool = False
|
||||||
|
|
||||||
|
# ------ - ------
|
||||||
|
# our own custom config vars mostly
|
||||||
|
# for syncing with the actor tree's singleton
|
||||||
|
# TTY `Lock`.
|
||||||
|
|
||||||
|
|
||||||
|
class PdbREPL(pdbp.Pdb):
|
||||||
|
'''
|
||||||
|
Add teardown hooks and local state describing any
|
||||||
|
ongoing TTY `Lock` request dialog.
|
||||||
|
|
||||||
|
'''
|
||||||
|
# override the pdbp config with our coolio one
|
||||||
|
# NOTE: this is only loaded when no `~/.pdbrc` exists
|
||||||
|
# so we should prolly pass it into the .__init__() instead?
|
||||||
|
# i dunno, see the `DefaultFactory` and `pdb.Pdb` impls.
|
||||||
|
DefaultConfig = TractorConfig
|
||||||
|
|
||||||
|
status = DebugStatus
|
||||||
|
|
||||||
|
# NOTE: see details in stdlib's `bdb.py`
|
||||||
|
# def user_exception(self, frame, exc_info):
|
||||||
|
# '''
|
||||||
|
# Called when we stop on an exception.
|
||||||
|
# '''
|
||||||
|
# log.warning(
|
||||||
|
# 'Exception during REPL sesh\n\n'
|
||||||
|
# f'{frame}\n\n'
|
||||||
|
# f'{exc_info}\n\n'
|
||||||
|
# )
|
||||||
|
|
||||||
|
# NOTE: this actually hooks but i don't see anyway to detect
|
||||||
|
# if an error was caught.. this is why currently we just always
|
||||||
|
# call `DebugStatus.release` inside `_post_mortem()`.
|
||||||
|
# def preloop(self):
|
||||||
|
# print('IN PRELOOP')
|
||||||
|
# super().preloop()
|
||||||
|
|
||||||
|
# TODO: cleaner re-wrapping of all this?
|
||||||
|
# -[ ] figure out how to disallow recursive .set_trace() entry
|
||||||
|
# since that'll cause deadlock for us.
|
||||||
|
# -[ ] maybe a `@cm` to call `super().<same_meth_name>()`?
|
||||||
|
# -[ ] look at hooking into the `pp` hook specially with our
|
||||||
|
# own set of pretty-printers?
|
||||||
|
# * `.pretty_struct.Struct.pformat()`
|
||||||
|
# * `.pformat(MsgType.pld)`
|
||||||
|
# * `.pformat(Error.tb_str)`?
|
||||||
|
# * .. maybe more?
|
||||||
|
#
|
||||||
|
def set_continue(self):
|
||||||
|
try:
|
||||||
|
super().set_continue()
|
||||||
|
finally:
|
||||||
|
# NOTE: for subactors the stdio lock is released via the
|
||||||
|
# allocated RPC locker task, so for root we have to do it
|
||||||
|
# manually.
|
||||||
|
if (
|
||||||
|
is_root_process()
|
||||||
|
and
|
||||||
|
Lock._debug_lock.locked()
|
||||||
|
and
|
||||||
|
DebugStatus.is_main_trio_thread()
|
||||||
|
):
|
||||||
|
# Lock.release(raise_on_thread=False)
|
||||||
|
Lock.release()
|
||||||
|
|
||||||
|
# XXX AFTER `Lock.release()` for root local repl usage
|
||||||
|
DebugStatus.release()
|
||||||
|
|
||||||
|
def set_quit(self):
|
||||||
|
try:
|
||||||
|
super().set_quit()
|
||||||
|
finally:
|
||||||
|
if (
|
||||||
|
is_root_process()
|
||||||
|
and
|
||||||
|
Lock._debug_lock.locked()
|
||||||
|
and
|
||||||
|
DebugStatus.is_main_trio_thread()
|
||||||
|
):
|
||||||
|
# Lock.release(raise_on_thread=False)
|
||||||
|
Lock.release()
|
||||||
|
|
||||||
|
# XXX after `Lock.release()` for root local repl usage
|
||||||
|
DebugStatus.release()
|
||||||
|
|
||||||
|
# XXX NOTE: we only override this because apparently the stdlib pdb
|
||||||
|
# bois likes to touch the SIGINT handler as much as i like to touch
|
||||||
|
# my d$%&.
|
||||||
|
def _cmdloop(self):
|
||||||
|
self.cmdloop()
|
||||||
|
|
||||||
|
@cached_property
|
||||||
|
def shname(self) -> str | None:
|
||||||
|
'''
|
||||||
|
Attempt to return the login shell name with a special check for
|
||||||
|
the infamous `xonsh` since it seems to have some issues much
|
||||||
|
different from std shells when it comes to flushing the prompt?
|
||||||
|
|
||||||
|
'''
|
||||||
|
# SUPER HACKY and only really works if `xonsh` is not used
|
||||||
|
# before spawning further sub-shells..
|
||||||
|
shpath = os.getenv('SHELL', None)
|
||||||
|
|
||||||
|
if shpath:
|
||||||
|
if (
|
||||||
|
os.getenv('XONSH_LOGIN', default=False)
|
||||||
|
or 'xonsh' in shpath
|
||||||
|
):
|
||||||
|
return 'xonsh'
|
||||||
|
|
||||||
|
return os.path.basename(shpath)
|
||||||
|
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
def mk_pdb() -> PdbREPL:
|
||||||
|
'''
|
||||||
|
Deliver a new `PdbREPL`: a multi-process safe `pdbp.Pdb`-variant
|
||||||
|
using the magic of `tractor`'s SC-safe IPC.
|
||||||
|
|
||||||
|
B)
|
||||||
|
|
||||||
|
Our `pdb.Pdb` subtype accomplishes multi-process safe debugging
|
||||||
|
by:
|
||||||
|
|
||||||
|
- mutexing access to the root process' std-streams (& thus parent
|
||||||
|
process TTY) via an IPC managed `Lock` singleton per
|
||||||
|
actor-process tree.
|
||||||
|
|
||||||
|
- temporarily overriding any subactor's SIGINT handler to shield
|
||||||
|
during live REPL sessions in sub-actors such that cancellation
|
||||||
|
is never (mistakenly) triggered by a ctrl-c and instead only by
|
||||||
|
explicit runtime API requests or after the
|
||||||
|
`pdb.Pdb.interaction()` call has returned.
|
||||||
|
|
||||||
|
FURTHER, the `pdbp.Pdb` instance is configured to be `trio`
|
||||||
|
"compatible" from a SIGINT handling perspective; we mask out
|
||||||
|
the default `pdb` handler and instead apply `trio`s default
|
||||||
|
which mostly addresses all issues described in:
|
||||||
|
|
||||||
|
- https://github.com/python-trio/trio/issues/1155
|
||||||
|
|
||||||
|
The instance returned from this factory should always be
|
||||||
|
preferred over the default `pdb[p].set_trace()` whenever using
|
||||||
|
a `pdb` REPL inside a `trio` based runtime.
|
||||||
|
|
||||||
|
'''
|
||||||
|
pdb = PdbREPL()
|
||||||
|
|
||||||
|
# XXX: These are the important flags mentioned in
|
||||||
|
# https://github.com/python-trio/trio/issues/1155
|
||||||
|
# which resolve the traceback spews to console.
|
||||||
|
pdb.allow_kbdint = True
|
||||||
|
pdb.nosigint = True
|
||||||
|
return pdb
|
|
@ -0,0 +1,333 @@
|
||||||
|
# tractor: structured concurrent "actors".
|
||||||
|
# Copyright 2018-eternity Tyler Goodlet.
|
||||||
|
|
||||||
|
# This program is free software: you can redistribute it and/or
|
||||||
|
# modify it under the terms of the GNU Affero General Public License
|
||||||
|
# as published by the Free Software Foundation, either version 3 of
|
||||||
|
# the License, or (at your option) any later version.
|
||||||
|
|
||||||
|
# This program is distributed in the hope that it will be useful, but
|
||||||
|
# WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||||
|
# Affero General Public License for more details.
|
||||||
|
|
||||||
|
# You should have received a copy of the GNU Affero General Public
|
||||||
|
# License along with this program. If not, see
|
||||||
|
# <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
'''
|
||||||
|
A custom SIGINT handler which mainly shields actor (task)
|
||||||
|
cancellation during REPL interaction.
|
||||||
|
|
||||||
|
'''
|
||||||
|
from __future__ import annotations
|
||||||
|
from typing import (
|
||||||
|
TYPE_CHECKING,
|
||||||
|
)
|
||||||
|
import trio
|
||||||
|
from tractor.log import get_logger
|
||||||
|
from tractor._state import (
|
||||||
|
current_actor,
|
||||||
|
is_root_process,
|
||||||
|
)
|
||||||
|
from ._repl import (
|
||||||
|
PdbREPL,
|
||||||
|
)
|
||||||
|
from ._tty_lock import (
|
||||||
|
any_connected_locker_child,
|
||||||
|
DebugStatus,
|
||||||
|
Lock,
|
||||||
|
)
|
||||||
|
|
||||||
|
if TYPE_CHECKING:
|
||||||
|
from tractor.ipc import (
|
||||||
|
Channel,
|
||||||
|
)
|
||||||
|
from tractor._runtime import (
|
||||||
|
Actor,
|
||||||
|
)
|
||||||
|
|
||||||
|
log = get_logger(__name__)
|
||||||
|
|
||||||
|
_ctlc_ignore_header: str = (
|
||||||
|
'Ignoring SIGINT while debug REPL in use'
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def sigint_shield(
|
||||||
|
signum: int,
|
||||||
|
frame: 'frame', # type: ignore # noqa
|
||||||
|
*args,
|
||||||
|
|
||||||
|
) -> None:
|
||||||
|
'''
|
||||||
|
Specialized, debugger-aware SIGINT handler.
|
||||||
|
|
||||||
|
In childred we always ignore/shield for SIGINT to avoid
|
||||||
|
deadlocks since cancellation should always be managed by the
|
||||||
|
supervising parent actor. The root actor-proces is always
|
||||||
|
cancelled on ctrl-c.
|
||||||
|
|
||||||
|
'''
|
||||||
|
__tracebackhide__: bool = True
|
||||||
|
actor: Actor = current_actor()
|
||||||
|
|
||||||
|
def do_cancel():
|
||||||
|
# If we haven't tried to cancel the runtime then do that instead
|
||||||
|
# of raising a KBI (which may non-gracefully destroy
|
||||||
|
# a ``trio.run()``).
|
||||||
|
if not actor._cancel_called:
|
||||||
|
actor.cancel_soon()
|
||||||
|
|
||||||
|
# If the runtime is already cancelled it likely means the user
|
||||||
|
# hit ctrl-c again because teardown didn't fully take place in
|
||||||
|
# which case we do the "hard" raising of a local KBI.
|
||||||
|
else:
|
||||||
|
raise KeyboardInterrupt
|
||||||
|
|
||||||
|
# only set in the actor actually running the REPL
|
||||||
|
repl: PdbREPL|None = DebugStatus.repl
|
||||||
|
|
||||||
|
# TODO: maybe we should flatten out all these cases using
|
||||||
|
# a match/case?
|
||||||
|
#
|
||||||
|
# root actor branch that reports whether or not a child
|
||||||
|
# has locked debugger.
|
||||||
|
if is_root_process():
|
||||||
|
# log.warning(
|
||||||
|
log.devx(
|
||||||
|
'Handling SIGINT in root actor\n'
|
||||||
|
f'{Lock.repr()}'
|
||||||
|
f'{DebugStatus.repr()}\n'
|
||||||
|
)
|
||||||
|
# try to see if the supposed (sub)actor in debug still
|
||||||
|
# has an active connection to *this* actor, and if not
|
||||||
|
# it's likely they aren't using the TTY lock / debugger
|
||||||
|
# and we should propagate SIGINT normally.
|
||||||
|
any_connected: bool = any_connected_locker_child()
|
||||||
|
|
||||||
|
problem = (
|
||||||
|
f'root {actor.uid} handling SIGINT\n'
|
||||||
|
f'any_connected: {any_connected}\n\n'
|
||||||
|
|
||||||
|
f'{Lock.repr()}\n'
|
||||||
|
)
|
||||||
|
|
||||||
|
if (
|
||||||
|
(ctx := Lock.ctx_in_debug)
|
||||||
|
and
|
||||||
|
(uid_in_debug := ctx.chan.uid) # "someone" is (ostensibly) using debug `Lock`
|
||||||
|
):
|
||||||
|
name_in_debug: str = uid_in_debug[0]
|
||||||
|
assert not repl
|
||||||
|
# if not repl: # but it's NOT us, the root actor.
|
||||||
|
# sanity: since no repl ref is set, we def shouldn't
|
||||||
|
# be the lock owner!
|
||||||
|
assert name_in_debug != 'root'
|
||||||
|
|
||||||
|
# IDEAL CASE: child has REPL as expected
|
||||||
|
if any_connected: # there are subactors we can contact
|
||||||
|
# XXX: only if there is an existing connection to the
|
||||||
|
# (sub-)actor in debug do we ignore SIGINT in this
|
||||||
|
# parent! Otherwise we may hang waiting for an actor
|
||||||
|
# which has already terminated to unlock.
|
||||||
|
#
|
||||||
|
# NOTE: don't emit this with `.pdb()` level in
|
||||||
|
# root without a higher level.
|
||||||
|
log.runtime(
|
||||||
|
_ctlc_ignore_header
|
||||||
|
+
|
||||||
|
f' by child '
|
||||||
|
f'{uid_in_debug}\n'
|
||||||
|
)
|
||||||
|
problem = None
|
||||||
|
|
||||||
|
else:
|
||||||
|
problem += (
|
||||||
|
'\n'
|
||||||
|
f'A `pdb` REPL is SUPPOSEDLY in use by child {uid_in_debug}\n'
|
||||||
|
f'BUT, no child actors are IPC contactable!?!?\n'
|
||||||
|
)
|
||||||
|
|
||||||
|
# IDEAL CASE: root has REPL as expected
|
||||||
|
else:
|
||||||
|
# root actor still has this SIGINT handler active without
|
||||||
|
# an actor using the `Lock` (a bug state) ??
|
||||||
|
# => so immediately cancel any stale lock cs and revert
|
||||||
|
# the handler!
|
||||||
|
if not DebugStatus.repl:
|
||||||
|
# TODO: WHEN should we revert back to ``trio``
|
||||||
|
# handler if this one is stale?
|
||||||
|
# -[ ] maybe after a counts work of ctl-c mashes?
|
||||||
|
# -[ ] use a state var like `stale_handler: bool`?
|
||||||
|
problem += (
|
||||||
|
'No subactor is using a `pdb` REPL according `Lock.ctx_in_debug`?\n'
|
||||||
|
'BUT, the root should be using it, WHY this handler ??\n\n'
|
||||||
|
'So either..\n'
|
||||||
|
'- some root-thread is using it but has no `.repl` set?, OR\n'
|
||||||
|
'- something else weird is going on outside the runtime!?\n'
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
# NOTE: since we emit this msg on ctl-c, we should
|
||||||
|
# also always re-print the prompt the tail block!
|
||||||
|
log.pdb(
|
||||||
|
_ctlc_ignore_header
|
||||||
|
+
|
||||||
|
f' by root actor..\n'
|
||||||
|
f'{DebugStatus.repl_task}\n'
|
||||||
|
f' |_{repl}\n'
|
||||||
|
)
|
||||||
|
problem = None
|
||||||
|
|
||||||
|
# XXX if one is set it means we ARE NOT operating an ideal
|
||||||
|
# case where a child subactor or us (the root) has the
|
||||||
|
# lock without any other detected problems.
|
||||||
|
if problem:
|
||||||
|
|
||||||
|
# detect, report and maybe clear a stale lock request
|
||||||
|
# cancel scope.
|
||||||
|
lock_cs: trio.CancelScope = Lock.get_locking_task_cs()
|
||||||
|
maybe_stale_lock_cs: bool = (
|
||||||
|
lock_cs is not None
|
||||||
|
and not lock_cs.cancel_called
|
||||||
|
)
|
||||||
|
if maybe_stale_lock_cs:
|
||||||
|
problem += (
|
||||||
|
'\n'
|
||||||
|
'Stale `Lock.ctx_in_debug._scope: CancelScope` detected?\n'
|
||||||
|
f'{Lock.ctx_in_debug}\n\n'
|
||||||
|
|
||||||
|
'-> Calling ctx._scope.cancel()!\n'
|
||||||
|
)
|
||||||
|
lock_cs.cancel()
|
||||||
|
|
||||||
|
# TODO: wen do we actually want/need this, see above.
|
||||||
|
# DebugStatus.unshield_sigint()
|
||||||
|
log.warning(problem)
|
||||||
|
|
||||||
|
# child actor that has locked the debugger
|
||||||
|
elif not is_root_process():
|
||||||
|
log.debug(
|
||||||
|
f'Subactor {actor.uid} handling SIGINT\n\n'
|
||||||
|
f'{Lock.repr()}\n'
|
||||||
|
)
|
||||||
|
|
||||||
|
rent_chan: Channel = actor._parent_chan
|
||||||
|
if (
|
||||||
|
rent_chan is None
|
||||||
|
or
|
||||||
|
not rent_chan.connected()
|
||||||
|
):
|
||||||
|
log.warning(
|
||||||
|
'This sub-actor thinks it is debugging '
|
||||||
|
'but it has no connection to its parent ??\n'
|
||||||
|
f'{actor.uid}\n'
|
||||||
|
'Allowing SIGINT propagation..'
|
||||||
|
)
|
||||||
|
DebugStatus.unshield_sigint()
|
||||||
|
|
||||||
|
repl_task: str|None = DebugStatus.repl_task
|
||||||
|
req_task: str|None = DebugStatus.req_task
|
||||||
|
if (
|
||||||
|
repl_task
|
||||||
|
and
|
||||||
|
repl
|
||||||
|
):
|
||||||
|
log.pdb(
|
||||||
|
_ctlc_ignore_header
|
||||||
|
+
|
||||||
|
f' by local task\n\n'
|
||||||
|
f'{repl_task}\n'
|
||||||
|
f' |_{repl}\n'
|
||||||
|
)
|
||||||
|
elif req_task:
|
||||||
|
log.debug(
|
||||||
|
_ctlc_ignore_header
|
||||||
|
+
|
||||||
|
f' by local request-task and either,\n'
|
||||||
|
f'- someone else is already REPL-in and has the `Lock`, or\n'
|
||||||
|
f'- some other local task already is replin?\n\n'
|
||||||
|
f'{req_task}\n'
|
||||||
|
)
|
||||||
|
|
||||||
|
# TODO can we remove this now?
|
||||||
|
# -[ ] does this path ever get hit any more?
|
||||||
|
else:
|
||||||
|
msg: str = (
|
||||||
|
'SIGINT shield handler still active BUT, \n\n'
|
||||||
|
)
|
||||||
|
if repl_task is None:
|
||||||
|
msg += (
|
||||||
|
'- No local task claims to be in debug?\n'
|
||||||
|
)
|
||||||
|
|
||||||
|
if repl is None:
|
||||||
|
msg += (
|
||||||
|
'- No local REPL is currently active?\n'
|
||||||
|
)
|
||||||
|
|
||||||
|
if req_task is None:
|
||||||
|
msg += (
|
||||||
|
'- No debug request task is active?\n'
|
||||||
|
)
|
||||||
|
|
||||||
|
log.warning(
|
||||||
|
msg
|
||||||
|
+
|
||||||
|
'Reverting handler to `trio` default!\n'
|
||||||
|
)
|
||||||
|
DebugStatus.unshield_sigint()
|
||||||
|
|
||||||
|
# XXX ensure that the reverted-to-handler actually is
|
||||||
|
# able to rx what should have been **this** KBI ;)
|
||||||
|
do_cancel()
|
||||||
|
|
||||||
|
# TODO: how to handle the case of an intermediary-child actor
|
||||||
|
# that **is not** marked in debug mode? See oustanding issue:
|
||||||
|
# https://github.com/goodboy/tractor/issues/320
|
||||||
|
# elif debug_mode():
|
||||||
|
|
||||||
|
# maybe redraw/print last REPL output to console since
|
||||||
|
# we want to alert the user that more input is expect since
|
||||||
|
# nothing has been done dur to ignoring sigint.
|
||||||
|
if (
|
||||||
|
DebugStatus.repl # only when current actor has a REPL engaged
|
||||||
|
):
|
||||||
|
flush_status: str = (
|
||||||
|
'Flushing stdout to ensure new prompt line!\n'
|
||||||
|
)
|
||||||
|
|
||||||
|
# XXX: yah, mega hack, but how else do we catch this madness XD
|
||||||
|
if (
|
||||||
|
repl.shname == 'xonsh'
|
||||||
|
):
|
||||||
|
flush_status += (
|
||||||
|
'-> ALSO re-flushing due to `xonsh`..\n'
|
||||||
|
)
|
||||||
|
repl.stdout.write(repl.prompt)
|
||||||
|
|
||||||
|
# log.warning(
|
||||||
|
log.devx(
|
||||||
|
flush_status
|
||||||
|
)
|
||||||
|
repl.stdout.flush()
|
||||||
|
|
||||||
|
# TODO: better console UX to match the current "mode":
|
||||||
|
# -[ ] for example if in sticky mode where if there is output
|
||||||
|
# detected as written to the tty we redraw this part underneath
|
||||||
|
# and erase the past draw of this same bit above?
|
||||||
|
# repl.sticky = True
|
||||||
|
# repl._print_if_sticky()
|
||||||
|
|
||||||
|
# also see these links for an approach from `ptk`:
|
||||||
|
# https://github.com/goodboy/tractor/issues/130#issuecomment-663752040
|
||||||
|
# https://github.com/prompt-toolkit/python-prompt-toolkit/blob/c2c6af8a0308f9e5d7c0e28cb8a02963fe0ce07a/prompt_toolkit/patch_stdout.py
|
||||||
|
else:
|
||||||
|
log.devx(
|
||||||
|
# log.warning(
|
||||||
|
'Not flushing stdout since not needed?\n'
|
||||||
|
f'|_{repl}\n'
|
||||||
|
)
|
||||||
|
|
||||||
|
# XXX only for tracing this handler
|
||||||
|
log.devx('exiting SIGINT')
|
|
@ -0,0 +1,220 @@
|
||||||
|
# tractor: structured concurrent "actors".
|
||||||
|
# Copyright 2018-eternity Tyler Goodlet.
|
||||||
|
|
||||||
|
# This program is free software: you can redistribute it and/or
|
||||||
|
# modify it under the terms of the GNU Affero General Public License
|
||||||
|
# as published by the Free Software Foundation, either version 3 of
|
||||||
|
# the License, or (at your option) any later version.
|
||||||
|
|
||||||
|
# This program is distributed in the hope that it will be useful, but
|
||||||
|
# WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||||
|
# Affero General Public License for more details.
|
||||||
|
|
||||||
|
# You should have received a copy of the GNU Affero General Public
|
||||||
|
# License along with this program. If not, see
|
||||||
|
# <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
'''
|
||||||
|
Debugger synchronization APIs to ensure orderly access and
|
||||||
|
non-TTY-clobbering graceful teardown.
|
||||||
|
|
||||||
|
|
||||||
|
'''
|
||||||
|
from __future__ import annotations
|
||||||
|
from contextlib import (
|
||||||
|
asynccontextmanager as acm,
|
||||||
|
)
|
||||||
|
from functools import (
|
||||||
|
partial,
|
||||||
|
)
|
||||||
|
from typing import (
|
||||||
|
AsyncGenerator,
|
||||||
|
Callable,
|
||||||
|
)
|
||||||
|
|
||||||
|
from tractor.log import get_logger
|
||||||
|
import trio
|
||||||
|
from trio.lowlevel import (
|
||||||
|
current_task,
|
||||||
|
Task,
|
||||||
|
)
|
||||||
|
from tractor._context import Context
|
||||||
|
from tractor._state import (
|
||||||
|
current_actor,
|
||||||
|
debug_mode,
|
||||||
|
is_root_process,
|
||||||
|
)
|
||||||
|
from ._repl import (
|
||||||
|
TractorConfig as TractorConfig,
|
||||||
|
)
|
||||||
|
from ._tty_lock import (
|
||||||
|
Lock,
|
||||||
|
request_root_stdio_lock,
|
||||||
|
any_connected_locker_child,
|
||||||
|
)
|
||||||
|
from ._sigint import (
|
||||||
|
sigint_shield as sigint_shield,
|
||||||
|
_ctlc_ignore_header as _ctlc_ignore_header
|
||||||
|
)
|
||||||
|
|
||||||
|
log = get_logger(__package__)
|
||||||
|
|
||||||
|
|
||||||
|
async def maybe_wait_for_debugger(
|
||||||
|
poll_steps: int = 2,
|
||||||
|
poll_delay: float = 0.1,
|
||||||
|
child_in_debug: bool = False,
|
||||||
|
|
||||||
|
header_msg: str = '',
|
||||||
|
_ll: str = 'devx',
|
||||||
|
|
||||||
|
) -> bool: # was locked and we polled?
|
||||||
|
|
||||||
|
if (
|
||||||
|
not debug_mode()
|
||||||
|
and
|
||||||
|
not child_in_debug
|
||||||
|
):
|
||||||
|
return False
|
||||||
|
|
||||||
|
logmeth: Callable = getattr(log, _ll)
|
||||||
|
|
||||||
|
msg: str = header_msg
|
||||||
|
if (
|
||||||
|
is_root_process()
|
||||||
|
):
|
||||||
|
# If we error in the root but the debugger is
|
||||||
|
# engaged we don't want to prematurely kill (and
|
||||||
|
# thus clobber access to) the local tty since it
|
||||||
|
# will make the pdb repl unusable.
|
||||||
|
# Instead try to wait for pdb to be released before
|
||||||
|
# tearing down.
|
||||||
|
ctx_in_debug: Context|None = Lock.ctx_in_debug
|
||||||
|
in_debug: tuple[str, str]|None = (
|
||||||
|
ctx_in_debug.chan.uid
|
||||||
|
if ctx_in_debug
|
||||||
|
else None
|
||||||
|
)
|
||||||
|
if in_debug == current_actor().uid:
|
||||||
|
log.debug(
|
||||||
|
msg
|
||||||
|
+
|
||||||
|
'Root already owns the TTY LOCK'
|
||||||
|
)
|
||||||
|
return True
|
||||||
|
|
||||||
|
elif in_debug:
|
||||||
|
msg += (
|
||||||
|
f'Debug `Lock` in use by subactor\n|\n|_{in_debug}\n'
|
||||||
|
)
|
||||||
|
# TODO: could this make things more deterministic?
|
||||||
|
# wait to see if a sub-actor task will be
|
||||||
|
# scheduled and grab the tty lock on the next
|
||||||
|
# tick?
|
||||||
|
# XXX => but it doesn't seem to work..
|
||||||
|
# await trio.testing.wait_all_tasks_blocked(cushion=0)
|
||||||
|
else:
|
||||||
|
logmeth(
|
||||||
|
msg
|
||||||
|
+
|
||||||
|
'Root immediately acquired debug TTY LOCK'
|
||||||
|
)
|
||||||
|
return False
|
||||||
|
|
||||||
|
for istep in range(poll_steps):
|
||||||
|
if (
|
||||||
|
Lock.req_handler_finished is not None
|
||||||
|
and not Lock.req_handler_finished.is_set()
|
||||||
|
and in_debug is not None
|
||||||
|
):
|
||||||
|
# caller_frame_info: str = pformat_caller_frame()
|
||||||
|
logmeth(
|
||||||
|
msg
|
||||||
|
+
|
||||||
|
'\n^^ Root is waiting on tty lock release.. ^^\n'
|
||||||
|
# f'{caller_frame_info}\n'
|
||||||
|
)
|
||||||
|
|
||||||
|
if not any_connected_locker_child():
|
||||||
|
Lock.get_locking_task_cs().cancel()
|
||||||
|
|
||||||
|
with trio.CancelScope(shield=True):
|
||||||
|
await Lock.req_handler_finished.wait()
|
||||||
|
|
||||||
|
log.devx(
|
||||||
|
f'Subactor released debug lock\n'
|
||||||
|
f'|_{in_debug}\n'
|
||||||
|
)
|
||||||
|
break
|
||||||
|
|
||||||
|
# is no subactor locking debugger currently?
|
||||||
|
if (
|
||||||
|
in_debug is None
|
||||||
|
and (
|
||||||
|
Lock.req_handler_finished is None
|
||||||
|
or Lock.req_handler_finished.is_set()
|
||||||
|
)
|
||||||
|
):
|
||||||
|
logmeth(
|
||||||
|
msg
|
||||||
|
+
|
||||||
|
'Root acquired tty lock!'
|
||||||
|
)
|
||||||
|
break
|
||||||
|
|
||||||
|
else:
|
||||||
|
logmeth(
|
||||||
|
'Root polling for debug:\n'
|
||||||
|
f'poll step: {istep}\n'
|
||||||
|
f'poll delya: {poll_delay}\n\n'
|
||||||
|
f'{Lock.repr()}\n'
|
||||||
|
)
|
||||||
|
with trio.CancelScope(shield=True):
|
||||||
|
await trio.sleep(poll_delay)
|
||||||
|
continue
|
||||||
|
|
||||||
|
return True
|
||||||
|
|
||||||
|
# else:
|
||||||
|
# # TODO: non-root call for #320?
|
||||||
|
# this_uid: tuple[str, str] = current_actor().uid
|
||||||
|
# async with acquire_debug_lock(
|
||||||
|
# subactor_uid=this_uid,
|
||||||
|
# ):
|
||||||
|
# pass
|
||||||
|
return False
|
||||||
|
|
||||||
|
|
||||||
|
@acm
|
||||||
|
async def acquire_debug_lock(
|
||||||
|
subactor_uid: tuple[str, str],
|
||||||
|
) -> AsyncGenerator[
|
||||||
|
trio.CancelScope|None,
|
||||||
|
tuple,
|
||||||
|
]:
|
||||||
|
'''
|
||||||
|
Request to acquire the TTY `Lock` in the root actor, release on
|
||||||
|
exit.
|
||||||
|
|
||||||
|
This helper is for actor's who don't actually need to acquired
|
||||||
|
the debugger but want to wait until the lock is free in the
|
||||||
|
process-tree root such that they don't clobber an ongoing pdb
|
||||||
|
REPL session in some peer or child!
|
||||||
|
|
||||||
|
'''
|
||||||
|
if not debug_mode():
|
||||||
|
yield None
|
||||||
|
return
|
||||||
|
|
||||||
|
task: Task = current_task()
|
||||||
|
async with trio.open_nursery() as n:
|
||||||
|
ctx: Context = await n.start(
|
||||||
|
partial(
|
||||||
|
request_root_stdio_lock,
|
||||||
|
actor_uid=subactor_uid,
|
||||||
|
task_uid=(task.name, id(task)),
|
||||||
|
)
|
||||||
|
)
|
||||||
|
yield ctx
|
||||||
|
ctx.cancel()
|
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
|
@ -15,8 +15,10 @@
|
||||||
# along with this program. If not, see <https://www.gnu.org/licenses/>.
|
# along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
'''
|
'''
|
||||||
Pretty formatters for use throughout the code base.
|
Pretty formatters for use throughout our internals.
|
||||||
Mostly handy for logging and exception message content.
|
|
||||||
|
Handy for logging and exception message content but also for `repr()`
|
||||||
|
in REPL(s).
|
||||||
|
|
||||||
'''
|
'''
|
||||||
import sys
|
import sys
|
||||||
|
@ -224,8 +226,8 @@ def pformat_cs(
|
||||||
field_prefix: str = ' |_',
|
field_prefix: str = ' |_',
|
||||||
) -> str:
|
) -> str:
|
||||||
'''
|
'''
|
||||||
Pretty format info about a `trio.CancelScope` including most
|
Pretty format info about a `trio.CancelScope` including most of
|
||||||
of its public state and `._cancel_status`.
|
its public state and `._cancel_status`.
|
||||||
|
|
||||||
The output can be modified to show a "var name" for the
|
The output can be modified to show a "var name" for the
|
||||||
instance as a field prefix, just a simple str before each
|
instance as a field prefix, just a simple str before each
|
||||||
|
@ -247,3 +249,279 @@ def pformat_cs(
|
||||||
+
|
+
|
||||||
fields
|
fields
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def nest_from_op(
|
||||||
|
input_op: str, # TODO, Literal of all op-"symbols" from below?
|
||||||
|
text: str,
|
||||||
|
prefix_op: bool = True, # unset is to suffix the first line
|
||||||
|
# optionally suffix `text`, by def on a newline
|
||||||
|
op_suffix='\n',
|
||||||
|
|
||||||
|
nest_prefix: str = '|_',
|
||||||
|
nest_indent: int|None = None,
|
||||||
|
# XXX indent `next_prefix` "to-the-right-of" `input_op`
|
||||||
|
# by this count of whitespaces (' ').
|
||||||
|
rm_from_first_ln: str|None = None,
|
||||||
|
|
||||||
|
) -> str:
|
||||||
|
'''
|
||||||
|
Depth-increment the input (presumably hierarchy/supervision)
|
||||||
|
input "tree string" below the provided `input_op` execution
|
||||||
|
operator, so injecting a `"\n|_{input_op}\n"`and indenting the
|
||||||
|
`tree_str` to nest content aligned with the ops last char.
|
||||||
|
|
||||||
|
'''
|
||||||
|
# `sclang` "structurred-concurrency-language": an ascii-encoded
|
||||||
|
# symbolic alphabet to describe concurrent systems.
|
||||||
|
#
|
||||||
|
# ?TODO? aa more fomal idea for a syntax to the state of
|
||||||
|
# concurrent systems as a "3-domain" (execution, scope, storage)
|
||||||
|
# model and using a minimal ascii/utf-8 operator-set.
|
||||||
|
#
|
||||||
|
# try not to take any of this seriously yet XD
|
||||||
|
#
|
||||||
|
# > is a "play operator" indicating (CPU bound)
|
||||||
|
# exec/work/ops required at the "lowest level computing"
|
||||||
|
#
|
||||||
|
# execution primititves (tasks, threads, actors..) denote their
|
||||||
|
# lifetime with '(' and ')' since parentheses normally are used
|
||||||
|
# in many langs to denote function calls.
|
||||||
|
#
|
||||||
|
# starting = (
|
||||||
|
# >( opening/starting; beginning of the thread-of-exec (toe?)
|
||||||
|
# (> opened/started, (finished spawning toe)
|
||||||
|
# |_<Task: blah blah..> repr of toe, in py these look like <objs>
|
||||||
|
#
|
||||||
|
# >) closing/exiting/stopping,
|
||||||
|
# )> closed/exited/stopped,
|
||||||
|
# |_<Task: blah blah..>
|
||||||
|
# [OR <), )< ?? ]
|
||||||
|
#
|
||||||
|
# ending = )
|
||||||
|
# >c) cancelling to close/exit
|
||||||
|
# c)> cancelled (caused close), OR?
|
||||||
|
# |_<Actor: ..>
|
||||||
|
# OR maybe "<c)" which better indicates the cancel being
|
||||||
|
# "delivered/returned" / returned" to LHS?
|
||||||
|
#
|
||||||
|
# >x) erroring to eventuall exit
|
||||||
|
# x)> errored and terminated
|
||||||
|
# |_<Actor: ...>
|
||||||
|
#
|
||||||
|
# scopes: supers/nurseries, IPC-ctxs, sessions, perms, etc.
|
||||||
|
# >{ opening
|
||||||
|
# {> opened
|
||||||
|
# }> closed
|
||||||
|
# >} closing
|
||||||
|
#
|
||||||
|
# storage: like queues, shm-buffers, files, etc..
|
||||||
|
# >[ opening
|
||||||
|
# [> opened
|
||||||
|
# |_<FileObj: ..>
|
||||||
|
#
|
||||||
|
# >] closing
|
||||||
|
# ]> closed
|
||||||
|
|
||||||
|
# IPC ops: channels, transports, msging
|
||||||
|
# => req msg
|
||||||
|
# <= resp msg
|
||||||
|
# <=> 2-way streaming (of msgs)
|
||||||
|
# <- recv 1 msg
|
||||||
|
# -> send 1 msg
|
||||||
|
#
|
||||||
|
# TODO: still not sure on R/L-HS approach..?
|
||||||
|
# =>( send-req to exec start (task, actor, thread..)
|
||||||
|
# (<= recv-req to ^
|
||||||
|
#
|
||||||
|
# (<= recv-req ^
|
||||||
|
# <=( recv-resp opened remote exec primitive
|
||||||
|
# <=) recv-resp closed
|
||||||
|
#
|
||||||
|
# )<=c req to stop due to cancel
|
||||||
|
# c=>) req to stop due to cancel
|
||||||
|
#
|
||||||
|
# =>{ recv-req to open
|
||||||
|
# <={ send-status that it closed
|
||||||
|
#
|
||||||
|
if (
|
||||||
|
nest_prefix
|
||||||
|
and
|
||||||
|
nest_indent != 0
|
||||||
|
):
|
||||||
|
if nest_indent is not None:
|
||||||
|
nest_prefix: str = textwrap.indent(
|
||||||
|
nest_prefix,
|
||||||
|
prefix=nest_indent*' ',
|
||||||
|
)
|
||||||
|
nest_indent: int = len(nest_prefix)
|
||||||
|
|
||||||
|
# determine body-text indent either by,
|
||||||
|
# - using wtv explicit indent value is provided,
|
||||||
|
# OR
|
||||||
|
# - auto-calcing the indent to embed `text` under
|
||||||
|
# the `nest_prefix` if provided, **IFF** `nest_indent=None`.
|
||||||
|
tree_str_indent: int = 0
|
||||||
|
if nest_indent not in {0, None}:
|
||||||
|
tree_str_indent = nest_indent
|
||||||
|
elif (
|
||||||
|
nest_prefix
|
||||||
|
and
|
||||||
|
nest_indent != 0
|
||||||
|
):
|
||||||
|
tree_str_indent = len(nest_prefix)
|
||||||
|
|
||||||
|
indented_tree_str: str = text
|
||||||
|
if tree_str_indent:
|
||||||
|
indented_tree_str: str = textwrap.indent(
|
||||||
|
text,
|
||||||
|
prefix=' '*tree_str_indent,
|
||||||
|
)
|
||||||
|
|
||||||
|
# inject any provided nesting-prefix chars
|
||||||
|
# into the head of the first line.
|
||||||
|
if nest_prefix:
|
||||||
|
indented_tree_str: str = (
|
||||||
|
f'{nest_prefix}{indented_tree_str[tree_str_indent:]}'
|
||||||
|
)
|
||||||
|
|
||||||
|
if (
|
||||||
|
not prefix_op
|
||||||
|
or
|
||||||
|
rm_from_first_ln
|
||||||
|
):
|
||||||
|
tree_lns: list[str] = indented_tree_str.splitlines()
|
||||||
|
first: str = tree_lns[0]
|
||||||
|
if rm_from_first_ln:
|
||||||
|
first = first.strip().replace(
|
||||||
|
rm_from_first_ln,
|
||||||
|
'',
|
||||||
|
)
|
||||||
|
indented_tree_str: str = '\n'.join(tree_lns[1:])
|
||||||
|
|
||||||
|
if prefix_op:
|
||||||
|
indented_tree_str = (
|
||||||
|
f'{first}\n'
|
||||||
|
f'{indented_tree_str}'
|
||||||
|
)
|
||||||
|
|
||||||
|
if prefix_op:
|
||||||
|
return (
|
||||||
|
f'{input_op}{op_suffix}'
|
||||||
|
f'{indented_tree_str}'
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
return (
|
||||||
|
f'{first}{input_op}{op_suffix}'
|
||||||
|
f'{indented_tree_str}'
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
# ------ modden.repr ------
|
||||||
|
# XXX originally taken verbaatim from `modden.repr`
|
||||||
|
'''
|
||||||
|
More "multi-line" representation then the stdlib's `pprint` equivs.
|
||||||
|
|
||||||
|
'''
|
||||||
|
from inspect import (
|
||||||
|
FrameInfo,
|
||||||
|
stack,
|
||||||
|
)
|
||||||
|
import pprint
|
||||||
|
import reprlib
|
||||||
|
from typing import (
|
||||||
|
Callable,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def mk_repr(
|
||||||
|
**repr_kws,
|
||||||
|
) -> Callable[[str], str]:
|
||||||
|
'''
|
||||||
|
Allocate and deliver a `repr.Repr` instance with provided input
|
||||||
|
settings using the std-lib's `reprlib` mod,
|
||||||
|
* https://docs.python.org/3/library/reprlib.html
|
||||||
|
|
||||||
|
------ Ex. ------
|
||||||
|
An up to 6-layer-nested `dict` as multi-line:
|
||||||
|
- https://stackoverflow.com/a/79102479
|
||||||
|
- https://docs.python.org/3/library/reprlib.html#reprlib.Repr.maxlevel
|
||||||
|
|
||||||
|
'''
|
||||||
|
def_kws: dict[str, int] = dict(
|
||||||
|
indent=3, # indent used for repr of recursive objects
|
||||||
|
maxlevel=616, # recursion levels
|
||||||
|
maxdict=616, # max items shown for `dict`
|
||||||
|
maxlist=616, # max items shown for `dict`
|
||||||
|
maxstring=616, # match editor line-len limit
|
||||||
|
maxtuple=616, # match editor line-len limit
|
||||||
|
maxother=616, # match editor line-len limit
|
||||||
|
)
|
||||||
|
def_kws |= repr_kws
|
||||||
|
reprr = reprlib.Repr(**def_kws)
|
||||||
|
return reprr.repr
|
||||||
|
|
||||||
|
|
||||||
|
def ppfmt(
|
||||||
|
obj: object,
|
||||||
|
do_print: bool = False,
|
||||||
|
) -> str:
|
||||||
|
'''
|
||||||
|
The `pprint.pformat()` version of `pprint.pp()`, namely
|
||||||
|
a default `sort_dicts=False`.. (which i think should be
|
||||||
|
the normal default in the stdlib).
|
||||||
|
|
||||||
|
'''
|
||||||
|
pprepr: Callable = mk_repr()
|
||||||
|
repr_str: str = pprepr(obj)
|
||||||
|
|
||||||
|
if do_print:
|
||||||
|
return pprint.pp(repr_str)
|
||||||
|
|
||||||
|
return repr_str
|
||||||
|
|
||||||
|
|
||||||
|
pformat = ppfmt
|
||||||
|
|
||||||
|
|
||||||
|
def pfmt_frame_info(fi: FrameInfo) -> str:
|
||||||
|
'''
|
||||||
|
Like a std `inspect.FrameInfo.__repr__()` but multi-line..
|
||||||
|
|
||||||
|
'''
|
||||||
|
return (
|
||||||
|
'FrameInfo(\n'
|
||||||
|
' frame={!r},\n'
|
||||||
|
' filename={!r},\n'
|
||||||
|
' lineno={!r},\n'
|
||||||
|
' function={!r},\n'
|
||||||
|
' code_context={!r},\n'
|
||||||
|
' index={!r},\n'
|
||||||
|
' positions={!r})'
|
||||||
|
).format(
|
||||||
|
fi.frame,
|
||||||
|
fi.filename,
|
||||||
|
fi.lineno,
|
||||||
|
fi.function,
|
||||||
|
fi.code_context,
|
||||||
|
fi.index,
|
||||||
|
fi.positions
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def pfmt_callstack(frames: int = 1) -> str:
|
||||||
|
'''
|
||||||
|
Generate a string of nested `inspect.FrameInfo` objects returned
|
||||||
|
from a `inspect.stack()` call such that only the `.frame` field
|
||||||
|
for each layer is pprinted.
|
||||||
|
|
||||||
|
'''
|
||||||
|
caller_frames: list[FrameInfo] = stack()[1:1+frames]
|
||||||
|
frames_str: str = ''
|
||||||
|
for i, frame_info in enumerate(caller_frames):
|
||||||
|
frames_str += textwrap.indent(
|
||||||
|
f'{frame_info.frame!r}\n',
|
||||||
|
prefix=' '*i,
|
||||||
|
|
||||||
|
)
|
||||||
|
return frames_str
|
||||||
|
|
|
@ -171,11 +171,23 @@ class Channel:
|
||||||
)
|
)
|
||||||
assert transport.raddr == addr
|
assert transport.raddr == addr
|
||||||
chan = Channel(transport=transport)
|
chan = Channel(transport=transport)
|
||||||
log.runtime(
|
|
||||||
f'Connected channel IPC transport\n'
|
# ?TODO, compact this into adapter level-methods?
|
||||||
f'[>\n'
|
# -[ ] would avoid extra repr-calcs if level not active?
|
||||||
f' |_{chan}\n'
|
# |_ how would the `calc_if_level` look though? func?
|
||||||
)
|
if log.at_least_level('runtime'):
|
||||||
|
from tractor.devx import (
|
||||||
|
pformat as _pformat,
|
||||||
|
)
|
||||||
|
chan_repr: str = _pformat.nest_from_op(
|
||||||
|
input_op='[>',
|
||||||
|
text=chan.pformat(),
|
||||||
|
nest_indent=1,
|
||||||
|
)
|
||||||
|
log.runtime(
|
||||||
|
f'Connected channel IPC transport\n'
|
||||||
|
f'{chan_repr}'
|
||||||
|
)
|
||||||
return chan
|
return chan
|
||||||
|
|
||||||
@cm
|
@cm
|
||||||
|
@ -196,9 +208,12 @@ class Channel:
|
||||||
self._transport.codec = orig
|
self._transport.codec = orig
|
||||||
|
|
||||||
# TODO: do a .src/.dst: str for maddrs?
|
# TODO: do a .src/.dst: str for maddrs?
|
||||||
def pformat(self) -> str:
|
def pformat(
|
||||||
|
self,
|
||||||
|
privates: bool = False,
|
||||||
|
) -> str:
|
||||||
if not self._transport:
|
if not self._transport:
|
||||||
return '<Channel with inactive transport?>'
|
return '<Channel( with inactive transport? )>'
|
||||||
|
|
||||||
tpt: MsgTransport = self._transport
|
tpt: MsgTransport = self._transport
|
||||||
tpt_name: str = type(tpt).__name__
|
tpt_name: str = type(tpt).__name__
|
||||||
|
@ -206,26 +221,35 @@ class Channel:
|
||||||
'connected' if self.connected()
|
'connected' if self.connected()
|
||||||
else 'closed'
|
else 'closed'
|
||||||
)
|
)
|
||||||
return (
|
repr_str: str = (
|
||||||
f'<Channel(\n'
|
f'<Channel(\n'
|
||||||
f' |_status: {tpt_status!r}\n'
|
f' |_status: {tpt_status!r}\n'
|
||||||
|
) + (
|
||||||
f' _closed={self._closed}\n'
|
f' _closed={self._closed}\n'
|
||||||
f' _cancel_called={self._cancel_called}\n'
|
f' _cancel_called={self._cancel_called}\n'
|
||||||
f'\n'
|
if privates else ''
|
||||||
f' |_peer: {self.aid}\n'
|
) + ( # peer-actor (processs) section
|
||||||
f'\n'
|
f' |_peer: {self.aid.reprol()!r}\n'
|
||||||
|
if self.aid else ' |_peer: <unknown>\n'
|
||||||
|
) + (
|
||||||
f' |_msgstream: {tpt_name}\n'
|
f' |_msgstream: {tpt_name}\n'
|
||||||
f' proto={tpt.laddr.proto_key!r}\n'
|
f' maddr: {tpt.maddr!r}\n'
|
||||||
f' layer={tpt.layer_key!r}\n'
|
f' proto: {tpt.laddr.proto_key!r}\n'
|
||||||
f' laddr={tpt.laddr}\n'
|
f' layer: {tpt.layer_key!r}\n'
|
||||||
f' raddr={tpt.raddr}\n'
|
f' codec: {tpt.codec_key!r}\n'
|
||||||
f' codec={tpt.codec_key!r}\n'
|
f' .laddr={tpt.laddr}\n'
|
||||||
f' stream={tpt.stream}\n'
|
f' .raddr={tpt.raddr}\n'
|
||||||
f' maddr={tpt.maddr!r}\n'
|
) + (
|
||||||
f' drained={tpt.drained}\n'
|
f' ._transport.stream={tpt.stream}\n'
|
||||||
|
f' ._transport.drained={tpt.drained}\n'
|
||||||
|
if privates else ''
|
||||||
|
) + (
|
||||||
f' _send_lock={tpt._send_lock.statistics()}\n'
|
f' _send_lock={tpt._send_lock.statistics()}\n'
|
||||||
f')>\n'
|
if privates else ''
|
||||||
|
) + (
|
||||||
|
')>\n'
|
||||||
)
|
)
|
||||||
|
return repr_str
|
||||||
|
|
||||||
# NOTE: making this return a value that can be passed to
|
# NOTE: making this return a value that can be passed to
|
||||||
# `eval()` is entirely **optional** FYI!
|
# `eval()` is entirely **optional** FYI!
|
||||||
|
@ -247,6 +271,10 @@ class Channel:
|
||||||
def raddr(self) -> Address|None:
|
def raddr(self) -> Address|None:
|
||||||
return self._transport.raddr if self._transport else None
|
return self._transport.raddr if self._transport else None
|
||||||
|
|
||||||
|
@property
|
||||||
|
def maddr(self) -> str:
|
||||||
|
return self._transport.maddr if self._transport else '<no-tpt>'
|
||||||
|
|
||||||
# TODO: something like,
|
# TODO: something like,
|
||||||
# `pdbp.hideframe_on(errors=[MsgTypeError])`
|
# `pdbp.hideframe_on(errors=[MsgTypeError])`
|
||||||
# instead of the `try/except` hack we have rn..
|
# instead of the `try/except` hack we have rn..
|
||||||
|
@ -434,8 +462,8 @@ class Channel:
|
||||||
await self.send(aid)
|
await self.send(aid)
|
||||||
peer_aid: Aid = await self.recv()
|
peer_aid: Aid = await self.recv()
|
||||||
log.runtime(
|
log.runtime(
|
||||||
f'Received hanshake with peer actor,\n'
|
f'Received hanshake with peer\n'
|
||||||
f'{peer_aid}\n'
|
f'<= {peer_aid.reprol(sin_uuid=False)}\n'
|
||||||
)
|
)
|
||||||
# NOTE, we always are referencing the remote peer!
|
# NOTE, we always are referencing the remote peer!
|
||||||
self.aid = peer_aid
|
self.aid = peer_aid
|
||||||
|
|
|
@ -17,9 +17,16 @@
|
||||||
Utils to tame mp non-SC madeness
|
Utils to tame mp non-SC madeness
|
||||||
|
|
||||||
'''
|
'''
|
||||||
|
|
||||||
|
# !TODO! in 3.13 this can be disabled (the-same/similarly) using
|
||||||
|
# a flag,
|
||||||
|
# - [ ] soo if it works like this, drop this module entirely for
|
||||||
|
# 3.13+ B)
|
||||||
|
# |_https://docs.python.org/3/library/multiprocessing.shared_memory.html
|
||||||
|
#
|
||||||
def disable_mantracker():
|
def disable_mantracker():
|
||||||
'''
|
'''
|
||||||
Disable all ``multiprocessing``` "resource tracking" machinery since
|
Disable all `multiprocessing` "resource tracking" machinery since
|
||||||
it's an absolute multi-threaded mess of non-SC madness.
|
it's an absolute multi-threaded mess of non-SC madness.
|
||||||
|
|
||||||
'''
|
'''
|
||||||
|
|
|
@ -26,7 +26,7 @@ from contextlib import (
|
||||||
from functools import partial
|
from functools import partial
|
||||||
from itertools import chain
|
from itertools import chain
|
||||||
import inspect
|
import inspect
|
||||||
from pprint import pformat
|
import textwrap
|
||||||
from types import (
|
from types import (
|
||||||
ModuleType,
|
ModuleType,
|
||||||
)
|
)
|
||||||
|
@ -43,7 +43,10 @@ from trio import (
|
||||||
SocketListener,
|
SocketListener,
|
||||||
)
|
)
|
||||||
|
|
||||||
# from ..devx import _debug
|
from ..devx.pformat import (
|
||||||
|
ppfmt,
|
||||||
|
nest_from_op,
|
||||||
|
)
|
||||||
from .._exceptions import (
|
from .._exceptions import (
|
||||||
TransportClosed,
|
TransportClosed,
|
||||||
)
|
)
|
||||||
|
@ -141,9 +144,8 @@ async def maybe_wait_on_canced_subs(
|
||||||
|
|
||||||
):
|
):
|
||||||
log.cancel(
|
log.cancel(
|
||||||
'Waiting on cancel request to peer..\n'
|
'Waiting on cancel request to peer\n'
|
||||||
f'c)=>\n'
|
f'c)=> {chan.aid.reprol()}@[{chan.maddr}]\n'
|
||||||
f' |_{chan.aid}\n'
|
|
||||||
)
|
)
|
||||||
|
|
||||||
# XXX: this is a soft wait on the channel (and its
|
# XXX: this is a soft wait on the channel (and its
|
||||||
|
@ -179,7 +181,7 @@ async def maybe_wait_on_canced_subs(
|
||||||
log.warning(
|
log.warning(
|
||||||
'Draining msg from disconnected peer\n'
|
'Draining msg from disconnected peer\n'
|
||||||
f'{chan_info}'
|
f'{chan_info}'
|
||||||
f'{pformat(msg)}\n'
|
f'{ppfmt(msg)}\n'
|
||||||
)
|
)
|
||||||
# cid: str|None = msg.get('cid')
|
# cid: str|None = msg.get('cid')
|
||||||
cid: str|None = msg.cid
|
cid: str|None = msg.cid
|
||||||
|
@ -248,7 +250,7 @@ async def maybe_wait_on_canced_subs(
|
||||||
if children := local_nursery._children:
|
if children := local_nursery._children:
|
||||||
# indent from above local-nurse repr
|
# indent from above local-nurse repr
|
||||||
report += (
|
report += (
|
||||||
f' |_{pformat(children)}\n'
|
f' |_{ppfmt(children)}\n'
|
||||||
)
|
)
|
||||||
|
|
||||||
log.warning(report)
|
log.warning(report)
|
||||||
|
@ -279,8 +281,9 @@ async def maybe_wait_on_canced_subs(
|
||||||
log.runtime(
|
log.runtime(
|
||||||
f'Peer IPC broke but subproc is alive?\n\n'
|
f'Peer IPC broke but subproc is alive?\n\n'
|
||||||
|
|
||||||
f'<=x {chan.aid}@{chan.raddr}\n'
|
f'<=x {chan.aid.reprol()}@[{chan.maddr}]\n'
|
||||||
f' |_{proc}\n'
|
f'\n'
|
||||||
|
f'{proc}\n'
|
||||||
)
|
)
|
||||||
|
|
||||||
return local_nursery
|
return local_nursery
|
||||||
|
@ -289,7 +292,7 @@ async def maybe_wait_on_canced_subs(
|
||||||
#
|
#
|
||||||
# -[x] maybe change to mod-func and rename for implied
|
# -[x] maybe change to mod-func and rename for implied
|
||||||
# multi-transport semantics?
|
# multi-transport semantics?
|
||||||
# -[ ] register each stream/tpt/chan with the owning `IPCEndpoint`
|
# -[ ] register each stream/tpt/chan with the owning `Endpoint`
|
||||||
# so that we can query per tpt all peer contact infos?
|
# so that we can query per tpt all peer contact infos?
|
||||||
# |_[ ] possibly provide a global viewing via a
|
# |_[ ] possibly provide a global viewing via a
|
||||||
# `collections.ChainMap`?
|
# `collections.ChainMap`?
|
||||||
|
@ -309,7 +312,7 @@ async def handle_stream_from_peer(
|
||||||
any `IPCServer.listen_on()` passed `stream_handler_tn: Nursery`
|
any `IPCServer.listen_on()` passed `stream_handler_tn: Nursery`
|
||||||
such that it is invoked as,
|
such that it is invoked as,
|
||||||
|
|
||||||
IPCEndpoint.stream_handler_tn.start_soon(
|
Endpoint.stream_handler_tn.start_soon(
|
||||||
handle_stream,
|
handle_stream,
|
||||||
stream,
|
stream,
|
||||||
)
|
)
|
||||||
|
@ -318,15 +321,16 @@ async def handle_stream_from_peer(
|
||||||
server._no_more_peers = trio.Event() # unset by making new
|
server._no_more_peers = trio.Event() # unset by making new
|
||||||
|
|
||||||
# TODO, debug_mode tooling for when hackin this lower layer?
|
# TODO, debug_mode tooling for when hackin this lower layer?
|
||||||
# with _debug.maybe_open_crash_handler(
|
# with debug.maybe_open_crash_handler(
|
||||||
# pdb=True,
|
# pdb=True,
|
||||||
# ) as boxerr:
|
# ) as boxerr:
|
||||||
|
|
||||||
chan = Channel.from_stream(stream)
|
chan = Channel.from_stream(stream)
|
||||||
con_status: str = (
|
con_status: str = (
|
||||||
'New inbound IPC connection <=\n'
|
f'New inbound IPC transport connection\n'
|
||||||
f'|_{chan}\n'
|
f'<=( {stream!r}\n'
|
||||||
)
|
)
|
||||||
|
con_status_steps: str = ''
|
||||||
|
|
||||||
# initial handshake with peer phase
|
# initial handshake with peer phase
|
||||||
try:
|
try:
|
||||||
|
@ -372,7 +376,7 @@ async def handle_stream_from_peer(
|
||||||
if _pre_chan := server._peers.get(uid):
|
if _pre_chan := server._peers.get(uid):
|
||||||
familiar: str = 'pre-existing-peer'
|
familiar: str = 'pre-existing-peer'
|
||||||
uid_short: str = f'{uid[0]}[{uid[1][-6:]}]'
|
uid_short: str = f'{uid[0]}[{uid[1][-6:]}]'
|
||||||
con_status += (
|
con_status_steps += (
|
||||||
f' -> Handshake with {familiar} `{uid_short}` complete\n'
|
f' -> Handshake with {familiar} `{uid_short}` complete\n'
|
||||||
)
|
)
|
||||||
|
|
||||||
|
@ -397,7 +401,7 @@ async def handle_stream_from_peer(
|
||||||
None,
|
None,
|
||||||
)
|
)
|
||||||
if event:
|
if event:
|
||||||
con_status += (
|
con_status_steps += (
|
||||||
' -> Waking subactor spawn waiters: '
|
' -> Waking subactor spawn waiters: '
|
||||||
f'{event.statistics().tasks_waiting}\n'
|
f'{event.statistics().tasks_waiting}\n'
|
||||||
f' -> Registered IPC chan for child actor {uid}@{chan.raddr}\n'
|
f' -> Registered IPC chan for child actor {uid}@{chan.raddr}\n'
|
||||||
|
@ -408,7 +412,7 @@ async def handle_stream_from_peer(
|
||||||
event.set()
|
event.set()
|
||||||
|
|
||||||
else:
|
else:
|
||||||
con_status += (
|
con_status_steps += (
|
||||||
f' -> Registered IPC chan for peer actor {uid}@{chan.raddr}\n'
|
f' -> Registered IPC chan for peer actor {uid}@{chan.raddr}\n'
|
||||||
) # type: ignore
|
) # type: ignore
|
||||||
|
|
||||||
|
@ -422,8 +426,15 @@ async def handle_stream_from_peer(
|
||||||
# TODO: can we just use list-ref directly?
|
# TODO: can we just use list-ref directly?
|
||||||
chans.append(chan)
|
chans.append(chan)
|
||||||
|
|
||||||
con_status += ' -> Entering RPC msg loop..\n'
|
con_status_steps += ' -> Entering RPC msg loop..\n'
|
||||||
log.runtime(con_status)
|
log.runtime(
|
||||||
|
con_status
|
||||||
|
+
|
||||||
|
textwrap.indent(
|
||||||
|
con_status_steps,
|
||||||
|
prefix=' '*3, # align to first-ln
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
# Begin channel management - respond to remote requests and
|
# Begin channel management - respond to remote requests and
|
||||||
# process received reponses.
|
# process received reponses.
|
||||||
|
@ -456,41 +467,67 @@ async def handle_stream_from_peer(
|
||||||
disconnected=disconnected,
|
disconnected=disconnected,
|
||||||
)
|
)
|
||||||
|
|
||||||
# ``Channel`` teardown and closure sequence
|
# `Channel` teardown and closure sequence
|
||||||
# drop ref to channel so it can be gc-ed and disconnected
|
# drop ref to channel so it can be gc-ed and disconnected
|
||||||
con_teardown_status: str = (
|
#
|
||||||
f'IPC channel disconnected:\n'
|
# -[x]TODO mk this be like
|
||||||
f'<=x uid: {chan.aid}\n'
|
# <=x Channel(
|
||||||
f' |_{pformat(chan)}\n\n'
|
# |_field: blah
|
||||||
|
# )>
|
||||||
|
op_repr: str = '<=x '
|
||||||
|
chan_repr: str = nest_from_op(
|
||||||
|
input_op=op_repr,
|
||||||
|
op_suffix='',
|
||||||
|
nest_prefix='',
|
||||||
|
text=chan.pformat(),
|
||||||
|
nest_indent=len(op_repr)-1,
|
||||||
|
rm_from_first_ln='<',
|
||||||
)
|
)
|
||||||
|
|
||||||
|
con_teardown_status: str = (
|
||||||
|
f'IPC channel disconnect\n'
|
||||||
|
f'\n'
|
||||||
|
f'{chan_repr}\n'
|
||||||
|
f'\n'
|
||||||
|
)
|
||||||
|
|
||||||
chans.remove(chan)
|
chans.remove(chan)
|
||||||
|
|
||||||
# TODO: do we need to be this pedantic?
|
# TODO: do we need to be this pedantic?
|
||||||
if not chans:
|
if not chans:
|
||||||
con_teardown_status += (
|
con_teardown_status += (
|
||||||
f'-> No more channels with {chan.aid}'
|
f'-> No more channels with {chan.aid.reprol()!r}\n'
|
||||||
)
|
)
|
||||||
server._peers.pop(uid, None)
|
server._peers.pop(uid, None)
|
||||||
|
|
||||||
peers_str: str = ''
|
if peers := list(server._peers.values()):
|
||||||
for uid, chans in server._peers.items():
|
peer_cnt: int = len(peers)
|
||||||
peers_str += (
|
if (
|
||||||
f'uid: {uid}\n'
|
(first := peers[0][0]) is not chan
|
||||||
)
|
and
|
||||||
for i, chan in enumerate(chans):
|
not disconnected
|
||||||
peers_str += (
|
and
|
||||||
f' |_[{i}] {pformat(chan)}\n'
|
peer_cnt > 1
|
||||||
|
):
|
||||||
|
con_teardown_status += (
|
||||||
|
f'-> Remaining IPC {peer_cnt-1!r} peers:\n'
|
||||||
)
|
)
|
||||||
|
for chans in server._peers.values():
|
||||||
con_teardown_status += (
|
first: Channel = chans[0]
|
||||||
f'-> Remaining IPC {len(server._peers)} peers: {peers_str}\n'
|
if not (
|
||||||
)
|
first is chan
|
||||||
|
and
|
||||||
|
disconnected
|
||||||
|
):
|
||||||
|
con_teardown_status += (
|
||||||
|
f' |_{first.aid.reprol()!r} -> {len(chans)!r} chans\n'
|
||||||
|
)
|
||||||
|
|
||||||
# No more channels to other actors (at all) registered
|
# No more channels to other actors (at all) registered
|
||||||
# as connected.
|
# as connected.
|
||||||
if not server._peers:
|
if not server._peers:
|
||||||
con_teardown_status += (
|
con_teardown_status += (
|
||||||
'Signalling no more peer channel connections'
|
'-> Signalling no more peer connections!\n'
|
||||||
)
|
)
|
||||||
server._no_more_peers.set()
|
server._no_more_peers.set()
|
||||||
|
|
||||||
|
@ -504,8 +541,8 @@ async def handle_stream_from_peer(
|
||||||
and
|
and
|
||||||
_state.is_debug_mode()
|
_state.is_debug_mode()
|
||||||
):
|
):
|
||||||
from ..devx import _debug
|
from ..devx import debug
|
||||||
pdb_lock = _debug.Lock
|
pdb_lock = debug.Lock
|
||||||
pdb_lock._blocked.add(uid)
|
pdb_lock._blocked.add(uid)
|
||||||
|
|
||||||
# TODO: NEEEDS TO BE TESTED!
|
# TODO: NEEEDS TO BE TESTED!
|
||||||
|
@ -540,7 +577,7 @@ async def handle_stream_from_peer(
|
||||||
f'last disconnected child uid: {uid}\n'
|
f'last disconnected child uid: {uid}\n'
|
||||||
f'locking child uid: {pdb_user_uid}\n'
|
f'locking child uid: {pdb_user_uid}\n'
|
||||||
)
|
)
|
||||||
await _debug.maybe_wait_for_debugger(
|
await debug.maybe_wait_for_debugger(
|
||||||
child_in_debug=True
|
child_in_debug=True
|
||||||
)
|
)
|
||||||
|
|
||||||
|
@ -577,12 +614,12 @@ async def handle_stream_from_peer(
|
||||||
# finally block closure
|
# finally block closure
|
||||||
|
|
||||||
|
|
||||||
class IPCEndpoint(Struct):
|
class Endpoint(Struct):
|
||||||
'''
|
'''
|
||||||
An instance of an IPC "bound" address where the lifetime of the
|
An instance of an IPC "bound" address where the lifetime of an
|
||||||
"ability to accept connections" (from clients) and then handle
|
"ability to accept connections" and handle the subsequent
|
||||||
those inbound sessions or sequences-of-packets is determined by
|
sequence-of-packets (maybe oriented as sessions) is determined by
|
||||||
a (maybe pair of) nurser(y/ies).
|
the underlying nursery scope(s).
|
||||||
|
|
||||||
'''
|
'''
|
||||||
addr: Address
|
addr: Address
|
||||||
|
@ -600,6 +637,24 @@ class IPCEndpoint(Struct):
|
||||||
MsgTransport, # handle to encoded-msg transport stream
|
MsgTransport, # handle to encoded-msg transport stream
|
||||||
] = {}
|
] = {}
|
||||||
|
|
||||||
|
def pformat(
|
||||||
|
self,
|
||||||
|
indent: int = 0,
|
||||||
|
privates: bool = False,
|
||||||
|
) -> str:
|
||||||
|
type_repr: str = type(self).__name__
|
||||||
|
fmtstr: str = (
|
||||||
|
# !TODO, always be ns aware!
|
||||||
|
# f'|_netns: {netns}\n'
|
||||||
|
f' |.addr: {self.addr!r}\n'
|
||||||
|
f' |_peers: {len(self.peer_tpts)}\n'
|
||||||
|
)
|
||||||
|
return (
|
||||||
|
f'<{type_repr}(\n'
|
||||||
|
f'{fmtstr}'
|
||||||
|
f')>'
|
||||||
|
)
|
||||||
|
|
||||||
async def start_listener(self) -> SocketListener:
|
async def start_listener(self) -> SocketListener:
|
||||||
tpt_mod: ModuleType = inspect.getmodule(self.addr)
|
tpt_mod: ModuleType = inspect.getmodule(self.addr)
|
||||||
lstnr: SocketListener = await tpt_mod.start_listener(
|
lstnr: SocketListener = await tpt_mod.start_listener(
|
||||||
|
@ -636,35 +691,43 @@ class IPCEndpoint(Struct):
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
class IPCServer(Struct):
|
class Server(Struct):
|
||||||
_parent_tn: Nursery
|
_parent_tn: Nursery
|
||||||
_stream_handler_tn: Nursery
|
_stream_handler_tn: Nursery
|
||||||
|
|
||||||
# level-triggered sig for whether "no peers are currently
|
# level-triggered sig for whether "no peers are currently
|
||||||
# connected"; field is **always** set to an instance but
|
# connected"; field is **always** set to an instance but
|
||||||
# initialized with `.is_set() == True`.
|
# initialized with `.is_set() == True`.
|
||||||
_no_more_peers: trio.Event
|
_no_more_peers: trio.Event
|
||||||
|
|
||||||
_endpoints: list[IPCEndpoint] = []
|
# active eps as allocated by `.listen_on()`
|
||||||
|
_endpoints: list[Endpoint] = []
|
||||||
|
|
||||||
# connection tracking & mgmt
|
# connection tracking & mgmt
|
||||||
_peers: defaultdict[
|
_peers: defaultdict[
|
||||||
str, # uaid
|
str, # uaid
|
||||||
list[Channel], # IPC conns from peer
|
list[Channel], # IPC conns from peer
|
||||||
] = defaultdict(list)
|
] = defaultdict(list)
|
||||||
|
|
||||||
|
# events-table with entries registered unset while the local
|
||||||
|
# actor is waiting on a new actor to inbound connect, often
|
||||||
|
# a parent waiting on its child just after spawn.
|
||||||
_peer_connected: dict[
|
_peer_connected: dict[
|
||||||
tuple[str, str],
|
tuple[str, str],
|
||||||
trio.Event,
|
trio.Event,
|
||||||
] = {}
|
] = {}
|
||||||
|
|
||||||
# syncs for setup/teardown sequences
|
# syncs for setup/teardown sequences
|
||||||
|
# - null when not yet booted,
|
||||||
|
# - unset when active,
|
||||||
|
# - set when fully shutdown with 0 eps active.
|
||||||
_shutdown: trio.Event|None = None
|
_shutdown: trio.Event|None = None
|
||||||
|
|
||||||
# TODO, maybe just make `._endpoints: list[IPCEndpoint]` and
|
# TODO, maybe just make `._endpoints: list[Endpoint]` and
|
||||||
# provide dict-views onto it?
|
# provide dict-views onto it?
|
||||||
# @property
|
# @property
|
||||||
# def addrs2eps(self) -> dict[Address, IPCEndpoint]:
|
# def addrs2eps(self) -> dict[Address, Endpoint]:
|
||||||
# ...
|
# ...
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def proto_keys(self) -> list[str]:
|
def proto_keys(self) -> list[str]:
|
||||||
return [
|
return [
|
||||||
|
@ -690,7 +753,7 @@ class IPCServer(Struct):
|
||||||
# TODO: obvi a different server type when we eventually
|
# TODO: obvi a different server type when we eventually
|
||||||
# support some others XD
|
# support some others XD
|
||||||
log.runtime(
|
log.runtime(
|
||||||
f'Cancelling server(s) for\n'
|
f'Cancelling server(s) for tpt-protos\n'
|
||||||
f'{self.proto_keys!r}\n'
|
f'{self.proto_keys!r}\n'
|
||||||
)
|
)
|
||||||
self._parent_tn.cancel_scope.cancel()
|
self._parent_tn.cancel_scope.cancel()
|
||||||
|
@ -708,7 +771,7 @@ class IPCServer(Struct):
|
||||||
await self._shutdown.wait()
|
await self._shutdown.wait()
|
||||||
else:
|
else:
|
||||||
tpt_protos: list[str] = []
|
tpt_protos: list[str] = []
|
||||||
ep: IPCEndpoint
|
ep: Endpoint
|
||||||
for ep in self._endpoints:
|
for ep in self._endpoints:
|
||||||
tpt_protos.append(ep.addr.proto_key)
|
tpt_protos.append(ep.addr.proto_key)
|
||||||
|
|
||||||
|
@ -717,6 +780,14 @@ class IPCServer(Struct):
|
||||||
f'protos: {tpt_protos!r}\n'
|
f'protos: {tpt_protos!r}\n'
|
||||||
)
|
)
|
||||||
|
|
||||||
|
def len_peers(
|
||||||
|
self,
|
||||||
|
) -> int:
|
||||||
|
return len([
|
||||||
|
chan.connected()
|
||||||
|
for chan in chain(*self._peers.values())
|
||||||
|
])
|
||||||
|
|
||||||
def has_peers(
|
def has_peers(
|
||||||
self,
|
self,
|
||||||
check_chans: bool = False,
|
check_chans: bool = False,
|
||||||
|
@ -730,13 +801,11 @@ class IPCServer(Struct):
|
||||||
has_peers
|
has_peers
|
||||||
and
|
and
|
||||||
check_chans
|
check_chans
|
||||||
|
and
|
||||||
|
(peer_cnt := self.len_peers())
|
||||||
):
|
):
|
||||||
has_peers: bool = (
|
has_peers: bool = (
|
||||||
any(chan.connected()
|
peer_cnt > 0
|
||||||
for chan in chain(
|
|
||||||
*self._peers.values()
|
|
||||||
)
|
|
||||||
)
|
|
||||||
and
|
and
|
||||||
has_peers
|
has_peers
|
||||||
)
|
)
|
||||||
|
@ -790,7 +859,7 @@ class IPCServer(Struct):
|
||||||
|
|
||||||
def epsdict(self) -> dict[
|
def epsdict(self) -> dict[
|
||||||
Address,
|
Address,
|
||||||
IPCEndpoint,
|
Endpoint,
|
||||||
]:
|
]:
|
||||||
return {
|
return {
|
||||||
ep.addr: ep
|
ep.addr: ep
|
||||||
|
@ -803,30 +872,66 @@ class IPCServer(Struct):
|
||||||
|
|
||||||
return ev.is_set()
|
return ev.is_set()
|
||||||
|
|
||||||
def pformat(self) -> str:
|
@property
|
||||||
eps: list[IPCEndpoint] = self._endpoints
|
def repr_state(self) -> str:
|
||||||
|
'''
|
||||||
|
A `str`-status describing the current state of this
|
||||||
|
IPC server in terms of the current operating "phase".
|
||||||
|
|
||||||
state_repr: str = (
|
'''
|
||||||
f'{len(eps)!r} IPC-endpoints active'
|
status = 'server is active'
|
||||||
)
|
if self.has_peers():
|
||||||
|
peer_cnt: int = self.len_peers()
|
||||||
|
status: str = (
|
||||||
|
f'{peer_cnt!r} peer chans'
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
status: str = 'No peer chans'
|
||||||
|
|
||||||
|
if self.is_shutdown():
|
||||||
|
status: str = 'server-shutdown'
|
||||||
|
|
||||||
|
return status
|
||||||
|
|
||||||
|
def pformat(
|
||||||
|
self,
|
||||||
|
privates: bool = False,
|
||||||
|
) -> str:
|
||||||
|
eps: list[Endpoint] = self._endpoints
|
||||||
|
|
||||||
|
# state_repr: str = (
|
||||||
|
# f'{len(eps)!r} endpoints active'
|
||||||
|
# )
|
||||||
fmtstr = (
|
fmtstr = (
|
||||||
f' |_state: {state_repr}\n'
|
f' |_state: {self.repr_state!r}\n'
|
||||||
f' no_more_peers: {self.has_peers()}\n'
|
|
||||||
)
|
)
|
||||||
if self._shutdown is not None:
|
if privates:
|
||||||
shutdown_stats: EventStatistics = self._shutdown.statistics()
|
fmtstr += f' no_more_peers: {self.has_peers()}\n'
|
||||||
|
|
||||||
|
if self._shutdown is not None:
|
||||||
|
shutdown_stats: EventStatistics = self._shutdown.statistics()
|
||||||
|
fmtstr += (
|
||||||
|
f' task_waiting_on_shutdown: {shutdown_stats}\n'
|
||||||
|
)
|
||||||
|
|
||||||
|
if eps := self._endpoints:
|
||||||
|
addrs: list[tuple] = [
|
||||||
|
ep.addr for ep in eps
|
||||||
|
]
|
||||||
|
repr_eps: str = ppfmt(addrs)
|
||||||
|
|
||||||
fmtstr += (
|
fmtstr += (
|
||||||
f' task_waiting_on_shutdown: {shutdown_stats}\n'
|
f' |_endpoints: {repr_eps}\n'
|
||||||
|
# ^TODO? how to indent closing ']'..
|
||||||
)
|
)
|
||||||
|
|
||||||
fmtstr += (
|
if peers := self._peers:
|
||||||
# TODO, use the `ppfmt()` helper from `modden`!
|
fmtstr += (
|
||||||
f' |_endpoints: {pformat(self._endpoints)}\n'
|
f' |_peers: {len(peers)} connected\n'
|
||||||
f' |_peers: {len(self._peers)} connected\n'
|
)
|
||||||
)
|
|
||||||
|
|
||||||
return (
|
return (
|
||||||
f'<IPCServer(\n'
|
f'<Server(\n'
|
||||||
f'{fmtstr}'
|
f'{fmtstr}'
|
||||||
f')>\n'
|
f')>\n'
|
||||||
)
|
)
|
||||||
|
@ -835,13 +940,13 @@ class IPCServer(Struct):
|
||||||
|
|
||||||
# TODO? maybe allow shutting down a `.listen_on()`s worth of
|
# TODO? maybe allow shutting down a `.listen_on()`s worth of
|
||||||
# listeners by cancelling the corresponding
|
# listeners by cancelling the corresponding
|
||||||
# `IPCEndpoint._listen_tn` only ?
|
# `Endpoint._listen_tn` only ?
|
||||||
# -[ ] in theory you could use this to
|
# -[ ] in theory you could use this to
|
||||||
# "boot-and-wait-for-reconnect" of all current and connecting
|
# "boot-and-wait-for-reconnect" of all current and connecting
|
||||||
# peers?
|
# peers?
|
||||||
# |_ would require that the stream-handler is intercepted so we
|
# |_ would require that the stream-handler is intercepted so we
|
||||||
# can intercept every `MsgTransport` (stream) and track per
|
# can intercept every `MsgTransport` (stream) and track per
|
||||||
# `IPCEndpoint` likely?
|
# `Endpoint` likely?
|
||||||
#
|
#
|
||||||
# async def unlisten(
|
# async def unlisten(
|
||||||
# self,
|
# self,
|
||||||
|
@ -854,7 +959,7 @@ class IPCServer(Struct):
|
||||||
*,
|
*,
|
||||||
accept_addrs: list[tuple[str, int|str]]|None = None,
|
accept_addrs: list[tuple[str, int|str]]|None = None,
|
||||||
stream_handler_nursery: Nursery|None = None,
|
stream_handler_nursery: Nursery|None = None,
|
||||||
) -> list[IPCEndpoint]:
|
) -> list[Endpoint]:
|
||||||
'''
|
'''
|
||||||
Start `SocketListeners` (i.e. bind and call `socket.listen()`)
|
Start `SocketListeners` (i.e. bind and call `socket.listen()`)
|
||||||
for all IPC-transport-protocol specific `Address`-types
|
for all IPC-transport-protocol specific `Address`-types
|
||||||
|
@ -885,10 +990,10 @@ class IPCServer(Struct):
|
||||||
)
|
)
|
||||||
|
|
||||||
log.runtime(
|
log.runtime(
|
||||||
f'Binding to endpoints for,\n'
|
f'Binding endpoints\n'
|
||||||
f'{accept_addrs}\n'
|
f'{ppfmt(accept_addrs)}\n'
|
||||||
)
|
)
|
||||||
eps: list[IPCEndpoint] = await self._parent_tn.start(
|
eps: list[Endpoint] = await self._parent_tn.start(
|
||||||
partial(
|
partial(
|
||||||
_serve_ipc_eps,
|
_serve_ipc_eps,
|
||||||
server=self,
|
server=self,
|
||||||
|
@ -896,15 +1001,21 @@ class IPCServer(Struct):
|
||||||
listen_addrs=accept_addrs,
|
listen_addrs=accept_addrs,
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
|
self._endpoints.extend(eps)
|
||||||
|
|
||||||
|
serv_repr: str = nest_from_op(
|
||||||
|
input_op='(>',
|
||||||
|
text=self.pformat(),
|
||||||
|
nest_indent=1,
|
||||||
|
)
|
||||||
log.runtime(
|
log.runtime(
|
||||||
f'Started IPC endpoints\n'
|
f'Started IPC server\n'
|
||||||
f'{eps}\n'
|
f'{serv_repr}'
|
||||||
)
|
)
|
||||||
|
|
||||||
self._endpoints.extend(eps)
|
# XXX, a little sanity on new ep allocations
|
||||||
# XXX, just a little bit of sanity
|
|
||||||
group_tn: Nursery|None = None
|
group_tn: Nursery|None = None
|
||||||
ep: IPCEndpoint
|
ep: Endpoint
|
||||||
for ep in eps:
|
for ep in eps:
|
||||||
if ep.addr not in self.addrs:
|
if ep.addr not in self.addrs:
|
||||||
breakpoint()
|
breakpoint()
|
||||||
|
@ -917,6 +1028,10 @@ class IPCServer(Struct):
|
||||||
return eps
|
return eps
|
||||||
|
|
||||||
|
|
||||||
|
# alias until we decide on final naming
|
||||||
|
IPCServer = Server
|
||||||
|
|
||||||
|
|
||||||
async def _serve_ipc_eps(
|
async def _serve_ipc_eps(
|
||||||
*,
|
*,
|
||||||
server: IPCServer,
|
server: IPCServer,
|
||||||
|
@ -941,20 +1056,24 @@ async def _serve_ipc_eps(
|
||||||
listen_tn: Nursery
|
listen_tn: Nursery
|
||||||
async with trio.open_nursery() as listen_tn:
|
async with trio.open_nursery() as listen_tn:
|
||||||
|
|
||||||
eps: list[IPCEndpoint] = []
|
eps: list[Endpoint] = []
|
||||||
# XXX NOTE, required to call `serve_listeners()` below.
|
# XXX NOTE, required to call `serve_listeners()` below.
|
||||||
# ?TODO, maybe just pass `list(eps.values()` tho?
|
# ?TODO, maybe just pass `list(eps.values()` tho?
|
||||||
listeners: list[trio.abc.Listener] = []
|
listeners: list[trio.abc.Listener] = []
|
||||||
for addr in listen_addrs:
|
for addr in listen_addrs:
|
||||||
ep = IPCEndpoint(
|
ep = Endpoint(
|
||||||
addr=addr,
|
addr=addr,
|
||||||
listen_tn=listen_tn,
|
listen_tn=listen_tn,
|
||||||
stream_handler_tn=stream_handler_tn,
|
stream_handler_tn=stream_handler_tn,
|
||||||
)
|
)
|
||||||
try:
|
try:
|
||||||
|
ep_sclang: str = nest_from_op(
|
||||||
|
input_op='>[',
|
||||||
|
text=f'{ep.pformat()}',
|
||||||
|
)
|
||||||
log.runtime(
|
log.runtime(
|
||||||
f'Starting new endpoint listener\n'
|
f'Starting new endpoint listener\n'
|
||||||
f'{ep}\n'
|
f'{ep_sclang}\n'
|
||||||
)
|
)
|
||||||
listener: trio.abc.Listener = await ep.start_listener()
|
listener: trio.abc.Listener = await ep.start_listener()
|
||||||
assert listener is ep._listener
|
assert listener is ep._listener
|
||||||
|
@ -992,17 +1111,6 @@ async def _serve_ipc_eps(
|
||||||
handler_nursery=stream_handler_tn
|
handler_nursery=stream_handler_tn
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
# TODO, wow make this message better! XD
|
|
||||||
log.runtime(
|
|
||||||
'Started server(s)\n'
|
|
||||||
+
|
|
||||||
'\n'.join([f'|_{addr}' for addr in listen_addrs])
|
|
||||||
)
|
|
||||||
|
|
||||||
log.runtime(
|
|
||||||
f'Started IPC endpoints\n'
|
|
||||||
f'{eps}\n'
|
|
||||||
)
|
|
||||||
task_status.started(
|
task_status.started(
|
||||||
eps,
|
eps,
|
||||||
)
|
)
|
||||||
|
@ -1010,7 +1118,7 @@ async def _serve_ipc_eps(
|
||||||
finally:
|
finally:
|
||||||
if eps:
|
if eps:
|
||||||
addr: Address
|
addr: Address
|
||||||
ep: IPCEndpoint
|
ep: Endpoint
|
||||||
for addr, ep in server.epsdict().items():
|
for addr, ep in server.epsdict().items():
|
||||||
ep.close_listener()
|
ep.close_listener()
|
||||||
server._endpoints.remove(ep)
|
server._endpoints.remove(ep)
|
||||||
|
@ -1045,8 +1153,7 @@ async def open_ipc_server(
|
||||||
try:
|
try:
|
||||||
yield ipc_server
|
yield ipc_server
|
||||||
log.runtime(
|
log.runtime(
|
||||||
f'Waiting on server to shutdown or be cancelled..\n'
|
'Server-tn running until terminated\n'
|
||||||
f'{ipc_server}'
|
|
||||||
)
|
)
|
||||||
# TODO? when if ever would we want/need this?
|
# TODO? when if ever would we want/need this?
|
||||||
# with trio.CancelScope(shield=True):
|
# with trio.CancelScope(shield=True):
|
||||||
|
|
|
@ -18,7 +18,6 @@ TCP implementation of tractor.ipc._transport.MsgTransport protocol
|
||||||
|
|
||||||
'''
|
'''
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
import ipaddress
|
|
||||||
from typing import (
|
from typing import (
|
||||||
ClassVar,
|
ClassVar,
|
||||||
)
|
)
|
||||||
|
@ -51,45 +50,13 @@ class TCPAddress(
|
||||||
_host: str
|
_host: str
|
||||||
_port: int
|
_port: int
|
||||||
|
|
||||||
def __post_init__(self):
|
|
||||||
try:
|
|
||||||
ipaddress.ip_address(self._host)
|
|
||||||
except ValueError as valerr:
|
|
||||||
raise ValueError(
|
|
||||||
'Invalid {type(self).__name__}._host = {self._host!r}\n'
|
|
||||||
) from valerr
|
|
||||||
|
|
||||||
proto_key: ClassVar[str] = 'tcp'
|
proto_key: ClassVar[str] = 'tcp'
|
||||||
unwrapped_type: ClassVar[type] = tuple[str, int]
|
unwrapped_type: ClassVar[type] = tuple[str, int]
|
||||||
def_bindspace: ClassVar[str] = '127.0.0.1'
|
def_bindspace: ClassVar[str] = '127.0.0.1'
|
||||||
|
|
||||||
# ?TODO, actually validate ipv4/6 with stdlib's `ipaddress`
|
|
||||||
@property
|
@property
|
||||||
def is_valid(self) -> bool:
|
def is_valid(self) -> bool:
|
||||||
'''
|
return self._port != 0
|
||||||
Predicate to ensure a valid socket-address pair.
|
|
||||||
|
|
||||||
'''
|
|
||||||
return (
|
|
||||||
self._port != 0
|
|
||||||
and
|
|
||||||
(ipaddr := ipaddress.ip_address(self._host))
|
|
||||||
and not (
|
|
||||||
ipaddr.is_reserved
|
|
||||||
or
|
|
||||||
ipaddr.is_unspecified
|
|
||||||
or
|
|
||||||
ipaddr.is_link_local
|
|
||||||
or
|
|
||||||
ipaddr.is_link_local
|
|
||||||
or
|
|
||||||
ipaddr.is_multicast
|
|
||||||
or
|
|
||||||
ipaddr.is_global
|
|
||||||
)
|
|
||||||
)
|
|
||||||
# ^XXX^ see various properties of invalid addrs here,
|
|
||||||
# https://docs.python.org/3/library/ipaddress.html#ipaddress.IPv4Address
|
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def bindspace(self) -> str:
|
def bindspace(self) -> str:
|
||||||
|
@ -160,10 +127,9 @@ async def start_listener(
|
||||||
Start a TCP socket listener on the given `TCPAddress`.
|
Start a TCP socket listener on the given `TCPAddress`.
|
||||||
|
|
||||||
'''
|
'''
|
||||||
log.info(
|
log.runtime(
|
||||||
f'Attempting to bind TCP socket\n'
|
f'Trying socket bind\n'
|
||||||
f'>[\n'
|
f'>[ {addr}\n'
|
||||||
f'|_{addr}\n'
|
|
||||||
)
|
)
|
||||||
# ?TODO, maybe we should just change the lower-level call this is
|
# ?TODO, maybe we should just change the lower-level call this is
|
||||||
# using internall per-listener?
|
# using internall per-listener?
|
||||||
|
@ -178,11 +144,10 @@ async def start_listener(
|
||||||
assert len(listeners) == 1
|
assert len(listeners) == 1
|
||||||
listener = listeners[0]
|
listener = listeners[0]
|
||||||
host, port = listener.socket.getsockname()[:2]
|
host, port = listener.socket.getsockname()[:2]
|
||||||
|
bound_addr: TCPAddress = type(addr).from_addr((host, port))
|
||||||
log.info(
|
log.info(
|
||||||
f'Listening on TCP socket\n'
|
f'Listening on TCP socket\n'
|
||||||
f'[>\n'
|
f'[> {bound_addr}\n'
|
||||||
f' |_{addr}\n'
|
|
||||||
)
|
)
|
||||||
return listener
|
return listener
|
||||||
|
|
||||||
|
|
|
@ -26,8 +26,9 @@ from logging import (
|
||||||
Logger,
|
Logger,
|
||||||
StreamHandler,
|
StreamHandler,
|
||||||
)
|
)
|
||||||
import colorlog # type: ignore
|
import threading
|
||||||
|
|
||||||
|
import colorlog # type: ignore
|
||||||
import trio
|
import trio
|
||||||
|
|
||||||
from ._state import current_actor
|
from ._state import current_actor
|
||||||
|
@ -44,7 +45,7 @@ LOG_FORMAT = (
|
||||||
"{log_color}{asctime}{reset}"
|
"{log_color}{asctime}{reset}"
|
||||||
" {bold_white}{thin_white}({reset}"
|
" {bold_white}{thin_white}({reset}"
|
||||||
"{thin_white}{actor_name}[{actor_uid}], "
|
"{thin_white}{actor_name}[{actor_uid}], "
|
||||||
"{process}, {task}){reset}{bold_white}{thin_white})"
|
"{process}, {thread_uid}, {task_uid}){reset}{bold_white}{thin_white})"
|
||||||
" {reset}{log_color}[{reset}{bold_log_color}{levelname}{reset}{log_color}]"
|
" {reset}{log_color}[{reset}{bold_log_color}{levelname}{reset}{log_color}]"
|
||||||
" {log_color}{name}"
|
" {log_color}{name}"
|
||||||
" {thin_white}{filename}{log_color}:{reset}{thin_white}{lineno}{log_color}"
|
" {thin_white}{filename}{log_color}:{reset}{thin_white}{lineno}{log_color}"
|
||||||
|
@ -81,10 +82,35 @@ BOLD_PALETTE = {
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def at_least_level(
|
||||||
|
log: Logger|LoggerAdapter,
|
||||||
|
level: int|str,
|
||||||
|
) -> bool:
|
||||||
|
'''
|
||||||
|
Predicate to test if a given level is active.
|
||||||
|
|
||||||
|
'''
|
||||||
|
if isinstance(level, str):
|
||||||
|
level: int = CUSTOM_LEVELS[level.upper()]
|
||||||
|
|
||||||
|
if log.getEffectiveLevel() <= level:
|
||||||
|
return True
|
||||||
|
return False
|
||||||
|
|
||||||
|
|
||||||
# TODO: this isn't showing the correct '{filename}'
|
# TODO: this isn't showing the correct '{filename}'
|
||||||
# as it did before..
|
# as it did before..
|
||||||
class StackLevelAdapter(LoggerAdapter):
|
class StackLevelAdapter(LoggerAdapter):
|
||||||
|
|
||||||
|
def at_least_level(
|
||||||
|
self,
|
||||||
|
level: str,
|
||||||
|
) -> bool:
|
||||||
|
return at_least_level(
|
||||||
|
log=self,
|
||||||
|
level=level,
|
||||||
|
)
|
||||||
|
|
||||||
def transport(
|
def transport(
|
||||||
self,
|
self,
|
||||||
msg: str,
|
msg: str,
|
||||||
|
@ -223,11 +249,19 @@ def pformat_task_uid(
|
||||||
return f'{task.name}[{tid_part}]'
|
return f'{task.name}[{tid_part}]'
|
||||||
|
|
||||||
|
|
||||||
|
def pformat_thread_uid() -> str:
|
||||||
|
curr_thr: threading.Thread = threading.current_thread()
|
||||||
|
return (
|
||||||
|
f'{curr_thr.name}@{curr_thr.ident}'
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
_conc_name_getters = {
|
_conc_name_getters = {
|
||||||
'task': pformat_task_uid,
|
'task_uid': pformat_task_uid,
|
||||||
'actor': lambda: current_actor(),
|
'actor': lambda: current_actor(),
|
||||||
'actor_name': lambda: current_actor().name,
|
'actor_name': lambda: current_actor().name,
|
||||||
'actor_uid': lambda: current_actor().uid[1][:6],
|
'actor_uid': lambda: current_actor().uid[1][:6],
|
||||||
|
'thread_uid': pformat_thread_uid,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
@ -237,10 +271,11 @@ class ActorContextInfo(Mapping):
|
||||||
|
|
||||||
'''
|
'''
|
||||||
_context_keys = (
|
_context_keys = (
|
||||||
'task',
|
'task_uid',
|
||||||
'actor',
|
'actor',
|
||||||
'actor_name',
|
'actor_name',
|
||||||
'actor_uid',
|
'actor_uid',
|
||||||
|
'thread_uid',
|
||||||
)
|
)
|
||||||
|
|
||||||
def __len__(self):
|
def __len__(self):
|
||||||
|
@ -270,7 +305,9 @@ def get_logger(
|
||||||
subsys_spec: str|None = None,
|
subsys_spec: str|None = None,
|
||||||
|
|
||||||
) -> StackLevelAdapter:
|
) -> StackLevelAdapter:
|
||||||
'''Return the package log or a sub-logger for ``name`` if provided.
|
'''
|
||||||
|
Return the `tractor`-library root logger or a sub-logger for
|
||||||
|
`name` if provided.
|
||||||
|
|
||||||
'''
|
'''
|
||||||
log: Logger
|
log: Logger
|
||||||
|
@ -282,7 +319,7 @@ def get_logger(
|
||||||
name != _proj_name
|
name != _proj_name
|
||||||
):
|
):
|
||||||
|
|
||||||
# NOTE: for handling for modules that use ``get_logger(__name__)``
|
# NOTE: for handling for modules that use `get_logger(__name__)`
|
||||||
# we make the following stylistic choice:
|
# we make the following stylistic choice:
|
||||||
# - always avoid duplicate project-package token
|
# - always avoid duplicate project-package token
|
||||||
# in msg output: i.e. tractor.tractor.ipc._chan.py in header
|
# in msg output: i.e. tractor.tractor.ipc._chan.py in header
|
||||||
|
@ -331,7 +368,7 @@ def get_logger(
|
||||||
|
|
||||||
def get_console_log(
|
def get_console_log(
|
||||||
level: str|None = None,
|
level: str|None = None,
|
||||||
logger: Logger|None = None,
|
logger: Logger|StackLevelAdapter|None = None,
|
||||||
**kwargs,
|
**kwargs,
|
||||||
|
|
||||||
) -> LoggerAdapter:
|
) -> LoggerAdapter:
|
||||||
|
@ -344,12 +381,23 @@ def get_console_log(
|
||||||
Yeah yeah, i know we can use `logging.config.dictConfig()`. You do it.
|
Yeah yeah, i know we can use `logging.config.dictConfig()`. You do it.
|
||||||
|
|
||||||
'''
|
'''
|
||||||
log = get_logger(
|
# get/create a stack-aware-adapter
|
||||||
logger=logger,
|
if (
|
||||||
**kwargs
|
logger
|
||||||
) # set a root logger
|
and
|
||||||
logger: Logger = log.logger
|
isinstance(logger, StackLevelAdapter)
|
||||||
|
):
|
||||||
|
# XXX, for ex. when passed in by a caller wrapping some
|
||||||
|
# other lib's logger instance with our level-adapter.
|
||||||
|
log = logger
|
||||||
|
|
||||||
|
else:
|
||||||
|
log: StackLevelAdapter = get_logger(
|
||||||
|
logger=logger,
|
||||||
|
**kwargs
|
||||||
|
)
|
||||||
|
|
||||||
|
logger: Logger|StackLevelAdapter = log.logger
|
||||||
if not level:
|
if not level:
|
||||||
return log
|
return log
|
||||||
|
|
||||||
|
@ -367,10 +415,7 @@ def get_console_log(
|
||||||
None,
|
None,
|
||||||
)
|
)
|
||||||
):
|
):
|
||||||
fmt = LOG_FORMAT
|
fmt: str = LOG_FORMAT # always apply our format?
|
||||||
# if logger:
|
|
||||||
# fmt = None
|
|
||||||
|
|
||||||
handler = StreamHandler()
|
handler = StreamHandler()
|
||||||
formatter = colorlog.ColoredFormatter(
|
formatter = colorlog.ColoredFormatter(
|
||||||
fmt=fmt,
|
fmt=fmt,
|
||||||
|
@ -391,19 +436,3 @@ def get_loglevel() -> str:
|
||||||
|
|
||||||
# global module logger for tractor itself
|
# global module logger for tractor itself
|
||||||
log: StackLevelAdapter = get_logger('tractor')
|
log: StackLevelAdapter = get_logger('tractor')
|
||||||
|
|
||||||
|
|
||||||
def at_least_level(
|
|
||||||
log: Logger|LoggerAdapter,
|
|
||||||
level: int|str,
|
|
||||||
) -> bool:
|
|
||||||
'''
|
|
||||||
Predicate to test if a given level is active.
|
|
||||||
|
|
||||||
'''
|
|
||||||
if isinstance(level, str):
|
|
||||||
level: int = CUSTOM_LEVELS[level.upper()]
|
|
||||||
|
|
||||||
if log.getEffectiveLevel() <= level:
|
|
||||||
return True
|
|
||||||
return False
|
|
||||||
|
|
|
@ -608,7 +608,7 @@ async def drain_to_final_msg(
|
||||||
#
|
#
|
||||||
# -[ ] make sure pause points work here for REPLing
|
# -[ ] make sure pause points work here for REPLing
|
||||||
# the runtime itself; i.e. ensure there's no hangs!
|
# the runtime itself; i.e. ensure there's no hangs!
|
||||||
# |_from tractor.devx._debug import pause
|
# |_from tractor.devx.debug import pause
|
||||||
# await pause()
|
# await pause()
|
||||||
|
|
||||||
# NOTE: we get here if the far end was
|
# NOTE: we get here if the far end was
|
||||||
|
|
|
@ -20,6 +20,7 @@ Prettified version of `msgspec.Struct` for easier console grokin.
|
||||||
'''
|
'''
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
from collections import UserList
|
from collections import UserList
|
||||||
|
import textwrap
|
||||||
from typing import (
|
from typing import (
|
||||||
Any,
|
Any,
|
||||||
Iterator,
|
Iterator,
|
||||||
|
@ -105,27 +106,11 @@ def iter_fields(struct: Struct) -> Iterator[
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def pformat(
|
def iter_struct_ppfmt_lines(
|
||||||
struct: Struct,
|
struct: Struct,
|
||||||
field_indent: int = 2,
|
field_indent: int = 0,
|
||||||
indent: int = 0,
|
) -> Iterator[tuple[str, str]]:
|
||||||
|
|
||||||
) -> str:
|
|
||||||
'''
|
|
||||||
Recursion-safe `pprint.pformat()` style formatting of
|
|
||||||
a `msgspec.Struct` for sane reading by a human using a REPL.
|
|
||||||
|
|
||||||
'''
|
|
||||||
# global whitespace indent
|
|
||||||
ws: str = ' '*indent
|
|
||||||
|
|
||||||
# field whitespace indent
|
|
||||||
field_ws: str = ' '*(field_indent + indent)
|
|
||||||
|
|
||||||
# qtn: str = ws + struct.__class__.__qualname__
|
|
||||||
qtn: str = struct.__class__.__qualname__
|
|
||||||
|
|
||||||
obj_str: str = '' # accumulator
|
|
||||||
fi: structs.FieldInfo
|
fi: structs.FieldInfo
|
||||||
k: str
|
k: str
|
||||||
v: Any
|
v: Any
|
||||||
|
@ -135,15 +120,18 @@ def pformat(
|
||||||
# ..]` over .__name__ == `Literal` but still get only the
|
# ..]` over .__name__ == `Literal` but still get only the
|
||||||
# latter for simple types like `str | int | None` etc..?
|
# latter for simple types like `str | int | None` etc..?
|
||||||
ft: type = fi.type
|
ft: type = fi.type
|
||||||
typ_name: str = getattr(ft, '__name__', str(ft))
|
typ_name: str = getattr(
|
||||||
|
ft,
|
||||||
|
'__name__',
|
||||||
|
str(ft)
|
||||||
|
).replace(' ', '')
|
||||||
|
|
||||||
# recurse to get sub-struct's `.pformat()` output Bo
|
# recurse to get sub-struct's `.pformat()` output Bo
|
||||||
if isinstance(v, Struct):
|
if isinstance(v, Struct):
|
||||||
val_str: str = v.pformat(
|
yield from iter_struct_ppfmt_lines(
|
||||||
indent=field_indent + indent,
|
struct=v,
|
||||||
field_indent=indent + field_indent,
|
field_indent=field_indent+field_indent,
|
||||||
)
|
)
|
||||||
|
|
||||||
else:
|
else:
|
||||||
val_str: str = repr(v)
|
val_str: str = repr(v)
|
||||||
|
|
||||||
|
@ -161,8 +149,39 @@ def pformat(
|
||||||
# raise
|
# raise
|
||||||
# return _Struct.__repr__(struct)
|
# return _Struct.__repr__(struct)
|
||||||
|
|
||||||
# TODO: LOLOL use `textwrap.indent()` instead dawwwwwg!
|
yield (
|
||||||
obj_str += (field_ws + f'{k}: {typ_name} = {val_str},\n')
|
' '*field_indent, # indented ws prefix
|
||||||
|
f'{k}: {typ_name} = {val_str},', # field's repr line content
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def pformat(
|
||||||
|
struct: Struct,
|
||||||
|
field_indent: int = 2,
|
||||||
|
indent: int = 0,
|
||||||
|
) -> str:
|
||||||
|
'''
|
||||||
|
Recursion-safe `pprint.pformat()` style formatting of
|
||||||
|
a `msgspec.Struct` for sane reading by a human using a REPL.
|
||||||
|
|
||||||
|
'''
|
||||||
|
obj_str: str = '' # accumulator
|
||||||
|
for prefix, field_repr, in iter_struct_ppfmt_lines(
|
||||||
|
struct,
|
||||||
|
field_indent=field_indent,
|
||||||
|
):
|
||||||
|
obj_str += f'{prefix}{field_repr}\n'
|
||||||
|
|
||||||
|
# global whitespace indent
|
||||||
|
ws: str = ' '*indent
|
||||||
|
if indent:
|
||||||
|
obj_str: str = textwrap.indent(
|
||||||
|
text=obj_str,
|
||||||
|
prefix=ws,
|
||||||
|
)
|
||||||
|
|
||||||
|
# qtn: str = ws + struct.__class__.__qualname__
|
||||||
|
qtn: str = struct.__class__.__qualname__
|
||||||
|
|
||||||
return (
|
return (
|
||||||
f'{qtn}(\n'
|
f'{qtn}(\n'
|
||||||
|
|
|
@ -154,6 +154,39 @@ class Aid(
|
||||||
# should also include at least `.pid` (equiv to port for tcp)
|
# should also include at least `.pid` (equiv to port for tcp)
|
||||||
# and/or host-part always?
|
# and/or host-part always?
|
||||||
|
|
||||||
|
@property
|
||||||
|
def uid(self) -> tuple[str, str]:
|
||||||
|
'''
|
||||||
|
Legacy actor "unique-id" pair format.
|
||||||
|
|
||||||
|
'''
|
||||||
|
return (
|
||||||
|
self.name,
|
||||||
|
self.uuid,
|
||||||
|
)
|
||||||
|
|
||||||
|
def reprol(
|
||||||
|
self,
|
||||||
|
sin_uuid: bool = True,
|
||||||
|
) -> str:
|
||||||
|
if not sin_uuid:
|
||||||
|
return (
|
||||||
|
f'{self.name}[{self.uuid[:6]}]@{self.pid!r}'
|
||||||
|
)
|
||||||
|
return (
|
||||||
|
f'{self.name}@{self.pid!r}'
|
||||||
|
)
|
||||||
|
|
||||||
|
# mk hashable via `.uuid`
|
||||||
|
def __hash__(self) -> int:
|
||||||
|
return hash(self.uuid)
|
||||||
|
|
||||||
|
def __eq__(self, other: Aid) -> bool:
|
||||||
|
return self.uuid == other.uuid
|
||||||
|
|
||||||
|
# use pretty fmt since often repr-ed for console/log
|
||||||
|
__repr__ = pretty_struct.Struct.__repr__
|
||||||
|
|
||||||
|
|
||||||
class SpawnSpec(
|
class SpawnSpec(
|
||||||
pretty_struct.Struct,
|
pretty_struct.Struct,
|
||||||
|
|
|
@ -38,7 +38,6 @@ from typing import (
|
||||||
import tractor
|
import tractor
|
||||||
from tractor._exceptions import (
|
from tractor._exceptions import (
|
||||||
InternalError,
|
InternalError,
|
||||||
is_multi_cancelled,
|
|
||||||
TrioTaskExited,
|
TrioTaskExited,
|
||||||
TrioCancelled,
|
TrioCancelled,
|
||||||
AsyncioTaskExited,
|
AsyncioTaskExited,
|
||||||
|
@ -49,7 +48,7 @@ from tractor._state import (
|
||||||
_runtime_vars,
|
_runtime_vars,
|
||||||
)
|
)
|
||||||
from tractor._context import Unresolved
|
from tractor._context import Unresolved
|
||||||
from tractor.devx import _debug
|
from tractor.devx import debug
|
||||||
from tractor.log import (
|
from tractor.log import (
|
||||||
get_logger,
|
get_logger,
|
||||||
StackLevelAdapter,
|
StackLevelAdapter,
|
||||||
|
@ -59,6 +58,9 @@ from tractor.log import (
|
||||||
# from tractor.msg import (
|
# from tractor.msg import (
|
||||||
# pretty_struct,
|
# pretty_struct,
|
||||||
# )
|
# )
|
||||||
|
from tractor.trionics import (
|
||||||
|
is_multi_cancelled,
|
||||||
|
)
|
||||||
from tractor.trionics._broadcast import (
|
from tractor.trionics._broadcast import (
|
||||||
broadcast_receiver,
|
broadcast_receiver,
|
||||||
BroadcastReceiver,
|
BroadcastReceiver,
|
||||||
|
@ -479,12 +481,12 @@ def _run_asyncio_task(
|
||||||
if (
|
if (
|
||||||
debug_mode()
|
debug_mode()
|
||||||
and
|
and
|
||||||
(greenback := _debug.maybe_import_greenback(
|
(greenback := debug.maybe_import_greenback(
|
||||||
force_reload=True,
|
force_reload=True,
|
||||||
raise_not_found=False,
|
raise_not_found=False,
|
||||||
))
|
))
|
||||||
):
|
):
|
||||||
log.info(
|
log.devx(
|
||||||
f'Bestowing `greenback` portal for `asyncio`-task\n'
|
f'Bestowing `greenback` portal for `asyncio`-task\n'
|
||||||
f'{task}\n'
|
f'{task}\n'
|
||||||
)
|
)
|
||||||
|
@ -841,7 +843,7 @@ async def translate_aio_errors(
|
||||||
except BaseException as _trio_err:
|
except BaseException as _trio_err:
|
||||||
trio_err = chan._trio_err = _trio_err
|
trio_err = chan._trio_err = _trio_err
|
||||||
# await tractor.pause(shield=True) # workx!
|
# await tractor.pause(shield=True) # workx!
|
||||||
entered: bool = await _debug._maybe_enter_pm(
|
entered: bool = await debug._maybe_enter_pm(
|
||||||
trio_err,
|
trio_err,
|
||||||
api_frame=inspect.currentframe(),
|
api_frame=inspect.currentframe(),
|
||||||
)
|
)
|
||||||
|
@ -1406,7 +1408,7 @@ def run_as_asyncio_guest(
|
||||||
)
|
)
|
||||||
# XXX make it obvi we know this isn't supported yet!
|
# XXX make it obvi we know this isn't supported yet!
|
||||||
assert 0
|
assert 0
|
||||||
# await _debug.maybe_init_greenback(
|
# await debug.maybe_init_greenback(
|
||||||
# force_reload=True,
|
# force_reload=True,
|
||||||
# )
|
# )
|
||||||
|
|
||||||
|
|
|
@ -31,4 +31,9 @@ from ._broadcast import (
|
||||||
)
|
)
|
||||||
from ._beg import (
|
from ._beg import (
|
||||||
collapse_eg as collapse_eg,
|
collapse_eg as collapse_eg,
|
||||||
|
maybe_collapse_eg as maybe_collapse_eg,
|
||||||
|
is_multi_cancelled as is_multi_cancelled,
|
||||||
|
)
|
||||||
|
from ._taskc import (
|
||||||
|
maybe_raise_from_masking_exc as maybe_raise_from_masking_exc,
|
||||||
)
|
)
|
||||||
|
|
|
@ -22,11 +22,16 @@ first-class-`trio` from a historical perspective B)
|
||||||
from contextlib import (
|
from contextlib import (
|
||||||
asynccontextmanager as acm,
|
asynccontextmanager as acm,
|
||||||
)
|
)
|
||||||
|
from typing import (
|
||||||
|
Literal,
|
||||||
|
)
|
||||||
|
|
||||||
|
import trio
|
||||||
|
|
||||||
|
|
||||||
def maybe_collapse_eg(
|
def maybe_collapse_eg(
|
||||||
beg: BaseExceptionGroup,
|
beg: BaseExceptionGroup,
|
||||||
) -> BaseException:
|
) -> BaseException|bool:
|
||||||
'''
|
'''
|
||||||
If the input beg can collapse to a single non-eg sub-exception,
|
If the input beg can collapse to a single non-eg sub-exception,
|
||||||
return it instead.
|
return it instead.
|
||||||
|
@ -35,11 +40,13 @@ def maybe_collapse_eg(
|
||||||
if len(excs := beg.exceptions) == 1:
|
if len(excs := beg.exceptions) == 1:
|
||||||
return excs[0]
|
return excs[0]
|
||||||
|
|
||||||
return beg
|
return False
|
||||||
|
|
||||||
|
|
||||||
@acm
|
@acm
|
||||||
async def collapse_eg():
|
async def collapse_eg(
|
||||||
|
hide_tb: bool = True,
|
||||||
|
):
|
||||||
'''
|
'''
|
||||||
If `BaseExceptionGroup` raised in the body scope is
|
If `BaseExceptionGroup` raised in the body scope is
|
||||||
"collapse-able" (in the same way that
|
"collapse-able" (in the same way that
|
||||||
|
@ -47,12 +54,75 @@ async def collapse_eg():
|
||||||
only raise the lone emedded non-eg in in place.
|
only raise the lone emedded non-eg in in place.
|
||||||
|
|
||||||
'''
|
'''
|
||||||
|
__tracebackhide__: bool = hide_tb
|
||||||
try:
|
try:
|
||||||
yield
|
yield
|
||||||
except* BaseException as beg:
|
except* BaseException as beg:
|
||||||
if (
|
if (
|
||||||
exc := maybe_collapse_eg(beg)
|
exc := maybe_collapse_eg(beg)
|
||||||
) is not beg:
|
):
|
||||||
|
if cause := exc.__cause__:
|
||||||
|
raise exc from cause
|
||||||
|
|
||||||
raise exc
|
raise exc
|
||||||
|
|
||||||
raise beg
|
raise beg
|
||||||
|
|
||||||
|
|
||||||
|
def is_multi_cancelled(
|
||||||
|
beg: BaseException|BaseExceptionGroup,
|
||||||
|
|
||||||
|
ignore_nested: set[BaseException] = set(),
|
||||||
|
|
||||||
|
) -> Literal[False]|BaseExceptionGroup:
|
||||||
|
'''
|
||||||
|
Predicate to determine if an `BaseExceptionGroup` only contains
|
||||||
|
some (maybe nested) set of sub-grouped exceptions (like only
|
||||||
|
`trio.Cancelled`s which get swallowed silently by default) and is
|
||||||
|
thus the result of "gracefully cancelling" a collection of
|
||||||
|
sub-tasks (or other conc primitives) and receiving a "cancelled
|
||||||
|
ACK" from each after termination.
|
||||||
|
|
||||||
|
Docs:
|
||||||
|
----
|
||||||
|
- https://docs.python.org/3/library/exceptions.html#exception-groups
|
||||||
|
- https://docs.python.org/3/library/exceptions.html#BaseExceptionGroup.subgroup
|
||||||
|
|
||||||
|
'''
|
||||||
|
|
||||||
|
if (
|
||||||
|
not ignore_nested
|
||||||
|
or
|
||||||
|
trio.Cancelled not in ignore_nested
|
||||||
|
# XXX always count-in `trio`'s native signal
|
||||||
|
):
|
||||||
|
ignore_nested.update({trio.Cancelled})
|
||||||
|
|
||||||
|
if isinstance(beg, BaseExceptionGroup):
|
||||||
|
# https://docs.python.org/3/library/exceptions.html#BaseExceptionGroup.subgroup
|
||||||
|
# |_ "The condition can be an exception type or tuple of
|
||||||
|
# exception types, in which case each exception is checked
|
||||||
|
# for a match using the same check that is used in an
|
||||||
|
# except clause. The condition can also be a callable
|
||||||
|
# (other than a type object) that accepts an exception as
|
||||||
|
# its single argument and returns true for the exceptions
|
||||||
|
# that should be in the subgroup."
|
||||||
|
matched_exc: BaseExceptionGroup|None = beg.subgroup(
|
||||||
|
tuple(ignore_nested),
|
||||||
|
|
||||||
|
# ??TODO, complain about why not allowed to use
|
||||||
|
# named arg style calling???
|
||||||
|
# XD .. wtf?
|
||||||
|
# condition=tuple(ignore_nested),
|
||||||
|
)
|
||||||
|
if matched_exc is not None:
|
||||||
|
return matched_exc
|
||||||
|
|
||||||
|
# NOTE, IFF no excs types match (throughout the error-tree)
|
||||||
|
# -> return `False`, OW return the matched sub-eg.
|
||||||
|
#
|
||||||
|
# IOW, for the inverse of ^ for the purpose of
|
||||||
|
# maybe-enter-REPL--logic: "only debug when the err-tree contains
|
||||||
|
# at least one exc-type NOT in `ignore_nested`" ; i.e. the case where
|
||||||
|
# we fallthrough and return `False` here.
|
||||||
|
return False
|
||||||
|
|
|
@ -40,6 +40,8 @@ from typing import (
|
||||||
import trio
|
import trio
|
||||||
from tractor._state import current_actor
|
from tractor._state import current_actor
|
||||||
from tractor.log import get_logger
|
from tractor.log import get_logger
|
||||||
|
from ._beg import collapse_eg
|
||||||
|
|
||||||
|
|
||||||
if TYPE_CHECKING:
|
if TYPE_CHECKING:
|
||||||
from tractor import ActorNursery
|
from tractor import ActorNursery
|
||||||
|
@ -70,8 +72,7 @@ async def maybe_open_nursery(
|
||||||
yield nursery
|
yield nursery
|
||||||
else:
|
else:
|
||||||
async with lib.open_nursery(**kwargs) as nursery:
|
async with lib.open_nursery(**kwargs) as nursery:
|
||||||
if lib == trio:
|
nursery.cancel_scope.shield = shield
|
||||||
nursery.cancel_scope.shield = shield
|
|
||||||
yield nursery
|
yield nursery
|
||||||
|
|
||||||
|
|
||||||
|
@ -112,17 +113,19 @@ async def gather_contexts(
|
||||||
None,
|
None,
|
||||||
]:
|
]:
|
||||||
'''
|
'''
|
||||||
Concurrently enter a sequence of async context managers (acms),
|
Concurrently enter a sequence of async context managers (`acm`s),
|
||||||
each from a separate `trio` task and deliver the unwrapped
|
each scheduled in a separate `trio.Task` and deliver their
|
||||||
`yield`-ed values in the same order once all managers have entered.
|
unwrapped `yield`-ed values in the same order once all `@acm`s
|
||||||
|
in every task have entered.
|
||||||
|
|
||||||
On exit, all acms are subsequently and concurrently exited.
|
On exit, all `acm`s are subsequently and concurrently exited with
|
||||||
|
**no order guarantees**.
|
||||||
|
|
||||||
This function is somewhat similar to a batch of non-blocking
|
This function is somewhat similar to a batch of non-blocking
|
||||||
calls to `contextlib.AsyncExitStack.enter_async_context()`
|
calls to `contextlib.AsyncExitStack.enter_async_context()`
|
||||||
(inside a loop) *in combo with* a `asyncio.gather()` to get the
|
(inside a loop) *in combo with* a `asyncio.gather()` to get the
|
||||||
`.__aenter__()`-ed values, except the managers are both
|
`.__aenter__()`-ed values, except the managers are both
|
||||||
concurrently entered and exited and *cancellation just works*(R).
|
concurrently entered and exited and *cancellation-just-works™*.
|
||||||
|
|
||||||
'''
|
'''
|
||||||
seed: int = id(mngrs)
|
seed: int = id(mngrs)
|
||||||
|
@ -142,16 +145,15 @@ async def gather_contexts(
|
||||||
if not mngrs:
|
if not mngrs:
|
||||||
raise ValueError(
|
raise ValueError(
|
||||||
'`.trionics.gather_contexts()` input mngrs is empty?\n'
|
'`.trionics.gather_contexts()` input mngrs is empty?\n'
|
||||||
|
'\n'
|
||||||
'Did try to use inline generator syntax?\n'
|
'Did try to use inline generator syntax?\n'
|
||||||
'Use a non-lazy iterator or sequence type intead!'
|
'Use a non-lazy iterator or sequence-type intead!\n'
|
||||||
)
|
)
|
||||||
|
|
||||||
async with trio.open_nursery(
|
async with (
|
||||||
strict_exception_groups=False,
|
collapse_eg(),
|
||||||
# ^XXX^ TODO? soo roll our own then ??
|
trio.open_nursery() as tn,
|
||||||
# -> since we kinda want the "if only one `.exception` then
|
):
|
||||||
# just raise that" interface?
|
|
||||||
) as tn:
|
|
||||||
for mngr in mngrs:
|
for mngr in mngrs:
|
||||||
tn.start_soon(
|
tn.start_soon(
|
||||||
_enter_and_wait,
|
_enter_and_wait,
|
||||||
|
@ -168,7 +170,7 @@ async def gather_contexts(
|
||||||
try:
|
try:
|
||||||
yield tuple(unwrapped.values())
|
yield tuple(unwrapped.values())
|
||||||
finally:
|
finally:
|
||||||
# NOTE: this is ABSOLUTELY REQUIRED to avoid
|
# XXX NOTE: this is ABSOLUTELY REQUIRED to avoid
|
||||||
# the following wacky bug:
|
# the following wacky bug:
|
||||||
# <tractorbugurlhere>
|
# <tractorbugurlhere>
|
||||||
parent_exit.set()
|
parent_exit.set()
|
||||||
|
|
|
@ -0,0 +1,185 @@
|
||||||
|
# tractor: structured concurrent "actors".
|
||||||
|
# Copyright 2018-eternity Tyler Goodlet.
|
||||||
|
|
||||||
|
# This program is free software: you can redistribute it and/or modify
|
||||||
|
# it under the terms of the GNU Affero General Public License as published by
|
||||||
|
# the Free Software Foundation, either version 3 of the License, or
|
||||||
|
# (at your option) any later version.
|
||||||
|
|
||||||
|
# This program is distributed in the hope that it will be useful,
|
||||||
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
# GNU Affero General Public License for more details.
|
||||||
|
|
||||||
|
# You should have received a copy of the GNU Affero General Public License
|
||||||
|
# along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
'''
|
||||||
|
`trio.Task` cancellation helpers, extensions and "holsters".
|
||||||
|
|
||||||
|
'''
|
||||||
|
from __future__ import annotations
|
||||||
|
from contextlib import (
|
||||||
|
asynccontextmanager as acm,
|
||||||
|
)
|
||||||
|
from typing import TYPE_CHECKING
|
||||||
|
|
||||||
|
import trio
|
||||||
|
from tractor.log import get_logger
|
||||||
|
|
||||||
|
log = get_logger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
if TYPE_CHECKING:
|
||||||
|
from tractor.devx.debug import BoxedMaybeException
|
||||||
|
|
||||||
|
|
||||||
|
def find_masked_excs(
|
||||||
|
maybe_masker: BaseException,
|
||||||
|
unmask_from: set[BaseException],
|
||||||
|
) -> BaseException|None:
|
||||||
|
''''
|
||||||
|
Deliver any `maybe_masker.__context__` provided
|
||||||
|
it a declared masking exc-type entry in `unmask_from`.
|
||||||
|
|
||||||
|
'''
|
||||||
|
if (
|
||||||
|
type(maybe_masker) in unmask_from
|
||||||
|
and
|
||||||
|
(exc_ctx := maybe_masker.__context__)
|
||||||
|
|
||||||
|
# TODO? what about any cases where
|
||||||
|
# they could be the same type but not same instance?
|
||||||
|
# |_i.e. a cancel masking a cancel ??
|
||||||
|
# or (
|
||||||
|
# exc_ctx is not maybe_masker
|
||||||
|
# )
|
||||||
|
):
|
||||||
|
return exc_ctx
|
||||||
|
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
# XXX, relevant ish discussion @ `trio`-core,
|
||||||
|
# https://github.com/python-trio/trio/issues/455#issuecomment-2785122216
|
||||||
|
#
|
||||||
|
@acm
|
||||||
|
async def maybe_raise_from_masking_exc(
|
||||||
|
tn: trio.Nursery|None = None,
|
||||||
|
unmask_from: (
|
||||||
|
BaseException|
|
||||||
|
tuple[BaseException]
|
||||||
|
) = (trio.Cancelled,),
|
||||||
|
|
||||||
|
raise_unmasked: bool = True,
|
||||||
|
extra_note: str = (
|
||||||
|
'This can occurr when,\n'
|
||||||
|
' - a `trio.Nursery` scope embeds a `finally:`-block '
|
||||||
|
'which executes a checkpoint!'
|
||||||
|
#
|
||||||
|
# ^TODO? other cases?
|
||||||
|
),
|
||||||
|
|
||||||
|
always_warn_on: tuple[BaseException] = (
|
||||||
|
trio.Cancelled,
|
||||||
|
),
|
||||||
|
# ^XXX, special case(s) where we warn-log bc likely
|
||||||
|
# there will be no operational diff since the exc
|
||||||
|
# is always expected to be consumed.
|
||||||
|
) -> BoxedMaybeException:
|
||||||
|
'''
|
||||||
|
Maybe un-mask and re-raise exception(s) suppressed by a known
|
||||||
|
error-used-as-signal type (cough namely `trio.Cancelled`).
|
||||||
|
|
||||||
|
Though this unmasker targets cancelleds, it can be used more
|
||||||
|
generally to capture and unwrap masked excs detected as
|
||||||
|
`.__context__` values which were suppressed by any error type
|
||||||
|
passed in `unmask_from`.
|
||||||
|
|
||||||
|
-------------
|
||||||
|
STILL-TODO ??
|
||||||
|
-------------
|
||||||
|
-[ ] support for egs which have multiple masked entries in
|
||||||
|
`maybe_eg.exceptions`, in which case we should unmask the
|
||||||
|
individual sub-excs but maintain the eg-parent's form right?
|
||||||
|
|
||||||
|
'''
|
||||||
|
from tractor.devx.debug import (
|
||||||
|
BoxedMaybeException,
|
||||||
|
pause,
|
||||||
|
)
|
||||||
|
boxed_maybe_exc = BoxedMaybeException(
|
||||||
|
raise_on_exit=raise_unmasked,
|
||||||
|
)
|
||||||
|
matching: list[BaseException]|None = None
|
||||||
|
maybe_eg: ExceptionGroup|None
|
||||||
|
maybe_eg: ExceptionGroup|None
|
||||||
|
|
||||||
|
if tn:
|
||||||
|
try: # handle egs
|
||||||
|
yield boxed_maybe_exc
|
||||||
|
return
|
||||||
|
except* unmask_from as _maybe_eg:
|
||||||
|
maybe_eg = _maybe_eg
|
||||||
|
matches: ExceptionGroup
|
||||||
|
matches, _ = maybe_eg.split(
|
||||||
|
unmask_from
|
||||||
|
)
|
||||||
|
if not matches:
|
||||||
|
raise
|
||||||
|
|
||||||
|
matching: list[BaseException] = matches.exceptions
|
||||||
|
else:
|
||||||
|
try: # handle non-egs
|
||||||
|
yield boxed_maybe_exc
|
||||||
|
return
|
||||||
|
except unmask_from as _maybe_exc:
|
||||||
|
maybe_exc = _maybe_exc
|
||||||
|
matching: list[BaseException] = [
|
||||||
|
maybe_exc
|
||||||
|
]
|
||||||
|
|
||||||
|
# XXX, only unmask-ed for debuggin!
|
||||||
|
# TODO, remove eventually..
|
||||||
|
except BaseException as _berr:
|
||||||
|
berr = _berr
|
||||||
|
await pause(shield=True)
|
||||||
|
raise berr
|
||||||
|
|
||||||
|
if matching is None:
|
||||||
|
raise
|
||||||
|
|
||||||
|
masked: list[tuple[BaseException, BaseException]] = []
|
||||||
|
for exc_match in matching:
|
||||||
|
|
||||||
|
if exc_ctx := find_masked_excs(
|
||||||
|
maybe_masker=exc_match,
|
||||||
|
unmask_from={unmask_from},
|
||||||
|
):
|
||||||
|
masked.append((exc_ctx, exc_match))
|
||||||
|
boxed_maybe_exc.value = exc_match
|
||||||
|
note: str = (
|
||||||
|
f'\n'
|
||||||
|
f'^^WARNING^^ the above {exc_ctx!r} was masked by a {unmask_from!r}\n'
|
||||||
|
)
|
||||||
|
if extra_note:
|
||||||
|
note += (
|
||||||
|
f'\n'
|
||||||
|
f'{extra_note}\n'
|
||||||
|
)
|
||||||
|
exc_ctx.add_note(note)
|
||||||
|
|
||||||
|
if type(exc_match) in always_warn_on:
|
||||||
|
log.warning(note)
|
||||||
|
|
||||||
|
# await tractor.pause(shield=True)
|
||||||
|
if raise_unmasked:
|
||||||
|
|
||||||
|
if len(masked) < 2:
|
||||||
|
raise exc_ctx from exc_match
|
||||||
|
else:
|
||||||
|
# ?TODO, see above but, possibly unmasking sub-exc
|
||||||
|
# entries if there are > 1
|
||||||
|
await pause(shield=True)
|
||||||
|
else:
|
||||||
|
raise
|
8
uv.lock
8
uv.lock
|
@ -417,7 +417,7 @@ dev = [
|
||||||
{ name = "pyperclip", specifier = ">=1.9.0" },
|
{ name = "pyperclip", specifier = ">=1.9.0" },
|
||||||
{ name = "pytest", specifier = ">=8.3.5" },
|
{ name = "pytest", specifier = ">=8.3.5" },
|
||||||
{ name = "stackscope", specifier = ">=0.2.2,<0.3" },
|
{ name = "stackscope", specifier = ">=0.2.2,<0.3" },
|
||||||
{ name = "typing-extensions", specifier = ">=4.14.1" },
|
{ name = "typing-extensions", specifier = ">=4.13.2" },
|
||||||
{ name = "xonsh", specifier = ">=0.19.2" },
|
{ name = "xonsh", specifier = ">=0.19.2" },
|
||||||
]
|
]
|
||||||
|
|
||||||
|
@ -452,11 +452,11 @@ wheels = [
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "typing-extensions"
|
name = "typing-extensions"
|
||||||
version = "4.14.1"
|
version = "4.13.2"
|
||||||
source = { registry = "https://pypi.org/simple" }
|
source = { registry = "https://pypi.org/simple" }
|
||||||
sdist = { url = "https://files.pythonhosted.org/packages/98/5a/da40306b885cc8c09109dc2e1abd358d5684b1425678151cdaed4731c822/typing_extensions-4.14.1.tar.gz", hash = "sha256:38b39f4aeeab64884ce9f74c94263ef78f3c22467c8724005483154c26648d36", size = 107673, upload-time = "2025-07-04T13:28:34.16Z" }
|
sdist = { url = "https://files.pythonhosted.org/packages/f6/37/23083fcd6e35492953e8d2aaaa68b860eb422b34627b13f2ce3eb6106061/typing_extensions-4.13.2.tar.gz", hash = "sha256:e6c81219bd689f51865d9e372991c540bda33a0379d5573cddb9a3a23f7caaef", size = 106967, upload-time = "2025-04-10T14:19:05.416Z" }
|
||||||
wheels = [
|
wheels = [
|
||||||
{ url = "https://files.pythonhosted.org/packages/b5/00/d631e67a838026495268c2f6884f3711a15a9a2a96cd244fdaea53b823fb/typing_extensions-4.14.1-py3-none-any.whl", hash = "sha256:d1e1e3b58374dc93031d6eda2420a48ea44a36c2b4766a4fdeb3710755731d76", size = 43906, upload-time = "2025-07-04T13:28:32.743Z" },
|
{ url = "https://files.pythonhosted.org/packages/8b/54/b1ae86c0973cc6f0210b53d508ca3641fb6d0c56823f288d108bc7ab3cc8/typing_extensions-4.13.2-py3-none-any.whl", hash = "sha256:a439e7c04b49fec3e5d3e2beaa21755cadbbdc391694e28ccdd36ca4a1408f8c", size = 45806, upload-time = "2025-04-10T14:19:03.967Z" },
|
||||||
]
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
|
|
Loading…
Reference in New Issue