Use AbstractContextManager instead of @contextmanager (#2561)

Author: adamchainz

django-stubs/contrib/admin/tests.pyi

@@ -1,5 +1,5 @@
-from collections.abc import Callable, Generator
-from contextlib import contextmanager
+from collections.abc import Callable
+from contextlib import AbstractContextManager
 from typing import Any
 
 from django.contrib.staticfiles.testing import StaticLiveServerTestCase
@@ -17,8 +17,7 @@ class AdminSeleniumTestCase(SeleniumTestCase, StaticLiveServerTestCase):
     def wait_until_visible(self, css_selector: str, timeout: int = ...) -> None: ...
     def wait_until_invisible(self, css_selector: str, timeout: int = ...) -> None: ...
     def wait_page_ready(self, timeout: int = ...) -> None: ...
-    @contextmanager
-    def wait_page_loaded(self, timeout: int = ...) -> Generator[None, None, None]: ...
+    def wait_page_loaded(self, timeout: int = ...) -> AbstractContextManager[None]: ...
     def admin_login(self, username: str, password: str, login_url: str = ...) -> None: ...
     def select_option(self, selector: str, value: Any) -> None: ...
     def deselect_option(self, selector: str, value: Any) -> None: ...

django-stubs/db/backends/base/base.pyi

@@ -1,5 +1,5 @@
-from collections.abc import Callable, Generator, Iterator, MutableMapping
-from contextlib import contextmanager
+from collections.abc import Callable, MutableMapping
+from contextlib import AbstractContextManager
 from datetime import tzinfo
 from logging import Logger
 from typing import Any
@@ -99,8 +99,7 @@ class BaseDatabaseWrapper:
     def set_rollback(self, rollback: bool) -> None: ...
     def validate_no_atomic_block(self) -> None: ...
     def validate_no_broken_transaction(self) -> None: ...
-    @contextmanager
-    def constraint_checks_disabled(self) -> Iterator[None]: ...
+    def constraint_checks_disabled(self) -> AbstractContextManager[None]: ...
     def disable_constraint_checking(self) -> bool: ...
     def enable_constraint_checking(self) -> None: ...
     def check_constraints(self, table_names: Any | None = None) -> None: ...
@@ -118,13 +117,10 @@ class BaseDatabaseWrapper:
     def chunked_cursor(self) -> CursorWrapper: ...
     def make_debug_cursor(self, cursor: CursorWrapper) -> CursorDebugWrapper: ...
     def make_cursor(self, cursor: CursorWrapper) -> CursorWrapper: ...
-    @contextmanager
-    def temporary_connection(self) -> Generator[CursorWrapper, None, None]: ...
-    @contextmanager
-    def _nodb_cursor(self) -> Generator[CursorWrapper, None, None]: ...
+    def temporary_connection(self) -> AbstractContextManager[CursorWrapper]: ...
+    def _nodb_cursor(self) -> AbstractContextManager[CursorWrapper]: ...
     def schema_editor(self, *args: Any, **kwargs: Any) -> BaseDatabaseSchemaEditor: ...
     def on_commit(self, func: Callable[[], object], robust: bool = False) -> None: ...
     def run_and_clear_commit_hooks(self) -> None: ...
-    @contextmanager
-    def execute_wrapper(self, wrapper: _ExecuteWrapper) -> Generator[None, None, None]: ...
+    def execute_wrapper(self, wrapper: _ExecuteWrapper) -> AbstractContextManager[None]: ...
     def copy(self, alias: str | None = None) -> Self: ...

django-stubs/db/backends/oracle/base.pyi

@@ -1,5 +1,5 @@
-from collections.abc import Generator, Iterator
-from contextlib import contextmanager
+from collections.abc import Iterator
+from contextlib import AbstractContextManager
 from typing import Any
 
 from django.db.backends.base.base import BaseDatabaseWrapper
@@ -11,8 +11,7 @@ from .introspection import DatabaseIntrospection
 from .operations import DatabaseOperations
 from .validation import DatabaseValidation
 
-@contextmanager
-def wrap_oracle_errors() -> Generator[None, None, None]: ...
+def wrap_oracle_errors() -> AbstractContextManager[None]: ...
 
 class _UninitializedOperatorsDescriptor:
     def __get__(self, instance: Any, cls: Any | None = None) -> Any: ...

django-stubs/db/backends/utils.pyi

@@ -1,6 +1,6 @@
 import datetime
-from collections.abc import Generator, Iterator, Mapping, Sequence
-from contextlib import contextmanager
+from collections.abc import Iterator, Mapping, Sequence
+from contextlib import AbstractContextManager
 from decimal import Decimal
 from logging import Logger
 from types import TracebackType
@@ -62,14 +62,13 @@ class CursorWrapper:
 class CursorDebugWrapper(CursorWrapper):
     cursor: Any
     db: Any
-    @contextmanager
     def debug_sql(
         self,
         sql: str | None = None,
         params: _ExecuteParameters | Sequence[_ExecuteParameters] | None = None,
         use_last_executed_query: bool = False,
         many: bool = False,
-    ) -> Generator[None, None, None]: ...
+    ) -> AbstractContextManager[None]: ...
 
 @overload
 def typecast_date(s: None | Literal[""]) -> None: ...  # type: ignore[overload-overlap]

django-stubs/db/migrations/state.pyi

@@ -1,5 +1,5 @@
 from collections.abc import Iterable, Iterator, Sequence
-from contextlib import contextmanager
+from contextlib import AbstractContextManager
 from typing import Any
 
 from django.apps import AppConfig
@@ -92,8 +92,7 @@ class StateApps(Apps):
     def __init__(
         self, real_apps: list[str], models: dict[tuple[str, str], ModelState], ignore_swappable: bool = False
     ) -> None: ...
