Add type annotations #76
Conversation
There was a problem hiding this comment.
I'm genuinely curious what the purpose of type stubs is. Sometimes my VSCode loads them for Django when I'm really just trying to look at the source code, and the type stub is an annoyance more than anything.
They seem to convey information that would be just as easily included in the code itself (and less likely to get out-of-sync). Would it be better to just add type hints to the codebase?
|
@craigds , I agree. My understanding is that type stubs can be incrementally added to projects and distributed separately/independently from those projects. Looking into this, I found that it's not necessary to distribute stubs if you are willing to include type hints in the codebase: https://peps.python.org/pep-0561/#packaging-type-information So if you're willing to include type hints in the codebase, that's preferable in my opinion. We can add a file named Another reference: https://blog.whtsky.me/tech/2021/dont-forget-py.typed-for-your-typed-python-package/ |
| self.presave(*args, **kwargs) | ||
| return super(TypedModel, self).save(*args, **kwargs) | ||
|
|
||
| def presave(self, *args, **kwargs) -> None: |
There was a problem hiding this comment.
why a separate method for this? I'd prefer to leave this in save() or underscore-prefix it, to avoid adding to the public API
| @@ -358,6 +368,8 @@ class Feline(Animal): | |||
| def say_something(self): | |||
| return "meoww" | |||
| ''' | |||
| _typedmodels_type: Optional[str] | |||
| _typedmodels_subtypes: Optional[list[str]] | |||
There was a problem hiding this comment.
list[str] requires from __future__ import annotations until Python 3.9
This project still states support for python 3.6+, although mostly because I haven't gotten around to changing that...
No description provided.