4.2 typings for db.migrations.operations (#1583)

GabDug · adamchainz · web-flow · commit 389d98629e30 · 2023-06-26T17:14:21.000+03:00
* fix: misc type fixes against 4.2

* chore: type config

* chore: improve typings for migrations.operations

* chore: remove decorator generics

* chore: rollback some changes

* chore: fix allowlist for CI

* Update django-stubs/db/migrations/state.pyi

Co-authored-by: Adam Johnson &lt;me@adamj.eu&gt;

---------

Co-authored-by: Adam Johnson &lt;me@adamj.eu&gt;
diff --git a/django-stubs/apps/config.pyi b/django-stubs/apps/config.pyi
@@ -3,8 +3,9 @@ from collections.abc import Iterator
 
 from django.apps.registry import Apps
 from django.db.models.base import Model
-from django.utils.functional import _StrOrPromise
+from django.utils.functional import _StrOrPromise, cached_property
 
+APPS_MODULE_NAME: str
 MODELS_MODULE_NAME: str
 
 class AppConfig:
@@ -17,7 +18,8 @@ class AppConfig:
     models_module: str | None
     models: dict[str, type[Model]]
     def __init__(self, app_name: str, app_module: types.ModuleType | None) -> None: ...
-    default_auto_field: str
+    @cached_property
+    def default_auto_field(self) -> str: ...
     @classmethod
     def create(cls, entry: str) -> AppConfig: ...
     def get_model(self, model_name: str, require_ready: bool = ...) -> type[Model]: ...
diff --git a/django-stubs/contrib/admin/views/main.pyi b/django-stubs/contrib/admin/views/main.pyi
@@ -12,7 +12,6 @@ from django.http.request import HttpRequest
 
 ALL_VAR: str
 ORDER_VAR: str
-ORDER_TYPE_VAR: str
 PAGE_VAR: str
 SEARCH_VAR: str
 ERROR_FLAG: str
diff --git a/django-stubs/contrib/contenttypes/management/__init__.pyi b/django-stubs/contrib/contenttypes/management/__init__.pyi
@@ -10,15 +10,15 @@ from django.db.migrations.state import StateApps
 from django.db.models.base import Model
 
 class RenameContentType(migrations.RunPython):
-    app_label: Any
-    old_model: Any
-    new_model: Any
+    app_label: str
+    old_model: str
+    new_model: str
     def __init__(self, app_label: str, old_model: str, new_model: str) -> None: ...
     def rename_forward(self, apps: StateApps, schema_editor: DatabaseSchemaEditor) -> None: ...
     def rename_backward(self, apps: StateApps, schema_editor: DatabaseSchemaEditor) -> None: ...
 
 def inject_rename_contenttypes_operations(
-    plan: list[tuple[Migration, bool]] = ..., apps: StateApps = ..., using: str = ..., **kwargs: Any
+    plan: list[tuple[Migration, bool]] | None = ..., apps: StateApps = ..., using: str = ..., **kwargs: Any
 ) -> None: ...
 def get_contenttypes_and_models(
     app_config: AppConfig, using: str, ContentType: type[ContentType]
diff --git a/django-stubs/db/migrations/operations/__init__.pyi b/django-stubs/db/migrations/operations/__init__.pyi
@@ -8,6 +8,7 @@ from .models import AlterIndexTogether as AlterIndexTogether
 from .models import AlterModelManagers as AlterModelManagers
 from .models import AlterModelOptions as AlterModelOptions
 from .models import AlterModelTable as AlterModelTable
+from .models import AlterModelTableComment as AlterModelTableComment
 from .models import AlterOrderWithRespectTo as AlterOrderWithRespectTo
 from .models import AlterUniqueTogether as AlterUniqueTogether
 from .models import CreateModel as CreateModel
diff --git a/django-stubs/db/migrations/operations/base.pyi b/django-stubs/db/migrations/operations/base.pyi
@@ -5,6 +5,7 @@ from django.db.backends.base.base import BaseDatabaseWrapper
 from django.db.backends.base.schema import BaseDatabaseSchemaEditor
 from django.db.migrations.state import ProjectState
 from django.db.models import Model
+from typing_extensions import Self
 
 class Operation:
     reversible: bool
@@ -13,6 +14,7 @@ class Operation:
     elidable: bool
     serialization_expand_args: list[str]
     _constructor_args: tuple[Sequence[Any], dict[str, Any]]
+    def __new__(cls, *args: Any, **kwargs: Any) -> Self: ...
     def deconstruct(self) -> tuple[str, Sequence[Any], dict[str, Any]]: ...
     def state_forwards(self, app_label: str, state: ProjectState) -> None: ...
     def database_forwards(
diff --git a/django-stubs/db/migrations/operations/fields.pyi b/django-stubs/db/migrations/operations/fields.pyi
@@ -1,14 +1,15 @@
 from django.db.models.fields import Field
+from django.utils.functional import cached_property
 
 from .base import Operation
 
 class FieldOperation(Operation):
     model_name: str
     name: str
     def __init__(self, model_name: str, name: str, field: Field | None = ...) -> None: ...
-    @property
+    @cached_property
     def name_lower(self) -> str: ...
-    @property
+    @cached_property
     def model_name_lower(self) -> str: ...
     def is_same_model_operation(self, operation: FieldOperation) -> bool: ...
     def is_same_field_operation(self, operation: FieldOperation) -> bool: ...
@@ -29,7 +30,7 @@ class RenameField(FieldOperation):
     old_name: str
     new_name: str
     def __init__(self, model_name: str, old_name: str, new_name: str) -> None: ...
-    @property
+    @cached_property
     def old_name_lower(self) -> str: ...
-    @property
+    @cached_property
     def new_name_lower(self) -> str: ...
diff --git a/django-stubs/db/migrations/operations/models.pyi b/django-stubs/db/migrations/operations/models.pyi
@@ -9,12 +9,14 @@ from django.db.models.fields import Field
 from django.db.models.indexes import Index
 from django.db.models.manager import Manager
 from django.db.models.options import _OptionTogetherT
+from django.utils.functional import cached_property
 
 class ModelOperation(Operation):
     name: str
     def __init__(self, name: str) -> None: ...
-    @property
+    @cached_property
     def name_lower(self) -> str: ...
+    def can_reduce_through(self, operation: Operation, app_label: str) -> bool: ...
 
 class CreateModel(ModelOperation):
     fields: list[tuple[str, Field]]
@@ -36,9 +38,9 @@ class RenameModel(ModelOperation):
     old_name: str
     new_name: str
     def __init__(self, old_name: str, new_name: str) -> None: ...
-    @property
+    @cached_property
     def old_name_lower(self) -> str: ...
-    @property
+    @cached_property
     def new_name_lower(self) -> str: ...
 
 class ModelOptionOperation(ModelOperation): ...
@@ -47,14 +49,29 @@ class AlterModelTable(ModelOptionOperation):
     table: str | None
     def __init__(self, name: str, table: str | None) -> None: ...
 
+class AlterModelTableComment(ModelOptionOperation):
+    table_comment: str
+    def __init__(self, name: str, table_comment: str) -> None: ...
+    def deconstruct(self) -> tuple[str, Sequence[Any], dict[str, Any]]: ...
+    def state_forwards(self, app_label: str, state: Any) -> None: ...
+    def database_forwards(
+        self, app_label: str, schema_editor: BaseDatabaseSchemaEditor, from_state: Any, to_state: Any
+    ) -> None: ...
+    def database_backwards(
+        self, app_label: str, schema_editor: BaseDatabaseSchemaEditor, from_state: Any, to_state: Any
+    ) -> None: ...
+    def describe(self) -> str: ...
+    @property
+    def migration_name_fragment(self) -> str: ...
+
 class AlterTogetherOptionOperation(ModelOptionOperation):
     option_name: str
     def __init__(
         self,
         name: str,
         option_value: _OptionTogetherT | None,
     ) -> None: ...
-    @property
+    @cached_property
     def option_value(self) -> set[tuple[str, ...]] | None: ...
     def deconstruct(self) -> tuple[str, Sequence[Any], dict[str, Any]]: ...
     def state_forwards(self, app_label: str, state: Any) -> None: ...
@@ -80,6 +97,7 @@ class AlterIndexTogether(AlterTogetherOptionOperation):
     def __init__(self, name: str, index_together: _OptionTogetherT | None) -> None: ...
 
 class AlterOrderWithRespectTo(ModelOptionOperation):
+    option_name: str
     order_with_respect_to: str
     def __init__(self, name: str, order_with_respect_to: str) -> None: ...
 
@@ -94,7 +112,7 @@ class AlterModelManagers(ModelOptionOperation):
 
 class IndexOperation(Operation):
     option_name: str
-    @property
+    @cached_property
     def model_name_lower(self) -> str: ...
 
 class AddIndex(IndexOperation):
@@ -119,9 +137,9 @@ class RenameIndex(IndexOperation):
         old_name: str | None = ...,
         old_fields: Sequence[str] | None = ...,
     ) -> None: ...
-    @property
+    @cached_property
     def old_name_lower(self) -> str: ...
-    @property
+    @cached_property
     def new_name_lower(self) -> str: ...
 
 class AddConstraint(IndexOperation):
diff --git a/django-stubs/db/migrations/operations/special.pyi b/django-stubs/db/migrations/operations/special.pyi
@@ -10,8 +10,9 @@ from .base import Operation
 class SeparateDatabaseAndState(Operation):
     database_operations: Sequence[Operation]
     state_operations: Sequence[Operation]
+
     def __init__(
-        self, database_operations: Sequence[Operation] = ..., state_operations: Sequence[Operation] = ...
+        self, database_operations: Sequence[Operation] | None = ..., state_operations: Sequence[Operation] | None = ...
     ) -> None: ...
 
 class RunSQL(Operation):
@@ -24,10 +25,12 @@ class RunSQL(Operation):
         self,
         sql: str | _ListOrTuple[str | tuple[str, dict[str, Any] | _ListOrTuple[str] | None]],
         reverse_sql: str | None | _ListOrTuple[str | tuple[str, dict[str, Any] | _ListOrTuple[str] | None]] = ...,
-        state_operations: Sequence[Operation] = ...,
+        state_operations: Sequence[Operation] | None = ...,
         hints: Mapping[str, Any] | None = ...,
         elidable: bool = ...,
     ) -> None: ...
+    @property
+    def reversible(self) -> bool: ...  # type: ignore[override]
 
 class _CodeCallable(Protocol):
     def __call__(self, __state_apps: StateApps, __schema_editor: BaseDatabaseSchemaEditor) -> None: ...
@@ -46,3 +49,5 @@ class RunPython(Operation):
     ) -> None: ...
     @staticmethod
     def noop(apps: StateApps, schema_editor: BaseDatabaseSchemaEditor) -> None: ...
