Improve system check registry hints #1249
Conversation
intgr
force-pushed
the
check-registry-hints
branch
from
a4a1974 to
a6334c5
Compare
|
@sobolevn Any ideas why only "pre-commit.ci" checks are running, but not the remaining workflows? |
|
No :( |
|
After making a new push, the workflows are now running. I guess it was a temporary GitHub glitch. |
intgr
force-pushed
the
check-registry-hints
branch
from
a86eef1 to
e31c9c7
Compare
|
This should be ready for review. @adamchainz do you have time to look at this again? |
|
Ping, this has been waiting for 3 weeks. @adamchainz @sobolevn? |
| _CheckCallable: TypeAlias = Callable[..., Sequence[CheckMessage]] | ||
| class _CheckCallable(Protocol): | ||
| def __call__( | ||
| self, *, app_configs: Apps, databases: Sequence[str] | None, **kwargs: Any |
There was a problem hiding this comment.
app_configs has the wrong type - it's a list of AppConfig, or None.
See https://docs.djangoproject.com/en/4.1/topics/checks/#writing-your-own-checks
The check function must accept an app_configs argument; this argument is the list of applications that should be inspected. If None, the check must be run on all installed apps in the project.
And an example check function in one of my packages: https://github.com/adamchainz/django-linear-migrations/blob/main/src/django_linear_migrations/apps.py#L129
There was a problem hiding this comment.
Doh that was sloppy. Thanks for the fixes!
tests/typecheck/core/test_checks.yml
Outdated
| @register("foo", deploy=True) | ||
| def check_foo(app_configs: Apps, databases: Optional[Sequence[str]], **kwargs: Any) -> list[Warning]: | ||
| if databases and 'databass' in databases: | ||
| return [Warning("Naughty list")] | ||
| return [] |
There was a problem hiding this comment.
most checks don't take a databases argument, so I'd like a test that checks that situation too
|
Tests failing until #1313... |
|
Thanks everyone! |
|
Lovely stuff, thanks everyone! |
The
@registerdecorator fromdjango.core.checkswas previously untyped.Fixes #1098.