Releases: python-trio/trio
v0.27.0
Full Changelog: v0.26.2...v0.27.0
Breaking changes
trio.move_on_after
andtrio.fail_after
previously set the deadline relative to initialization time, instead of more intuitively upon entering the context manager. This might change timeouts if a program relied on this behavior. If you want to restore previous behavior you should instead usetrio.move_on_at(trio.current_time() + ...)
.
flake8-async has a new rule to catch this, in case you're supporting older trio versions. SeeASYNC122
. (#2512)
Features
CancelScope.relative_deadline
andCancelScope.is_relative
added, as well as arelative_deadline
parameter to__init__
. This allows initializing scopes ahead of time, but where the specified relative deadline doesn't count down until the scope is entered. (#2512)trio.Lock
andtrio.StrictFIFOLock
will now raisetrio.BrokenResourceError
whentrio.Lock.acquire
would previously stall due to the owner of the lock exiting without releasing the lock. (#3035)trio.move_on_at
,trio.move_on_after
,trio.fail_at
andtrio.fail_after
now accept shield as a keyword argument. If specified, it provides an initial value for the~trio.CancelScope.shield
attribute of thetrio.CancelScope
object created by the context manager. (#3052)- Added
trio.lowlevel.add_parking_lot_breaker
andtrio.lowlevel.remove_parking_lot_breaker
to allow creating custom lock/semaphore implementations that will break their underlying parking lot if a task exits unexpectedly.trio.lowlevel.ParkingLot.break_lot
is also added, to allow breaking a parking lot intentionally. (#3081)
Bugfixes
- Allow sockets to bind any
os.PathLike
object. (#3041) - Update
trio.lowlevel.open_process
's documentation to allow bytes. (#3076) - Update
trio.sleep_forever
to beNoReturn
. (#3095)
Improved documentation
- Add docstrings for memory channels'
statistics()
andaclose
methods. (#3101)
v0.26.2
v0.26.1
v0.26.0
Full Changelog: v0.25.1...v0.26.0
Features
-
Added an interactive interpreter
python -m trio
.This makes it easier to try things and experiment with trio in the a Python repl.
Use theawait
keyword without needing to calltrio.run()
$ python -m trio
Trio 0.26.0, Python 3.10.6
Use "await" directly instead of "trio.run()".
Type "help", "copyright", "credits" or "license" for more information.
>>> import trio
>>> await trio.sleep(1); print("hi") # prints after one second
hi
See interactive debugging for further detail. (#2972)
trio.testing.RaisesGroup
can now catch an unwrapped exception withunwrapped=True
. This means that the behaviour ofexcept*
can be fully replicated in combination withflatten_subgroups=True
(formerlystrict=False
). (#2989)
Bugfixes
- Fixed a bug where
trio.testing.RaisesGroup(..., strict=False)
would check the number of exceptions in the raisedExceptionGroup
before flattening subgroups, leading to incorrectly failed matches.
It now properly supports end ($
) regex markers in thematch
message, by no longer including " (x sub-exceptions)" in the string it matches against. (#2989)
Deprecations and removals
- Deprecated
strict
parameter fromtrio.testing.RaisesGroup
, previous functionality ofstrict=False
is now inflatten_subgroups=True
. (#2989)
v0.25.1
v0.25.0
Full Changelog: v0.24.0...v0.25.0
Breaking changes
-
The
strict_exception_groups
parameter now defaults toTrue
intrio.run
andtrio.lowlevel.start_guest_run
.trio.open_nursery
still defaults to the same value as was specified intrio.run
/trio.lowlevel.start_guest_run
, but if you didn't specify it there then all subsequent calls totrio.open_nursery
will change.
This is unfortunately very tricky to change with a deprecation period, as raising aDeprecationWarning
wheneverstrict_exception_groups
is not specified would raise a lot of unnecessary warnings.Notable side effects of changing code to run with
strict_exception_groups==True
-
If an iterator raises
StopAsyncIteration
orStopIteration
inside a nursery, then python will not recognize wrapped instances of those for stopping iteration. -
trio.run_process
is now documented that it can raise anExceptionGroup
. It previously could do this in very rare circumstances, but withstrict_exception_groups
set toTrue
it will now do so whenever exceptions occur indeliver_cancel
or with problems communicating with the subprocess.- Errors in opening the process is now done outside the internal nursery, so if code previously ran with
strict_exception_groups=True
there are cases now where anExceptionGroup
is no longer added.
- Errors in opening the process is now done outside the internal nursery, so if code previously ran with
-
trio.TrioInternalError
.__cause__
might be wrapped in one or moreExceptionGroups <ExceptionGroup>
(#2786)
-
Features
-
Add
trio.testing.wait_all_threads_completed
, which blocks until no threads are running tasks. This is intended to be used in the same way astrio.testing.wait_all_tasks_blocked
. (#2937) -
Path
is now a subclass ofpathlib.PurePath
, allowing it to interoperate with other standard
pathlib
types.Instantiating
Path
now returns a concrete platform-specific subclass, one ofPosixPath
or
WindowsPath
, matching the behavior ofpathlib.Path
. (#2959)
Bugfixes
- The pthread functions are now correctly found on systems using vanilla versions of musl libc. (#2939)
Miscellaneous internal changes
- use the regular readme for the PyPI long_description (#2866)
v0.24.0
Full Changelog: v0.23.2...v0.24.0
Features
-
New helper classes:
testing.RaisesGroup
andtesting.Matcher
.In preparation for changing the default of
strict_exception_groups
toTrue
, we're introducing a set of helper classes that can be used in place ofpytest.raises
in tests, to check for an expectedExceptionGroup
.
These are provisional, and only planned to be supplied until there's a good solution inpytest
. See pytest-dev/pytest#11538 (#2785)
Deprecations and removals
MultiError
has been fully removed, and all relevant trio functions now raise ExceptionGroups instead. This should not affect end users that have transitioned to usingexcept*
or catching ExceptionGroup/BaseExceptionGroup. (#2891)
v0.23.2
Full Changelog: v0.23.1...v0.23.2
Features
- TypeVarTuple is now used to fully type
nursery.start_soon()
,trio.run()
,trio.to_thread.run_sync()
, and other similar functions accepting(func, *args)
. This means type checkers will be able to verify types are used correctly.nursery.start()
is not fully typed yet however. (#2881)
Bugfixes
- Make pyright recognize
open_memory_channel
as generic. (#2873)
Miscellaneous internal changes
v0.23.1
v0.23.0
Full Changelog: v0.22.2...v0.23.0
Headline features
- Add type hints. (#543)
Features
- When exiting a nursery block, the parent task always waits for child tasks to exit. This wait cannot be cancelled. However, previously, if you tried to cancel it, it would inject a
Cancelled
exception, even though it wasn't cancelled. Most users probably never noticed either way, but injecting aCancelled
here is not really useful, and in some rare cases caused confusion or problems, so Trio no longer does that. (#1457) - If called from a thread spawned by
trio.to_thread.run_sync
,trio.from_thread.run
andtrio.from_thread.run_sync
now reuse the task and cancellation status of the host task; this means that context variables and cancel scopes naturally propagate 'through' threads spawned by Trio. You can also usetrio.from_thread.check_cancelled
to efficiently check for cancellation without reentering the Trio thread. (#2392) trio.lowlevel.start_guest_run
now does a bit more setup of the guest run before it returns to its caller, so that the caller can immediately make calls totrio.current_time
,trio.lowlevel.spawn_system_task
,trio.lowlevel.current_trio_token
, etc. (#2696)
Bugfixes
- When a starting function raises before calling
trio.TaskStatus.started
,trio.Nursery.start
will no longer wrap the exception in an undocumentedExceptionGroup
. Previously,trio.Nursery.start
would incorrectly raise anExceptionGroup
containing it when usingtrio.run(..., strict_exception_groups=True)
. (#2611)
Deprecations and removals
- To better reflect the underlying thread handling semantics, the keyword argument for
trio.to_thread.run_sync
that was previously calledcancellable
is now namedabandon_on_cancel
. It still does the same thing -- allow the thread to be abandoned if the call totrio.to_thread.run_sync
is cancelled -- but since we now have other ways to propagate a cancellation without abandoning the thread, "cancellable" has become somewhat of a misnomer. The oldcancellable
name is now deprecated. (#2841) - Deprecated support for
math.inf
for thebacklog
argument inopen_tcp_listeners
, making its docstring correct in the fact that onlyTypeError
is raised if invalid arguments are passed. (#2842)
Removals without deprecations
- Drop support for Python3.7 and PyPy3.7/3.8. (#2668)
- Removed special
MultiError
traceback handling for IPython. As of version 8.15ExceptionGroup
is handled natively. (#2702)
Miscellaneous internal changes
- Trio now indicates its presence to
sniffio
using thesniffio.thread_local
interface that is preferred since sniffio v1.3.0. This should be less likely than the previous approach to causesniffio.current_async_library
to return incorrect results due to unintended inheritance of contextvars. (#2700) - On windows, if SIO_BASE_HANDLE failed and SIO_BSP_HANDLE_POLL didn't return a different socket, runtime error will now raise from the OSError that indicated the issue so that in the event it does happen it might help with debugging. (#2807)