+    @property
+    def reversible(self) -> bool: ...  # type: ignore[override]
diff --git a/django-stubs/db/migrations/state.pyi b/django-stubs/db/migrations/state.pyi
@@ -1,4 +1,4 @@
-from collections.abc import Iterator, Sequence
+from collections.abc import Iterable, Iterator, Sequence
 from contextlib import contextmanager
 from typing import Any
 
@@ -7,8 +7,10 @@ from django.apps.registry import Apps
 from django.db.models.base import Model
 from django.db.models.fields import Field
 from django.db.models.manager import Manager
+from django.utils.functional import cached_property
 
-class AppConfigStub(AppConfig): ...
+class AppConfigStub(AppConfig):
+    def __init__(self, label: str) -> None: ...
 
 class ModelState:
     name: str
@@ -30,9 +32,8 @@ class ModelState:
     def construct_managers(self) -> Iterator[tuple[str, Manager]]: ...
     @classmethod
     def from_model(cls, model: type[Model], exclude_rels: bool = ...) -> ModelState: ...
-    # Removed in 3.2, but back in 4.0
-    # def get_field(self, field_name: str) -> Field: ...
-    @property
+    def get_field(self, field_name: str) -> Field: ...
+    @cached_property
     def name_lower(self) -> str: ...
     def render(self, apps: Apps) -> Any: ...
     def get_index_by_name(self, name: str) -> Any: ...
