📝 Changelog¶

All notable changes to APIException will be documented here. This project uses Semantic Versioning.

[0.2.0] - 2025-08-23¶

Advanced logging customizations in register_exception_handlers:
log_level: override verbosity for exception logging.
log_request_context: toggle to include/exclude request headers in logs.
log_header_keys: define which headers are logged (default: x-request-id, user-agent, etc.).
extra_log_fields: inject custom structured metadata into logs (e.g. user_id, masked API keys).
Response headers echo in register_exception_handlers:
response_headers=True → default headers echoed back.
response_headers=False → no headers echoed.
response_headers=("x-user-id",) → custom headers echoed.
APIException now accepts header parameters (headers can carry custom values into responses).
Mypy support added for static type checking.
Improved documentation for register_exception_handlers with usage patterns, logging, and examples.

Logging format has been revamped → now more structured, readable, and consistent.
Error logging now includes richer metadata: request path, method, client IP, HTTP version, etc.

Swagger/OpenAPI sometimes showed inconsistent error schemas when data was missing.
File structure cleanup: imports in __init__.py were fixed and simplified.
The package is now easier to import and fully modular.
Fixed a type issue where error_code was not properly annotated as BaseExceptionCode.

✅ Stable release! ✅ Initial stable and suggested version

Added missing import traceback in __init__.py.
This resolves a NameError when using register_exception_handlers with traceback logging enabled.

Refactored __init__.py to use relative imports (from .module import ...) for cleaner packaging and better IDE compatibility.
Unified and simplified __all__ so developers can import everything directly from api_exception (e.g. from api_exception import ResponseModel, APIException).

Unified import interface: all core classes and functions can now be imported directly from api_exception (e.g. from api_exception import ResponseModel, APIException).
Cleaner __init__.py exports with __all__.

Internal imports refactored, simplified folder structure for enums.py, response_model.py, rfc7807_model.py.

Global logging control (set_global_log) with log param in register_exception_handlers.
RFC7807 full support with application/problem+json responses.
Automatic injection of data: null in OpenAPI error examples.

RFC 7807 standard support for consistent error responses (application/problem+json)
OpenAPI (Swagger) schema consistency: nullable fields are now explicitly shown for better compatibility
Poetry support has been added for dependency management
uv support has been added.
extra logger message param has been added to APIException for more detailed logging
log_traceback and log_traceback_unhandled_exception parameters have been added to register_exception_handlers() for more control over logging behavior
log_exception parameter has been added to APIException for more control over logging behavior
log_message parameter has been added to APIException for more control over logging behavior
Logging now uses add_file_handler() to write logs to a file
Logging improvements: now includes exception arguments in logs for better debugging
Documentation has been updated.
Readme.md has been updated.

setup.py has been updated.
Project name has been updated. Instead of APIException we will use apiexception to comply with PEP 625.
Documentation has been updated.
Readme.md has been updated.

setup.py has been updated.
Project name has been updated. Instead of APIException we will use apiexception to comply with PEP 625.

🚀 Prototype started!