Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add throw option in wait(::Task) #53685

Merged
merged 1 commit into from
Mar 11, 2024
Merged

Add throw option in wait(::Task) #53685

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion base/condition.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,9 @@ Block the current task until some event occurs, depending on the type of the arg
* `Process`: Wait for a process or process chain to exit. The `exitcode` field of a process
can be used to determine success or failure.
* [`Task`](@ref): Wait for a `Task` to finish. If the task fails with an exception, a
`TaskFailedException` (which wraps the failed task) is thrown.
`TaskFailedException` (which wraps the failed task) is thrown. Waiting on a task
additionally allows passing `throw=false` which prevents throwing a `TaskFailedException`
when the task fails.
* [`RawFD`](@ref): Wait for changes on a file descriptor (see the `FileWatching` package).

If no argument is passed, the task blocks for an undefined period. A task can only be
Expand Down
6 changes: 3 additions & 3 deletions base/task.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -356,11 +356,11 @@ function _wait2(t::Task, waiter::Task)
nothing
end

function wait(t::Task)
function wait(t::Task; throw=true)
t === current_task() && error("deadlock detected: cannot wait on current task")
_wait(t)
if istaskfailed(t)
throw(TaskFailedException(t))
if throw && istaskfailed(t)
Core.throw(TaskFailedException(t))
end
nothing
end
Expand Down
13 changes: 13 additions & 0 deletions test/threads.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -341,3 +341,16 @@ end
@testset "Base.Threads docstrings" begin
@test isempty(Docs.undocumented_names(Threads))
end

@testset "wait failed task" begin
@testset "wait without throw keyword" begin
t = Threads.@spawn error("Error")
@test_throws TaskFailedException wait(t)
end

@testset "wait with throw=false" begin
t = Threads.@spawn error("Error")
wait(t; throw=false)
@test istaskfailed(t)
end
end
Loading