fastapi-cbx 1.0.0__tar.gz → 1.0.2__tar.gz

{fastapi_cbx-1.0.0/fastapi_cbx.egg-info → fastapi_cbx-1.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-cbx
-Version: 1.0.0
+Version: 1.0.2
 Summary: Minimal class-based routing extension for FastAPI
 Author-email: HeHongye <18348574371@139.com>
 Project-URL: Homepage, https://github.com/HeHongyeFY/fastapi-cbx
@@ -22,10 +22,14 @@ One scenario, one route.
 
 A precise complement to the FastAPI ecosystem, unifying layered routing patterns and strict resource lifecycle management into a clean, production‑ready solution.
 
-Originally proposed and contributed to FastAPI as PR #15392.
+Originally proposed and contributed to FastAPI as PR #15447.
 
 ![CI](https://github.com/HeHongyeFY/fastapi-cbx/actions/workflows/ci.yml/badge.svg)
 ![Codecov](https://codecov.io/github/HeHongyeFY/fastapi-cbx/graph/badge.svg)
+
+🔥 **Featured Case Study:**  
+> How we refactored vLLM’s API server and cut structural boilerplate by ~50%  
+> 👉 [Read: Refactoring vLLM API Architecture](https://github.com/HeHongyeFY/fastapi-cbx/wiki/refactoring-vllm-api-architecture)
 ---
 
 ## Overview
@@ -33,7 +37,8 @@ fastapi-cbx introduces three **orthogonal, scenario‑driven routing patterns**
 
 ## Features
 - Adds two scenario-driven class-based routing patterns to native FastAPI
-- Ultra-lightweight: ~110 lines of clean code
+- HTTP and WebSocket endpoints bound by the same decorator style
+- Ultra-lightweight: ~130 lines of clean code
 - 100% test coverage
 - No monkey patching, no metaprogramming, no hidden magic
 - Fully backward compatible, no breaking changes
@@ -42,11 +47,6 @@ fastapi-cbx introduces three **orthogonal, scenario‑driven routing patterns**
 - Predictable, transparent behavior
 - Minimal API surface, easy to maintain
 
-## Installation
-```bash
-pip install fastapi-cbx
-```
-
 ## Quick Start (30 Seconds)
 fastapi-cbx provides CBR (Class-Based Route), an original, intuitive, high-performance class-based routing utility for FastAPI.
 
@@ -95,8 +95,8 @@ class MyCBR:
         return self.CBRModel(key=key, value=self.heavies.get(key, "One scenario, one route"))
 
 
-app = FastAPI()
 MyCBR(version="1.0.0")
+app = FastAPI()
 app.include_router(MyCBR.router)
 ```
 
@@ -177,8 +177,8 @@ class MyCBV:
         cls.CBVModel.model_fields["value"].default = body.value
 
 
-app = FastAPI()
 MyCBV(version="1.0.0")
+app = FastAPI()
 app.include_router(MyCBV.router)
 ```
 
@@ -188,7 +188,7 @@ import logging
 import asyncio
 import time
 from typing import Dict
-from fastapi import FastAPI, APIRouter, Response, status, Cookie, Depends, HTTPException
+from fastapi import FastAPI, APIRouter, Response, status, Cookie, Depends, HTTPException, WebSocket
 from cbx import cbr
 from pydantic import BaseModel
 
@@ -246,9 +246,16 @@ class MyCBR:
         time.sleep(1)
         return cls.CBRModel(key="sync", value="ok")
 
+    @cbr.websocket("/heavies", name="websocket heavies")  # WebSocket support
+    async def websocket_heavies(self, websocket: WebSocket) -> None:
+        await websocket.accept()
+        key = await websocket.receive_text()
+        await websocket.send_text(self.heavies.get(key, "One scenario, one route"))
+        await websocket.close()
+
 
-app = FastAPI()
 MyCBR(version="1.0.0")
+app = FastAPI()
 app.include_router(MyCBR.router)
 ```
 

{fastapi_cbx-1.0.0 → fastapi_cbx-1.0.2}/README.md

@@ -5,10 +5,14 @@ One scenario, one route.
 
 A precise complement to the FastAPI ecosystem, unifying layered routing patterns and strict resource lifecycle management into a clean, production‑ready solution.
 
-Originally proposed and contributed to FastAPI as PR #15392.
+Originally proposed and contributed to FastAPI as PR #15447.
 
 ![CI](https://github.com/HeHongyeFY/fastapi-cbx/actions/workflows/ci.yml/badge.svg)
 ![Codecov](https://codecov.io/github/HeHongyeFY/fastapi-cbx/graph/badge.svg)
+
+🔥 **Featured Case Study:**  
+> How we refactored vLLM’s API server and cut structural boilerplate by ~50%  
+> 👉 [Read: Refactoring vLLM API Architecture](https://github.com/HeHongyeFY/fastapi-cbx/wiki/refactoring-vllm-api-architecture)
 ---
 
 ## Overview
@@ -16,7 +20,8 @@ fastapi-cbx introduces three **orthogonal, scenario‑driven routing patterns**
 
 ## Features
 - Adds two scenario-driven class-based routing patterns to native FastAPI
-- Ultra-lightweight: ~110 lines of clean code
+- HTTP and WebSocket endpoints bound by the same decorator style
+- Ultra-lightweight: ~130 lines of clean code
 - 100% test coverage
 - No monkey patching, no metaprogramming, no hidden magic
 - Fully backward compatible, no breaking changes
@@ -25,11 +30,6 @@ fastapi-cbx introduces three **orthogonal, scenario‑driven routing patterns**
 - Predictable, transparent behavior
 - Minimal API surface, easy to maintain
 
-## Installation
-```bash
-pip install fastapi-cbx
-```
-
 ## Quick Start (30 Seconds)
 fastapi-cbx provides CBR (Class-Based Route), an original, intuitive, high-performance class-based routing utility for FastAPI.
 
@@ -78,8 +78,8 @@ class MyCBR:
         return self.CBRModel(key=key, value=self.heavies.get(key, "One scenario, one route"))
 
 
-app = FastAPI()
 MyCBR(version="1.0.0")
+app = FastAPI()
 app.include_router(MyCBR.router)
 ```
 
@@ -160,8 +160,8 @@ class MyCBV:
         cls.CBVModel.model_fields["value"].default = body.value
 
 
-app = FastAPI()
 MyCBV(version="1.0.0")
+app = FastAPI()
 app.include_router(MyCBV.router)
 ```
 
@@ -171,7 +171,7 @@ import logging
 import asyncio
 import time
 from typing import Dict
-from fastapi import FastAPI, APIRouter, Response, status, Cookie, Depends, HTTPException
+from fastapi import FastAPI, APIRouter, Response, status, Cookie, Depends, HTTPException, WebSocket
 from cbx import cbr
 from pydantic import BaseModel
 
@@ -229,9 +229,16 @@ class MyCBR:
         time.sleep(1)
         return cls.CBRModel(key="sync", value="ok")
 
+    @cbr.websocket("/heavies", name="websocket heavies")  # WebSocket support
+    async def websocket_heavies(self, websocket: WebSocket) -> None:
+        await websocket.accept()
+        key = await websocket.receive_text()
+        await websocket.send_text(self.heavies.get(key, "One scenario, one route"))
+        await websocket.close()
+
 
-app = FastAPI()
 MyCBR(version="1.0.0")
+app = FastAPI()
 app.include_router(MyCBR.router)
 ```
 

{fastapi_cbx-1.0.0 → fastapi_cbx-1.0.2}/cbx.py

@@ -1,8 +1,8 @@
 import inspect
 import logging
 from collections.abc import Callable
-from functools import partial, wraps
-from typing import Any, TypeVar, Generic
+from functools import partial
+from typing import Any, Generic, TypeVar
 from fastapi import APIRouter
 
 
@@ -10,6 +10,7 @@ T = TypeVar("T")
 
 
 class CBV(Generic[T]):
+
     def __init__(self, cls: type[T], router: APIRouter):
         self.logger = logging.getLogger(self.__class__.__name__)
         self.router = router
@@ -28,7 +29,6 @@ class CBV(Generic[T]):
             "trace": 200,
             "connect": 200,
         }.items():
-
             if hasattr(self.instance, name):
                 method = getattr(self.instance, name)
                 self.router.add_api_route(
@@ -64,12 +64,19 @@ class CBR(Generic[T]):
         ):
             if cbx_router := endpoint.__annotations__.get("cbx_router"):
                 for router in cbx_router:
-                    self.router.add_api_route(
-                        path=router["path"],
-                        endpoint=endpoint,
-                        methods=[router["method"]],
-                        **router["kwargs"]
-                    )
+                    if router["method"] == "WEBSOCKET":
+                        self.router.add_api_websocket_route(
+                            path=router["path"],
+                            endpoint=endpoint,
+                            **router["kwargs"],
+                        )
+                    else:
+                        self.router.add_api_route(
+                            path=router["path"],
+                            endpoint=endpoint,
+                            methods=[router["method"]],
+                            **router["kwargs"],
+                        )
         return self.instance
 
     def __dir__(self) -> list[str]:
@@ -80,16 +87,18 @@ class CBR(Generic[T]):
 
 
 class cbv(Generic[T]):
+
     def __init__(self, router: APIRouter):
         self.router = router
 
     def __call__(self, cls: type[T]) -> CBV[T]:
-        return wraps(cls)(CBV(cls, self.router))
+        return CBV(cls, self.router)
 
 
 class cbr(Generic[T]):
 
     class method:
+
         def __init__(self, method: str, path: str, **kwargs: Any):
             self.method = method
             self.path = path
@@ -97,25 +106,13 @@ class cbr(Generic[T]):
 
         def __call__(self, endpoint: Callable[..., Any]) -> Callable[..., Any]:
             if "cbx_router" in endpoint.__annotations__:
-                cbx_router: list = endpoint.__annotations__["cbx_router"]
-                cbx_router.append(
-                    {
-                        "method": self.method,
-                        "path": self.path,
-                        "kwargs": self.kwargs
-                    }
+                endpoint.__annotations__["cbx_router"].append(
+                    {"method": self.method, "path": self.path, "kwargs": self.kwargs}
                 )
-
             else:
-                cbx_router: list = [
-                    {
-                        "method": self.method,
-                        "path": self.path,
-                        "kwargs": self.kwargs
-                    }
-                ]
                 endpoint.__annotations__.setdefault(
-                    "cbx_router", cbx_router
+                    "cbx_router",
+                    [{"method": self.method, "path": self.path, "kwargs": self.kwargs}]
                 )
             return endpoint
 
@@ -128,9 +125,10 @@ class cbr(Generic[T]):
     options = partial(method, "OPTIONS")
     trace = partial(method, "TRACE")
     connect = partial(method, "CONNECT")
+    websocket = partial(method, "WEBSOCKET")
 
     def __init__(self, router: APIRouter):
         self.router = router
 
     def __call__(self, cls: type[T]) -> CBR[T]:
-        return wraps(cls)(CBR(cls, self.router))
+        return CBR(cls, self.router)

{fastapi_cbx-1.0.0 → fastapi_cbx-1.0.2/fastapi_cbx.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-cbx
-Version: 1.0.0
+Version: 1.0.2
 Summary: Minimal class-based routing extension for FastAPI
 Author-email: HeHongye <18348574371@139.com>
 Project-URL: Homepage, https://github.com/HeHongyeFY/fastapi-cbx
@@ -22,10 +22,14 @@ One scenario, one route.
 
 A precise complement to the FastAPI ecosystem, unifying layered routing patterns and strict resource lifecycle management into a clean, production‑ready solution.
 
-Originally proposed and contributed to FastAPI as PR #15392.
+Originally proposed and contributed to FastAPI as PR #15447.
 
 ![CI](https://github.com/HeHongyeFY/fastapi-cbx/actions/workflows/ci.yml/badge.svg)
 ![Codecov](https://codecov.io/github/HeHongyeFY/fastapi-cbx/graph/badge.svg)
+
+🔥 **Featured Case Study:**  
+> How we refactored vLLM’s API server and cut structural boilerplate by ~50%  
+> 👉 [Read: Refactoring vLLM API Architecture](https://github.com/HeHongyeFY/fastapi-cbx/wiki/refactoring-vllm-api-architecture)
 ---
 
 ## Overview
@@ -33,7 +37,8 @@ fastapi-cbx introduces three **orthogonal, scenario‑driven routing patterns**
 
 ## Features
 - Adds two scenario-driven class-based routing patterns to native FastAPI
-- Ultra-lightweight: ~110 lines of clean code
+- HTTP and WebSocket endpoints bound by the same decorator style
+- Ultra-lightweight: ~130 lines of clean code
 - 100% test coverage
 - No monkey patching, no metaprogramming, no hidden magic
 - Fully backward compatible, no breaking changes
@@ -42,11 +47,6 @@ fastapi-cbx introduces three **orthogonal, scenario‑driven routing patterns**
 - Predictable, transparent behavior
 - Minimal API surface, easy to maintain
 
-## Installation
-```bash
-pip install fastapi-cbx
-```
-
 ## Quick Start (30 Seconds)
 fastapi-cbx provides CBR (Class-Based Route), an original, intuitive, high-performance class-based routing utility for FastAPI.
 
@@ -95,8 +95,8 @@ class MyCBR:
         return self.CBRModel(key=key, value=self.heavies.get(key, "One scenario, one route"))
 
 
-app = FastAPI()
 MyCBR(version="1.0.0")
+app = FastAPI()
 app.include_router(MyCBR.router)
 ```
 
@@ -177,8 +177,8 @@ class MyCBV:
         cls.CBVModel.model_fields["value"].default = body.value
 
 
-app = FastAPI()
 MyCBV(version="1.0.0")
+app = FastAPI()
 app.include_router(MyCBV.router)
 ```
 
@@ -188,7 +188,7 @@ import logging
 import asyncio
 import time
 from typing import Dict
-from fastapi import FastAPI, APIRouter, Response, status, Cookie, Depends, HTTPException
+from fastapi import FastAPI, APIRouter, Response, status, Cookie, Depends, HTTPException, WebSocket
 from cbx import cbr
 from pydantic import BaseModel
 
@@ -246,9 +246,16 @@ class MyCBR:
         time.sleep(1)
         return cls.CBRModel(key="sync", value="ok")
 
+    @cbr.websocket("/heavies", name="websocket heavies")  # WebSocket support
+    async def websocket_heavies(self, websocket: WebSocket) -> None:
+        await websocket.accept()
+        key = await websocket.receive_text()
+        await websocket.send_text(self.heavies.get(key, "One scenario, one route"))
+        await websocket.close()
+
 
-app = FastAPI()
 MyCBR(version="1.0.0")
+app = FastAPI()
 app.include_router(MyCBR.router)
 ```
 

{fastapi_cbx-1.0.0 → fastapi_cbx-1.0.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "fastapi-cbx"
-version = "1.0.0"
+version = "1.0.2"
 description = "Minimal class-based routing extension for FastAPI"
 readme = "README.md"
 requires-python = ">=3.8"