strawberry
strawberry copied to clipboard
strawberry-graphql
Enable Ruff annotations checks
In #2476 we enabled a bunch of additional checks on Ruff, but I haven't enabled some that are probably more important for us, namely the ones for annotations. We'd like our library to be fully annotated 😊
We can enable all these checks one at the time:
- [ ] ANN001
- [ ] ANN002
- [x] ANN003
- [ ] ~ANN102~
- [x] ANN201
- [x] ANN202
- [x] ANN204
- [x] ANN205
- [x] ANN206
- [ ] ANN401
We can skip these checks on tests, it's nice to have tests type too, but it might take a lot of time 😊
Feel free to ask me any question for this, some of the annotations might be easy to add, some might not 😊
Upvote & Fund
- We're using Polar.sh so you can upvote and help fund this issue.
- We receive the funding once the issue is completed & confirmed by you.
- Thank you in advance for helping prioritize & fund our backlog.
Annotations are disabled here: https://github.com/strawberry-graphql/strawberry/blob/main/pyproject.toml#L178-L187
To work on any of them, remove the line of the annotation and then run ruff . and see what you get 😊 Then you can work from there to add annotations :)
Hi @patrick91, I'm interested in contributing to this issue. Can you please assign this to me
Thank You.
hi @MadhuMPandurangi, I think it's fine to start a PR directly ☺️
Please do only one check at the time, enabling all of them at once will require a lot of work ☺️
OK, diving into ANN001. @patrick91 no expectations that you'll want to check a WIP but if you want to take a peek and verify I'm on the right path, might save us some time...
Before:
After:
@alexauritt yes, that looks good! Feel free to open a draft PR too if you want more feedback on specific lines 😊
@alexauritt it is also fine to have # noqa: ANN001 where it is quite complex to add annotations btw 😊 we can always do this in multiple PRs :)
I wanna work on ANN201, maybe it's better to make it with multiple PRs as there are 1387 errors, what do you think @patrick91
