o
e9 @ s U d Z ddlZddlZddlZddlmZ ddlmZmZm Z m
Z
ddl m Z m
Z
er/ddlZddlmZmZ ddlmZ dae
d ed
< ed d kZe G d
d d Ze d de
e defddZdefddZ de
e ddfddZ dededefddZ dededefd d Z dS ) zSContains `WebhooksServer` and `webhook_endpoint` to create a webhook server easily. N)wraps)
TYPE_CHECKINGCallableDictOptional ) experimentalis_gradio_available)FastAPIRequest) JSONResponseWebhooksServer _global_appZSYSTEMspacesc sr e Zd ZdZd fdd Z dded dee ddfd d
Zdd ee defd d
Z dddZ
dddZ Z S )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 `run` 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.
`WebhooksServer` is experimental. Its API is subject to change in the future.
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.run()
```
returnc s t stdt | S )NzjYou must have `gradio` installed to use `WebhooksServer`. Please run `pip install --upgrade gradio` first.)r ImportErrorsuper__new__)clsargskwargs __class__ PD:\Projects\ConvertPro\env\Lib\site-packages\huggingface_hub/_webhooks_server.pyr \ s
zWebhooksServer.__new__Nui gr.Blockswebhook_secretc C s* || _ |p td| _i | _t| j d S )NZWEBHOOK_SECRET)_uiosgetenvr registered_webhooks_warn_on_empty_secret)selfr r r r r __init__d s zWebhooksServer.__init__pathc s0 t r
S ttj fdd}|S )au
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.run()
```
c sF | d }d p |j d }|jv r td| d|j|< d S )Nr z
/webhooks//zWebhook z already exists.)__name__stripr!
ValueError)r r funcabs_pathr% r# r r _inner_post s
z/WebhooksServer.add_webhook.._inner_post)callable add_webhookr r
post)r# r% r- r r, r r/ o s
zWebhooksServer.add_webhookc s | j p| }|jdtd\| _}}| j D ]\}}| jdur't|| jd}| j || q|j
p5|j d d}|dd
fdd | jD 7 }|d
7 }t| | dS ) zIStarts the Gradio app with the FastAPI server and registers the webhooks.T)Zprevent_thread_lockshareNr r& z/
Webhooks are correctly setup and ready to use:
c 3 s | ]
}d | V qdS )z - POST Nr ).0webhookurlr r s z%WebhooksServer.run..zG
Go to https://huggingface.co/settings/webhooks to setup your webhooks.)r _get_default_uiZlaunch _is_localZ fastapi_appr! itemsr _wrap_webhook_to_check_secretr0 Z share_urlZ local_urlr( joinprintZ block_thread)r# r _r% r* messager r6 r run s
" zWebhooksServer.runc C s ddl }| 6}|d |d |t| j dd ddd | j D |tr3d
nd W d |S 1 sAw Y |S ) zLDefault UI if not provided (lists webhooks and provides basic instructions).r Nu) # This is an app to process 🤗 WebhooksaT Webhooks 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
c s s. | ]\}}d | dt |j| dV qdS )z- [z]()N)_get_webhook_doc_urlr' )r4 webhook_pathr5 r r r r8 s
z1WebhooksServer._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! r= r; r: )r# grr r r r r9 s0
z WebhooksServer._get_default_ui)r r
)NNN)r N)r r )
r'
__module__ __qualname____doc__r r strr$ r r/ rA r9
__classcell__r r r r r
% s 5
+r% r c s6 t r t S ttjdtdtf fdd }|S )a Decorator 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.
`webhook_endpoint` is experimental. Its API is subject to change in the future.
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.run()
```
r* r c sN t | t jdkrt j t j fdd}|| _| S )Nr c s t j d S rI )atexit
unregisterrA r Zappr r _run_now s z2webhook_endpoint.._inner.._run_now)_get_global_appr/ rG r! rO registerrA r )r* rR r% rQ r _inner s z webhook_endpoint.._inner)r. webhook_endpointr r
r/ r )r% rV r rU r rW s
<
rW c C s t d u rt a t S rI )r r
r r r r rS ) s rS r c C s0 | d u rt d t d t d d S t d d S )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.)r> r2 r r r r" 0 s r" webhook_namerD c C s d| | dd d S )z@Returns the anchor to a given webhook in the docs (experimental)z/docs#/default/r& r? _post)replace)rX rD r r r rC ? s rC r* c sd t t dtf fdd }djvr0jt jdt jjtdftj d|_
|S )a Wraps 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 s| | j d}|d u rtddiddS |kr tddiddS djv r(| |d< t r7 d i |I d H S d i |S )
Nzx-webhook-secreterrorz x-webhook-secret header not set.i ) status_codezInvalid webhook secret.i r[ r )headersgetr
parametersinspectiscoroutinefunction)r[ r Zrequest_secretr* Z initial_sigr r r _protected_funcU s
z6_wrap_webhook_to_check_secret.._protected_func)namekind
annotation)r` ) ra signaturer r r` rZ ParameterPOSITIONAL_OR_KEYWORDtuplevalues
__signature__)r* r rd r rc r r< D s
r< rI ) rL rO ra r functoolsr typingr r r r utilsr r rE rH Zfastapir
r Zfastapi.responsesr r __annotations__r r: r
rM rW rS r" rC r< r r r r s, 0S