python-trio / python-trio/trio
How can we help catch the mistake of issuing a blocking operation without a timeout set?
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 7.3k
- Forks
- 431
- Avg merge
- 2d 17h
- Merged PRs (30d)
- 6
Description
There are some operations that are safe to call without a timeout set, like Event.wait when you know that another task will definitely call Event.set eventually. But for something like network IO, blocking without a timeout is basically always a bug.
In principle, this is pretty easy to check -- just make the dangerous operations call current_effective_deadline before running, and do something if the deadline is inf. (And most of these operations are already calling yield_if_cancelled, so in principle this check could be made almost free... though that interacts with #58).
The bigger question is how to expose this to users. Some options:
- Always check; make it an error to do network I/O without a timeout set.
- Always check; issue a warning if they're doing network I/O without a timeout set.
- Or combining these two approaches, issue a warning that has a default filter which makes it an error.
- Check when running in some sort of "debugging mode", like a special env-var set or an argument to
runor whatever.
I'm not a huge fan of "debugging mode" as an approach for something like this, just because this approach has reduced impact: lots of people who would benefit will probably not notice the feature exists and think to turn it on. OTOH maybe it's too obnoxious or creates too much of a slowdown to force people to have timeouts set, esp. for new users or things like test suites that use socketpairs? Further experimentation needed.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the existing network I/O operations that call current_effective_deadline and yield_if_cancelled, and review the interaction with #58. Compare the proposed always-error, warning, and debugging-mode approaches, including behavior for socketpairs and possible slowdown. Done means selecting and implementing a clear policy, with experiments or tests covering blocking operations without a timeout.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- networking
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100