django-types 0.19.0__py3-none-any.whl → 0.20.0__py3-none-any.whl

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

@@ -81,11 +81,11 @@ class FileField(Field[FileDescriptor, FileDescriptor]):
     def generate_filename(self, instance: Model | None, filename: str) -> str: ...
 
 class ImageFileDescriptor(FileDescriptor):
-    field: ImageField
+    field: ImageField  # pyright: ignore[reportIncompatibleVariableOverride]
     def __set__(self, instance: Model, value: str | None) -> None: ...
 
 class ImageFieldFile(ImageFile, FieldFile):
-    field: ImageField
+    field: ImageField  # pyright: ignore[reportIncompatibleVariableOverride]
     def delete(self, save: bool = ...) -> None: ...
 
 class ImageField(FileField):

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

@@ -1,7 +1,7 @@
 import json
 from collections.abc import Callable, Iterable
 from typing import Any, TypeVar, overload
-from typing_extensions import Literal
+from typing_extensions import Literal, Self
 
 from django.db.models import lookups
 from django.db.models.expressions import Combinable
@@ -20,9 +20,10 @@ class JSONField(CheckFieldDefaultMixin, Field[_A | Combinable, _A]):
     def get_transform(self, name: Any) -> Any: ...
     def value_to_string(self, obj: Any) -> Any: ...
     @overload
