doc: add doc.patch to fix typing.TYPE_CHECKING blocks for sphinx

csernazs · csernazs · commit 6f21c20a437c · 2024-04-03T15:17:26.000+02:00
diff --git a/doc/conf.py b/doc/conf.py
@@ -24,6 +24,7 @@
 
 sys.path.insert(0, os.path.abspath(".."))
 
+import doc.patch
 
 # -- General configuration ------------------------------------------------
 
diff --git a/doc/patch.py b/doc/patch.py
@@ -0,0 +1,16 @@
+# this is required to make sphinx able to find references for classes put inside
+# typing.TYPE_CHECKING block
+
+from ssl import SSLContext
+
+from werkzeug.wrappers import Request
+from werkzeug.wrappers import Response
+
+import pytest_httpserver.blocking_httpserver
+import pytest_httpserver.httpserver
+
+pytest_httpserver.httpserver.SSLContext = SSLContext
+pytest_httpserver.blocking_httpserver.SSLContext = SSLContext
+
+pytest_httpserver.blocking_httpserver.Request = Request
+pytest_httpserver.blocking_httpserver.Response = Response
diff --git a/pyproject.toml b/pyproject.toml
@@ -87,7 +87,7 @@ markers = [
 ]
 
 [tool.mypy]
-files = ["pytest_httpserver", "scripts", "tests", "doc"]
+files = ["pytest_httpserver", "scripts", "tests"]
 implicit_reexport = false
 
 
diff --git a/tests/test_release.py b/tests/test_release.py
@@ -183,6 +183,7 @@ def test_sdist_contents(build: Build, version: str):
             "howto.rst",
             "index.rst",
             "Makefile",
+            "patch.py",
             "tutorial.rst",
             "upgrade.rst",
         },

Original file line number	Diff line number	Diff line change
`@@ -24,6 +24,7 @@`
`24`	`24`
`25`	`25`	`sys.path.insert(0, os.path.abspath(".."))`
`26`	`26`
	`27`	`+import doc.patch`
`27`	`28`
`28`	`29`	`# -- General configuration ------------------------------------------------`
`29`	`30`
Original file line number	Diff line number	Diff line change
`@@ -87,7 +87,7 @@ markers = [`
`87`	`87`	`]`
`88`	`88`
`89`	`89`	`[tool.mypy]`
`90`		`-files = ["pytest_httpserver", "scripts", "tests", "doc"]`
	`90`	`+files = ["pytest_httpserver", "scripts", "tests"]`
`91`	`91`	`implicit_reexport = false`
`92`	`92`
`93`	`93`