Skip to content

ExceptionMiddleware

faststream.ExceptionMiddleware #

ExceptionMiddleware(handlers=None, publish_handlers=None)
Source code in faststream/broker/middlewares/exception.py 
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
def __init__(
    self,
    handlers: Optional[
        Dict[
            Type[Exception],
            GeneralExceptionHandler,
        ]
    ] = None,
    publish_handlers: Optional[
        Dict[
            Type[Exception],
            PublishingExceptionHandler,
        ]
    ] = None,
) -> None:
    self._handlers: CastedHandlers = [
        (IgnoredException, ignore_handler),
        *(
            (
                exc_type,
                apply_types(
                    cast(Callable[..., Awaitable[None]], to_async(handler))
                ),
            )
            for exc_type, handler in (handlers or {}).items()
        ),
    ]

    self._publish_handlers: CastedPublishingHandlers = [
        (IgnoredException, ignore_handler),
        *(
            (exc_type, apply_types(to_async(handler)))
            for exc_type, handler in (publish_handlers or {}).items()
        ),
    ]

add_handler #

add_handler(exc: Type[Exception], publish: Literal[False] = False) -> Callable[[GeneralExceptionHandler], GeneralExceptionHandler]

add_handler(exc: Type[Exception], publish: Literal[True]) -> Callable[[PublishingExceptionHandler], PublishingExceptionHandler]

add_handler(exc, publish=False)
Source code in faststream/broker/middlewares/exception.py 
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
def add_handler(
    self,
    exc: Type[Exception],
    publish: bool = False,
) -> Union[
    Callable[[GeneralExceptionHandler], GeneralExceptionHandler],
    Callable[[PublishingExceptionHandler], PublishingExceptionHandler],
]:
    if publish:

        def pub_wrapper(
            func: PublishingExceptionHandler,
        ) -> PublishingExceptionHandler:
            self._publish_handlers.append(
                (
                    exc,
                    apply_types(to_async(func)),
                )
            )
            return func

        return pub_wrapper

    else:

        def default_wrapper(
            func: GeneralExceptionHandler,
        ) -> GeneralExceptionHandler:
            self._handlers.append(
                (
                    exc,
                    apply_types(to_async(func)),
                )
            )
            return func

        return default_wrapper