U ʹj8=@s8UdZddlZddlZddlZddlmZddlmZmZm Z m Z m Z ddl m Z mZmZerrddlZddlmZerddlmZmZdd lmZn dZZZdae d ed <ejd dkZe Gd d d Ze de ee dddZedddZe eddddZ eeedddZ!e ee dddZ"dS)zSContains `WebhooksServer` and `webhook_endpoint` to create a webhook server easily.N)wraps) TYPE_CHECKINGAnyCallableDictOptional) experimentalis_fastapi_availableis_gradio_available)Request)FastAPIr ) JSONResponseWebhooksServer _global_appZSPACE_IDcszeZdZdZddfdd Zdedeedddd Zdeeed d d Z de e ddddZ ddddZ ZS)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 setup 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() ``` returncs(tstdtstdt|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___/var/www/html/bwave/python/venv/lib/python3.8/site-packages/huggingface_hub/_webhooks_server.pyr[szWebhooksServer.__new__Nz gr.Blocks)uiwebhook_secretrcCs*||_|ptd|_i|_t|jdS)NZWEBHOOK_SECRET)_uiosgetenvrregistered_webhooks_warn_on_empty_secret)selfrrrrr__init__hszWebhooksServer.__init__pathrcs0trSttjfdd}|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() ``` csF|d}dp|jd}|jkr8td|d|j|<dS)Nrz /webhooks//zWebhook z already exists.)__name__stripr" ValueError)rrfuncabs_pathr'r$rr _inner_posts  z/WebhooksServer.add_webhook.._inner_post)callable add_webhookrr post)r$r'r/rr.rr1ss  zWebhooksServer.add_webhookF)prevent_thread_lock launch_kwargsrc  s|jp |}|dt|jfddi|\|_}}|jD]0\}}|jdk r`t ||jd}|j ||q@t j d}|dk rd|n |jp|jdkrtdd d }|d d fd d |jD7}|d7}t||s|dS)zLaunch the Gradio app and register webhooks to the underlying FastAPI server. Input parameters are forwarded to Gradio when launching the app. Zsharer3TNrZ 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: c3s|]}d|VqdS)z - POST Nr).0webhookurlrr sz(WebhooksServer.launch..zG Go to https://huggingface.co/settings/webhooks to setup your webhooks.)r_get_default_ui setdefault _is_locallaunchZ fastapi_appr"itemsr_wrap_webhook_to_check_secretr2r environgetZ share_urlZ local_urlr+r*joinprintZ block_thread) r$r3r4r_r'r,Z space_hostmessagerr9rr?s$    "zWebhooksServer.launchc Cszddl}|`}|d|d|t|jddddd |jD|trfd nd W5QRX|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 css,|]$\}}d|dt|j|dVqdS)z- [z]()N)_get_webhook_doc_urlr))r7 webhook_pathr8rrrr;sz1WebhooksServer._get_default_ui..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'.)gradioZBlocksMarkdownlenr"rDr@r>)r$grrrrrr<s*    zWebhooksServer._get_default_ui)NN)N)F)r) __module__ __qualname____doc__rrstrr%rr1boolrr?r< __classcell__rrrrr*s/ +$r&cs4trtSttjttdfdd }|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 setup 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() ``` )r,rcsNt|tjdkr.tjtjfdd}||_|S)NrcstjdSN)atexit unregisterr?rZapprr _launch_now$s z5webhook_endpoint.._inner.._launch_now)_get_global_appr1rMr"rVregisterr?r)r,rYr'rXr_inners z webhook_endpoint.._inner)r0webhook_endpointrrr1r)r'r]rr\rr^s 6 r^rcCstdkrtatSrU)rrrrrrrZ0srZ)rrcCs.|dkr"tdtdtdntddS)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.)rEr5rrrr#7sr#) webhook_namerJrcCsd||dddS)z@Returns the anchor to a given webhook in the docs (experimental)z/docs#/default/r(rF_post)replace)r_rJrrrrIFsrI)r,rrcsdtttdfdd }djkr`jtjdtjjtdftj d|_ |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. )requestcsv|jd}|dkr$tddiddS|kr._protected_funcrb)namekind annotation)rf) rg signaturerr rfra ParameterPOSITIONAL_OR_KEYWORDtuplevalues __signature__)r,rrjrrirrAKs   rA)N)#rQrVrgr functoolsrtypingrrrrrutilsr r r rKrNZfastapir r Zfastapi.responsesrr__annotations__rBrCr>rrRr^rZr#rIrArrrrs0   8M