9i4=%SrSSKrSSKrSSKrSSKJr SSKJrJrJ r J r SSK J r J r Jr \(a SSKrSSKJr \ "5(aSSKJrJr SS KJr OS=r=rrSq\ S \S '\R0R3S 5SLr\ "S S 55r\ SS\ \S\ 4Sjj5rS\4SjrS\ \SS4SjrS\S\S\4Sjr S\ S\S\ 4Sjr!g)zSContains `WebhooksServer` and `webhook_endpoint` to create a webhook server easily.N)wraps) TYPE_CHECKINGAnyCallableOptional) experimentalis_fastapi_availableis_gradio_available)Request)FastAPIr ) JSONResponseWebhooksServer _global_appSPACE_IDc^\rSrSrSrSU4SjjrSS\SS\\SS4S jjrSS \\S\ 4S jjr SS \ S \ SS4Sjjr SSjrSrU=r$)r*a 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() ``` returnc>[5(d [S5e[5(d [S5e[TU]U5$)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/land-doc-ocr/venv/lib/python3.13/site-packages/huggingface_hub/_webhooks_server.pyrWebhooksServer.__new__[sL"$$ $%% ws##Nui gr.Blockswebhook_secretcXlU=(d [R"S5Ul0Ul[ UR5 g)NWEBHOOK_SECRET)_uiosgetenvr"registered_webhooks_warn_on_empty_secret)selfr r"s r__init__WebhooksServer.__init__hs6 ,K :J0K8: d112rpathc^^[T5(aTR5"T5$[[R5UU4Sj5nU$)a 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>USnST=(d URRS53nUTR;a[SUS35eUTRU'g)Nrz /webhooks//zWebhook z already exists.)__name__stripr( ValueError)rrfuncabs_pathr-r*s r _inner_post/WebhooksServer.add_webhook.._inner_posts`7D#T%:T]]$A$A#$F#GHH4333 8H:5E!FGG15D $ $X .r)callable add_webhookrr post)r*r-r6s`` rr9WebhooksServer.add_webhookssG8 D>>##%d+ + w||  6  6rprevent_thread_lock launch_kwargsc ^ UR=(d UR5nURS[5 UR"SSS0UD6uUl nUR R5HFupVURb[X`RS9nUR RU5"U5 MH [RRS5nUbSU-OUR=(d URm T c [!S5eT R#S 5m S nUS S R%U 4S jUR 55-- nUS - n['U5 U(dUR)5 gg)zLaunch the Gradio app and register webhooks to the underlying FastAPI server. Input parameters are forwarded to Gradio when launching the app. sharer<TNr" SPACE_HOSTzhttps://zWCannot find the URL of the app. Please provide a valid `ui` or update `gradio` version.r0z/ Webhooks are correctly setup and ready to use: c32># UH nSTU3v M g7f)z - POST N).0webhookurls r (WebhooksServer.launch..s#gNf7iuWI$>NfszG Go to https://huggingface.co/settings/webhooks to setup your webhooks.rD)r%_get_default_ui setdefault _is_locallaunch fastapi_appr(itemsr"_wrap_webhook_to_check_secretr:r&environget share_url local_urlr3r2joinprint block_thread) r*r<r=r _r-r4 space_hostmessagerGs @rrMWebhooksServer.launchsB XX /--/   )4!#!Ut!U}!U!Q2288:JD"".4TJ]J]^    ! !$ ' - ;ZZ^^L1 )3)?j:%bllFbVXVbVb ;vw wiinD4$))#gdNfNf#gggg]] g" OO #rc SSKnUR"5nUR"S5 UR"S5 UR"[UR5S3S-SR SURR 555-5 UR"[(aS OS 5 SSS5 U$!,(df  W$=f) 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 c3`# UH$upSUS[URU5S3v M& g7f)z- [z]()N)_get_webhook_doc_urlr1)rE webhook_pathrFs rrH1WebhooksServer._get_default_ui..s:1Q- ,r*>w?O?OQ]*^)__`a1Qs,.zGo 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(rUrOrL)r*grr s rrJWebhooksServer._get_default_uis YY[B KKC D KKD  KKt//011LM**151I1I1O1O1Q  KK9qv  !2 3[2 s B C C)r%rNr(r")rr)NNN)F)rr!)r1 __module__ __qualname____firstlineno____doc__rrstrr+rr9boolrrMrJ__static_attributes__ __classcell__)rs@rrr*s~-^ $%)(, 3 [ ! 3!  3  3) ))V"$""QU"Hrr-rc^[T5(a[5"T5$[[R5S[ S[ 4U4Sjj5nU$)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() ``` r4rc>^[5mTRT5"U5 [TR5S:Xa [R "TR 5 [TR 5U4Sj5nXlU$)Nrcf>[R"TR5 TR5 grh)atexit unregisterrM)appsr _launch_now5webhook_endpoint.._inner.._launch_now$s    cjj ) JJLr)_get_global_appr9rer(rtregisterrMr)r4rwrvr-s @r_inner webhook_endpoint.._innersf d# s&& '1 , OOCJJ ' szz     "  r)r8webhook_endpointrrr9r)r-r{s` rr}r}sOl~~!$'' > % %&X(' Mrc0[c [5q[$rh)rrrDrrryry0s$& rr"cdUc"[S5 [S5 [S5 g[S5 g)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.)rVr@s rr)r)7s: jk  J   H 45r webhook_namer`c8SU-URSS5-S-$)z@Returns the anchor to a given webhook in the docs (experimental)z/docs#/default/r0rX_post)replace)rr`s rr_r_Fs$ | +l.B.B3.L Lw VVrr4cf^^^[R"T5m[T5S[4UUU4Sjj5nSTR;aiTR [R "S[R R[S94[TRR55-S9Ul U$)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. requestc># URRS5nUc [SS0SS9$UT:wa [SS0SS9$STR;aXS'[R "T5(aT"S 0UD6IShvN $T"S 0UD6$N 7f) Nzx-webhook-secreterrorz x-webhook-secret header not set.i) status_codezInvalid webhook secret.irrD)headersrRr parametersinspectiscoroutinefunction)rrrequest_secretr4 initial_sigr"s r_protected_func6_wrap_webhook_to_check_secret.._protected_func\s ,,-?@  !*L M[^_ _ ^ +*C DRUV V  .. . '9   & &t , ,' '>&> !(sA7B :B; B )namekind annotation)r) r signaturerr rr ParameterPOSITIONAL_OR_KEYWORDtuplevalues __signature__)r4r"rrs`` @rrPrPKs##D)K 4["w"""$ ...(3(;(;!!yw7H7H7^7^krsK**11345)<) % rrh)"rlrtrr& functoolsrtypingrrrrutilsr r r rbrffastapir r fastapi.responsesrr__annotations__rQrRrLrrmr}ryr)r_rPrDrrrsZ  99JJ(.(,+G+g +/ X& '. JJNN: &$ . tttnJ8C=JHJJZ 6(3- 6D 6WsW#W#W --#-(-r