Various fixes for Django 4.2 (#1536)

* Add new postgres lookups
* New encoder parameter for django.utils.html.json_script
* `F` expression that output `BooleanField` can now be negated
* django.forms.ModelForm now accepts a new Meta option formfield_callback
* New KT expression for django.db.models.JSONField
* Fix `json.KeyTextTransform.from_lookup`
* Fix NegatedExpression typing
* Fix NegatedExpression related types
* Adding generics to monkeypatch
* Fix NegatedExpression typevar
* Removed NegatedExpression from monkeypatching, see comments

---------

Co-authored-by: Marti Raudsepp <[email protected]>

Author: Alexerson

django-stubs/contrib/postgres/lookups.pyi

@@ -12,3 +12,5 @@ class HasAnyKeys(HasKeys): ...
 class Unaccent(Transform): ...
 class SearchLookup(SearchVectorExact): ...
 class TrigramSimilar(PostgresOperatorLookup): ...
+class TrigramWordSimilar(PostgresOperatorLookup): ...
+class TrigramStrictWordSimilar(PostgresOperatorLookup): ...

django-stubs/contrib/postgres/search.pyi

@@ -59,7 +59,7 @@ class SearchQuery(SearchQueryCombinable, Func):  # type: ignore
         invert: bool = ...,
         search_type: str = ...,
     ) -> None: ...