-    @contextmanager
-    def bulk_update(self) -> Iterator[None]: ...
+    def bulk_update(self) -> AbstractContextManager[None]: ...
     def clone(self) -> StateApps: ...
     def render_multiple(self, model_states: list[ModelState]) -> None: ...
     def register_model(self, app_label: str, model: type[Model]) -> None: ...

django-stubs/db/transaction.pyi

@@ -1,5 +1,5 @@
-from collections.abc import Callable, Iterator
-from contextlib import contextmanager
+from collections.abc import Callable
+from contextlib import AbstractContextManager
 from types import TracebackType
 from typing import Any, TypeVar, overload
 
@@ -18,8 +18,7 @@ def savepoint_commit(sid: str, using: str | None = None) -> None: ...
 def clean_savepoints(using: str | None = None) -> None: ...
 def get_rollback(using: str | None = None) -> bool: ...
 def set_rollback(rollback: bool, using: str | None = None) -> None: ...
-@contextmanager
-def mark_for_rollback_on_error(using: str | None = None) -> Iterator[None]: ...
+def mark_for_rollback_on_error(using: str | None = None) -> AbstractContextManager[None]: ...
 def on_commit(func: Callable[[], object], using: str | None = None, robust: bool = False) -> None: ...
 
 _C = TypeVar("_C", bound=Callable)  # Any callable

django-stubs/template/context.pyi

@@ -1,5 +1,5 @@
 from collections.abc import Callable, Iterable, Iterator
-from contextlib import contextmanager
+from contextlib import AbstractContextManager
 from types import TracebackType
 from typing import Any
 
@@ -56,15 +56,13 @@ class Context(BaseContext):
         use_l10n: bool | None = None,
         use_tz: bool | None = None,
     ) -> None: ...
-    @contextmanager
-    def bind_template(self, template: Template) -> Iterator[None]: ...
+    def bind_template(self, template: Template) -> AbstractContextManager[None]: ...
     def update(self, other_dict: dict[str, Any] | Context) -> ContextDict: ...
 
 class RenderContext(BaseContext):
     dicts: list[dict[IncludeNode | str, str]]
     template: Template | None
-    @contextmanager
-    def push_state(self, template: Template, isolated_context: bool = True) -> Iterator[None]: ...
+    def push_state(self, template: Template, isolated_context: bool = True) -> AbstractContextManager[None]: ...
 
 class RequestContext(Context):
     autoescape: bool
@@ -84,8 +82,7 @@ class RequestContext(Context):
         autoescape: bool = True,
     ) -> None: ...
     template: Template | None
-    @contextmanager
-    def bind_template(self, template: Template) -> Iterator[None]: ...
+    def bind_template(self, template: Template) -> AbstractContextManager[None]: ...
     def new(self, values: _ContextValues | None = None) -> RequestContext: ...
 
 def make_context(context: dict[str, Any] | None, request: HttpRequest | None = None, **kwargs: Any) -> Context: ...

django-stubs/test/runner.pyi

@@ -1,7 +1,7 @@
 import logging
 from argparse import ArgumentParser
-from collections.abc import Iterator, Sequence
-from contextlib import contextmanager
+from collections.abc import Sequence
+from contextlib import AbstractContextManager
 from io import StringIO
 from typing import Any, Literal
 from unittest import TestCase, TestLoader, TestSuite, TextTestResult, TextTestRunner
@@ -144,8 +144,7 @@ class DiscoverRunner:
     def log(self, msg: str, level: int | None) -> None: ...
     def setup_test_environment(self, **kwargs: Any) -> None: ...
     def setup_shuffler(self) -> None: ...
-    @contextmanager
-    def load_with_patterns(self) -> Iterator[None]: ...
+    def load_with_patterns(self) -> AbstractContextManager[None]: ...
     def load_tests_for_label(self, label: str, discover_kwargs: dict[str, str]) -> TestSuite: ...
     def build_suite(self, test_labels: Sequence[str] | None = ..., **kwargs: Any) -> TestSuite: ...
     def setup_databases(self, **kwargs: Any) -> list[tuple[BaseDatabaseWrapper, str, bool]]: ...

django-stubs/test/selenium.pyi

@@ -1,5 +1,4 @@
-from collections.abc import Generator
-from contextlib import contextmanager
+from contextlib import AbstractContextManager
 from typing import Any
 
 from django.test import LiveServerTestCase
@@ -14,5 +13,4 @@ class SeleniumTestCaseBase:
 class SeleniumTestCase(LiveServerTestCase):
     implicit_wait: int
     selenium: Any
-    @contextmanager
-    def disable_implicit_wait(self) -> Generator[None, None, None]: ...
+    def disable_implicit_wait(self) -> AbstractContextManager[None]: ...

django-stubs/test/testcases.pyi

@@ -1,7 +1,7 @@
 import threading
 import unittest
-from collections.abc import Callable, Collection, Generator, Iterable, Iterator, Mapping, Sequence
-from contextlib import contextmanager
+from collections.abc import Callable, Collection, Iterable, Iterator, Mapping, Sequence
+from contextlib import AbstractContextManager
 from types import TracebackType
 from typing import Any, overload
 
@@ -184,10 +184,9 @@ class TestCase(TransactionTestCase):
     @classmethod
     def setUpTestData(cls) -> None: ...
     @classmethod
-    @contextmanager
     def captureOnCommitCallbacks(
         cls, *, using: str = ..., execute: bool = ...
-    ) -> Generator[list[Callable[[], Any]], None, None]: ...
+    ) -> AbstractContextManager[list[Callable[[], Any]]]: ...
 
 class CheckCondition:
     conditions: Sequence[tuple[Callable, str]]