wemake-services / wemake-services/wemake-python-styleguide
Improve .pyi files support
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2.9k
- Forks
- 430
- Avg merge
- 5h 14m
- Merged PRs (30d)
- 34
Description
Currently, we have a lot of rules that are not very aligned with .pyi files.
Here are some of them:
...usage as a placeholder- complexity rules like number of arguments, methods, etc (we cannot control things like it in annotations)
And probably others as well.
What we need to do here is ignoring this violations when filename has .pyi extension.
And better docs about this case.
Related: https://github.com/dry-python/returns/blob/master/setup.cfg#L50
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 reviewing the rules related to .pyi files and the related configuration in setup.cfg. Identify violations that should be ignored when the filename has a .pyi extension, including placeholder and complexity checks, and update the documentation to explain this behavior. Done means the relevant rules are skipped for stub files and the case is documented.
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
- Mostly clear
- Newbie friendliness
- 35/100