Typechecking on API URLs (mostly error suppression) #4915
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #4915 +/- ##
=======================================
Coverage 96.62% 96.62%
=======================================
Files 760 760
Lines 25818 25819 +1
Branches 3382 3382
=======================================
+ Hits 24947 24948 +1
Misses 606 606
Partials 265 265 ☔ View full report in Codecov by Sentry. |
It's doing a lot of duck-typing and does not play nice with the types defined in django-stubs, which would ideally be protocols rather than named types for these kind of things. However, we let the decorator_include declare the type it wants in the path arguments, and apply a cast around the custom class to silence the remaining type checker warnings. The most important thing here is that the input types for decorator_include are checked and our urls.py modules aren't unusable.
sergei-maertens
force-pushed
the
cleanup/typecheck-api-urls
branch
from
c3462e3 to
07ef1ca
Compare
vaszig
approved these changes
Dec 18, 2024
| @@ -13,6 +14,9 @@ | |||
|
|
|||
| from openforms.typing import AnyRequest | |||
|
|
|||
| if TYPE_CHECKING: | |||
| from django.conf.urls import _IncludedURLConf | |||
There was a problem hiding this comment.
Is it good that we are using Django's private API here?
There was a problem hiding this comment.
this is not actually private API, but types defined by django-stubs! this import does not exist at runtime, and that's why it's guarded by the if TYPE_CHECKING: in combination with from __future__ import annotations
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.