o NK&h @sddlmZddlmZddlmZddlmZmZm Z ddl m Z ddl m Z mZddlmZmZddlmZGd d d e d Zd S) )deque)partial) attrgetter)CallableUnionoverload) SanicMeta) MiddlewareMiddlewareLocation)FutureMiddlewareMiddlewareType)Routerc@seZdZUeed<dddZdefddZe dd d d e de de de de f ddZ e dd d d e de de de dee ge ff ddZ dd d d ee e fde de de dee ee ge fff ddZ dd d de fddZdd d ddZdddZdS)MiddlewareMixinrouterreturnNcOs g|_dSN)_future_middleware)selfargskwargsrJ/var/www/html/venv/lib/python3.10/site-packages/sanic/mixins/middleware.py__init__s zMiddlewareMixin.__init__ middlewarecCstr)NotImplementedError)rrrrr_apply_middlewaresz!MiddlewareMixin._apply_middlewarerequestTrprioritymiddleware_or_request attach_toapplyrcCdSrrrrr r!rrrrrzMiddlewareMixin.middlewarecCr"rrr#rrrrr$cs2dfdd }t|r|||dSt||dS)aDecorator for registering middleware. Decorate and register middleware to be called before a request is handled or after a response is created. Can either be called as *@app.middleware* or *@app.middleware('request')*. Although, it is recommended to use *@app.on_request* or *@app.on_response* instead for clarity and convenience. See [Middleware](/guide/basics/middleware) for more information. Args: middleware_or_request (Union[Callable, str]): Middleware function or the keyword 'request' or 'response'. attach_to (str, optional): When to apply the middleware; either 'request' (before the request is handled) or 'response' (after the response is created). Defaults to `'request'`. apply (bool, optional): Whether the middleware should be applied. Defaults to `True`. priority (int, optional): The priority level of the middleware. Lower numbers are executed first. Defaults to `0`. Returns: Union[Callable, Callable[[Callable], Callable]]: The decorated middleware function or a partial function depending on how the method was called. Example: ```python @app.middleware('request') async def custom_middleware(request): ... ``` rcsJ|dkrtjntj}t||d}t||}j|r#||S)Nrr)r REQUESTRESPONSEr r rappendr)rr locationfuture_middlewarer!rrrrregister_middlewareSs   z7MiddlewareMixin.middleware..register_middleware)r N)r)callabler)rrr r!rr+rr*rr)s*cC(t|r |j|d|dSt|jd|dS)aSRegister a middleware to be called before a request is handled. This is the same as *@app.middleware('request')*. Args: middleware (Callable, optional): A callable that takes in a request. Defaults to `None`. Returns: Callable: The decorated middleware function or a partial function depending on how the method was called. Examples: ```python @app.on_request async def custom_middleware(request): request.ctx.custom = 'value' ``` rrr rr,rrrrrrrr on_requestl zMiddlewareMixin.on_requestcCr-)avRegister a middleware to be called after a response is created. This is the same as *@app.middleware('response')*. Args: middleware (Callable, optional): A callable that takes in a request and response. Defaults to `None`. Returns: Callable: The decorated middleware function or a partial function depending on how the method was called. Examples: ```python @app.on_response async def custom_middleware(request, response): response.headers['X-Server'] = 'Sanic' ``` responserr.r/r0rrr on_responser2zMiddlewareMixin.on_responsecCs|jjD]C}tj|j|j|jtt j d}tj|j |j |jtt j d}tt|tddd|j_tt|tdddddd|j_ qtj|jt j d}tj|j t j d}tt|tddd|_tt|tdddddd|_ dS)auFinalize the middleware configuration for the Sanic application. This method completes the middleware setup for the application. Middleware in Sanic is used to process requests globally before they reach individual routes or after routes have been processed. Finalization consists of identifying defined routes and optimizing Sanic's performance to meet the application's specific needs. If you are manually adding routes, after Sanic has started, you will typically want to use the `amend` context manager rather than calling this method directly. .. note:: This method is usually called internally during the server setup process and does not typically need to be invoked manually. Example: ```python app.finalize_middleware() ``` )r(orderT)keyreverseN)rroutesr convertrequest_middlewarenamed_request_middlewaregetnamerr r%response_middlewarenamed_response_middlewarer&sortedrextra)rrouter;r?rrrfinalize_middlewaresf   z#MiddlewareMixin.finalize_middleware)rN)rTr)__name__ __module__ __qualname__r __annotations__rr rrr strboolintrrrr1r4rDrrrrr sl         Cr) metaclassN) collectionsr functoolsroperatorrtypingrrrsanic.base.metarsanic.middlewarer r sanic.models.futuresr r sanic.routerr rrrrrs