Update drf_simple_api_errors modules

Author: gripep

drf_simple_api_errors/exception_handler.py

@@ -1,19 +1,11 @@
 import logging
-from typing import Dict, Union
 
-from django.core.exceptions import (
-    PermissionDenied,
-    ValidationError as DjangoValidationError,
-)
-from django.http import Http404
 from rest_framework import exceptions
 from rest_framework.response import Response
-from rest_framework.serializers import as_serializer_error
 from rest_framework.views import set_rollback
 
-from drf_simple_api_errors import formatter
+from drf_simple_api_errors import formatter, handlers
 from drf_simple_api_errors.exceptions import ServerError
-from drf_simple_api_errors.settings import api_settings
 from drf_simple_api_errors.types import ExceptionHandlerContext
 
 logger = logging.getLogger(__name__)
@@ -41,22 +33,22 @@ def exception_handler(exc: Exception, context: ExceptionHandlerContext) -> Respo
     # This allows for custom exception handling logic.
     # If other kinds of exceptions are raised and should be handled,
     # they can be added to the EXTRA_HANDLERS setting.
-    _apply_extra_handlers(exc)
+    handlers.apply_extra_handlers(exc)
 
     # If the exception is not an instance of APIException, we can try to convert it
     # to DRF APIException if it's a Django exception.
-    exc = _convert_django_exc_to_drf_api_exc(exc)
+    exc = handlers.convert_django_exc_to_drf_api_exc(exc)
     # If the exception is still not an instance of APIException, thus could be
     # converted to one, we cannot handle it.
     # This will result in a 500 error response without any detail.
     # This is because it's not good practice to expose the details of
     # unhandled exceptions to the client.
     if not isinstance(exc, exceptions.APIException):
-        logger.debug("Server error", exc_info=True)
+        logger.info("Server error (500) from unexpected exception.", exc_info=True)
         return ServerError
 
     # Get the API response headers from the exception.
-    headers = _get_response_headers(exc)
+    headers = handlers.get_response_headers(exc)
     # Get the API response data from the exception.
     # If the exception is an instance of APIException, we can handle it and
     # will format it to a structured API response data.
@@ -65,61 +57,3 @@ def exception_handler(exc: Exception, context: ExceptionHandlerContext) -> Respo
     set_rollback()
     # Finally, return the API response \(◕ ◡ ◕\)
     return Response(data, status=exc.status_code, headers=headers)
-
-
-def _apply_extra_handlers(exc: Exception):
-    """
-    Apply any extra exception handlers defined in the settings.
-
-    Args:
-        exc (Exception): The exception to handle.
-    """
-    extra_handlers = api_settings.EXTRA_HANDLERS
-    if extra_handlers:
-        for handler in extra_handlers:
-            handler(exc)
-
-
-def _convert_django_exc_to_drf_api_exc(
-    exc: Exception,
-) -> Union[exceptions.APIException, Exception]:
-    """
-    Convert Django exceptions to DRF APIException, if possible.
-
-    Args:
-        exc (Exception): The exception to convert.
-
-    Returns:
-        exceptions.APIException | Exception: The converted exception or the original.
-    """
-    if isinstance(exc, DjangoValidationError):
-        return exceptions.ValidationError(as_serializer_error(exc))
-
-    if isinstance(exc, Http404):
-        return exceptions.NotFound()
-
-    if isinstance(exc, PermissionDenied):
-        return exceptions.PermissionDenied()
-
-    return exc
-
-
-def _get_response_headers(exc: exceptions.APIException) -> Dict:
-    """
-    Get the response headers for the given exception.
-
-    Args:
-        exc (exceptions.APIException): The exception to get headers for.
-
-    Returns:
-        dict: A dictionary containing the response headers.
-    """
-    # This is from DRF's default exception handler.
-    # https://github.com/encode/django-rest-framework/blob/48a21aa0eb3a95d32456c2a927eff9552a04231e/rest_framework/views.py#L87-L91
-    headers = {}
-    if getattr(exc, "auth_header", None):
-        headers["WWW-Authenticate"] = exc.auth_header
-    if getattr(exc, "wait", None):
-        headers["Retry-After"] = "%d" % exc.wait
-
-    return headers

drf_simple_api_errors/extra_handlers.py

@@ -0,0 +1,38 @@
+"""
+This module contains custom error handlers for DRF exceptions.
+It allows you to define additional handlers for specific exceptions
+or to modify the behavior of existing exceptions.
+
+Functions:
+    - `set_default_detail_to_formatted_exc_default_code`:
+        Formats the `default_detail` for specific DRF exceptions
+        by setting it to a human-readable string based on the exception `default_code`.
+"""
+
+from django.utils.translation import gettext_lazy as _
+from rest_framework import exceptions
+
+
+def set_default_detail_to_formatted_exc_default_code(
+    exc: exceptions.APIException,
+) -> exceptions.APIException:
+    """
+    Formats the `default_detail` for specific DRF exceptions
+    by setting it to a human-readable string based on the exception `default_code`.
+
+    This ensures that the `default_detail` is consistent and descriptive, such as
+    'Method not allowed.' instead of using a template string, leaving the exception
+    `detail` to be more informative.
+    """
+    exceptions_to_format = (
+        exceptions.MethodNotAllowed,
+        exceptions.UnsupportedMediaType,
+    )
+
+    if not isinstance(exc, exceptions_to_format):
+        return exc
+
+    # Compose the title based on the exception code.
+    title = exc.default_code.replace("_", " ").capitalize() + "."
+    exc.default_detail = _(title)
+    return exc