-    def __invert__(self: Self) -> Self: ...
+    def __invert__(self: Self) -> Self: ...  # type: ignore[override]
 
 class CombinedSearchQuery(SearchQueryCombinable, CombinedExpression):  # type: ignore
     def __init__(

django-stubs/db/models/expressions.pyi

@@ -1,7 +1,7 @@
 import datetime
 from collections.abc import Callable, Iterable, Iterator, Sequence
 from decimal import Decimal
-from typing import Any, Literal
+from typing import Any, Generic, Literal, TypeVar
 
 from _typeshed import Self
 from django.db.backends.base.base import BaseDatabaseWrapper
@@ -41,6 +41,7 @@ class Combinable:
     def bitand(self, other: int) -> CombinedExpression: ...
     def bitleftshift(self, other: int) -> CombinedExpression: ...
     def bitrightshift(self, other: int) -> CombinedExpression: ...
+    def __xor__(self, other: Combinable | Q) -> Q: ...
     def bitxor(self, other: int) -> CombinedExpression: ...
     def __or__(self, other: Combinable | Q) -> Q: ...
     def bitor(self, other: int) -> CombinedExpression: ...
@@ -52,6 +53,8 @@ class Combinable:
     def __rpow__(self, other: _Numeric | Combinable) -> CombinedExpression: ...
     def __rand__(self, other: Any) -> Combinable: ...
     def __ror__(self, other: Any) -> Combinable: ...
+    def __rxor__(self, other: Any) -> Combinable: ...
+    def __invert__(self) -> NegatedExpression[Combinable]: ...
 
 class BaseExpression:
     is_summary: bool
@@ -199,8 +202,15 @@ class ExpressionList(Func):
 
 class OrderByList(Func): ...
 
-class ExpressionWrapper(Expression):
-    def __init__(self, expression: Q | Combinable, output_field: Field) -> None: ...
+_E = TypeVar("_E", bound=Q | Combinable)
+
+class ExpressionWrapper(Expression, Generic[_E]):
+    def __init__(self, expression: _E, output_field: Field) -> None: ...
+    expression: _E
+
+class NegatedExpression(ExpressionWrapper[_E]):
+    def __init__(self, expression: _E) -> None: ...
+    def __invert__(self) -> _E: ...  # type: ignore[override]
 
 class When(Expression):
     template: str
@@ -226,7 +236,6 @@ class Subquery(BaseExpression, Combinable):
 
 class Exists(Subquery):
     def __init__(self, queryset: Query | QuerySet, **kwargs: Any) -> None: ...
-    def __invert__(self) -> Exists: ...
 
 class OrderBy(Expression):
     template: str

django-stubs/db/models/fields/json.pyi

@@ -1,6 +1,8 @@
 import json
+from collections.abc import Callable
 from typing import Any
 
+from _typeshed import Self
 from django.db.backends.base.base import BaseDatabaseWrapper
 from django.db.models import lookups
 from django.db.models.lookups import PostgresOperatorLookup, Transform
@@ -27,6 +29,7 @@ class ContainedBy(PostgresOperatorLookup): ...
 
 class HasKeyLookup(PostgresOperatorLookup):
     logical_operator: str | None
+    def compile_json_path_final_key(self, key_transform: Any) -> str: ...
 
 class HasKey(HasKeyLookup):
     postgres_operator: str
@@ -39,7 +42,9 @@ class HasAnyKeys(HasKeys):
     postgres_operator: str
     logical_operator: str
 
+class HasKeyOrArrayIndex(HasKey): ...
 class JSONExact(lookups.Exact): ...
+class JSONIContains(CaseInsensitiveMixin, lookups.IContains): ...
 
 class KeyTransform(Transform):
     key_name: str
@@ -51,6 +56,10 @@ class KeyTransform(Transform):
 class KeyTextTransform(KeyTransform):
     postgres_operator: str
     postgres_nested_operator: str
+    @classmethod
+    def from_lookup(cls: type[Self], lookup: str) -> Self: ...
+
+KT: Callable[[str], KeyTextTransform]
 
 class KeyTransformTextLookupMixin:
     def __init__(self, key_transform: Any, *args: Any, **kwargs: Any) -> None: ...

django-stubs/forms/models.pyi

@@ -70,6 +70,7 @@ class ModelFormOptions(Generic[_M]):
     help_texts: _HelpTexts | None
     error_messages: _ErrorMessages | None
     field_classes: dict[str, type[Field]] | None
+    formfield_callback: _FormFieldCallback | None
     def __init__(self, options: type | None = ...) -> None: ...
 
 class ModelFormMetaclass(DeclarativeFieldsMetaclass): ...
@@ -116,6 +117,7 @@ _ModelFormT = TypeVar("_ModelFormT", bound=ModelForm)
 
 class BaseModelFormSet(Generic[_M, _ModelFormT], BaseFormSet[_ModelFormT]):
     model: type[_M]
+    edit_only: bool
     unique_fields: Collection[str]
     queryset: QuerySet[_M] | None
     initial_extra: Sequence[dict[str, Any]] | None
@@ -172,6 +174,8 @@ def modelformset_factory(
     field_classes: Mapping[str, type[Field]] | None = ...,
     absolute_max: int | None = ...,
     can_delete_extra: bool = ...,
+    renderer: BaseRenderer | None = ...,
+    edit_only: bool = ...,
 ) -> type[BaseModelFormSet[_M, _ModelFormT]]: ...
 
 class BaseInlineFormSet(Generic[_M, _ParentM, _ModelFormT], BaseModelFormSet[_M, _ModelFormT]):
@@ -220,6 +224,8 @@ def inlineformset_factory(
     field_classes: Mapping[str, type[Field]] | None = ...,
     absolute_max: int | None = ...,
     can_delete_extra: bool = ...,
+    renderer: BaseRenderer | None = ...,
+    edit_only: bool = ...,
 ) -> type[BaseInlineFormSet[_M, _ParentM, _ModelFormT]]: ...
 
 class InlineForeignKeyField(Field):

django-stubs/utils/html.pyi

@@ -1,5 +1,6 @@
 from collections.abc import Iterable
 from html.parser import HTMLParser
+from json import JSONEncoder
 from re import Pattern
 from typing import Any
 
@@ -14,7 +15,7 @@ simple_url_2_re: Pattern[str]
 
 def escape(text: Any) -> SafeString: ...
 def escapejs(value: Any) -> SafeString: ...
-def json_script(value: Any, element_id: str) -> SafeString: ...
+def json_script(value: Any, element_id: str | None = ..., encoder: type[JSONEncoder] | None = ...) -> SafeString: ...
 def conditional_escape(text: Any) -> str: ...
 def format_html(format_string: str, *args: Any, **kwargs: Any) -> SafeString: ...
 def format_html_join(sep: str, format_string: str, args_generator: Iterable[Iterable[Any]]) -> SafeString: ...

django_stubs_ext/django_stubs_ext/patch.py

@@ -8,6 +8,7 @@
 from django.contrib.syndication.views import Feed
 from django.core.files.utils import FileProxyMixin
 from django.core.paginator import Paginator
+from django.db.models.expressions import ExpressionWrapper
 from django.db.models.fields import Field
 from django.db.models.fields.related import ForeignKey
 from django.db.models.lookups import Lookup
@@ -66,6 +67,7 @@ def __repr__(self) -> str:
     MPGeneric(FileProxyMixin),
     MPGeneric(Lookup),
     MPGeneric(BaseConnectionHandler),
+    MPGeneric(ExpressionWrapper),
     # These types do have native `__class_getitem__` method since django 3.1:
     MPGeneric(QuerySet, (3, 1)),
     MPGeneric(BaseManager, (3, 1)),