add mypy support #106
add mypy support #106
Conversation
sneakers-the-rat
force-pushed
the
add-mypy
branch
from
006659d to
932f77c
Compare
|
Oh, thank you for this. I had this on my list because all of the mypy stuff is commented out in the "full" version of the template. I'll leave to Moritz for review I just wanted to thank you for this!! Also, get your poster done 🙃 |
| help: "Do you want to pre-commit hooks to format your code on save?" | ||
|
|
||
| use_types: | ||
| use_mypy: |
There was a problem hiding this comment.
I originally went with use_types, as folks might want to run pyright or another alternative to mypy. It's fair to commit to mypy, though, especially as this is targeted more at beginners.
| """) | ||
|
|
||
| root = generated(use_hatch_envs=use_hatch_envs, use_mypy=True) | ||
| pkg_path = root / "src" / "alien_clones" |
There was a problem hiding this comment.
Can the name be gotten from the generated project somehow? Would be better than hard-coding it here.
|
hi friends! I am going to do another bigger-ish review and update of the "FULL" version of this template. I am just letting you know as it could cause merge conflicts here. But I need to do it before next week's workshop. I'll try to keep each PR scoped following the work I just did today in pyosPackage. ✨ |
|
I turned off typing for the FULL version for the time being. I think typing it is great, but there is also a sharp learning curve and significant time associated with adding it. I did this mostly because it wasn't configured but also I just wonder if it is "custom" rather than full. For individuals who are well-versed in how they want their package configured. It would be lovely to get this pr merged if we can!! I have implemented some other updates for our workshop this week that conflict here but it is not that significant that a quick rebase won't fix!! |
3 participants
fix #100
my nerves are shot and i am procrastinating making my scipy posters badly
added a basic mypy config, these are just the config settings i like, so requesting review from @Midnighter who had the previous config in there. took out pydantic-specific stuff bc i figure we don't want to assume people will be using pydantic.
i also renamed the option from
use_typetouse_mypyand changed the prompt text accordingly - everyone should use type annotations :) and also this switch does just enable/disable mypy anyway. i still don't really like how pydoclint has no option for "ignore type annotations in function signatures" and it must be either "all functions must have type signatures" or "no functions may have type signatures" - that's enough of a problem for me that i wouldn't use pydoclint and by proxy this template, but a problem for another time.other stuff:
FBT001rule in test code which i think is silly - it forbids the presence of any positional boolean variables. like ok maybe in some circumstances like the ones they cite in the rule explanation are a code smell but banning an entire type from signatures is overkill, especially in tests.