Module slack_bolt.middleware.custom_middleware

Classes

class CustomMiddleware (*, app_name: str, func: Callable, base_logger: Optional[logging.Logger] = None)

A middleware can process request data before other middleware and listener functions.

Expand source code

class CustomMiddleware(Middleware):
    app_name: str
    func: Callable[..., Any]
    arg_names: MutableSequence[str]
    logger: Logger

    def __init__(self, *, app_name: str, func: Callable, base_logger: Optional[Logger] = None):
        self.app_name = app_name
        self.func = func
        self.arg_names = get_arg_names_of_callable(func)
        self.logger = get_bolt_app_logger(self.app_name, self.func, base_logger)

    def process(
        self,
        *,
        req: BoltRequest,
        resp: BoltResponse,
        # As this method is not supposed to be invoked by bolt-python users,
        # the naming conflict with the built-in one affects
        # only the internals of this method
        next: Callable[[], BoltResponse],
    ) -> BoltResponse:
        return self.func(
            **build_required_kwargs(
                logger=self.logger,
                required_arg_names=self.arg_names,
                request=req,
                response=resp,
                next_func=next,  # type: ignore[arg-type]
                this_func=self.func,
            )
        )

    @property
    def name(self) -> str:
        return f"CustomMiddleware(func={get_name_for_callable(self.func)})"

Ancestors

• Middleware

Class variables

var app_name : str

var arg_names : MutableSequence[str]

var func : Callable[..., Any]

var logger : logging.Logger

Inherited members

• Middleware:
  • name
  • process