Implement __repr__ for route classes

starlette/routing.py

@@ -283,6 +283,12 @@ def __eq__(self, other: typing.Any) -> bool:
             and self.methods == other.methods
         )
 
+    def __repr__(self) -> str:
+        return (
+            f"<{self.__class__.__name__}: "
+            f"path={self.path}, name={self.name}, methods={sorted(self.methods or [])}>"
+        )
+
 
 class WebSocketRoute(BaseRoute):
     def __init__(
@@ -341,6 +347,9 @@ def __eq__(self, other: typing.Any) -> bool:
             and self.endpoint == other.endpoint
         )
 
+    def __repr__(self) -> str:
+        return f"<{self.__class__.__name__}: path={self.path}, name={self.name}>"
+
 
 class Mount(BaseRoute):
     def __init__(
@@ -440,6 +449,12 @@ def __eq__(self, other: typing.Any) -> bool:
             and self.app == other.app
         )
 
+    def __repr__(self) -> str:
+        return (
+            f"<{self.__class__.__name__}: "
+            f"path={self.path}, name={self.name or ''}, app={self.app}>"
+        )
+
 
 class Host(BaseRoute):
     def __init__(
@@ -507,6 +522,12 @@ def __eq__(self, other: typing.Any) -> bool:
             and self.app == other.app
         )
 
+    def __repr__(self) -> str:
+        return (
+            f"<{self.__class__.__name__}: "
+            f"host={self.host}, name={self.name or ''}, app={self.app}>"
+        )
+
 
 _T = typing.TypeVar("_T")
 
@@ -847,3 +868,8 @@ def decorator(func: typing.Callable) -> typing.Callable:
             return func
 
         return decorator
+
+    def __repr__(self) -> str:
+        routes_count = len(self.routes)
+        noun = "route" if routes_count == 1 else "routes"
+        return f"<{self.__class__.__name__}: {routes_count} {noun}>"

tests/test_routing.py

@@ -952,3 +952,85 @@ async def modified_send(msg: Message) -> None:
     resp = client.get("/mount/err")
     assert resp.status_code == 403, resp.content
     assert "X-Mounted" not in resp.headers
+
+
+def test_route_repr() -> None:
+    route = Route("/welcome", endpoint=homepage)
+    assert (
+        repr(route) == "<Route: path=/welcome, name=homepage, methods=['GET', 'HEAD']>"
+    )
+
+
+def test_route_repr_without_methods() -> None:
+    route = Route("/welcome", endpoint=Endpoint, methods=None)
+    assert repr(route) == "<Route: path=/welcome, name=Endpoint, methods=[]>"
+
+
+def test_websocket_route_repr() -> None:
+    route = WebSocketRoute("/ws", endpoint=websocket_endpoint)
+    assert repr(route) == "<WebSocketRoute: path=/ws, name=websocket_endpoint>"
+
+
+def test_mount_repr() -> None:
+    route = Mount(
+        "/app",
+        routes=[
+            Route("/", endpoint=homepage),
+        ],
+    )
+    assert repr(route) == "<Mount: path=/app, name=, app=<Router: 1 route>>"
+
+
+def test_mount_named_repr() -> None:
+    route = Mount(
+        "/app",
+        name="app",
+        routes=[
+            Route("/", endpoint=homepage),
+        ],
+    )
+    assert repr(route) == "<Mount: path=/app, name=app, app=<Router: 1 route>>"
+
+
+def test_host_repr() -> None:
+    route = Host(
+        "example.com",
+        app=Router(
+            [
+                Route("/", endpoint=homepage),
+            ]
+        ),
+    )
+    assert repr(route) == "<Host: host=example.com, name=, app=<Router: 1 route>>"
+
+
+def test_host_named_repr() -> None:
+    route = Host(
+        "example.com",
+        name="app",
+        app=Router(
+            [
+                Route("/", endpoint=homepage),
+            ]
+        ),
+    )
+    assert repr(route) == "<Host: host=example.com, name=app, app=<Router: 1 route>>"
+
+
+def test_router_repr() -> None:
+    route = Router(
+        routes=[
+            Route("/", endpoint=homepage),
+        ]
+    )
+    assert repr(route) == "<Router: 1 route>"
+
+
+def test_router_repr_plural() -> None:
+    route = Router(
+        routes=[
+            Route("/", endpoint=homepage),
+            Route("/app", endpoint=homepage),
+        ]
+    )
+    assert repr(route) == "<Router: 2 routes>"