feat: re-export SettingsWrapper from pytest_django for typing (#1257)

Author: SAY-5

docs/changelog.rst

@@ -4,6 +4,14 @@ Changelog
 v4.12.1 (unreleased)
 --------------------
 
+Improvements
+^^^^^^^^^^^^
+
+* Exposed :class:`~pytest_django.SettingsWrapper` from the top-level
+  :mod:`pytest_django` namespace so the :fixture:`settings` fixture can be
+  type-annotated without reaching into ``pytest_django.fixtures``
+  (`#1257 <https://github.com/pytest-dev/pytest-django/issues/1257>`__).
+
 Bugfixes
 ^^^^^^^^
 

docs/helpers.rst

@@ -442,6 +442,13 @@ Example
         settings.USE_TZ = True
         assert settings.USE_TZ
 
+If you use type annotations, you can annotate the fixture like this::
+
+    from pytest_django import SettingsWrapper
+
+    def test_with_specific_settings(settings: SettingsWrapper):
+        ...
+
 
 .. fixture:: django_assert_num_queries
 

pytest_django/__init__.py

@@ -5,13 +5,14 @@
     __version__ = "unknown"
 
 
-from .fixtures import DjangoAssertNumQueries, DjangoCaptureOnCommitCallbacks
+from .fixtures import DjangoAssertNumQueries, DjangoCaptureOnCommitCallbacks, SettingsWrapper
 from .plugin import DjangoDbBlocker
 
 
 __all__ = [
     "DjangoAssertNumQueries",
     "DjangoCaptureOnCommitCallbacks",
     "DjangoDbBlocker",
+    "SettingsWrapper",
     "__version__",
 ]

tests/test_fixtures.py

@@ -461,6 +461,13 @@ def test_set_non_existent(settings):
             ]
         )
 
+    def test_settings_wrapper_is_publicly_reexported(self) -> None:
+        import pytest_django
+        from pytest_django.fixtures import SettingsWrapper as _Wrapper
+
+        assert "SettingsWrapper" in pytest_django.__all__
+        assert pytest_django.SettingsWrapper is _Wrapper
+
 
 class TestLiveServer:
     @pytest.mark.skipif("PYTEST_XDIST_WORKER" in os.environ, reason="xdist in use")