[pre-commit.ci] pre-commit autoupdate (#33)

* [pre-commit.ci] pre-commit autoupdate

updates:
- [github.com/pre-commit/pre-commit-hooks: v4.5.0 → v5.0.0](pre-commit/pre-commit-hooks@v4.5.0...v5.0.0)
- [github.com/astral-sh/ruff-pre-commit: v0.3.4 → v0.11.2](astral-sh/ruff-pre-commit@v0.3.4...v0.11.2)
- [github.com/psf/black-pre-commit-mirror: 24.3.0 → 25.1.0](psf/black-pre-commit-mirror@24.3.0...25.1.0)
- [github.com/codespell-project/codespell: v2.2.6 → v2.4.1](codespell-project/codespell@v2.2.6...v2.4.1)
- [github.com/alessandrojcm/commitlint-pre-commit-hook: v9.13.0 → v9.22.0](alessandrojcm/commitlint-pre-commit-hook@v9.13.0...v9.22.0)

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* style: fix lint

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: WSH032 <[email protected]>

Author: pre-commit-ci[bot]

.pre-commit-config.yaml

@@ -9,7 +9,7 @@ default_install_hook_types: [pre-commit, commit-msg]
 
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
+    rev: v5.0.0
     hooks:
       - id: no-commit-to-branch
       - id: check-added-large-files
@@ -22,25 +22,25 @@ repos:
       - id: trailing-whitespace
   # ruff must before black
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.3.4
+    rev: v0.11.2
     hooks:
       - id: ruff
         alias: ruff # NOTE: don't change this alias, it's used in `ver_sync.py`, keep consistent with `pyproject.toml`
         args: [--fix, --exit-non-zero-on-fix]
   - repo: https://github.com/psf/black-pre-commit-mirror
-    rev: 24.3.0
+    rev: 25.1.0
     hooks:
       - id: black
         alias: black # NOTE: don't change this alias, it's used in `ver_sync.py`, keep consistent with `pyproject.toml`
   - repo: https://github.com/codespell-project/codespell
-    rev: v2.2.6
+    rev: v2.4.1
     hooks:
       - id: codespell
         alias: codespell # NOTE: don't change this alias, it's used in `ver_sync.py`, keep consistent with `pyproject.toml`
         additional_dependencies:
           - tomli
   - repo: https://github.com/alessandrojcm/commitlint-pre-commit-hook
-    rev: v9.13.0
+    rev: v9.22.0
     hooks:
       - id: commitlint
         stages: [commit-msg]

docs_src/advanced/modify-request.py

@@ -2,9 +2,10 @@
 from typing import Any
 
 import httpx
-from fastapi_proxy_lib.fastapi.app import reverse_http_app
 from httpx import Request
 
+from fastapi_proxy_lib.fastapi.app import reverse_http_app
+
 
 class MyCustomAuth(httpx.Auth):
     # ref: https://www.python-httpx.org/advanced/#customizing-authentication

docs_src/advanced/modify-response-particular.py

@@ -2,9 +2,10 @@
 from contextlib import asynccontextmanager
 
 from fastapi import FastAPI
-from fastapi_proxy_lib.core.http import ReverseHttpProxy
 from starlette.requests import Request
 
+from fastapi_proxy_lib.core.http import ReverseHttpProxy
+
 proxy = ReverseHttpProxy(base_url="http://httpbin.org/")
 
 

docs_src/advanced/modify-response.py

@@ -2,10 +2,11 @@
 from contextlib import asynccontextmanager
 
 from fastapi import FastAPI
-from fastapi_proxy_lib.core.http import ReverseHttpProxy
 from starlette.requests import Request
 from starlette.responses import AsyncContentStream, StreamingResponse
 
+from fastapi_proxy_lib.core.http import ReverseHttpProxy
+
 proxy = ReverseHttpProxy(base_url="http://www.example.com/")
 
 

pyproject.toml

@@ -84,9 +84,9 @@ dependencies = [
     #   NOTE: 👇
     #   The versions of `black`, `ruff`, `codespell`,  must be consistent with the `.pre-commit-config.yaml`.
     #   Don't edit them manually, use `pre-commit run ver_sync` instead.
-    "black==24.3.0",
-    "ruff==0.3.4",
-    "codespell==2.2.6",
+    "black==25.1.0",
+    "ruff==0.11.2",
+    "codespell==2.4.1",
     #   Don't write comments on these lines, because they will be removed by `pre-commit run ver_sync`.
     #   NOTE: 👆
 
@@ -107,7 +107,7 @@ dependencies = [
 # xml for codecov, html for local review
 test = "pytest tests/ --cov --cov-report=xml --cov-report=html"
 # ruff must before black
-lint = ["- ruff --fix .", "- black .", "- pyright .", "- codespell . -i 3 -w"]
+lint = ["- ruff check --fix .", "- black .", "- pyright .", "- codespell . -i 3 -w"]
 lint-check = [
     "ruff check .",
     "black --check .",

src/fastapi_proxy_lib/core/_tool.py

@@ -29,18 +29,18 @@
 from typing_extensions import deprecated, overload
 
 __all__ = (
-    "check_base_url",
-    "return_err_msg_response",
-    "check_http_version",
     "BaseURLError",
     "ErrMsg",
     "ErrRseponseJson",
     "ProxyFilterProto",
+    "_RejectedProxyRequestError",
+    "check_base_url",
+    "check_http_version",
     "default_proxy_filter",
-    "warn_for_none_filter",
     "lru_get_url",
     "reset_lru_get_url",
-    "_RejectedProxyRequestError",
+    "return_err_msg_response",
+    "warn_for_none_filter",
 )
 
 _logger = logging.getLogger(__name__)
@@ -100,7 +100,7 @@ class ErrMsg(TypedDict):
 class ErrRseponseJson(TypedDict):
     """A json-like dict for return by `JSONResponse`.
 
-    Somethin like:
+    Something like:
     ```json
     {
         "detail": {

src/fastapi_proxy_lib/core/http.py

@@ -37,8 +37,8 @@
 
 __all__ = (
     "BaseHttpProxy",
-    "ReverseHttpProxy",
     "ForwardHttpProxy",
+    "ReverseHttpProxy",
 )
 
 _logger = logging.getLogger(__name__)

src/fastapi_proxy_lib/core/tool.py

@@ -2,4 +2,4 @@
 
 from ._tool import ProxyFilterProto, default_proxy_filter
 
-__all__ = ("default_proxy_filter", "ProxyFilterProto")
+__all__ = ("ProxyFilterProto", "default_proxy_filter")

src/fastapi_proxy_lib/core/websocket.py

@@ -490,12 +490,12 @@ async def send_request_to_target(  # pyright: ignore [reportIncompatibleMethodOv
 
         # httpx.stream()
         # refer to: https://www.python-httpx.org/api/#helper-functions
-        client_request_headers: "HeaderTypes" = _change_client_header(
+        client_request_headers: HeaderTypes = _change_client_header(
             headers=websocket.headers, target_url=target_url
         )
         # TODO, FIXME: do not shallow clone (i.e, `tuple(...)`) the query_params,
         # see: <https://github.com/WSH032/fastapi-proxy-lib/pull/57#issuecomment-2750153934>
-        client_request_params: "QueryParamTypes" = tuple(
+        client_request_params: QueryParamTypes = tuple(
             websocket.query_params.multi_items()
         )
 

tests/conftest.py

@@ -21,12 +21,13 @@
 import pytest
 import uvicorn
 from asgi_lifespan import LifespanManager
+from typing_extensions import ParamSpec
+
 from fastapi_proxy_lib.fastapi.app import (
     forward_http_app,
     reverse_http_app,
     reverse_ws_app,
 )
-from typing_extensions import ParamSpec
 
 from .app.echo_http_app import get_app as get_http_test_app
 from .app.echo_ws_app import get_app as get_ws_test_app
@@ -68,13 +69,13 @@ def __call__(  # noqa: D102
 
 
 # https://anyio.readthedocs.io/en/stable/testing.html#specifying-the-backends-to-run-on
-@pytest.fixture()
+@pytest.fixture
 def anyio_backend() -> Literal["asyncio"]:
     """Specify the async backend for `pytest.mark.anyio`."""
     return "asyncio"
 
 
-@pytest.fixture()
+@pytest.fixture
 async def lifespan_manager() -> AsyncIterator[LifespanManagerFixture]:
     """Fixture for asgi lifespan manager.
 
@@ -103,7 +104,7 @@ async def _lifespan_manager(app: ASGIApp) -> ASGIApp:
 # 所以这里明确要求每个fixture的作用域都是"function"，不要共享 TestAppDataclass
 
 
-@pytest.fixture()
+@pytest.fixture
 async def echo_http_test_model(
     lifespan_manager: LifespanManagerFixture,
 ) -> LifeAppDataclass4Test:
@@ -119,7 +120,7 @@ def LifeAppDataclass4Test.request(): Get the latest original http request from t
     return LifeAppDataclass4Test(app=life_app, request_dict=app_dataclass.request_dict)
 
 
-@pytest.fixture()
+@pytest.fixture
 async def echo_ws_test_model(
     lifespan_manager: LifespanManagerFixture,
 ) -> LifeAppDataclass4Test:
@@ -157,7 +158,7 @@ async def wappered_app_fct(*args: _P.args, **kwargs: _P.kwargs) -> ASGIApp:
     return wappered_app_fct
 
 
-@pytest.fixture()
+@pytest.fixture
 def forward_http_app_fct(
     lifespan_manager: LifespanManagerFixture,
 ):  # -> AppFactoryFixture
@@ -168,7 +169,7 @@ def forward_http_app_fct(
     return _app_fct_life_wapper(forward_http_app, lifespan_manager)
 
 
-@pytest.fixture()
+@pytest.fixture
 def reverse_http_app_fct(
     lifespan_manager: LifespanManagerFixture,
 ):  # -> AppFactoryFixture
@@ -179,7 +180,7 @@ def reverse_http_app_fct(
     return _app_fct_life_wapper(reverse_http_app, lifespan_manager)
 
 
-@pytest.fixture()
+@pytest.fixture
 def reverse_ws_app_fct(
     lifespan_manager: LifespanManagerFixture,
 ):  # -> AppFactoryFixture
@@ -190,7 +191,7 @@ def reverse_ws_app_fct(
     return _app_fct_life_wapper(reverse_ws_app, lifespan_manager)
 
 
-@pytest.fixture()
+@pytest.fixture
 async def uvicorn_server_fixture() -> AsyncIterator[UvicornServerFixture]:
     """Fixture for UvicornServer.
 

tests/test_core_lib.py

@@ -3,6 +3,9 @@
 import httpx
 import pytest
 from fastapi import APIRouter, FastAPI
+from httpx import ASGITransport
+from starlette.responses import JSONResponse
+
 from fastapi_proxy_lib.core._tool import (
     BaseURLError,
     ErrMsg,
@@ -13,8 +16,6 @@
 from fastapi_proxy_lib.core.http import ReverseHttpProxy
 from fastapi_proxy_lib.fastapi.app import forward_http_app, reverse_http_app
 from fastapi_proxy_lib.fastapi.router import RouterHelper
-from httpx import ASGITransport
-from starlette.responses import JSONResponse
 
 from .tool import DEFAULT_URL
 
@@ -43,7 +44,7 @@ def test_base_url_cheking_when_init() -> None:
         assert check_base_url("http://www.echo.com/?p=1#foo") == "http://www.echo.com/"
 
 
-@pytest.mark.anyio()
+@pytest.mark.anyio
 async def test_func_return_err_msg_response() -> None:
     """Test `fastapi_proxy_lib.core._tool.return_err_msg_response()`."""
 

tests/test_docs_examples.py

@@ -7,11 +7,12 @@ def test_forward_http_proxy() -> None:
     from contextlib import asynccontextmanager
 
     from fastapi import FastAPI
-    from fastapi_proxy_lib.core.http import ForwardHttpProxy
-    from fastapi_proxy_lib.core.tool import default_proxy_filter
     from httpx import AsyncClient
     from starlette.requests import Request
 
+    from fastapi_proxy_lib.core.http import ForwardHttpProxy
+    from fastapi_proxy_lib.core.tool import default_proxy_filter
+
     proxy = ForwardHttpProxy(AsyncClient(), proxy_filter=default_proxy_filter)
 
     @asynccontextmanager
@@ -37,10 +38,11 @@ def test_reverse_http_proxy() -> None:
     from contextlib import asynccontextmanager
 
     from fastapi import FastAPI
-    from fastapi_proxy_lib.core.http import ReverseHttpProxy
     from httpx import AsyncClient
     from starlette.requests import Request
 
+    from fastapi_proxy_lib.core.http import ReverseHttpProxy
+
     proxy = ReverseHttpProxy(AsyncClient(), base_url="http://www.example.com/")
 
     @asynccontextmanager
@@ -75,10 +77,11 @@ def test_reverse_ws_proxy() -> None:
     from contextlib import asynccontextmanager
 
     from fastapi import FastAPI
-    from fastapi_proxy_lib.core.websocket import ReverseWebSocketProxy
     from httpx import AsyncClient
     from starlette.websockets import WebSocket
 
+    from fastapi_proxy_lib.core.websocket import ReverseWebSocketProxy
+
     proxy = ReverseWebSocketProxy(AsyncClient(), base_url="ws://echo.websocket.events/")
 
     @asynccontextmanager
@@ -101,6 +104,7 @@ async def _(websocket: WebSocket, path: str = ""):
 def test_router_helper() -> None:
     """测试 RouterHelper 中的例子."""
     from fastapi import APIRouter, FastAPI
+
     from fastapi_proxy_lib.core.http import ForwardHttpProxy, ReverseHttpProxy
     from fastapi_proxy_lib.core.tool import default_proxy_filter
     from fastapi_proxy_lib.core.websocket import ReverseWebSocketProxy