feat: add callback api to WebSocketProxy

- bump `typing_extensions` from `4.5.0` to `4.12.0`
- explicitly add `anyio` as a dependency
- fix docs `host` typo

Author: WSH032

mkdocs.yml

@@ -108,6 +108,8 @@ plugins:
           import:
             - https://frankie567.github.io/httpx-ws/objects.inv
             - https://fastapi.tiangolo.com/objects.inv
+            - https://anyio.readthedocs.io/en/stable/objects.inv
+            - https://docs.python.org/3/objects.inv
           options:
             docstring_style: google
           paths: [src]

pyproject.toml

@@ -52,7 +52,8 @@ dependencies = [
     "httpx",
     "httpx-ws >= 0.4.2",
     "starlette",
-    "typing_extensions >=4.5.0",
+    "typing_extensions >= 4.12",
+    "anyio >= 4",
 ]
 
 [project.optional-dependencies]
@@ -91,13 +92,12 @@ dependencies = [
     #   NOTE: 👆
 
     # lint-check
-    "pyright == 1.1.356", # pyright must be installed in the runtime environment
+    "pyright == 1.1.372", # pyright must be installed in the runtime environment
     # test
     "pytest == 7.*",
     "pytest-cov ==  4.*",
     "uvicorn[standard] < 1.0.0", # TODO: Once it releases version 1.0.0, we will remove this restriction.
     "httpx[http2]",              # we don't set version here, instead set it in `[project].dependencies`.
-    "anyio",                     # we don't set version here, because fastapi has a dependency on it
     "asgi-lifespan==2.*",
     "pytest-timeout==2.*",
 ]

src/fastapi_proxy_lib/core/http.py

@@ -222,7 +222,7 @@ class BaseHttpProxy(BaseProxyModel):
     """
 
     @override
-    async def send_request_to_target(  # pyright: ignore [reportIncompatibleMethodOverride]
+    async def send_request_to_target(
         self, *, request: StarletteRequest, target_url: httpx.URL
     ) -> StarletteResponse:
         """Change request headers and send request to target url.
@@ -318,6 +318,8 @@ class ReverseHttpProxy(BaseHttpProxy):
 
     # # Examples
 
+    ## Basic usage
+
     ```python
     from contextlib import asynccontextmanager
     from typing import AsyncIterator
@@ -341,7 +343,7 @@ async def close_proxy_event(_: FastAPI) -> AsyncIterator[None]:  # (1)!
     async def _(request: Request, path: str = ""):
         return await proxy.proxy(request=request, path=path)  # (3)!
 
-    # Then run shell: `uvicorn <your.py>:app --host http://127.0.0.1:8000 --port 8000`
+    # Then run shell: `uvicorn <your_py>:app --host 127.0.0.1 --port 8000`
     # visit the app: `http://127.0.0.1:8000/`
     # you will get the response from `http://www.example.com/`
     ```
@@ -452,6 +454,8 @@ class ForwardHttpProxy(BaseHttpProxy):
 
     # # Examples
 
+    ## Basic usage
+
     ```python
     from contextlib import asynccontextmanager
     from typing import AsyncIterator
@@ -476,7 +480,7 @@ async def close_proxy_event(_: FastAPI) -> AsyncIterator[None]:
     async def _(request: Request, path: str = ""):
         return await proxy.proxy(request=request, path=path)
 
-    # Then run shell: `uvicorn <your.py>:app --host http://127.0.0.1:8000 --port 8000`
+    # Then run shell: `uvicorn <your_py>:app --host 127.0.0.1 --port 8000`
     # visit the app: `http://127.0.0.1:8000/http://www.example.com`
     # you will get the response from `http://www.example.com`
     ```