✨ Show a clear error on attempt to include router into itself (#14258)

Co-authored-by: Javier Sánchez <javier.sanchez.castro@bookline.ai>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Motov Yurii <109919500+YuriiMotov@users.noreply.github.com>

diff --git a/fastapi/routing.py b/fastapi/routing.py
index 16a89ef3e33176840c33d2397d8e6bc1b5d4f565..ed873fda8ca6ff8763365a7e94aaf5e7223bf0de 100644 (file)
--- a/fastapi/routing.py
+++ b/fastapi/routing.py
@@ -1393,6 +1393,10 @@ class APIRouter(routing.Router):
         app.include_router(internal_router)
         ```
         """
+        assert self is not router, (
+            "Cannot include the same APIRouter instance into itself. "
+            "Did you mean to include a different router?"
+        )
         if prefix:
             assert prefix.startswith("/"), "A path prefix must start with '/'"
             assert not prefix.endswith("/"), (

diff --git a/tests/test_router_circular_import.py b/tests/test_router_circular_import.py
new file mode 100644 (file)
index 0000000..492a26d
--- /dev/null
+++ b/tests/test_router_circular_import.py
@@ -0,0 +1,12 @@
+import pytest
+from fastapi import APIRouter
+
+
+def test_router_circular_import():
+    router = APIRouter()
+
+    with pytest.raises(
+        AssertionError,
+        match="Cannot include the same APIRouter instance into itself. Did you mean to include a different router?",
+    ):
+        router.include_router(router)