patrick-kidger / patrick-kidger/jaxtyping
Provide a way to get error diagnostics out of isinstance checks
Open
Nobody has claimed this yet.
feature
- Dominant language
- Python
- Stars
- 1.9k
- Forks
- 96
- PR merge metrics
- No merged PRs in 30d
Description
The assert isinstance(...) pattern prints a mostly useless message, just "AssertionError" without explanation. Would it be possible to expose an assertIsInstance(x, ty) API that prints expected versus actual, like we get for errors in the function arguments?
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 locating the existing handling for function-argument type errors and the current assert isinstance(...) pattern. Trace how an assertIsInstance(x, ty) API could fit that reporting path; done means the API exposes expected-versus-actual diagnostics instead of only AssertionError.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- testing
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100