Improve types for dispatch.dispatcher (Signal) #1567
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
- Remove providing_args (removed in Django 4.0) - Loosen send_robust tuple types (signals can return anything) - Explicit kwargs for receiver (kwargs for connect) - Better (not perfect) types for attributes
sobolevn
reviewed
Jun 22, 2023
flaeppe
reviewed
Jun 22, 2023
adamchainz
reviewed
Jun 23, 2023
There was a problem hiding this comment.
CI failures are due to use of ParamSpec:
E ../../home/runner/work/django-stubs/django-stubs/django-stubs/dispatch/dispatcher.pyi:4: error: Module "typing" has no attribute "ParamSpec"; maybe "_ParamSpec"? (diff)
E ../../home/runner/work/django-stubs/django-stubs/django-stubs/dispatch/dispatcher.pyi:4: note: Use `from typing_extensions import ParamSpec` instead (diff)
E ../../home/runner/work/django-stubs/django-stubs/django-stubs/dispatch/dispatcher.pyi:4: note: See https://mypy.readthedocs.io/en/stable/runtime_troubles.html#using-new-additions-to-the-typing-module (diff)
E ../../home/runner/work/django-stubs/django-stubs/django-stubs/dispatch/dispatcher.pyi:38: error: The first argument to Callable must be a list of types, parameter specification, or "..." (diff)
E ../../home/runner/work/django-stubs/django-stubs/django-stubs/dispatch/dispatcher.pyi:38: note: See https://mypy.readthedocs.io/en/stable/kinds_of_types.html#callable-types-and-lambdas (diff)
Is it possible to use a TypeVar bound to Callable instead?
GabDug
force-pushed
the
improve-dispatch-signal
branch
from
19042cb
to
77dd6eb
Compare
Seems to yield the same returns for Mypy and Pyright, so I changed it, thanks! |
sobolevn
reviewed
Jun 23, 2023
descope bot
added a commit
to descope/django-descope
that referenced
this pull request
Jul 18, 2023
This PR contains the following updates: | Package | Type | Update | Change | Pending | |---|---|---|---|---| | [django-stubs](https://togithub.com/typeddjango/django-stubs) ([changelog](https://togithub.com/typeddjango/django-stubs/releases)) | dev | patch | `4.2.1` -> `4.2.2` | `4.2.3` | --- ### Release Notes <details> <summary>typeddjango/django-stubs (django-stubs)</summary> ### [`v4.2.2`](https://togithub.com/typeddjango/django-stubs/releases/tag/4.2.2) [Compare Source](https://togithub.com/typeddjango/django-stubs/compare/4.2.1...4.2.2) #### Headline changes - **mypy 1.4:** Recommended mypy version updated to 1.4.x - Support for `django-split-settings`, `django-configurations` and other Django settings addons with `strict_settings = false` option, [see README for details](https://togithub.com/typeddjango/django-stubs#how-to-use-a-custom-library-to-handle-django-settings) - We have now adopted [mypy's stubtest](https://mypy.readthedocs.io/en/stable/stubtest.html) to automatically find discrepancies between Django and django-stubs. If you want to contribute to django-stubs but are not sure where to start, have a look at [stubtest's TODO list](https://togithub.com/typeddjango/django-stubs/blob/master/scripts/stubtest/allowlist_todo.txt) file, which lists the many issues discovered by stubtest. ##### Django 4.2 changes - Applied Django 4.2 deprecations by [@​Alexerson](https://togithub.com/Alexerson) in [typeddjango/django-stubs#1523 - Updated global settings and `AppConfig` class to match Django 4.2 by [@​Alexerson](https://togithub.com/Alexerson) in [typeddjango/django-stubs#1524 - Added types for new 'system checks' in Django 4.2 by [@​Alexerson](https://togithub.com/Alexerson) in [typeddjango/django-stubs#1526 - Added `ManifestStaticFilesStorage` new parameters by [@​Alexerson](https://togithub.com/Alexerson) in [typeddjango/django-stubs#1528 - Added new methods to `Sitemap` class by [@​Alexerson](https://togithub.com/Alexerson) in [typeddjango/django-stubs#1527 - Added new `headers=` parameter to `(Async)RequestFactory` and `(Async)Client` classes by [@​Alexerson](https://togithub.com/Alexerson) in [typeddjango/django-stubs#1529 - Additional fixes by [@​intgr](https://togithub.com/intgr) in [typeddjango/django-stubs#1537 - GDAL-related GeoDjango updates in Django 4.2 by [@​Alexerson](https://togithub.com/Alexerson) in [typeddjango/django-stubs#1525 - Added ORM `^` and `~` operator support, JSON lookup classes, Postgres lookup classes, `ModelForm` changes, `json_script` template filter parameters by [@​Alexerson](https://togithub.com/Alexerson) in [typeddjango/django-stubs#1536 - Added and updated `db.backends` `DatabaseIntrospection` and `DatabaseOperations` classes by [@​GabDug](https://togithub.com/GabDug) in [typeddjango/django-stubs#1571 ##### Stubs additions - Added `QuerySet._result_cache` attribute and `_fetch_all()` method by [@​adamchainz](https://togithub.com/adamchainz) in [typeddjango/django-stubs#1505 - Added `ModelAdmin.search_help_text` attribute by [@​adamchainz](https://togithub.com/adamchainz) in [typeddjango/django-stubs#1546 - Added email console handler `EmailBackend.write_message()` method by [@​adamchainz](https://togithub.com/adamchainz) in [typeddjango/django-stubs#1547 - Added `ModelAdmin.get_formset_kwargs()` method by [@​adamchainz](https://togithub.com/adamchainz) in [typeddjango/django-stubs#1545 - Added `Signal._live_receivers()` method by [@​adamchainz](https://togithub.com/adamchainz) in [typeddjango/django-stubs#1551 - Added `SQLCompiler._order_by_pairs()` method by [@​adamchainz](https://togithub.com/adamchainz) in [typeddjango/django-stubs#1586 - Added `memcache_key_warnings()` function by [@​rvanlaar](https://togithub.com/rvanlaar) in [typeddjango/django-stubs#1562 ##### Stubs fixes - Fixed `create_model_instance` incorrect data argument type by [@​namper](https://togithub.com/namper) in [typeddjango/django-stubs#1521 - Marked `RequestSite.{save,delete}` methods as `NoReturn` since they always raise by [@​sobolevn](https://togithub.com/sobolevn) in [typeddjango/django-stubs#1530 - Updated `SafeExceptionReporterFilter` attributes and removed obsolete `CLEANSED_SUBSTITUTE` by [@​mthuurne](https://togithub.com/mthuurne) in [typeddjango/django-stubs#1540 - Changed `AppConfig.default_auto_field` to attribute instead of method by [@​mthuurne](https://togithub.com/mthuurne) in [typeddjango/django-stubs#1541 - Fixed `default_error_messages` attribute type of base `Field` and `GenericIPAddressField` classes by [@​asottile](https://togithub.com/asottile) in [typeddjango/django-stubs#1538 - Improved spatialite `DatabaseWrapper` attributes by [@​filbasi](https://togithub.com/filbasi) in [typeddjango/django-stubs#1544 - Improved types for Signal `dispatch.dispatcher` by [@​GabDug](https://togithub.com/GabDug) in [typeddjango/django-stubs#1567 - Accept `str` field names for `Window.order_by()`, allow `None` for `asc/desc` arguments by [@​GabDug](https://togithub.com/GabDug) in [typeddjango/django-stubs#1574 - Updated many `django.utils.*` types from stubtest by [@​GabDug](https://togithub.com/GabDug) in [typeddjango/django-stubs#1575 - Updated many `db.migrations.operations` types from stubtest by [@​GabDug](https://togithub.com/GabDug) in [typeddjango/django-stubs#1583 - Added `StepValueValidator`, fixed argument for `SRIDCacheEntry`/`EmailValidator`, improved `urls.resolvers` types by [@​GabDug](https://togithub.com/GabDug) in [typeddjango/django-stubs#1589 ##### Plugin changes - Fixed `ForeignKey` queryset filters on un-swapped models by [@​UnknownPlatypus](https://togithub.com/UnknownPlatypus) in [typeddjango/django-stubs#1495 - Add `strict_settings` option, allow runtime fallbacks for custom settings by [@​sobolevn](https://togithub.com/sobolevn) in [typeddjango/django-stubs#1557 - Add "Settings" section to README by [@​sobolevn](https://togithub.com/sobolevn) in [typeddjango/django-stubs#1581 - Automatically reset mypy cache when plugin settings change by [@​sobolevn](https://togithub.com/sobolevn) in [typeddjango/django-stubs#1578 - Fixed unhandled exception `KeyError: 'model_bases'` and related errors by [@​intgr](https://togithub.com/intgr) in [typeddjango/django-stubs#1563 ##### django-stubs-ext - Added `TypedDatabaseRouter` as database router base class by [@​intgr](https://togithub.com/intgr) in [typeddjango/django-stubs#1522 ##### CI/testing - CI: Replace isort with Ruff import sorting by [@​intgr](https://togithub.com/intgr) in [typeddjango/django-stubs#1507 - CI: Auto-remove unused imports using Ruff by [@​intgr](https://togithub.com/intgr) in [typeddjango/django-stubs#1508 - CI: Enable Ruff pyupgrade fixes by [@​intgr](https://togithub.com/intgr) in [typeddjango/django-stubs#1509 - CI: Run django-stubs-ext tests in full build matrix by [@​intgr](https://togithub.com/intgr) in [typeddjango/django-stubs#1552 - Remove typecheck test and clean things up by [@​sobolevn](https://togithub.com/sobolevn) in [typeddjango/django-stubs#1556 - Add stubtest with lots of errors (currently) by [@​sobolevn](https://togithub.com/sobolevn) in [typeddjango/django-stubs#1560 - Removed extra `--generate-allowlist` by [@​sobolevn](https://togithub.com/sobolevn) in [typeddjango/django-stubs#1576 ##### Housekeeping - Removed unsupported Django versions from package classifiers by [@​intgr](https://togithub.com/intgr) in [typeddjango/django-stubs#1553 - Removed try-except around import of `ArrayField` by [@​sobolevn](https://togithub.com/sobolevn) in [typeddjango/django-stubs#1558 - Reverted: Fix crash when psycopg2 is not installed by [@​intgr](https://togithub.com/intgr) in [typeddjango/django-stubs#1565 - Removed usage of `mypy_extensions` by [@​sobolevn](https://togithub.com/sobolevn) in [typeddjango/django-stubs#1566 - Upgrade to Mypy 1.4.0 by [@​christianbundy](https://togithub.com/christianbundy) in [typeddjango/django-stubs#1572 - Chore: set Black Python target to 3.8+ explicitely by [@​GabDug](https://togithub.com/GabDug) in [typeddjango/django-stubs#1573 - Update `flake8` plugins by [@​sobolevn](https://togithub.com/sobolevn) in [typeddjango/django-stubs#1579 - CI: Run tests and pre-commit using newest Python version by [@​intgr](https://togithub.com/intgr) in [typeddjango/django-stubs#1582 - Removed duplicate "import all" test file by [@​adamchainz](https://togithub.com/adamchainz) in [typeddjango/django-stubs#1587 - Update compatible-mypy to 1.4.x by [@​intgr](https://togithub.com/intgr) in [typeddjango/django-stubs#1588 - Version 4.2.2 release (django-stubs, django-stubs-ext) by [@​intgr](https://togithub.com/intgr) in [typeddjango/django-stubs#1590 #### New Contributors - [@​namper](https://togithub.com/namper) made their first contribution in [typeddjango/django-stubs#1521 - [@​filbasi](https://togithub.com/filbasi) made their first contribution in [typeddjango/django-stubs#1544 - [@​GabDug](https://togithub.com/GabDug) made their first contribution in [typeddjango/django-stubs#1567 - [@​rvanlaar](https://togithub.com/rvanlaar) made their first contribution in [typeddjango/django-stubs#1562 **Full Changelog**: typeddjango/django-stubs@4.2.1...4.2.2 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNi4xLjExIiwidXBkYXRlZEluVmVyIjoiMzYuMS4xMSIsInRhcmdldEJyYW5jaCI6Im1haW4ifQ==--> Co-authored-by: descope[bot] <descope[bot]@users.noreply.github.com>
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.
I have made things!
Improved types for the dispatch module and Signals:
Any feedback is welcome, as it's my first contribution in this project. Thanks!