Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Documentation clarifications

Fix function name typo leading to missed coverage

Co-authored-by: Joshua Oreman <oremanj@gmail.com>
  • Loading branch information
richardsheridan and oremanj authored Oct 18, 2023
1 parent 2f79f15 commit 96e45c5
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 8 deletions.
4 changes: 2 additions & 2 deletions docs/source/reference-core.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1826,8 +1826,8 @@ to spawn a child thread, and then use a :ref:`memory channel
.. note::

The ``from_thread.run*`` functions reuse the host task that called
:func:`trio.to_thread.run_sync` to run your provided function in the typical case,
namely when ``cancellable=False`` so Trio can be sure that the task will always be
:func:`trio.to_thread.run_sync` to run your provided function, as long as you're
using the default ``cancellable=False`` so Trio can be sure that the task will remain
around to perform the work. If you pass ``cancellable=True`` at the outset, or if
you provide a :class:`~trio.lowlevel.TrioToken` when calling back in to Trio, your
functions will be executed in a new system task. Therefore, the
Expand Down
21 changes: 15 additions & 6 deletions trio/_threads.py
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ def run_in_system_nursery(self, token: TrioToken) -> None:
def in_trio_thread() -> None:
try:
trio.lowlevel.spawn_system_task(
self.run, name=self.afn, context=self.context
self.run_system, name=self.afn, context=self.context
)
except RuntimeError: # system nursery is closed
self.queue.put_nowait(
Expand Down Expand Up @@ -394,10 +394,16 @@ def from_thread_check_cancelled() -> None:
.. note::
The check for cancellation attempts of ``cancellable=False`` threads is
interrupted while executing ``from_thread.run*`` functions, which can lead to
edge cases where this function may raise or not depending on the timing of
:class:`~trio.CancelScope` shields being raised or lowered in the Trio threads.
To be precise, :func:`~trio.from_thread.check_cancelled` checks whether the task
running :func:`trio.to_thread.run_sync` has ever been cancelled since the last
time it was running a :func:`trio.from_thread.run` or :func:`trio.from_thread.run_sync`
function. It may raise `trio.Cancelled` even if a cancellation occurred that was
later hidden by a modification to `trio.CancelScope.shield` between the cancelled
`~trio.CancelScope` and :func:`trio.to_thread.run_sync`. This differs from the
behavior of normal Trio checkpoints, which raise `~trio.Cancelled` only if the
cancellation is still active when the checkpoint executes. The distinction here is
*exceedingly* unlikely to be relevant to your application, but we mention it
for completeness.
"""
try:
raise_cancel = PARENT_TASK_DATA.cancel_register[0]
Expand Down Expand Up @@ -456,7 +462,10 @@ def from_thread_run(
RunFinishedError: if the corresponding call to :func:`trio.run` has
already completed, or if the run has started its final cleanup phase
and can no longer spawn new system tasks.
Cancelled: if the task enters cancelled status or call to :func:`trio.run`
Cancelled: If the original call to :func:`trio.to_thread.run_sync` is cancelled
(if *trio_token* is None) or the call to :func:`trio.run` completes
(if *trio_token* is not None) while ``afn(*args)`` is running,
then *afn* is likely to raise
completes while ``afn(*args)`` is running, then ``afn`` is likely to raise
:exc:`trio.Cancelled`.
RuntimeError: if you try calling this from inside the Trio thread,
Expand Down

0 comments on commit 96e45c5

Please sign in to comment.