}tj=UdZddlZddlZddlZddlmZddlmZddlm Z m Z m Z ddl m Z mZmZe r ddlZddlmZerdd lmZmZdd lmZndxZxZZdae d ed <ejd duZe Gdd Ze ddedzdefdZdefdZdedzddfdZ dededefdZ!dededefdZ"dS)zSContains `WebhooksServer` and `webhook_endpoint` to create a webhook server easily.N)Callable)wraps) TYPE_CHECKINGAnyOptional) experimentalis_fastapi_availableis_gradio_available)Request)FastAPIr ) JSONResponseWebhooksServer _global_appSPACE_IDceZdZdZdfd Z ddeddedzddfdZdd edzdefd Z dd e d e ddfdZ ddZ xZS)ra The [`WebhooksServer`] class lets you create an instance of a Gradio app that can receive Huggingface webhooks. These webhooks can be registered using the [`~WebhooksServer.add_webhook`] decorator. Webhook endpoints are added to the app as a POST endpoint to the FastAPI router. Once all the webhooks are registered, the `launch` method has to be called to start the app. It is recommended to accept [`WebhookPayload`] as the first argument of the webhook function. It is a Pydantic model that contains all the information about the webhook event. The data will be parsed automatically for you. Check out the [webhooks guide](../guides/webhooks_server) for a step-by-step tutorial on how to set up your WebhooksServer and deploy it on a Space. > [!WARNING] > `WebhooksServer` is experimental. Its API is subject to change in the future. > [!WARNING] > You must have `gradio` installed to use `WebhooksServer` (`pip install --upgrade gradio`). Args: ui (`gradio.Blocks`, optional): A Gradio UI instance to be used as the Space landing page. If `None`, a UI displaying instructions about the configured webhooks is created. webhook_secret (`str`, optional): A secret key to verify incoming webhook requests. You can set this value to any secret you want as long as you also configure it in your [webhooks settings panel](https://huggingface.co/settings/webhooks). You can also set this value as the `WEBHOOK_SECRET` environment variable. If no secret is provided, the webhook endpoints are opened without any security. Example: ```python import gradio as gr from huggingface_hub import WebhooksServer, WebhookPayload with gr.Blocks() as ui: ... app = WebhooksServer(ui=ui, webhook_secret="my_secret_key") @app.add_webhook("/say_hello") async def hello(payload: WebhookPayload): return {"message": "hello"} app.launch() ``` returnctstdtstdt|S)NzjYou must have `gradio` installed to use `WebhooksServer`. Please run `pip install --upgrade gradio` first.zlYou must have `fastapi` installed to use `WebhooksServer`. Please run `pip install --upgrade fastapi` first.)r ImportErrorr super__new__)clsargskwargs __class__s ^/var/www/html/CA-Chatbot/venv/lib/python3.11/site-packages/huggingface_hub/_webhooks_server.pyrzWebhooksServer.__new__[sg"$$  $%%  wws###Nui gr.Blockswebhook_secretc||_|ptjd|_i|_t |jdS)NWEBHOOK_SECRET)_uiosgetenvr registered_webhooks_warn_on_empty_secret)selfrr s r__init__zWebhooksServer.__init__hsB ,K :J0K0K8: d122222rpathctrSttjfd}|S)ax Decorator to add a webhook to the [`WebhooksServer`] server. Args: path (`str`, optional): The URL path to register the webhook function. If not provided, the function name will be used as the path. In any case, all webhooks are registered under `/webhooks`. Raises: ValueError: If the provided path is already registered as a webhook. Example: ```python from huggingface_hub import WebhooksServer, WebhookPayload app = WebhooksServer() @app.add_webhook async def trigger_training(payload: WebhookPayload): if payload.repo.type == "dataset" and payload.event.action == "update": # Trigger a training job if a dataset is updated ... app.launch() ``` c|d}dp|jd}|jvrtd|d|j|<dS)Nrz /webhooks//zWebhook z already exists.)__name__stripr& ValueError)rrfuncabs_pathr*r(s r _inner_postz/WebhooksServer.add_webhook.._inner_postsi7DHT%:T]$A$A#$F$FHHH4333 !FH!F!F!FGGG15D $X . . .r)callable add_webhookrr post)r(r*r3s`` rr5zWebhooksServer.add_webhookssm8 D>> ,%4##%%d++ + w|   6 6 6 6 6   6rFprevent_thread_lock launch_kwargsc  |jp|}|dt|jdddi|\|_}}|jD]E\}}|jt||j}|j ||Ftj d}|d|zn |jp|j t!d d  d }|d d  fd |jDzz }|d z }t'||s|dSdS)zLaunch the Gradio app and register webhooks to the underlying FastAPI server. Input parameters are forwarded to Gradio when launching the app. sharer7TNr SPACE_HOSTzhttps://zWCannot find the URL of the app. Please provide a valid `ui` or update `gradio` version.r-z/ Webhooks are correctly setup and ready to use: c3&K|] }d|V dS)z - POST N).0webhookurls r z(WebhooksServer.launch..s1#g#g7$>$>W$>$>#g#g#g#g#g#grzG Go to https://huggingface.co/settings/webhooks to setup your webhooks.r?)r#_get_default_ui setdefault _is_locallaunch fastapi_appr&itemsr _wrap_webhook_to_check_secretr6r$environget share_url local_urlr0r/joinprint block_thread) r(r7r8r_r*r1 space_hostmessagerBs @rrGzWebhooksServer.launchs X /--//   )444!*!U!Ut!U}!U!U!Q288:: . .JD$".4T$J]^^^ (D  ! !$ ' ' - - - -Z^^L11 )3)?j:%%blFbVXVb ;vww wiinnD4$))#g#g#g#gdNf#g#g#ggggg]] g"  OO       rc ddl}|j5}|jd|jd|jt|jddzdd|jDz|jtrd nd dddn #1swxYwY|S) zLDefault UI if not provided (lists webhooks and provides basic instructions).rNu)# This is an app to process 🤗 WebhooksaTWebhooks are a foundation for MLOps-related features. They allow you to listen for new changes on specific repos or to all repos belonging to particular set of users/organizations (not just your repos, but any repo). Check out this [guide](https://huggingface.co/docs/hub/webhooks) to get to know more about webhooks on the Huggingface Hub.z webhook(s) are registered:z z c3TK|]#\}}d|dt|j|dV$dS)z- [z]()N)_get_webhook_doc_urlr.)r@ webhook_pathrAs rrCz1WebhooksServer._get_default_ui..s]- gb,aa*>w?OQ]*^*^aaarzGo to https://huggingface.co/settings/webhooks to setup your webhooks. You app is running locally. Please look at the logs to check the full URL you need to set.z This app is running on a Space. You can find the corresponding URL in the options menu (top-right) > 'Embed the Space'. The URL looks like 'https://{username}-{repo_name}.hf.space'.)gradioBlocksMarkdownlenr&rOrIrF)r(grrs rrDzWebhooksServer._get_default_uisP RY[[ B BKC D D D BKD    BKt/00MMM**151I1O1O1Q1Q    BKqqv    !               2 sBB99B=B=)rr)NNN)F)rr)r. __module__ __qualname____doc__rrstrr)rr5boolrrGrD __classcell__)rs@rrr*s--^ $ $ $ $ $ $%)%) 3 3 [ ! 3d  3  3 3 3 3))d )h))))V""$""QU""""Hrr*rctrtSttjdt dt ffd }|S)aDecorator to start a [`WebhooksServer`] and register the decorated function as a webhook endpoint. This is a helper to get started quickly. If you need more flexibility (custom landing page or webhook secret), you can use [`WebhooksServer`] directly. You can register multiple webhook endpoints (to the same server) by using this decorator multiple times. Check out the [webhooks guide](../guides/webhooks_server) for a step-by-step tutorial on how to set up your server and deploy it on a Space. > [!WARNING] > `webhook_endpoint` is experimental. Its API is subject to change in the future. > [!WARNING] > You must have `gradio` installed to use `webhook_endpoint` (`pip install --upgrade gradio`). Args: path (`str`, optional): The URL path to register the webhook function. If not provided, the function name will be used as the path. In any case, all webhooks are registered under `/webhooks`. Examples: The default usage is to register a function as a webhook endpoint. The function name will be used as the path. The server will be started automatically at exit (i.e. at the end of the script). ```python from huggingface_hub import webhook_endpoint, WebhookPayload @webhook_endpoint async def trigger_training(payload: WebhookPayload): if payload.repo.type == "dataset" and payload.event.action == "update": # Trigger a training job if a dataset is updated ... # Server is automatically started at the end of the script. ``` Advanced usage: register a function as a webhook endpoint and start the server manually. This is useful if you are running it in a notebook. ```python from huggingface_hub import webhook_endpoint, WebhookPayload @webhook_endpoint async def trigger_training(payload: WebhookPayload): if payload.repo.type == "dataset" and payload.event.action == "update": # Trigger a training job if a dataset is updated ... # Start the server manually trigger_training.launch() ``` r1rct|tjdkrt jjtjfd}||_|S)NrcbtjjdSr_)atexit unregisterrG)appsr _launch_nowz5webhook_endpoint.._inner.._launch_now$s)  cj ) ) ) JJLLLLLr)_get_global_appr5r]r&riregisterrGr)r1rlrkr*s @r_innerz webhook_endpoint.._innersd### s& ' '1 , , OCJ ' ' ' sz          "  r)r4webhook_endpointrrr5r)r*ros` rrprpstl~~(!!!$''' > %&&X('& Mrc:ttatSr_)rrr?rrrmrm0s$&& rr c|/tdtdtddStddS)NzZWebhook secret is not defined. This means your webhook endpoints will be open to everyone.zTo add a secret, set `WEBHOOK_SECRET` as environment variable or pass it at initialization: `app = WebhooksServer(webhook_secret='my_secret', ...)`zpFor more details about webhook secrets, please refer to https://huggingface.co/docs/hub/webhooks#webhook-secret.z$Webhook secret is correctly defined.)rPr;s rr'r'7sj jkkk  J     H     455555r webhook_namerYc@d|z|ddzdzS)z@Returns the anchor to a given webhook in the docs (experimental)z/docs#/default/r-rR_post)replace)rsrYs rrXrXFs' | +l.B.B3.L.L Lw VVrr1cftjtdtffd }djvrltjdtjjtftj z|_ |S)aWraps a webhook function to check the webhook secret before calling the function. This is a hacky way to add the `request` parameter to the function signature. Since FastAPI based itself on route parameters to inject the values to the function, we need to hack the function signature to retrieve the `Request` object (and hence the headers). A far cleaner solution would be to use a middleware. However, since `fastapi==0.90.1`, a middleware cannot be added once the app has started. And since the FastAPI app is started by Gradio internals (and not by us), we cannot add a middleware. This method is called only when a secret has been defined by the user. If a request is sent without the "x-webhook-secret", the function will return a 401 error (unauthorized). If the header is sent but is incorrect, the function will return a 403 error (forbidden). Inspired by https://stackoverflow.com/a/33112180. requestcK|jd}|tddidS|krtddidSdjvr||d<t jrd i|d{VSd i|S) Nzx-webhook-secreterrorz x-webhook-secret header not set.i) status_codezInvalid webhook secret.irxr?)headersrLr parametersinspectiscoroutinefunction)rxrrequest_secretr1 initial_sigr s r_protected_funcz6_wrap_webhook_to_check_secret.._protected_func\s ,,-?@@  !*L M[^___ _ ^ + +*C DRUVVV V  . . . 'F9   &t , , "'''''' '4>>&>> !r)namekind annotation)r}) r~ signaturerr r}rv ParameterPOSITIONAL_OR_KEYWORDtuplevalues __signature__)r1r rrs`` @rrJrJKs#D))K 4[["w"""""""["$ ...(3(;(;!yw7H7^krsssK*1133445)<) ) % rr_)#rbrir~r$collections.abcr functoolsrtypingrrrutilsr r r rZr^fastapir r fastapi.responsesrr__annotations__rKrLrFrrcrprmr'rXrJr?rrrsSZYY  $$$$$$//////////JJJJJJJJJJ ,((((((((.......(,+G+g +/ X& '... JNN: & &$ . ttttttttnJJ3:JJJJJZ 6#* 6 6 6 6 6WsW#W#WWWW --#-(------r