rPj=jUdZddlZddlZddlZddlmZddlmZddlm Z m Z m Z ddl m Z mZmZe rddlZddlmamadd lmadae d ed <ej2j5d duZe Gd d Ze ddedzdefdZdefdZddZ dedzddfdZ!dededefdZ"dededefdZ#y)zSContains `WebhooksServer` and `webhook_endpoint` to create a webhook server easily.N)Callable)wraps) TYPE_CHECKINGAnyOptional) experimentalis_fastapi_availableis_gradio_availableFastAPIRequest JSONResponseWebhooksServer _global_appSPACE_IDceZdZdZdfd Z ddeddedzddfdZdd edzdefd Z dd e d e ddfd Z 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() ``` returncts tdts tdtt||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 _load_fastapisuper__new__)clsargskwargs __class__s e/home/oem/CyberBrain26-unified/.venv/lib/python3.12/site-packages/huggingface_hub/_webhooks_server.pyrzWebhooksServer.__new__UsK"$ $%  ws##Nui gr.Blockswebhook_secretc||_|xstjd|_i|_t |jy)NWEBHOOK_SECRET)_uiosgetenvr#registered_webhooks_warn_on_empty_secret)selfr!r#s r__init__zWebhooksServer.__init__cs8 ,K :J0K8: d112r pathctrjSttjfd}|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}dxs |jjd}|jvrtd|d|j|<y)Nrz /webhooks//zWebhook z already exists.)__name__stripr) ValueError)rrfuncabs_pathr-r+s r _inner_postz/WebhooksServer.add_webhook.._inner_posts`7D#T%:T]]$A$A#$F#GHH4333 8H:5E!FGG15D $ $X .r )callable add_webhookrr post)r+r-r6s`` rr8zWebhooksServer.add_webhooknsG8 D>%4##%d+ + w||  6  6r prevent_thread_lock launch_kwargsc  |jxs|j}|jdt|jdddi|\|_}}|j jD]I\}}|jt||j}|j j||Ktjjd}|d|zn|jxs |j t!d j#d  d }|d d j% fd |j Dzz }|d z }t'||s|j)yy)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: c3,K|] }d| yw)z - POST N).0webhookurls r z(WebhooksServer.launch..s#g7iuWI$>#gszG Go to https://huggingface.co/settings/webhooks to setup your webhooks.rB)r&_get_default_ui setdefault _is_locallaunch fastapi_appr)itemsr#_wrap_webhook_to_check_secretr9r'environget share_url local_urlr3r2joinprint block_thread) r+r:r;r!_r-r4 space_hostmessagerEs @rrJzWebhooksServer.launchsO XX /--/   )4!*!Ut!U}!U!Q2288: .JD$"".4T$J]J]^ (D   ! !$ ' -  .ZZ^^L1 )3)?j:%bllFbVXVbVb ;vw wiinD4$))#gdNfNf#gggg]] g" OO #r c ddl}|j5}|jd|jd|jt|jddzdj d|jj Dz|jtrd nd ddd|S#1swYSxYw) 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\K|]$\}}d|dt|j|d&yw)z- [z]()N)_get_webhook_doc_urlr1)rC webhook_pathrDs rrFz1WebhooksServer._get_default_ui..s<- g,r*>w?O?OQ]*^)__`as*,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)rRrLrI)r+grr!s rrGzWebhooksServer._get_default_uis RYY[ B BKKC D BKKD  BKKt//011LM**151I1I1O1O1Q  BKKqv  ! 2 3 2 s BB;;C)rr)NNN)F)rr")r1 __module__ __qualname____doc__rrstrr,rr8boolrrJrG __classcell__)rs@rrr$sy-^ $ %)%) 3 [ ! 3d  3  3)d )h)V"$""QU"Hr r-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() ``` r4rctj|tjdk(rt j j tj fd}||_|S)Nrcdtjjjyrb)atexit unregisterrJ)appsr _launch_nowz5webhook_endpoint.._inner.._launch_nows    cjj ) JJLr )_get_global_appr8r`r)rlregisterrJr)r4rornr-s @r_innerz webhook_endpoint.._innersjd# s&& '1 , OOCJJ ' szz     "  r )r7webhook_endpointrrr8r)r-rrs` rrsrssPl~!!$'' > % %&X(' Mr c.t tatSrb)rrrBr rrprp+s$& r c ddlmamaddlmay)Nrr r)fastapir rfastapi.responsesrrBr rrr2s ).r r#cb|"tdtdtdytdy)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.)rSr>s rr*r*9s: jk  J   H 45r webhook_namer\c8d|z|jddzdzS)z@Returns the anchor to a given webhook in the docs (experimental)z/docs#/default/r0rU_post)replace)ryr\s rr[r[Hs$ | +l.B.B3.L Lw VVr r4cftjtdtffd }djvrnj tj dtj jtftjjz|_ |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|jjd}|tddidS|k7rtddidSdjvr||d<t j rd i|d{Sd i|S7 w) Nzx-webhook-secreterrorz x-webhook-secret header not set.i) status_codezInvalid webhook secret.ir~rB)headersrOr parametersinspectiscoroutinefunction)r~rrequest_secretr4 initial_sigr#s r_protected_funcz6_wrap_webhook_to_check_secret.._protected_func^s ,,-?@  !*L M[^_ _ ^ +*C DRUV V  .. . 'F9   & &t ,' '>&> !(sA4B7B8 B)namekind annotation)r) r signaturerrrr| ParameterPOSITIONAL_OR_KEYWORDtuplevalues __signature__)r4r#rrs`` @rrMrMMs##D)K 4["w""$ ...(3(;(;!!yw7H7H7^7^krsK**11345)<) % r rb)rN)$rerlrr'collections.abcr functoolsrtypingrrrutilsr r r r]rarvr rrwrr__annotations__rNrOrIrrfrsrprr*r[rMrBr rrsZ  $//JJ(.+/ X& '. JJNN: &$ . uuupJ3:JJJZ/ 6#* 6 6WsW#W#W --#-(-r