-    def __new__(  # type: ignore [misc]
+    def __new__(
         cls,
         verbose_name: str | None = ...,
+        *,
         name: str | None = ...,
         encoder: type[json.JSONEncoder] = ...,
         decoder: type[json.JSONDecoder] = ...,
@@ -30,7 +31,7 @@ class JSONField(CheckFieldDefaultMixin, Field[_A | Combinable, _A]):
         max_length: int | None = ...,
         unique: bool = ...,
         blank: bool = ...,
-        null: Literal[False] = ...,
+        null: Literal[False] = False,
         db_index: bool = ...,
         default: Any | Callable[[], Any] | None = ...,
         editable: bool = ...,
@@ -52,6 +53,7 @@ class JSONField(CheckFieldDefaultMixin, Field[_A | Combinable, _A]):
     def __new__(
         cls,
         verbose_name: str | None = ...,
+        *,
         name: str | None = ...,
         encoder: type[json.JSONEncoder] = ...,
         decoder: type[json.JSONDecoder] = ...,
@@ -59,7 +61,7 @@ class JSONField(CheckFieldDefaultMixin, Field[_A | Combinable, _A]):
         max_length: int | None = ...,
         unique: bool = ...,
         blank: bool = ...,
-        null: Literal[True] = ...,
+        null: Literal[True],
         db_index: bool = ...,
         default: Any | Callable[[], Any] = ...,
         editable: bool = ...,
@@ -135,6 +137,8 @@ class KeyTransform(Transform):
 class KeyTextTransform(KeyTransform):
     postgres_operator: str = ...
     postgres_nested_operator: str = ...
+    @classmethod
+    def from_lookup(cls, lookup: str) -> Self: ...
 
 class KeyTransformTextLookupMixin:
     def __init__(self, key_transform: Any, *args: Any, **kwargs: Any) -> None: ...
@@ -187,4 +191,4 @@ class KeyTransformFactory:
     def __init__(self, key_name: Any) -> None: ...
     def __call__(self, *args: Any, **kwargs: Any) -> Any: ...
 
-KT: KeyTextTransform = ...
+KT = KeyTextTransform.from_lookup

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

@@ -54,10 +54,10 @@ _ErrorMessagesToOverride = dict[str, Any]
 RECURSIVE_RELATIONSHIP_CONSTANT: str = ...
 
 class RelatedField(FieldCacheMixin, Generic[_ST, _GT], Field[_ST, _GT]):
-    one_to_many: bool = ...
-    one_to_one: bool = ...
-    many_to_many: bool = ...
-    many_to_one: bool = ...
+    one_to_many: bool = ...  # pyright: ignore[reportIncompatibleVariableOverride]
+    one_to_one: bool = ...  # pyright: ignore[reportIncompatibleVariableOverride]
+    many_to_many: bool = ...  # pyright: ignore[reportIncompatibleVariableOverride]
+    many_to_one: bool = ...  # pyright: ignore[reportIncompatibleVariableOverride]
     related_model: type[_GT] = ...
     opts: Any = ...
     def get_forward_related_filter(self, obj: Model) -> dict[str, int | UUID]: ...
@@ -74,10 +74,18 @@ class RelatedField(FieldCacheMixin, Generic[_ST, _GT], Field[_ST, _GT]):
 _M = TypeVar("_M", bound=Model | None)
 
 class ForeignObject(Generic[_M], RelatedField[_M, _M]):
-    one_to_many: Literal[False] = ...
-    one_to_one: Literal[False] = ...
-    many_to_many: Literal[False] = ...
-    many_to_one: Literal[True] = ...
+    one_to_many: Literal[  # pyright: ignore[reportIncompatibleVariableOverride]
+        False
+    ] = ...
+    one_to_one: Literal[  # pyright: ignore[reportIncompatibleVariableOverride]
+        False
+    ] = ...
+    many_to_many: Literal[  # pyright: ignore[reportIncompatibleVariableOverride]
+        False
+    ] = ...
+    many_to_one: Literal[  # pyright: ignore[reportIncompatibleVariableOverride]
+        True
+    ] = ...
     related_model: type[_M] = ...
     @overload
     def __new__(
@@ -86,6 +94,7 @@ class ForeignObject(Generic[_M], RelatedField[_M, _M]):
         on_delete: _OnDeleteOptions,
         from_fields: Sequence[str],
         to_fields: Sequence[str],
+        *,
         rel: ForeignObjectRel | None = ...,
         related_name: str | None = ...,
         related_query_name: str | None = ...,
@@ -99,7 +108,7 @@ class ForeignObject(Generic[_M], RelatedField[_M, _M]):
         max_length: int | None = ...,
         unique: bool = ...,
         blank: bool = ...,
-        null: Literal[False] = ...,
+        null: Literal[False] = False,
         db_index: bool = ...,
         default: _M | Callable[[], _M] | None = ...,
         editable: bool = ...,
@@ -122,6 +131,7 @@ class ForeignObject(Generic[_M], RelatedField[_M, _M]):
         on_delete: _OnDeleteOptions,
         from_fields: Sequence[str],
         to_fields: Sequence[str],
+        *,
         rel: ForeignObjectRel | None = ...,
         related_name: str | None = ...,
         related_query_name: str | None = ...,
@@ -135,7 +145,7 @@ class ForeignObject(Generic[_M], RelatedField[_M, _M]):
         max_length: int | None = ...,
         unique: bool = ...,
         blank: bool = ...,
-        null: Literal[True] = ...,
+        null: Literal[True],
         db_index: bool = ...,
         default: _M | Callable[[], _M] = ...,
         editable: bool = ...,
@@ -163,6 +173,7 @@ class ForeignKey(Generic[_M], ForeignObject[_M]):
         cls,
         to: type[_M] | str,
         on_delete: _OnDeleteOptions,
+        *,
         to_field: str | None = ...,
         related_name: str | None = ...,
         related_query_name: str | None = ...,
@@ -176,7 +187,7 @@ class ForeignKey(Generic[_M], ForeignObject[_M]):
         max_length: int | None = ...,
         unique: bool = ...,
         blank: bool = ...,
-        null: Literal[False] = ...,
+        null: Literal[False] = False,
         db_index: bool = ...,
         default: _M | Callable[[], _M] | None = ...,
         editable: bool = ...,
@@ -197,6 +208,7 @@ class ForeignKey(Generic[_M], ForeignObject[_M]):
         cls,
         to: type[_M] | str,
         on_delete: _OnDeleteOptions,
+        *,
         to_field: str | None = ...,
         related_name: str | None = ...,
         related_query_name: str | None = ...,
@@ -210,7 +222,7 @@ class ForeignKey(Generic[_M], ForeignObject[_M]):
         max_length: int | None = ...,
         unique: bool = ...,
         blank: bool = ...,
-        null: Literal[True] = ...,
+        null: Literal[True],
         db_index: bool = ...,
         default: _M | Callable[[], _M] = ...,
         editable: bool = ...,
@@ -247,6 +259,7 @@ class OneToOneField(Generic[_M], ForeignKey[_M]):
         cls,
         to: type[_M] | str,
         on_delete: _OnDeleteOptions,
+        *,
         to_field: str | None = ...,
         related_name: str | None = ...,
         related_query_name: str | None = ...,
@@ -260,7 +273,7 @@ class OneToOneField(Generic[_M], ForeignKey[_M]):
         max_length: int | None = ...,
         unique: Literal[True] = ...,
         blank: bool = ...,
-        null: Literal[False] = ...,
+        null: Literal[False] = False,
         db_index: bool = ...,
         default: _M | Callable[[], _M] | None = ...,
         editable: bool = ...,
@@ -281,6 +294,7 @@ class OneToOneField(Generic[_M], ForeignKey[_M]):
         cls,
         to: type[_M] | str,
         on_delete: _OnDeleteOptions,
+        *,
         to_field: str | None = ...,
         related_name: str | None = ...,
         related_query_name: str | None = ...,
@@ -294,7 +308,7 @@ class OneToOneField(Generic[_M], ForeignKey[_M]):
         max_length: int | None = ...,
         unique: Literal[True] = ...,
         blank: bool = ...,
-        null: Literal[True] = ...,
+        null: Literal[True],
         db_index: bool = ...,
         default: _M | Callable[[], _M] = ...,
         editable: bool = ...,
@@ -326,10 +340,18 @@ _MN = TypeVar("_MN", bound=Model)
 class ManyToManyField(
     Generic[_MM, _MN], RelatedField[Sequence[_MN], ManyToManyRelatedManager[_MM, _MN]]
 ):
-    one_to_many: Literal[False] = ...
-    one_to_one: Literal[False] = ...
-    many_to_many: Literal[True] = ...
-    many_to_one: Literal[False] = ...
+    one_to_many: Literal[  # pyright: ignore[reportIncompatibleVariableOverride]
+        False
+    ] = ...
+    one_to_one: Literal[  # pyright: ignore[reportIncompatibleVariableOverride]
+        False
+    ] = ...
+    many_to_many: Literal[  # pyright: ignore[reportIncompatibleVariableOverride]
+        True
+    ] = ...
+    many_to_one: Literal[  # pyright: ignore[reportIncompatibleVariableOverride]
+        False
+    ] = ...
     rel_class: Any = ...
     description: Any = ...
     has_null_arg: Any = ...

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

@@ -31,7 +31,7 @@ class ForwardManyToOneDescriptor:
 
 class ForwardOneToOneDescriptor(ForwardManyToOneDescriptor):
     RelatedObjectDoesNotExist: type[ObjectDoesNotExist]
-    field: OneToOneField[Any]
+    field: OneToOneField[Any]  # pyright: ignore[reportIncompatibleVariableOverride]
     def get_object(self, instance: Model) -> Model: ...
 
 class ReverseOneToOneDescriptor:
@@ -64,8 +64,8 @@ class ReverseManyToOneDescriptor:
 def create_reverse_many_to_one_manager(superclass: Any, rel: Any) -> Any: ...
 
 class ManyToManyDescriptor(ReverseManyToOneDescriptor):
-    field: RelatedField[Any, Any]
-    rel: ManyToManyRel
+    field: RelatedField[Any, Any]  # pyright: ignore[reportIncompatibleVariableOverride]
+    rel: ManyToManyRel  # pyright: ignore[reportIncompatibleVariableOverride]
     reverse: bool = ...
     def __init__(self, rel: ManyToManyRel, reverse: bool = ...) -> None: ...
     @property

django-stubs/db/models/functions/__init__.pyi

@@ -1,6 +1,8 @@
 from .comparison import Cast as Cast
 from .comparison import Coalesce as Coalesce
+from .comparison import Collate as Collate
 from .comparison import Greatest as Greatest
+from .comparison import JSONObject as JSONObject
 from .comparison import Least as Least
 from .comparison import NullIf as NullIf
 from .datetime import Extract as Extract

django-stubs/db/models/functions/comparison.pyi

@@ -9,6 +9,14 @@ class Cast(Func):
     ) -> None: ...
 
 class Coalesce(Func): ...
+
+class Collate(Func):
+    def __init__(self, expression: Any, collation: str) -> None: ...
+
 class Greatest(Func): ...
+
+class JSONObject(Func):
+    def __init__(self, **fields: Any) -> None: ...
+
 class Least(Func): ...
 class NullIf(Func): ...

django-stubs/db/models/manager.pyi

@@ -1,5 +1,5 @@
 from collections.abc import Iterable, MutableMapping
-from typing import Any, Generic, TypeVar
+from typing import Any, Callable, Generic, TypeVar
 from typing_extensions import Self
 
 from django.db.models.base import Model
@@ -19,21 +19,26 @@ class BaseManager(QuerySet[_T]):
     def __init__(self) -> None: ...
     def deconstruct(
         self,
-    ) -> tuple[bool, str, None, tuple[Any, ...], dict[str, int]]: ...
+    ) -> tuple[
+        bool, str | None, str | None, tuple[Any, ...] | None, dict[str, Any] | None
+    ]: ...
     def check(self, **kwargs: Any) -> list[Any]: ...
     @classmethod
     def from_queryset(
-        cls, queryset_class: type[QuerySet[Any]], class_name: str | None = ...
-    ) -> Any: ...
+        cls, queryset_class: type[QuerySet[_T]], class_name: str | None = ...
+    ) -> type[Self]: ...
     @classmethod
-    def _get_queryset_methods(cls, queryset_class: type) -> dict[str, Any]: ...
+    def _get_queryset_methods(
+        cls, queryset_class: type[QuerySet[_T]]
+    ) -> dict[str, Callable[..., Any]]: ...
     def contribute_to_class(self, model: type[Model], name: str) -> None: ...
     def db_manager(
         self, using: str | None = ..., hints: dict[str, Model] | None = ...
     ) -> Self: ...
     def get_queryset(self) -> QuerySet[_T]: ...
 
-class Manager(BaseManager[_T]): ...
+class Manager(BaseManager[_T]):
+    _queryset_class: type[QuerySet[_T]]
 
 class RelatedManager(Manager[_T]):
     related_val: tuple[int, ...]

django-stubs/db/models/query.pyi

@@ -42,7 +42,7 @@ class _BaseQuerySet(Generic[_T], Sized):
     def __and__(self, other: _BaseQuerySet[_T]) -> Self: ...
     def __or__(self, other: _BaseQuerySet[_T]) -> Self: ...
     def iterator(self, chunk_size: int = ...) -> Iterator[_T]: ...
-    async def aiterator(self, chunk_size: int = ...) -> Iterator[_T]: ...
+    def aiterator(self, chunk_size: int = ...) -> AsyncIterator[_T]: ...
     def aggregate(self, *args: Any, **kwargs: Any) -> dict[str, Any]: ...
     async def aaggregate(self, *args: Any, **kwargs: Any) -> dict[str, Any]: ...
     def get(self, *args: Any, **kwargs: Any) -> _T: ...
@@ -70,6 +70,9 @@ class _BaseQuerySet(Generic[_T], Sized):
     def bulk_update(
         self, objs: Iterable[_T], fields: Sequence[str], batch_size: int | None = ...
     ) -> int: ...
+    async def abulk_update(
+        self, objs: Iterable[_T], fields: Sequence[str], batch_size: int | None = ...
+    ) -> int: ...
     def get_or_create(
         self, defaults: MutableMapping[str, Any] | None = ..., **kwargs: Any
     ) -> tuple[_T, bool]: ...

django-stubs/db/models/query_utils.pyi

@@ -37,6 +37,7 @@ class Q(tree.Node):
     def __init__(self, *args: Any, **kwargs: Any) -> None: ...
     def __or__(self, other: Any) -> Q: ...
     def __and__(self, other: Any) -> Q: ...
+    def __xor__(self, other: Any) -> Q: ...
     def __invert__(self) -> Q: ...
     def resolve_expression(
         self,

django-stubs/db/transaction.pyi

@@ -1,5 +1,6 @@
 from collections.abc import Callable, Iterator
 from contextlib import contextmanager
+from types import TracebackType
 from typing import Any, TypeVar, overload
 
 from django.db import ProgrammingError
@@ -35,7 +36,12 @@ class Atomic:
     # When decorating, return the decorated function as-is, rather than clobbering it as ContextDecorator does.
     def __call__(self, func: _C) -> _C: ...
     def __enter__(self) -> None: ...
-    def __exit__(self, exc_type: None, exc_value: None, traceback: None) -> None: ...
+    def __exit__(
+        self,
+        exc_type: type[BaseException] | None,
+        exc_value: BaseException | None,
+        traceback: TracebackType | None,
+    ) -> None: ...
 
 # Bare decorator
 @overload

django-stubs/forms/boundfield.pyi

@@ -1,3 +1,4 @@
+from collections.abc import Iterable
 from typing import Any
 
 from django.forms.fields import Field
@@ -18,9 +19,10 @@ class BoundField:
     label: str = ...
     help_text: str = ...
     def __init__(self, form: BaseForm, field: Field, name: str) -> None: ...
+    @property
     def subwidgets(self) -> list[BoundWidget]: ...
     def __bool__(self) -> bool: ...
-    def __iter__(self) -> Any: ...
+    def __iter__(self) -> Iterable[BoundWidget]: ...
     def __len__(self) -> int: ...
     def __getitem__(
         self, idx: int | slice | str

django-stubs/forms/forms.pyi

@@ -1,38 +1,34 @@
-from collections.abc import Iterator, Mapping, Sequence
-from typing import Any
+from collections.abc import Iterator, Mapping
+from typing import Any, ClassVar
 
 from django.core.exceptions import ValidationError as ValidationError
 from django.core.files import uploadedfile
-from django.db.models.options import Options
 from django.forms.boundfield import BoundField
 from django.forms.fields import Field
 from django.forms.renderers import BaseRenderer
-from django.forms.utils import ErrorDict, ErrorList
+from django.forms.utils import ErrorDict, ErrorList, RenderableFormMixin
 from django.forms.widgets import Media, MediaDefiningClass
 from django.utils.datastructures import MultiValueDict
 from django.utils.safestring import SafeText
 
 class DeclarativeFieldsMetaclass(MediaDefiningClass): ...
 
-class BaseForm:
-    class Meta:
-        fields: Sequence[str] = ...
-    _meta: Options[Any]
-    default_renderer: Any = ...
-    field_order: Any = ...
-    use_required_attribute: bool = ...
-    is_bound: bool = ...
-    data: dict[str, Any] = ...
-    files: MultiValueDict[str, uploadedfile.UploadedFile] = ...
-    auto_id: bool | str = ...
-    initial: dict[str, Any] = ...
-    error_class: type[ErrorList] = ...
-    prefix: str | None = ...
-    label_suffix: str = ...
-    empty_permitted: bool = ...
-    fields: dict[str, Any] = ...
-    renderer: BaseRenderer = ...
-    cleaned_data: Any = ...
+class BaseForm(RenderableFormMixin):
+    default_renderer: type[BaseRenderer]
+    field_order: list[str] | None
+    use_required_attribute: bool
+    is_bound: bool
+    data: dict[str, Any]
+    files: MultiValueDict[str, uploadedfile.UploadedFile]
+    auto_id: bool | str
+    initial: dict[str, Any]
+    error_class: type[ErrorList]
+    prefix: str | None
+    label_suffix: str
+    empty_permitted: bool
+    fields: dict[str, Field]
+    renderer: BaseRenderer
+    cleaned_data: dict[str, Any]
     def __init__(
         self,
         data: Mapping[str, Any] | None = ...,
@@ -43,9 +39,9 @@ class BaseForm:
         error_class: type[ErrorList] = ...,
         label_suffix: str | None = ...,
         empty_permitted: bool = ...,
-        field_order: Any | None = ...,
+        field_order: list[str] | None = ...,
         use_required_attribute: bool | None = ...,
-        renderer: Any = ...,
+        renderer: type[BaseRenderer] | None = ...,
     ) -> None: ...
     def order_fields(self, field_order: list[str] | None) -> None: ...
     def __iter__(self) -> Iterator[BoundField]: ...
@@ -55,12 +51,9 @@ class BaseForm:
     def is_valid(self) -> bool: ...
     def add_prefix(self, field_name: str) -> str: ...
     def add_initial_prefix(self, field_name: str) -> str: ...
-    def as_table(self) -> SafeText: ...
-    def as_ul(self) -> SafeText: ...
-    def as_p(self) -> SafeText: ...
     def non_field_errors(self) -> ErrorList: ...
     def add_error(self, field: str | None, error: ValidationError | str) -> None: ...
-    def has_error(self, field: Any, code: Any | None = ...) -> Any: ...
+    def has_error(self, field: str, code: str | None = ...) -> bool: ...
     def full_clean(self) -> None: ...
     def clean(self) -> dict[str, Any]: ...
     def has_changed(self) -> bool: ...
@@ -68,9 +61,9 @@ class BaseForm:
     def changed_data(self) -> list[str]: ...
     @property
     def media(self) -> Media: ...
-    def is_multipart(self) -> Any: ...
-    def hidden_fields(self) -> Any: ...
-    def visible_fields(self) -> Any: ...
+    def is_multipart(self) -> bool: ...
+    def hidden_fields(self) -> list[BoundField]: ...
+    def visible_fields(self) -> list[BoundField]: ...
     def get_initial_for_field(self, field: Field, field_name: str) -> Any: ...
     def _html_output(
         self,
@@ -81,6 +74,6 @@ class BaseForm:
         errors_on_separate_row: bool,
     ) -> SafeText: ...
 
-class Form(BaseForm):
-    base_fields: dict[str, Field]
-    declared_fields: dict[str, Field]
+class Form(BaseForm, metaclass=DeclarativeFieldsMetaclass):
+    base_fields: ClassVar[dict[str, Field]]
+    declared_fields: ClassVar[dict[str, Field]]