Changelog

All notable changes to this project will be documented here.

[0.6.0] - 2026-01-05

HTTP Range Support for Video Streaming: Static files now support HTTP Range requests with 206 Partial Content responses (#1)
Strict Path Routing: Bidirectional redirect support (FastAPI-style) ensures /foo and /foo/ are both accessible, returning 307 Temporary Redirect to the canonical URL (#7)
Streaming Response Support: Implemented StreamingResponse for efficiency streaming of content from sync and async iterators (#3)
Async Request Body Support: Added await request.body() and async for chunk in request.stream() methods for async compatibility (#4)
Keyword Arguments Support: Automatic injection of path and query parameters into handler keyword arguments (#6)
Query Params Alias: Added request.query_params property (alias to request.args) for FastAPI compatibility (#5)
Flask-style send_file Helper: Updated to return FileResponse for efficient file serving with Range support
Absolute Path Support: FileResponse now automatically converts relative paths to absolute paths for flexible file serving
Video streaming example (examples/27_video_stream.py) demonstrating static and dynamic video serving
Documentation: Updated user guides for Routing, Responses (Streaming), and Request Data (Async Body).

FastAPI Compatibility Layer:
Added support for Header, Cookie, Form, and File parameter validators.
Implemented UploadFile wrapper for easier file handling.
Added BackgroundTasks for simple background execution.
Introduced JSONResponse, HTMLResponse, PlainTextResponse, RedirectResponse, FileResponse aliases.
Core Context Improvements:
Implemented functional g (application globals) and current_app context proxies.
Fixed issues where these globals were exported but not importable/functional.
Ensured correct context isolation using contextvars.
API Completeness:
Improved Request object compatibility with Flask/Werkzeug (e.g. request.files, request.cookies via Rust).

Dependency Injection System: Full-featured Depends() support with recursive resolution.
Supports nested dependencies (dependency functions depending on other dependencies).
Recursive Parameter Extraction: Dependencies can define their own Query, Path, and Body parameters, which are automatically extracted from the request.
Async support: Dependencies can be sync or async functions.
Per-request caching and generator cleanup (dependency usage scope).
Body Validation: Added Body() helper for JSON request body validation.
Support for dictionary and Pydantic-like validation.
Automatic type coercion and error handling (400 Bad Request).
Integration with static and dynamic routes.

Benchmark Results: Achieved 19,969 RPS on root endpoint (benchmarked against Flask @ 4.7k and FastAPI @ 2.1k).
Optimized Dispatch: Intelligent keyword argument filtering in dispatch wrappers prevents argument pollution while determining handler signatures at runtime.

Static Route Validations: Fixed bug where static routes (fast path) skipped body and query parameter extraction.
TestClient: Added proper json parameter support to TestClient methods for easier API testing.
Signature Errors: Resolved "unexpected keyword argument" errors by filtering kwargs based on handler signatures.

Query Parameter Validation: FastAPI-compatible Query() helper for query parameter validation
Type coercion: str → int, float, bool, list
All validation constraints: ge, le, gt, lt, min_length, max_length, regex
Required vs optional parameters with default values
OpenAPI schema generation with full constraint details
Example: examples/23_query_validation.py

Cookie Parsing: Moved cookie parsing from Python to Rust for 10-100x performance improvement
Request cookies now parsed in Rust with URL decoding
Zero Python overhead for cookie extraction

Response Cookies: Enhanced Response.set_cookie() API
URL encoding for cookie values (security)
Support for datetime objects and timestamps in expires parameter
SameSite validation (Strict, Lax, None)
Improved delete_cookie() with all cookie attributes for proper deletion
Path Documentation: Integrated Path parameter metadata into OpenAPI documentation generator
Path constraints now visible in Swagger UI/ReDoc
Full OpenAPI 3.0 compliance

Benchmark Suite: Complete overhaul of benchmarks/run_comparison_auto.py to include FastAPI, detailed metrics (min/max latency, transfer rate), and "futuristic" reporting.
Python Compatibility: Explicit support for Python 3.10 through 3.14 (experimental).

Reloader: Fixed watchfiles integration on Linux by correctly serializing the subprocess command.
Linting: Resolved ruff B904 error in rate_limit.py by properly chaining exceptions.

Codebase Refactoring: Python codebase completely refactored into modular sub-packages (bustapi.core, bustapi.http, bustapi.routing, bustapi.security, etc.) for improved maintainability.
Documentation Overhaul: Comprehensive documentation rewrite using MkDocs with "Beginner to Advanced" guides.
Security Enhancements:
Rust-based Rate Limiter for high-performance request throttling.
Secure static file serving (blocking hidden files and path traversal).
Security extension for CORS and Security Headers.

New Examples: 10_rate_limit_demo.py showcasing the new rate limiter and logging.
Rust-based Logging: High-performance, colorful request logging implemented in Rust.
User Experience:
Hot Reloading: Enabled via debug=True or reload=True using watchfiles.
ASGI/WSGI Support: Run BustAPI with uvicorn, gunicorn, or hypercorn (e.g., app.run(server='uvicorn')).
Benchmark Tools: Built-in compatibility layer allows benchmarking against standard Python servers.

Comprehensive Examples: Added examples for Templates (05_templates.py), Blueprints (06_blueprints.py), Database (07_database_raw.py), Auto-docs (08_auto_docs.py), and Complex Routing (09_complex_routing.py).
Automated Benchmarks: New benchmarks/run_comparison_auto.py with CPU/RAM monitoring and device info capture.
Documentation: Expanded documentation structure with mkdocs, including User Guide and API Reference.
CI/CD Improvements: Robust CI pipeline with black, ruff, and strict dependency management (requests, etc.).

BREAKING: Migrated from Hyper to Actix-web for 50x+ performance improvement
Updated PyO3 from 0.20 to 0.23 with free-threading support
Added gil_used = false annotation for Python 3.13 free-threaded mode [No longer available on v0.4.0+]
Removed spawn_blocking - direct Python handler calls for parallel execution
Server now uses Actix-web's built-in worker pool (auto-scales to CPU cores)