python-trio / python-trio/trio

Better error messages for accidentally adding/forgetting an "async"?

Open
#65 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

todo soon user happiness
Dominant language
Python
Stars
7.3k
Forks
431
Avg merge
2d 17h
Merged PRs (30d)
6

Description

We should go through our (async) context managers and (async) iterators and make sure they give helpful error messages if you accidentally write async where you shouldn't or vice-versa.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Search the Trio codebase for its async and synchronous context managers and iterators, then identify where misuse of async is currently reported. Review existing tests and error-message conventions before determining the cases to cover. Done means the relevant interfaces consistently provide helpful errors when async is added or omitted accidentally.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.