drf_simple_api_errors/formatter.py

@@ -1,5 +1,6 @@
 """
-This module provides functionality to format API exceptions into a structured error response.
+This module provides functionality to format API exceptions into a structured
+error response.
 
 It defines the `APIErrorResponse` class, which represents
 the structure of the error response, and the `format_exc` function, which
@@ -22,7 +23,6 @@
 from rest_framework.settings import api_settings as drf_api_settings
 
 from drf_simple_api_errors import utils
-from drf_simple_api_errors.settings import api_settings
 from drf_simple_api_errors.types import APIErrorResponseDict
 
 logger = logging.getLogger(__name__)
@@ -52,7 +52,7 @@ class APIErrorResponse:
         - invalid_params: A list of invalid parameters, if any
     """
 
-    title: str = dataclass_field(init=False)
+    title: str = dataclass_field(default="")
     detail: Optional[List[str]] = dataclass_field(default=None)
     invalid_params: Optional[List[InvalidParam]] = dataclass_field(default=None)
 

drf_simple_api_errors/handlers.py

@@ -0,0 +1,90 @@
+"""
+Handlers to deal with different types of exceptions and format them into
+API error responses, and other utility functions.
+
+Functions:
+    - `apply_extra_handlers`:
+        Applies any extra exception handlers defined in the settings.
+    - `convert_django_exc_to_drf_api_exc`:
+        Converts Django exceptions to DRF APIException, if possible.
+    - `get_response_headers`: Gets the response headers for the given exception.
+"""
+
+from typing import Dict, Union
+
+from django.core.exceptions import (
+    PermissionDenied,
+    ValidationError as DjangoValidationError,
+)
+from django.http import Http404
+from rest_framework import exceptions
+from rest_framework.serializers import as_serializer_error
+
+from drf_simple_api_errors import extra_handlers
+from drf_simple_api_errors.settings import api_settings
+
+
+def apply_extra_handlers(exc: Exception):
+    """
+    Apply any extra exception handlers defined in the settings.
+
+    Args:
+        exc (Exception): The exception to handle.
+    """
+    # Get the default extra handlers and the ones defined in the settings.
+    # The default handlers are always applied to ensure that exceptions
+    # are formatted correctly.
+    default_extra_handlers = [
+        extra_handlers.set_default_detail_to_formatted_exc_default_code
+    ]
+    settings_extra_handlers = api_settings.EXTRA_HANDLERS
+
+    extra_handlers_to_apply = default_extra_handlers + settings_extra_handlers
+    if extra_handlers_to_apply:
+        for handler in extra_handlers_to_apply:
+            handler(exc)
+
+
+def convert_django_exc_to_drf_api_exc(
+    exc: Exception,
+) -> Union[exceptions.APIException, Exception]:
+    """
+    Convert Django exceptions to DRF APIException, if possible.
+
+    Args:
+        exc (Exception): The exception to convert.
+
+    Returns:
+        exceptions.APIException | Exception: The converted exception or the original.
+    """
+    if isinstance(exc, DjangoValidationError):
+        return exceptions.ValidationError(as_serializer_error(exc))
+
+    if isinstance(exc, Http404):
+        return exceptions.NotFound()
+
+    if isinstance(exc, PermissionDenied):
+        return exceptions.PermissionDenied()
+
+    return exc
+
+
+def get_response_headers(exc: exceptions.APIException) -> Dict:
+    """
+    Get the response headers for the given exception.
+
+    Args:
+        exc (exceptions.APIException): The exception to get headers for.
+
+    Returns:
+        dict: A dictionary containing the response headers.
+    """
+    # This is from DRF's default exception handler.
+    # https://github.com/encode/django-rest-framework/blob/48a21aa0eb3a95d32456c2a927eff9552a04231e/rest_framework/views.py#L87-L91
+    headers = {}
+    if getattr(exc, "auth_header", None):
+        headers["WWW-Authenticate"] = exc.auth_header
+    if getattr(exc, "wait", None):
+        headers["Retry-After"] = "%d" % exc.wait
+
+    return headers

drf_simple_api_errors/settings.py

@@ -1,3 +1,8 @@
+"""
+Settings for the DRF Simple API Errors package.
+This module defines the default settings and user settings for the package.
+"""
+
 from django.conf import settings
 from rest_framework.settings import APISettings
 

drf_simple_api_errors/types.py

@@ -1,3 +1,7 @@
+"""
+Types for exception handler and its modules.
+"""
+
 from typing import Dict, List, Optional, Tuple, TypedDict
 
 from rest_framework.request import Request

drf_simple_api_errors/utils.py

@@ -1,3 +1,13 @@
+"""
+Utility functions for handling API errors and formatting responses.
+
+Functions:
+    - `camelize`:
+        Converts a snake_case string to camelCase according to the CAMELIZE setting.
+    - `flatten_dict`: Flattens a nested dictionary into a single-level dictionary
+        according to the specified FIELDS_SEPARATOR setting.
+"""
+
 import re
 
 from drf_simple_api_errors.settings import api_settings
@@ -11,7 +21,7 @@ def camelize(s: str) -> str:
     Args:
         s (str): The string to convert.
     Returns:
-        str: The camelCase version of the string, or the original if CAMELIZE is `False`.
+        str: The camelCase version of a string, or the original if CAMELIZE is `False`.
     """
 
     def underscore_to_camel(match: re.Match) -> str: