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

Jump to bottom

trio.sleep_forever should mention that it raises if rescheduled #3113

Closed
A5rocks opened this issue Oct 18, 2024 · 1 comment · Fixed by #3115
Closed

trio.sleep_forever should mention that it raises if rescheduled #3113

A5rocks opened this issue Oct 18, 2024 · 1 comment · Fixed by #3115

Comments

@A5rocks
Copy link
Contributor

A5rocks commented Oct 18, 2024

This causes a regression for anyone who was using trio.sleep_forever combined with trio.lowlevel.reschedule. Okay, maybe they (we (I)) should have been using trio.lowlevel.wait_task_rescheduled but the RuntimeError should have been phased in with a warning over one release cycle.

Originally posted by @richardsheridan in #3096 (comment)
@A5rocks
Copy link
Contributor Author

A5rocks commented Oct 18, 2024 •
edited
Loading

I think this regression is ultimately ok, especially since it's already done. We can update the docstring to mention this as in #3096 (comment).

@A5rocks A5rocks changed the title Regression due to trio.sleep_forever raising trio.sleep_forever should mention that it raises if rescheduled Oct 18, 2024
@A5rocks A5rocks mentioned this issue Oct 19, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Document that trio.sleep_forever will raise RuntimeError instead of returning A5rocks/trio
1 participant
@A5rocks