-
-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Add stubs for django-environ #14573
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Add stubs for django-environ #14573
Conversation
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
Thanks! I just want to note that the project doesn’t seem to be very actively maintained (the last commit was 7 months ago), so I wouldn’t expect type hints to be added to the library itself anytime soon. FTR: here’s a recent issue essentially complaining about the lack of type hints: joke2k/django-environ#567, and another one joke2k/django-environ#365 that might give some insight into the maintainer’s stance on adding them. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good! Just few moments:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! Looks good overall, see remarks below
__copyright__: str | ||
__version__: str | ||
__license__: str | ||
__author_email__: str | ||
__maintainer__: str | ||
__maintainer_email__: str | ||
__url__: str | ||
__description__: str |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These look like they can be marked as Final
def db_url_config(cls, url: _Str | ParseResult, engine: _Str | None = None) -> _Dict: ... | ||
@classmethod | ||
def cache_url_config(cls, url: _Str | ParseResult, backend: _Str | None = None) -> _Dict: ... | ||
@classmethod | ||
def email_url_config(cls, url: _Str | ParseResult, backend: _Str | None = None) -> _Dict: ... | ||
@classmethod | ||
def channels_url_config(cls, url: _Str | ParseResult, backend: _Str | None = None) -> _Dict: ... | ||
@classmethod | ||
def search_url_config(cls, url: _Str | ParseResult, engine: _Str | None = None) -> _Dict: ... |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These could return TypedDicts since the keys appear to be fixed
class FileAwareEnv(Env): | ||
ENVIRON: FileAwareMapping | ||
|
||
class _PathKwargs(TypedDict, total=False): |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
class _PathKwargs(TypedDict, total=False): | |
@type_check_only | |
class _PathKwargs(TypedDict, total=False): |
This comment has been minimized.
This comment has been minimized.
According to mypy_primer, this change has no effect on the checked open source code. 🤖🎉 |
I noticed that you’ve added quite a few |
Types for
django-environ
.