辅助函数
on

Gradio 新手？从这里开始：快速入门

load_chat

set_static_paths

on

gradio.on(···)

描述

设置一个事件监听器，当指定事件发生时触发一个函数。当同一个函数需要由多个事件触发时，这尤其有用。触发器列表中的所有事件只生成一个 API 端点。

用法示例

import gradio as gr

with gr.Blocks() as demo:
    with gr.Row():
        input = gr.Textbox()
        button = gr.Button("Submit")
    output = gr.Textbox()
    gr.on(
        triggers=[button.click, input.submit],
        fn=lambda x: x,
        inputs=[input],
        outputs=[output]
    )

demo.launch()

初始化

🔗

triggers: list[EventListenerCallable] | EventListenerCallable | None

默认值 = None

要监听的触发器列表，例如 [btn.click, number.change]。如果为 None，则将在应用加载和任何输入更改时运行。

🔗

fn: Callable[..., Any] | None | Literal['decorator']

默认值 = "decorator"

当此事件触发时要调用的函数。通常是机器学习模型的预测函数。函数的每个参数对应一个输入组件，函数应返回一个单一值或一个值的元组，其中元组中的每个元素对应一个输出组件。

🔗

inputs: Component | BlockContext | list[Component | BlockContext] | Set[Component | BlockContext] | None

默认值 = None

用作输入的 gradio.components 列表。如果函数没有输入，则应为空列表。

🔗

outputs: Component | BlockContext | list[Component | BlockContext] | Set[Component | BlockContext] | None

默认值 = None

用作输出的 gradio.components 列表。如果函数没有输出，则应为空列表。

🔗

api_name: str | None | Literal[False]

默认值 = None

定义端点在 API 文档中如何显示。可以是字符串、None 或 False。如果为 False，则端点不会在 API 文档中公开。如果设置为 None，将使用函数名作为端点路由。如果设置为字符串，则端点将以给定名称在 API 文档中公开。

🔗

scroll_to_output: bool

默认值 = False

如果为 True，则在完成时将滚动到输出组件。

🔗

show_progress: Literal['full', 'minimal', 'hidden']

默认值 = "full"

事件运行时如何显示进度动画：“full” 显示一个覆盖输出组件区域和右上角运行时显示的小程序，“minimal” 只显示运行时显示，“hidden” 完全不显示进度动画。

🔗

show_progress_on: Component | list[Component] | None

默认值 = None

显示进度动画的组件或组件列表。如果为 None，则将在所有输出组件上显示进度动画。

🔗

queue: bool

默认值 = True

如果为 True，则如果队列已启用，将把请求放入队列。如果为 False，即使队列已启用，也不会将此事件放入队列。如果为 None，将使用 Gradio 应用的队列设置。

🔗

batch: bool

默认值 = False

如果为 True，则函数应处理一批输入，这意味着它应为每个参数接受一个输入值列表。列表的长度应相等（并且最大长度为 `max_batch_size`）。函数然后*必须*返回一个列表元组（即使只有一个输出组件），其中元组中的每个列表对应一个输出组件。

🔗

max_batch_size: int

默认值 = 4

如果从队列调用此事件，则最大批处理输入数量（仅在 batch=True 时相关）

🔗

preprocess: bool

默认值 = True

如果为 False，则在运行 'fn' 之前不会对组件数据进行预处理（例如，如果使用 `Image` 组件调用此方法，则将其保留为 base64 字符串）。

🔗

postprocess: bool

默认值 = True

如果为 False，则在将 'fn' 输出返回到浏览器之前不会对组件数据进行后处理。

🔗

cancels: dict[str, Any] | list[dict[str, Any]] | None

默认值 = None

当此监听器触发时要取消的其他事件列表。例如，设置 cancels=[click_event] 将取消 click_event，其中 click_event 是另一个组件的 .click 方法的返回值。尚未运行的函数（或正在迭代的生成器）将被取消，但当前正在运行的函数将被允许完成。

🔗

trigger_mode: Literal['once', 'multiple', 'always_last'] | None

默认值 = None

如果为“once”（除 `.change()` 之外所有事件的默认值），则在事件待处理期间不允许任何提交。如果设置为“multiple”，则在待处理期间允许无限次提交，而“always_last”（`.change()` 和 `.key_up()` 事件的默认值）将在待处理事件完成后允许第二次提交。

🔗

js: str | Literal[True] | None

默认值 = None

在运行 'fn' 之前运行的可选前端 js 方法。js 方法的输入参数是 'inputs' 的值，返回值应是输出组件的值列表。

🔗

concurrency_limit: int | None | Literal['default']

默认值 = "default"

如果设置，这是可以同时运行的此事件的最大数量。可以设置为 None 表示没有并发限制（此事件的任何数量都可以同时运行）。设置为“default”以使用默认并发限制（由 `Blocks.queue()` 中的 `default_concurrency_limit` 参数定义，其本身默认为 1）。

🔗

concurrency_id: str | None

默认值 = None

如果设置，这是并发组的 ID。具有相同 concurrency_id 的事件将受最低设置的 concurrency_limit 限制。

🔗

show_api: bool

默认值 = True

是否在 Gradio 应用的“查看 API”页面或 Gradio 客户端的 “.view_api()” 方法中显示此事件。与将 api_name 设置为 False 不同，将 show_api 设置为 False 仍然允许下游应用和客户端使用此事件。如果 fn 为 None，show_api 将自动设置为 False。

🔗

time_limit: int | None

默认值 = None

函数运行的时间限制。此参数仅用于 `.stream()` 事件。

🔗

stream_every: float

默认值 = 0.5

流数据块发送到后端的延迟（秒）。默认为 0.5 秒。此参数仅用于 `.stream()` 事件。

🔗

key: int | str | tuple[int | str, ...] | None

默认值 = None

←

load_chat

set_static_paths

→