@@ -45,22 +46,46 @@ def get_related_models_recursive(model: type[Model]) -> set[tuple[str, str]]: ..
 class ProjectState:
     is_delayed: bool
     models: dict[Any, Any]
-    real_apps: list[str]
+    real_apps: set[str]
     def __init__(
-        self, models: dict[tuple[str, str], ModelState] | None = ..., real_apps: list[str] | None = ...
+        self, models: dict[tuple[str, str], ModelState] | None = ..., real_apps: set[str] | None = ...
     ) -> None: ...
-    def add_model(self, model_state: ModelState) -> None: ...
     @property
+    def relations(self) -> Any: ...
+    def add_model(self, model_state: ModelState) -> None: ...
+    @cached_property
     def apps(self) -> StateApps: ...
     def clear_delayed_apps_cache(self) -> None: ...
     def clone(self) -> ProjectState: ...
-    @property
-    def concrete_apps(self) -> StateApps: ...
     @classmethod
     def from_apps(cls, apps: Apps) -> ProjectState: ...
     def reload_model(self, app_label: str, model_name: str, delay: bool = ...) -> None: ...
     def reload_models(self, models: list[Any], delay: bool = ...) -> None: ...
     def remove_model(self, app_label: str, model_name: str) -> None: ...
+    def rename_model(self, app_label: str, old_name: str, new_name: str) -> None: ...
+    def alter_model_options(
+        self, app_label: str, model_name: str, options: dict[str, Any], option_keys: Iterable[str] | None = ...
+    ) -> None: ...
+    def remove_model_options(self, app_label: str, model_name: str, option_name: str, value_to_remove: Any) -> None: ...
+    def alter_model_managers(self, app_label: str, model_name: str, managers: list[tuple[str, Manager]]) -> None: ...
+    def add_index(self, app_label: str, model_name: str, index: Any) -> None: ...
+    def remove_index(self, app_label: str, model_name: str, index_name: str) -> None: ...
+    def rename_index(self, app_label: str, model_name: str, old_index_name: str, new_index_name: str) -> None: ...
+    def add_constraint(self, app_label: str, model_name: str, constraint: Any) -> None: ...
+    def remove_constraint(self, app_label: str, model_name: str, constraint_name: str) -> None: ...
+    def add_field(self, app_label: str, model_name: str, name: str, field: Field, preserve_default: Any) -> None: ...
+    def remove_field(self, app_label: str, model_name: str, name: str) -> None: ...
+    def alter_field(self, app_label: str, model_name: str, name: str, field: Field, preserve_default: Any) -> None: ...
+    def rename_field(self, app_label: str, model_name: str, old_name: str, new_name: str) -> None: ...
+    def update_model_field_relation(
+        self, model: type[Model], model_key: tuple[str, str], field_name: str, field: Field, concretes: Any
+    ) -> None: ...
+    def resolve_model_field_relations(
+        self, model_key: tuple[str, str], field_name: str, field: Field, concretes: Any | None = ...
+    ) -> None: ...
+    def resolve_model_relations(self, model_key: tuple[str, str], concretes: Any | None = ...) -> None: ...
+    def resolve_fields_and_relations(self) -> None: ...
+    def get_concrete_model_key(self, model: type[Model]) -> Any: ...
 
 class StateApps(Apps):
     real_models: list[ModelState]
