Skip to content
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

feat: type db.backends introspection and operations on 4.2 #1571

Merged

Conversation

GabDug
Copy link
Contributor

@GabDug GabDug commented Jun 23, 2023

I have made things!

Hey!

This PR attemps to improve the typings for django.db.backends.*.operations and django.db.backends.*.introspection .

I also deleted some overrides of the base that were just typed as Any, which was sometime less specific than the base. I was wondering if there were some type-checker issues that forced us to copy typings on subclasses? If not, we may delete even more duplicates.

Typings can still be improved and I need to dig a little deeper to remove some Anys and check things, feedback is very much appreciated!

Related issues

@sobolevn
Copy link
Member

Why is it marked as a draft? :)

@GabDug GabDug marked this pull request as ready for review June 23, 2023 13:38
@GabDug
Copy link
Contributor Author

GabDug commented Jun 23, 2023

Why is it marked as a draft? :)

Put it in ready for review -- sorry about that.

Copy link
Member

@sobolevn sobolevn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

django-stubs/db/backends/base/operations.pyi Outdated Show resolved Hide resolved
Copy link
Member

@sobolevn sobolevn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will merge this, we can always fix some issues later! Thanks!

@sobolevn sobolevn merged commit efc6d20 into typeddjango:master Jun 23, 2023
@GabDug GabDug deleted the fix-db-backend-introspection-operations branch June 24, 2023 15:59
descope bot referenced this pull request in descope/django-descope Jul 18, 2023
This PR contains the following updates:

| Package | Type | Update | Change | Pending |
|---|---|---|---|---|
| [django-stubs](https://github.com/typeddjango/django-stubs)
([changelog](https://github.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://github.com/typeddjango/django-stubs/releases/tag/4.2.2)

[Compare
Source](https://github.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://github.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://github.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
[@&#8203;Alexerson](https://github.com/Alexerson) in
[https://github.com/typeddjango/django-stubs/pull/1523](https://github.com/typeddjango/django-stubs/pull/1523)
- Updated global settings and `AppConfig` class to match Django 4.2 by
[@&#8203;Alexerson](https://github.com/Alexerson) in
[https://github.com/typeddjango/django-stubs/pull/1524](https://github.com/typeddjango/django-stubs/pull/1524)
- Added types for new 'system checks' in Django 4.2 by
[@&#8203;Alexerson](https://github.com/Alexerson) in
[https://github.com/typeddjango/django-stubs/pull/1526](https://github.com/typeddjango/django-stubs/pull/1526)
- Added `ManifestStaticFilesStorage` new parameters by
[@&#8203;Alexerson](https://github.com/Alexerson) in
[https://github.com/typeddjango/django-stubs/pull/1528](https://github.com/typeddjango/django-stubs/pull/1528)
- Added new methods to `Sitemap` class by
[@&#8203;Alexerson](https://github.com/Alexerson) in
[https://github.com/typeddjango/django-stubs/pull/1527](https://github.com/typeddjango/django-stubs/pull/1527)
- Added new `headers=` parameter to `(Async)RequestFactory` and
`(Async)Client` classes by
[@&#8203;Alexerson](https://github.com/Alexerson) in
[https://github.com/typeddjango/django-stubs/pull/1529](https://github.com/typeddjango/django-stubs/pull/1529)
- Additional fixes by [@&#8203;intgr](https://github.com/intgr) in
[https://github.com/typeddjango/django-stubs/pull/1537](https://github.com/typeddjango/django-stubs/pull/1537)
- GDAL-related GeoDjango updates in Django 4.2 by
[@&#8203;Alexerson](https://github.com/Alexerson) in
[https://github.com/typeddjango/django-stubs/pull/1525](https://github.com/typeddjango/django-stubs/pull/1525)
- Added ORM `^` and `~` operator support, JSON lookup classes, Postgres
lookup classes, `ModelForm` changes, `json_script` template filter
parameters by [@&#8203;Alexerson](https://github.com/Alexerson) in
[https://github.com/typeddjango/django-stubs/pull/1536](https://github.com/typeddjango/django-stubs/pull/1536)
- Added and updated `db.backends` `DatabaseIntrospection` and
`DatabaseOperations` classes by
[@&#8203;GabDug](https://github.com/GabDug) in
[https://github.com/typeddjango/django-stubs/pull/1571](https://github.com/typeddjango/django-stubs/pull/1571)

##### Stubs additions

- Added `QuerySet._result_cache` attribute and `_fetch_all()` method by
[@&#8203;adamchainz](https://github.com/adamchainz) in
[https://github.com/typeddjango/django-stubs/pull/1505](https://github.com/typeddjango/django-stubs/pull/1505)
- Added `ModelAdmin.search_help_text` attribute by
[@&#8203;adamchainz](https://github.com/adamchainz) in
[https://github.com/typeddjango/django-stubs/pull/1546](https://github.com/typeddjango/django-stubs/pull/1546)
- Added email console handler `EmailBackend.write_message()` method by
[@&#8203;adamchainz](https://github.com/adamchainz) in
[https://github.com/typeddjango/django-stubs/pull/1547](https://github.com/typeddjango/django-stubs/pull/1547)
- Added `ModelAdmin.get_formset_kwargs()` method by
[@&#8203;adamchainz](https://github.com/adamchainz) in
[https://github.com/typeddjango/django-stubs/pull/1545](https://github.com/typeddjango/django-stubs/pull/1545)
- Added `Signal._live_receivers()` method by
[@&#8203;adamchainz](https://github.com/adamchainz) in
[https://github.com/typeddjango/django-stubs/pull/1551](https://github.com/typeddjango/django-stubs/pull/1551)
- Added `SQLCompiler._order_by_pairs()` method by
[@&#8203;adamchainz](https://github.com/adamchainz) in
[https://github.com/typeddjango/django-stubs/pull/1586](https://github.com/typeddjango/django-stubs/pull/1586)
- Added `memcache_key_warnings()` function by
[@&#8203;rvanlaar](https://github.com/rvanlaar) in
[https://github.com/typeddjango/django-stubs/pull/1562](https://github.com/typeddjango/django-stubs/pull/1562)

##### Stubs fixes

- Fixed `create_model_instance` incorrect data argument type by
[@&#8203;namper](https://github.com/namper) in
[https://github.com/typeddjango/django-stubs/pull/1521](https://github.com/typeddjango/django-stubs/pull/1521)
- Marked `RequestSite.{save,delete}` methods as `NoReturn` since they
always raise by [@&#8203;sobolevn](https://github.com/sobolevn) in
[https://github.com/typeddjango/django-stubs/pull/1530](https://github.com/typeddjango/django-stubs/pull/1530)
- Updated `SafeExceptionReporterFilter` attributes and removed obsolete
`CLEANSED_SUBSTITUTE` by
[@&#8203;mthuurne](https://github.com/mthuurne) in
[https://github.com/typeddjango/django-stubs/pull/1540](https://github.com/typeddjango/django-stubs/pull/1540)
- Changed `AppConfig.default_auto_field` to attribute instead of method
by [@&#8203;mthuurne](https://github.com/mthuurne) in
[https://github.com/typeddjango/django-stubs/pull/1541](https://github.com/typeddjango/django-stubs/pull/1541)
- Fixed `default_error_messages` attribute type of base `Field` and
`GenericIPAddressField` classes by
[@&#8203;asottile](https://github.com/asottile) in
[https://github.com/typeddjango/django-stubs/pull/1538](https://github.com/typeddjango/django-stubs/pull/1538)
- Improved spatialite `DatabaseWrapper` attributes by
[@&#8203;filbasi](https://github.com/filbasi) in
[https://github.com/typeddjango/django-stubs/pull/1544](https://github.com/typeddjango/django-stubs/pull/1544)
- Improved types for Signal `dispatch.dispatcher` by
[@&#8203;GabDug](https://github.com/GabDug) in
[https://github.com/typeddjango/django-stubs/pull/1567](https://github.com/typeddjango/django-stubs/pull/1567)
- Accept `str` field names for `Window.order_by()`, allow `None` for
`asc/desc` arguments by [@&#8203;GabDug](https://github.com/GabDug) in
[https://github.com/typeddjango/django-stubs/pull/1574](https://github.com/typeddjango/django-stubs/pull/1574)
- Updated many `django.utils.*` types from stubtest by
[@&#8203;GabDug](https://github.com/GabDug) in
[https://github.com/typeddjango/django-stubs/pull/1575](https://github.com/typeddjango/django-stubs/pull/1575)
- Updated many `db.migrations.operations` types from stubtest by
[@&#8203;GabDug](https://github.com/GabDug) in
[https://github.com/typeddjango/django-stubs/pull/1583](https://github.com/typeddjango/django-stubs/pull/1583)
- Added `StepValueValidator`, fixed argument for
`SRIDCacheEntry`/`EmailValidator`, improved `urls.resolvers` types by
[@&#8203;GabDug](https://github.com/GabDug) in
[https://github.com/typeddjango/django-stubs/pull/1589](https://github.com/typeddjango/django-stubs/pull/1589)

##### Plugin changes

- Fixed `ForeignKey` queryset filters on un-swapped models by
[@&#8203;UnknownPlatypus](https://github.com/UnknownPlatypus) in
[https://github.com/typeddjango/django-stubs/pull/1495](https://github.com/typeddjango/django-stubs/pull/1495)
- Add `strict_settings` option, allow runtime fallbacks for custom
settings by [@&#8203;sobolevn](https://github.com/sobolevn) in
[https://github.com/typeddjango/django-stubs/pull/1557](https://github.com/typeddjango/django-stubs/pull/1557)
- Add "Settings" section to README by
[@&#8203;sobolevn](https://github.com/sobolevn) in
[https://github.com/typeddjango/django-stubs/pull/1581](https://github.com/typeddjango/django-stubs/pull/1581)
- Automatically reset mypy cache when plugin settings change by
[@&#8203;sobolevn](https://github.com/sobolevn) in
[https://github.com/typeddjango/django-stubs/pull/1578](https://github.com/typeddjango/django-stubs/pull/1578)
- Fixed unhandled exception `KeyError: 'model_bases'` and related errors
by [@&#8203;intgr](https://github.com/intgr) in
[https://github.com/typeddjango/django-stubs/pull/1563](https://github.com/typeddjango/django-stubs/pull/1563)

##### django-stubs-ext

- Added `TypedDatabaseRouter` as database router base class by
[@&#8203;intgr](https://github.com/intgr) in
[https://github.com/typeddjango/django-stubs/pull/1522](https://github.com/typeddjango/django-stubs/pull/1522)

##### CI/testing

- CI: Replace isort with Ruff import sorting by
[@&#8203;intgr](https://github.com/intgr) in
[https://github.com/typeddjango/django-stubs/pull/1507](https://github.com/typeddjango/django-stubs/pull/1507)
- CI: Auto-remove unused imports using Ruff by
[@&#8203;intgr](https://github.com/intgr) in
[https://github.com/typeddjango/django-stubs/pull/1508](https://github.com/typeddjango/django-stubs/pull/1508)
- CI: Enable Ruff pyupgrade fixes by
[@&#8203;intgr](https://github.com/intgr) in
[https://github.com/typeddjango/django-stubs/pull/1509](https://github.com/typeddjango/django-stubs/pull/1509)
- CI: Run django-stubs-ext tests in full build matrix by
[@&#8203;intgr](https://github.com/intgr) in
[https://github.com/typeddjango/django-stubs/pull/1552](https://github.com/typeddjango/django-stubs/pull/1552)
- Remove typecheck test and clean things up by
[@&#8203;sobolevn](https://github.com/sobolevn) in
[https://github.com/typeddjango/django-stubs/pull/1556](https://github.com/typeddjango/django-stubs/pull/1556)
- Add stubtest with lots of errors (currently) by
[@&#8203;sobolevn](https://github.com/sobolevn) in
[https://github.com/typeddjango/django-stubs/pull/1560](https://github.com/typeddjango/django-stubs/pull/1560)
- Removed extra `--generate-allowlist` by
[@&#8203;sobolevn](https://github.com/sobolevn) in
[https://github.com/typeddjango/django-stubs/pull/1576](https://github.com/typeddjango/django-stubs/pull/1576)

##### Housekeeping

- Removed unsupported Django versions from package classifiers by
[@&#8203;intgr](https://github.com/intgr) in
[https://github.com/typeddjango/django-stubs/pull/1553](https://github.com/typeddjango/django-stubs/pull/1553)
- Removed try-except around import of `ArrayField` by
[@&#8203;sobolevn](https://github.com/sobolevn) in
[https://github.com/typeddjango/django-stubs/pull/1558](https://github.com/typeddjango/django-stubs/pull/1558)
- Reverted: Fix crash when psycopg2 is not installed by
[@&#8203;intgr](https://github.com/intgr) in
[https://github.com/typeddjango/django-stubs/pull/1565](https://github.com/typeddjango/django-stubs/pull/1565)
- Removed usage of `mypy_extensions` by
[@&#8203;sobolevn](https://github.com/sobolevn) in
[https://github.com/typeddjango/django-stubs/pull/1566](https://github.com/typeddjango/django-stubs/pull/1566)
- Upgrade to Mypy 1.4.0 by
[@&#8203;christianbundy](https://github.com/christianbundy) in
[https://github.com/typeddjango/django-stubs/pull/1572](https://github.com/typeddjango/django-stubs/pull/1572)
- Chore: set Black Python target to 3.8+ explicitely by
[@&#8203;GabDug](https://github.com/GabDug) in
[https://github.com/typeddjango/django-stubs/pull/1573](https://github.com/typeddjango/django-stubs/pull/1573)
- Update `flake8` plugins by
[@&#8203;sobolevn](https://github.com/sobolevn) in
[https://github.com/typeddjango/django-stubs/pull/1579](https://github.com/typeddjango/django-stubs/pull/1579)
- CI: Run tests and pre-commit using newest Python version by
[@&#8203;intgr](https://github.com/intgr) in
[https://github.com/typeddjango/django-stubs/pull/1582](https://github.com/typeddjango/django-stubs/pull/1582)
- Removed duplicate "import all" test file by
[@&#8203;adamchainz](https://github.com/adamchainz) in
[https://github.com/typeddjango/django-stubs/pull/1587](https://github.com/typeddjango/django-stubs/pull/1587)
- Update compatible-mypy to 1.4.x by
[@&#8203;intgr](https://github.com/intgr) in
[https://github.com/typeddjango/django-stubs/pull/1588](https://github.com/typeddjango/django-stubs/pull/1588)
- Version 4.2.2 release (django-stubs, django-stubs-ext) by
[@&#8203;intgr](https://github.com/intgr) in
[https://github.com/typeddjango/django-stubs/pull/1590](https://github.com/typeddjango/django-stubs/pull/1590)

#### New Contributors

- [@&#8203;namper](https://github.com/namper) made their first
contribution in
[https://github.com/typeddjango/django-stubs/pull/1521](https://github.com/typeddjango/django-stubs/pull/1521)
- [@&#8203;filbasi](https://github.com/filbasi) made their first
contribution in
[https://github.com/typeddjango/django-stubs/pull/1544](https://github.com/typeddjango/django-stubs/pull/1544)
- [@&#8203;GabDug](https://github.com/GabDug) made their first
contribution in
[https://github.com/typeddjango/django-stubs/pull/1567](https://github.com/typeddjango/django-stubs/pull/1567)
- [@&#8203;rvanlaar](https://github.com/rvanlaar) made their first
contribution in
[https://github.com/typeddjango/django-stubs/pull/1562](https://github.com/typeddjango/django-stubs/pull/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
Labels
None yet
Development

Successfully merging this pull request may close these issues.

Database operations method signatures are not updated for Django >= 4.1
2 participants