Back to Bolt Python

slack_bolt.middleware.async_middleware_error_handler API documentation

docs/reference/middleware/async_middleware_error_handler.html

1.28.03.9 KB
Original Source

Classes

class AsyncCustomMiddlewareErrorHandler (logger: logging.Logger,func: Callable[..., Awaitable[BoltResponse | None]])#Expand source code

class AsyncCustomMiddlewareErrorHandler(AsyncMiddlewareErrorHandler):
    def __init__ (self, logger: Logger, func: Callable[..., Awaitable[Optional[BoltResponse]]]):
        self.func = func
        self.logger = logger
        self.arg_names = get_arg_names_of_callable(func)

    async def handle(
        self,
        error: Exception,
        request: AsyncBoltRequest,
        response: Optional[BoltResponse],
    ) -> None:
        kwargs: Dict[str, Any] = build_async_required_kwargs(
            required_arg_names=self.arg_names,
            logger=self.logger,
            error=error,
            request=request,
            response=response,
            next_keys_required=False,
        )
        returned_response = await self.func(**kwargs)
        if returned_response is not None and isinstance(returned_response, BoltResponse):
            assert response is not None, "response must be provided when returning a BoltResponse from an error handler"
            response.status = returned_response.status
            response.headers = returned_response.headers
            response.body = returned_response.body

Ancestors

Inherited members

  • AsyncMiddlewareErrorHandler:
    • handle

class AsyncDefaultMiddlewareErrorHandler (logger: logging.Logger)#Expand source code

class AsyncDefaultMiddlewareErrorHandler(AsyncMiddlewareErrorHandler):
    def __init__ (self, logger: Logger):
        self.logger = logger

    async def handle(
        self,
        error: Exception,
        request: AsyncBoltRequest,
        response: Optional[BoltResponse],
    ):
        message = f"Failed to run a middleware function (error: {error})"
        self.logger.exception(message)

Ancestors

Inherited members

  • AsyncMiddlewareErrorHandler:
    • handle

class AsyncMiddlewareErrorHandler#Expand source code

class AsyncMiddlewareErrorHandler(metaclass=ABCMeta):
    @abstractmethod
    async def handle(
        self,
        error: Exception,
        request: AsyncBoltRequest,
        response: Optional[BoltResponse],
    ) -> None:
        """Handles an unhandled exception.

        Args:
            error: The raised exception.
            request: The request.
            response: The response.
        """
        raise NotImplementedError()

Subclasses

Methods

async def handle(self,error: Exception,request: AsyncBoltRequest,response: BoltResponse | None) ‑> None#Expand source code

@abstractmethod
async def handle(
    self,
    error: Exception,
    request: AsyncBoltRequest,
    response: Optional[BoltResponse],
) -> None:
    """Handles an unhandled exception.

    Args:
        error: The raised exception.
        request: The request.
        response: The response.
    """
    raise NotImplementedError()

Handles an unhandled exception.

Args

error The raised exception. request The request. response The response.