Suggest `TypeGuard` usage
Open
Nobody has claimed this yet.
type-feature
- Dominant language
- Python
- Stars
- 83
- Forks
- 22
- PR merge metrics
- No merged PRs in 30d
Description
If some function:
- Has a name that starts with
is - Has first arg typed as
object - Returns
bool
It might be a TypeGuard.
The amount of false-positives will be too high to enable this by default, but we can follow my OPY suggestion here: https://github.com/PyCQA/flake8-pyi/pull/135#issuecomment-1023922091
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 with the linked OPY suggestion and inspect the repository's existing checker entry points to find where new diagnostics are defined. Confirm the intended opt-in or default behavior and false-positive handling; done means recognizing the listed name, argument, and return-type pattern with appropriate coverage.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100