diff --git a/django-stubs/db/models/enums.pyi b/django-stubs/db/models/enums.pyi
@@ -19,6 +19,8 @@ class Choices(enum.Enum, metaclass=ChoicesMeta):
     def label(self) -> str: ...
     @enum_property
     def value(self) -> Any: ...
+    @property
+    def do_not_call_in_templates(self) -> bool: ...
 
 # fake
 class _IntegerChoicesMeta(ChoicesMeta):
diff --git a/django-stubs/db/models/expressions.pyi b/django-stubs/db/models/expressions.pyi
@@ -1,5 +1,5 @@
 import datetime
-from collections.abc import Callable, Iterable, Iterator, Sequence
+from collections.abc import Callable, Iterable, Iterator, Mapping, Sequence
 from decimal import Decimal
 from typing import Any, Generic, Literal, TypeVar
 
@@ -135,6 +135,7 @@ class F(Combinable):
         summarize: bool = ...,
         for_save: bool = ...,
     ) -> F: ...
+    def replace_expressions(self, replacements: Mapping[F, Any]) -> F: ...
     def asc(
         self,
         *,
@@ -148,7 +149,7 @@ class F(Combinable):
         nulls_first: bool | None = ...,
         nulls_last: bool | None = ...,
     ) -> OrderBy: ...
