feat!: remove path parameter in proxy method

Author: WSH032

src/fastapi_proxy_lib/core/http.py

@@ -327,8 +327,8 @@ async def close_proxy_event(_: FastAPI) -> AsyncIterator[None]:  # (1)!
     app = FastAPI(lifespan=close_proxy_event)
 
     @app.get("/{path:path}")  # (2)!
-    async def _(request: Request, path: str = ""):
-        return await proxy.proxy(request=request, path=path)  # (3)!
+    async def _(request: Request):
+        return await proxy.proxy(request=request)  # (3)!
 
     # Then run shell: `uvicorn <your.py>:app --host http://127.0.0.1:8000 --port 8000`
     # visit the app: `http://127.0.0.1:8000/`
@@ -339,10 +339,6 @@ async def _(request: Request, path: str = ""):
     2. `{path:path}` is the key.<br>
         It allows the app to accept all path parameters.<br>
         visit <https://www.starlette.io/routing/#path-parameters> for more info.
-    3. !!! info
-        In fact, you only need to pass the `request: Request` argument.<br>
-        `fastapi_proxy_lib` can automatically get the `path` from `request`.<br>
-        Explicitly pointing it out here is just to remind you not to forget to specify `{path:path}`.
     '''
 
     client: httpx.AsyncClient
@@ -376,25 +372,20 @@ def __init__(
 
     @override
     async def proxy(  # pyright: ignore [reportIncompatibleMethodOverride]
-        self, *, request: StarletteRequest, path: Optional[str] = None
+        self, *, request: StarletteRequest
     ) -> StarletteResponse:
         """Send request to target server.
 
         Args:
             request: `starlette.requests.Request`
-            path: The path params of request, which means the path params of base url.<br>
-                If None, will get it from `request.path_params`.<br>
-                **Usually, you don't need to pass this argument**.
 
         Returns:
             The response from target server.
         """
         base_url = self.base_url
 
         # 只取第一个路径参数。注意，我们允许没有路径参数，这代表直接请求
-        path_param: str = (
-            path if path is not None else next(iter(request.path_params.values()), "")
-        )
+        path_param: str = next(iter(request.path_params.values()), "")
 
         # 将路径参数拼接到目标url上
         # e.g: "https://www.example.com/p0/" + "p1"
@@ -462,8 +453,8 @@ async def close_proxy_event(_: FastAPI) -> AsyncIterator[None]:
     app = FastAPI(lifespan=close_proxy_event)
 
     @app.get("/{path:path}")
-    async def _(request: Request, path: str = ""):
-        return await proxy.proxy(request=request, path=path)
+    async def _(request: Request):
+        return await proxy.proxy(request=request)
 
     # Then run shell: `uvicorn <your.py>:app --host http://127.0.0.1:8000 --port 8000`
     # visit the app: `http://127.0.0.1:8000/http://www.example.com`
@@ -502,25 +493,20 @@ async def proxy(  # pyright: ignore [reportIncompatibleMethodOverride]
         self,
         *,
         request: StarletteRequest,
-        path: Optional[str] = None,
     ) -> StarletteResponse:
         """Send request to target server.
 
         Args:
             request: `starlette.requests.Request`
-            path: The path params of request, which means the full url of target server.<br>
-                If None, will get it from `request.path_params`.<br>
-                **Usually, you don't need to pass this argument**.
 
         Returns:
             The response from target server.
         """
         proxy_filter = self.proxy_filter
 
         # 只取第一个路径参数
-        path_param: str = (
-            next(iter(request.path_params.values()), "") if path is None else path
-        )
+        path_param: str = next(iter(request.path_params.values()), "")
+
         # 如果没有路径参数，即在正向代理中未指定目标url，则返回400
         if path_param == "":
             error = _BadTargetUrlError("Must provide target url.")

src/fastapi_proxy_lib/core/websocket.py

@@ -671,8 +671,8 @@ async def close_proxy_event(_: FastAPI) -> AsyncIterator[None]:
     app = FastAPI(lifespan=close_proxy_event)
 
     @app.websocket("/{path:path}")
-    async def _(websocket: WebSocket, path: str = ""):
-        return await proxy.proxy(websocket=websocket, path=path)
+    async def _(websocket: WebSocket):
+        return await proxy.proxy(websocket=websocket)
 
     # Then run shell: `uvicorn <your.py>:app --host http://127.0.0.1:8000 --port 8000`
     # visit the app: `ws://127.0.0.1:8000/`
@@ -737,15 +737,12 @@ def __init__(
 
     @override
     async def proxy(  # pyright: ignore [reportIncompatibleMethodOverride]
-        self, *, websocket: starlette_ws.WebSocket, path: Optional[str] = None
+        self, *, websocket: starlette_ws.WebSocket
     ) -> Union[Literal[False], StarletteResponse]:
         """Establish websocket connection for both client and target_url, then pass messages between them.
 
         Args:
             websocket: The client websocket requests.
-            path: The path params of websocket request, which means the path params of base url.<br>
-                If None, will get it from `websocket.path_params`.<br>
-                **Usually, you don't need to pass this argument**.
 
         Returns:
             If the establish websocket connection unsuccessfully:
@@ -757,9 +754,7 @@ async def proxy(  # pyright: ignore [reportIncompatibleMethodOverride]
         base_url = self.base_url
 
         # 只取第一个路径参数。注意，我们允许没有路径参数，这代表直接请求
-        path_param: str = (
-            path if path is not None else next(iter(websocket.path_params.values()), "")
-        )
+        path_param: str = next(iter(websocket.path_params.values()), "")
 
         # 将路径参数拼接到目标url上
         # e.g: "https://www.example.com/p0/" + "p1"

src/fastapi_proxy_lib/fastapi/router.py

@@ -63,7 +63,7 @@ def _http_register_router(
     @router.patch("/{path:path}", **kwargs)
     @router.trace("/{path:path}", **kwargs)
     async def http_proxy(  # pyright: ignore[reportUnusedFunction]
-        request: Request, path: str = ""
+        request: Request,
     ) -> Response:
         """HTTP proxy endpoint.
 
@@ -74,7 +74,7 @@ async def http_proxy(  # pyright: ignore[reportUnusedFunction]
         Returns:
             The response from target server.
         """
-        return await proxy.proxy(request=request, path=path)
+        return await proxy.proxy(request=request)
 
 
 def _ws_register_router(
@@ -96,7 +96,7 @@ def _ws_register_router(
 
     @router.websocket("/{path:path}", **kwargs)
     async def ws_proxy(  # pyright: ignore[reportUnusedFunction]
-        websocket: WebSocket, path: str = ""
+        websocket: WebSocket,
     ) -> Union[Response, Literal[False]]:
         """WebSocket proxy endpoint.
 
@@ -111,7 +111,7 @@ async def ws_proxy(  # pyright: ignore[reportUnusedFunction]
             If the establish websocket connection successfully:
                 - Will run forever until the connection is closed. Then return False.
         """
-        return await proxy.proxy(websocket=websocket, path=path)
+        return await proxy.proxy(websocket=websocket)
 
 
 class RouterHelper:

tests/test_docs_examples.py

@@ -23,8 +23,8 @@ async def close_proxy_event(_: FastAPI) -> AsyncIterator[None]:
     app = FastAPI(lifespan=close_proxy_event)
 
     @app.get("/{path:path}")
-    async def _(request: Request, path: str = ""):
-        return await proxy.proxy(request=request, path=path)
+    async def _(request: Request):
+        return await proxy.proxy(request=request)
 
     # Then run shell: `uvicorn <your.py>:app --host http://127.0.0.1:8000 --port 8000`
     # visit the app: `http://127.0.0.1:8000/http://www.example.com`
@@ -52,8 +52,8 @@ async def close_proxy_event(_: FastAPI) -> AsyncIterator[None]:  # (1)!
     app = FastAPI(lifespan=close_proxy_event)
 
     @app.get("/{path:path}")  # (2)!
-    async def _(request: Request, path: str = ""):
-        return await proxy.proxy(request=request, path=path)  # (3)!
+    async def _(request: Request):
+        return await proxy.proxy(request=request)  # (3)!
 
     # Then run shell: `uvicorn <your.py>:app --host http://127.0.0.1:8000 --port 8000`
     # visit the app: `http://127.0.0.1:8000/`
@@ -62,11 +62,7 @@ async def _(request: Request, path: str = ""):
     """ 1. lifespan please refer to [starlette/lifespan](https://www.starlette.io/lifespan/)
     2. `{path:path}` is the key.<br>
         It allows the app to accept all path parameters.<br>
-        visit <https://www.starlette.io/routing/#path-parameters> for more info.
-    3. !!! info
-        In fact, you only need to pass the `request: Request` argument.<br>
-        `fastapi_proxy_lib` can automatically get the `path` from `request`.<br>
-        Explicitly pointing it out here is just to remind you not to forget to specify `{path:path}`. """
+        visit <https://www.starlette.io/routing/#path-parameters> for more info. """
 
 
 def test_reverse_ws_proxy() -> None:
@@ -90,8 +86,8 @@ async def close_proxy_event(_: FastAPI) -> AsyncIterator[None]:
     app = FastAPI(lifespan=close_proxy_event)
 
     @app.websocket("/{path:path}")
-    async def _(websocket: WebSocket, path: str = ""):
-        return await proxy.proxy(websocket=websocket, path=path)
+    async def _(websocket: WebSocket):
+        return await proxy.proxy(websocket=websocket)
 
     # Then run shell: `uvicorn <your.py>:app --host http://127.0.0.1:8000 --port 8000`
     # visit the app: `ws://127.0.0.1:8000/`