Check for pseudo-Protocols in argument types
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 83
- Forks
- 22
- PR merge metrics
- No merged PRs in 30d
Description
There are a few ABCs that look deceptively like protocols, but aren't, for example Sequence or Mapping. We usually have good protocol alternatives for these in typeshed, but it's easy to slip in one of these pseudo-protocols by accident. Edit: It makes sense to at least explicitly acknowledge the intentional use of these by adding a # noqa comment.
We should warn about using these in argument types, but probably as an opt-in warning (which we could eventually enable in typeshed).
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
The issue names no files, tests, or entry points. Start by locating the relevant argument-type check and opt-in warning configuration; done means pseudo-protocols such as Sequence and Mapping are warned about, while intentional uses can be acknowledged with a # noqa comment.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- devtools
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100