-    def deconstruct(self) -> Any: ...  # fake
+    def copy(self) -> F: ...
 
 class ResolvedOuterRef(F): ...
 
diff --git a/django-stubs/db/models/sql/constants.pyi b/django-stubs/db/models/sql/constants.pyi
@@ -1,4 +1,3 @@
-from re import Pattern
 from typing import Final, Literal
 
 GET_ITERATOR_CHUNK_SIZE: Final[int]
@@ -8,7 +7,6 @@ SINGLE: Literal["single"]
 CURSOR: Literal["cursor"]
 NO_RESULTS: Literal["no results"]
 
-ORDER_PATTERN: Pattern
 ORDER_DIR: dict[str, tuple[str, str]]
 
 INNER: Literal["INNER JOIN"]
diff --git a/django-stubs/template/base.pyi b/django-stubs/template/base.pyi
@@ -19,7 +19,6 @@ VARIABLE_TAG_START: str
 VARIABLE_TAG_END: str
 COMMENT_TAG_START: str
 COMMENT_TAG_END: str
-TRANSLATOR_COMMENT_MARK: str
 SINGLE_BRACE_START: str
 SINGLE_BRACE_END: str
 UNKNOWN_SOURCE: str
diff --git a/django-stubs/views/debug.pyi b/django-stubs/views/debug.pyi
@@ -6,9 +6,10 @@ from typing import Any
 
 from django.http.request import HttpRequest, QueryDict
 from django.http.response import Http404, HttpResponse
+from django.template import Engine
 from django.utils.safestring import SafeString
 
-CURRENT_DIR: Path
+DEBUG_ENGINE: Engine
 
 class CallableSettingWrapper:
     def __init__(self, callable_setting: Callable | type[Any]) -> None: ...
diff --git a/scripts/stubtest/allowlist.txt b/scripts/stubtest/allowlist.txt
@@ -70,3 +70,7 @@ django.utils.translation.template.context_re
 django.utils.translation.template.constant_re
 django.utils.translation.template.block_re
 django.utils.version.version_component_re
+
+# AlterTogetherOptionsOperation.option_name is set as None,
+# but is required in the init, so we type it as str
+django.db.migrations.operations.models.AlterTogetherOptionOperation.option_name
diff --git a/scripts/stubtest/allowlist_todo.txt b/scripts/stubtest/allowlist_todo.txt
