+ &j=aRt"0tRt^RIt^RIt^RIt^RIHt^RIHt^RI H t H t H t ^RI HtHtHt] 'd ^RIt^RIHt]!4'd^RIHtHt^RIHtMR;t;ttRs]^k]P2P5R 4RJt]!R R 44t]RR R ll4tRRltRRltRRlt RRlt!R#)zSContains `WebhooksServer` and `webhook_endpoint` to create a webhook server easily.NCallable)wraps) TYPE_CHECKINGAnyOptional) experimentalis_fastapi_availableis_gradio_availableRequest)FastAPIr ) JSONResponseSPACE_IDcaa]tRt^*toRtV3RlV3RlltR V3RlRlltRV3RlRlltRV3RlR lltV3R lR lt R t Vt V;t #)WebhooksServera 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() ``` c<V^8dQhRR/#)returnr)format __classdict__s"x/Users/jameslopez/projects/CWCArchive/cwc-podcast/.venv/lib/python3.14/site-packages/huggingface_hub/_webhooks_server.py __annotate__WebhooksServer.__annotate__[s $ $)9 $c<\4'g \R4h\4'g \R4h\SV`V4#)zjYou 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&*,rrWebhooksServer.__new__[sL"$$ $%% ws##rcF<V^8dQhRS[R,RS[R,RR/#)rui gr.Blockswebhook_secretNr)rstr)rrs"rrrhs2 3 3 [ ! 3d  3  3rcWnT;'g\P!R4Vn/Vn\ VP4R#)WEBHOOK_SECRETN)_uiosgetenvr(registered_webhooks_warn_on_empty_secret)selfr&r(s&&&r__init__WebhooksServer.__init__hs9 ,KK :J0K8: d112rc4<V^8dQhRS[R,RS[/#rpathNrr)r)rrs"rrrss))d )h)rc aa\S4'dSP4!S4#\\P4VV3Rl4pV#)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<V^,pRS;'g VPPR4 2pVSP9d\RV R24hVSPV&R#)z /webhooks//zWebhook z already exists.N)__name__stripr/ ValueError)r!r"funcabs_pathr6r1s*, r _inner_post/WebhooksServer.add_webhook.._inner_postsc7D#T%:%:T]]$A$A#$F#GHH4333 8H:5E!FGG15D $ $X .r)callable add_webhookrr post)r1r6rAsff rrDWebhooksServer.add_webhookssG8 D>>##%d+ + w||  6  6rc*<V^8dQhRS[RS[RR/#)rprevent_thread_lock launch_kwargsrN)boolr)rrs"rrrs#""$""QU"rc $a VP;'gVP4pVPR\4VP!RRR/VBwVnpVP P4FJwrVVPe\W`PR7pVP PV4!V4KL \PPR4pVe RV,MVP;'g VPo S f \!R4hS P#R 4o R pVR R P%V 3R lVP 44,, pVR , p\'V4V'gVP)4R#R#)zLaunch the Gradio app and register webhooks to the underlying FastAPI server. Input parameters are forwarded to Gradio when launching the app. sharerHTNr( 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: c32<"TF pRS V 2xK R#5i)z - POST Nr).0webhookurls& r (WebhooksServer.launch..s#gNf7iuWI$>NfszG 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_secretrEr-environget share_url local_urlr>r=joinprint block_thread) r1rHrIr&_r6r? space_hostmessagerSs &&, @rrYWebhooksServer.launchsH XX / /--/   )4!#!Ut!U}!U!Q2288:JD"".4TJ]J]^    ! !$ ' - ;ZZ^^L1 )3)?j:%bllFbFbVXVbVb ;vw wiinD4$))#gdNfNf#gggg]] g" OO #rc<V^8dQhRR/#)rrr'r)rrs"rrrsrc  ^RIpVP!4;_uu_4pVP!R4VP!R4VP!\VP4 R2R,RP RVPP 444,4VP!\'dR MR4RRR4V# +'giX#;i) zLDefault UI if not provided (lists webhooks and provides basic instructions).Nu)# 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`"TF$wrRV R\VPV4 R2xK& R#5i)z- [z]()N)_get_webhook_doc_urlr<)rQ webhook_pathrRs& rrT1WebhooksServer._get_default_ui..s:1Q- ,r*>w?O?OQ]*^)__`a1Qs,.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'.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.)gradioBlocksMarkdownlenr/rar[rX)r1grr&s& rrVWebhooksServer._get_default_uis YY[[B KKC D KKD  KKt//011LM**151I1I1O1O1Q  KK9qv  !2 3[2 s B)C C" )r,rZr/r()NNN)F) r< __module__ __qualname____firstlineno____doc__rr2rDrYrV__static_attributes____classdictcell__ __classcell__)r#rs@@rrr*sD-^ $ $ 3 3))V""Hrrc>V^8dQhR\R,R\/#r5r7)rs"rrrs"JJ3:JJrca\S4'd\4!S4#\\P4RV3Rll4pV#)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() ``` c0V^8dQhR\R\/#)rr?rr)rs"rr&webhook_endpoint..__annotate__sX(rc<a\4oSPS4!V4\SP4^8Xd!\P !SP 4\SP 4V3Rl4pWnV#)ch<\P!SP4SP4R#ru)atexit unregisterrY)appsr _launch_now5webhook_endpoint.._inner.._launch_now$s    cjj ) JJLr)_get_global_apprDrrr/rregisterrYr)r?rrr6s& @r_inner webhook_endpoint.._innersf d# s&& '1 , OOCJJ ' szz     "  r)rCwebhook_endpointrrrD)r6rsf rrrsAl~~!$'' > % %&' Mrc$V^8dQhR\/#)rr)r)rs"rrr0src2\f \4s\#ru) _global_apprrrrrr0s$& rc6V^8dQhR\R,RR/#)rr(Nrr))rs"rrr7s 6 6#* 6 6rcjVf$\R4\R4\R4R#\R4R#)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.)rbrMs&rr0r07s: jk  J   H 45rc<V^8dQhR\R\R\/#)r webhook_namermrr)rs"rrrFs&WWsW#W#WrcPRV,VPRR4,R,#)z@Returns the anchor to a given webhook in the docs (experimental)z/docs#/default/r;rd_post)replace)rrms&&rrlrlFs$ | +l.B.B3.L Lw VVrc<V^8dQhR\R\R\/#)rr?r(r)rr))rs"rrrKs!---#-(-rcraaa\P!S4o\S4RVVV3Rll4pRSP9dtSP \P !R\P P \R73\SPP44,R7Vn V#)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. c$V^8dQhR\/#)rrequestr )rs"rr3_wrap_webhook_to_check_secret..__annotate__]s""w"rc*<"VPPR4pVf\RR/RR7#VS8wd\RR/RR7#RSP9dWR&\P !S4'dS!R /VBGRjxL #S!R /VB#L 5i) zx-webhook-secretNerrorz x-webhook-secret header not set.i) status_codezInvalid webhook secret.irr)headersr^r parametersinspectiscoroutinefunction)rr"request_secretr? initial_sigr(s&, r_protected_func6_wrap_webhook_to_check_secret.._protected_func\s ,,-?@  !*L M[^_ _ ^ +*C DRUV V  .. . '9   & &t , ,' '>&> !(sA5B9 BB Br)namekind annotation)r) r signaturerrr ParameterPOSITIONAL_OR_KEYWORDr tuplevalues __signature__)r?r(rrsff @rr\r\Ks##D)K 4["""$ ...(3(;(;!!yw7H7H7^7^krsK**11345)<) % rcNV^8dQh/^\9d\R,;R&#)rrr)__conditional_annotations__r)rs"rrrs!YY0/.X& '.1Zrru)#rryrrr-collections.abcr functoolsrtypingrrrutilsrr r rorsfastapir r fastapi.responsesrrr]r^rXrrrr0rlr\r)rs@rrsZ  $//JJ(.(,+G+g +/ . JJNN: &$ . tttnJJZ 6W -r