构建演示
Blocks

使用我们的文档 MCP

刚开始使用 Gradio？从这里开始：入门指南

TabbedInterface

渲染

Blocks

with gradio.Blocks():

描述

Blocks 是 Gradio 的低级 API，它允许您创建比 Interfaces 更自定义的 Web 应用程序和演示（但仍然完全在 Python 中）。

与 Interface 类相比，Blocks 在以下方面提供了更大的灵活性和控制：(1) 组件的布局 (2) 触发函数执行的事件 (3) 数据流（例如，输入可以触发输出，输出可以触发下一级输出）。Blocks 还提供了将相关演示分组的方法，例如使用选项卡。

Blocks 的基本用法如下：创建 Blocks 对象，然后将其用作上下文（使用 "with" 语句），然后在 Blocks 上下文中定义布局、组件或事件。最后，调用 launch() 方法来启动演示。

示例用法

import gradio as gr
def update(name):
    return f"Welcome to Gradio, {name}!"

with gr.Blocks() as demo:
    gr.Markdown("Start typing below and then click **Run** to see the output.")
    with gr.Row():
        inp = gr.Textbox(placeholder="What is your name?")
        out = gr.Textbox()
    btn = gr.Button("Run")
    btn.click(fn=update, inputs=inp, outputs=out)

demo.launch()

初始化

🔗

analytics_enabled: bool | None

默认 = None

是否允许基本遥测。如果为 None，将使用 GRADIO_ANALYTICS_ENABLED 环境变量或默认为 True。

🔗

mode: str

默认值 = "blocks"

为正在创建的 Blocks 或 Interface 类型提供一个易于人类理解的名称。在内部用于分析。

🔗

title: str | I18nData

默认值 = "Gradio"

在浏览器窗口中打开时显示的选项卡标题。

🔗

fill_height: bool

默认 = False

是否将顶级子组件垂直扩展到窗口高度。如果为 True，则当子组件的 scale 值 >= 1 时发生扩展。

🔗

fill_width: bool

默认 = False

是否水平扩展以完全填充容器。如果为 False，则居中并限制应用程序的最大宽度。仅当这是 Gradio 应用程序中最外层的 `Blocks` 时才适用。

🔗

delete_cache: tuple[int, int] | None

默认 = None

一个元组，对应 [频率, 存活时间]，两者均以秒为单位表示。每隔 `frequency` 秒，如果自文件创建以来已超过 `age` 秒，则将删除此 Blocks 实例创建的临时文件。例如，将其设置为 (86400, 86400) 将每天删除临时文件。服务器重新启动时将完全删除缓存。如果为 None，则不会发生缓存删除。

演示

方法

启动

gradio.Blocks.launch(···)

描述

启动一个简单的 Web 服务器来提供演示服务。也可以通过设置 share=True 来创建一个可供任何人从其浏览器访问演示的公共链接。

使用示例

import gradio as gr
def reverse(text):
    return text[::-1]
with gr.Blocks() as demo:
    button = gr.Button(value="Reverse")
    button.click(reverse, gr.Textbox(), gr.Textbox())
demo.launch(share=True, auth=("username", "password"))

🔗

inline: bool | None

默认 = None

是否在 iframe 中内联显示 gradio 应用程序。在 Python notebook 中默认为 True；否则为 False。

🔗

inbrowser: bool

默认 = False

是否在默认浏览器中自动在新选项卡中启动 gradio 应用程序。

🔗

share: bool | None

默认 = None

是否为 gradio 应用程序创建可公开共享的链接。创建一个 SSH 隧道，使您的 UI 可以从任何地方访问。如果未提供，默认情况下每次都设置为 False，但在 Google Colab 中运行时除外。当 localhost 不可访问时（例如 Google Colab），不支持设置 share=False。可以通过环境变量 GRADIO_SHARE=True 进行设置。

🔗

debug: bool

默认 = False

如果为 True，则阻止主线程运行。如果在 Google Colab 中运行，需要此选项才能在单元格输出中打印错误。

🔗

max_threads: int

默认 = 40

Gradio 应用程序可以并行生成的总线程数上限。默认值继承自 starlette 库（目前为 40）。

🔗

auth: Callable[[str, str], bool] | tuple[str, str] | list[tuple[str, str]] | None

默认 = None

如果提供，访问应用程序需要用户名和密码（或用户名-密码元组列表）。也可以提供一个函数，该函数接受用户名和密码并返回 True（如果登录有效）。

🔗

auth_message: str | None

默认 = None

如果提供，在登录页面上提供的 HTML 消息。

🔗

prevent_thread_lock: bool

默认 = False

默认情况下，Gradio 应用程序在服务器运行时会阻塞主线程。如果设置为 True，Gradio 应用程序将不会阻塞，并且 Gradio 服务器将在脚本完成后立即终止。

🔗

show_error: bool

默认 = False

如果为 True，gradio 应用程序中的任何错误将显示在警报模态框中并打印在浏览器控制台日志中。它们也将显示在 gr.load() 此应用程序的下游应用程序的警报模态框中。

🔗

server_name: str | None

默认 = None

要使应用程序在本地网络上可访问，请将其设置为 "0.0.0.0"。可以通过环境变量 GRADIO_SERVER_NAME 进行设置。如果为 None，将使用 "127.0.0.1"。

🔗

server_port: int | None

默认 = None

将在此端口启动 gradio 应用程序（如果可用）。可以通过环境变量 GRADIO_SERVER_PORT 进行设置。如果为 None，将从 7860 开始搜索可用端口。

🔗

height: int

默认 = 500

包含 gradio 应用程序的 iframe 元素的高度（以像素为单位）（在 inline=True 时使用）

🔗

width: int | str

默认值 = "100%"

包含 gradio 应用程序的 iframe 元素的宽度（以像素为单位）（在 inline=True 时使用）

🔗

favicon_path: str | Path | None

默认 = None

如果提供了文件路径（.png、.gif 或 .ico），它将用作网页的图标。

🔗

ssl_keyfile: str | None

默认 = None

如果提供了文件路径，将使用此文件作为私钥文件来创建在 https 上运行的本地服务器。

🔗

ssl_certfile: str | None

默认 = None

如果提供了文件路径，将使用此文件作为 https 的签名证书。如果提供了 ssl_keyfile，则需要提供此文件。

🔗

ssl_keyfile_password: str | None

默认 = None

如果提供了密码，将与 ssl 证书一起用于 https。

🔗

ssl_verify: bool

默认 = True

如果为 False，则跳过证书验证，允许使用自签名证书。

🔗

quiet: bool

默认 = False

如果为 True，则禁止大多数打印语句。

🔗

footer_links: list[Literal['api', 'gradio', 'settings'] | dict[str, str]] | None

默认 = None

要显示在应用程序页脚中的链接。接受一个列表，列表中的每个元素必须是“api”、“gradio”或“settings”之一，分别对应 API 文档、“built with Gradio”和设置页面。如果为 None，则在页脚中显示所有三个链接。空列表表示不显示页脚。

🔗

allowed_paths: list[str] | None

默认 = None

允许 Gradio 提供服务的完整文件路径或父目录列表。必须是绝对路径。警告：如果您提供目录，这些目录或其子目录中的任何文件都可供应用程序的所有用户访问。可以通过逗号分隔的环境变量 GRADIO_ALLOWED_PATHS 进行设置。这些文件通常被认为是安全的，并且在可能的情况下会显示在浏览器中。

🔗

blocked_paths: list[str] | None

默认 = None

不允许 Gradio 提供服务的完整文件路径或父目录列表（即，不允许应用程序的用户访问）。必须是绝对路径。警告：优先于 `allowed_paths` 和 Gradio 默认公开的所有其他目录。可以通过逗号分隔的环境变量 GRADIO_BLOCKED_PATHS 进行设置。

🔗

root_path: str | None

默认 = None

应用程序的根路径（或“挂载点”），如果它不是从域的根目录 ("/") 提供服务。当应用程序位于反向代理后面并将请求转发到应用程序时，通常会使用此功能。例如，如果应用程序在 "https://example.com/myapp" 提供服务，则 `root_path` 应设置为 "/myapp"。可以提供以 http:// 或 https:// 开头的完整 URL，它将作为完整的根路径使用。可以通过环境变量 GRADIO_ROOT_PATH 进行设置。默认为 ""。

🔗

app_kwargs: dict[str, Any] | None

默认 = None

要传递给底层 FastAPI 应用程序的附加关键字参数，作为参数键和参数值的字典。例如，`{"docs_url": "/docs"}`

🔗

state_session_capacity: int

默认值 = 10000

存储在内存中的会话信息最大数量。如果会话数超过此数量，则将删除最旧的会话。使用 gradio.State 或从函数返回更新的组件时，减少容量以减少内存使用量。默认为 10000。

🔗

share_server_address: str | None

默认 = None

用于指定用于共享 Gradio 应用程序的自定义 FRP 服务器和端口（仅当 share=True 时适用）。如果未提供，将使用 https://gradio.live 上的默认 FRP 服务器。有关详细信息，请参阅 https://github.com/huggingface/frp。

🔗

share_server_protocol: Literal['http', 'https'] | None

默认 = None

用于指定用于共享链接的协议。默认为 "https"，除非提供了自定义 share_server_address，在这种情况下，它默认为 "http"。如果您正在使用自定义 share_server_address 并希望使用 https，则必须将其设置为 "https"。

🔗

share_server_tls_certificate: str | None

默认 = None

连接到自定义共享服务器时使用的 TLS 证书文件的路径。此参数不用于 https://gradio.live 上的默认 FRP 服务器。否则，您必须提供相对于当前工作目录的有效 TLS 证书文件（例如 "cert.pem"），否则连接将不使用 TLS 加密，这是不安全的。

🔗

auth_dependency: Callable[[fastapi.Request], str | None] | None

默认 = None

一个函数，接受 FastAPI 请求并返回字符串用户 ID 或 None。如果函数对于特定请求返回 None，则该用户无权访问应用程序（他们将看到 401 Unauthorized 响应）。用于外部身份验证系统（如 OAuth）。不能与 `auth` 一起使用。

🔗

max_file_size: str | int | None

默认 = None

可以上传的最大文件大小（以字节为单位）。可以是一个形式为 `` 的字符串，其中 value 是任何正整数，unit 是“b”、“kb”、“mb”、“gb”、“tb”之一。如果为 None，则不设置限制。

🔗

enable_monitoring: bool | None

默认 = None

通过 /monitoring 端点启用应用程序的流量监控。默认值为 None，这会启用此端点。如果明确设置为 True，还会将监控 URL 打印到控制台。如果为 False，则完全禁用监控。

🔗

strict_cors: bool

默认 = True

如果为 True，则阻止外部域向在 localhost 上运行的 Gradio 服务器发出请求。如果为 False，则允许源自 localhost（但也允许源自 "null"）的请求访问 localhost。此参数通常应为 True 以防止 CSRF 攻击，但在使用 web components 嵌入*本地运行的 Gradio 应用程序*时可能需要为 False。

🔗

node_server_name: str | None

默认 = None

🔗

node_port: int | None

默认 = None

🔗

ssr_mode: bool | None

默认 = None

如果为 True，Gradio 应用程序将以服务器端渲染模式渲染，这通常性能更高并提供更好的 SEO，但这需要系统上安装 Node 20+。如果为 False，应用程序将以客户端渲染模式渲染。如果为 None，将使用 GRADIO_SSR_MODE 环境变量或默认为 False。

🔗

pwa: bool | None

默认 = None

如果为 True，Gradio 应用程序将设置为可安装的 PWA（Progressive Web App）。如果设置为 None（默认行为），则如果此 Gradio 应用程序在 Spaces 上启动，则 PWA 功能将启用，否则不启用。

🔗

mcp_server: bool | None

默认 = None

如果为 True，Gradio 应用程序将设置为 MCP 服务器，并且文档化的函数将作为 MCP 工具添加。如果为 None（默认行为），则将使用 GRADIO_MCP_SERVER 环境变量来确定是否应启用 MCP 服务器。

🔗

i18n: I18n | None

默认 = None

包含自定义翻译的 I18n 实例，用于翻译组件中的字符串（例如组件的标签或 Markdown 字符串）。此功能只能用于翻译前端中的静态文本，而不能翻译后端中的值。

🔗

theme: Theme | str | None

默认 = None

Theme 对象或表示主题的字符串。如果为字符串，将查找具有该名称的内置主题（例如“soft”或“default”），或者将尝试从 Hugging Face Hub 加载主题（例如“gradio/monochrome”）。如果为 None，将使用 Default 主题。

🔗

css: str | None

默认 = None

自定义 CSS 作为代码字符串。此 CSS 将包含在演示网页中。

🔗

css_paths: str | Path | list[str | Path] | None

默认 = None

自定义 CSS 作为 pathlib.Path 到 CSS 文件或此类路径的列表。这些 CSS 文件将被读取、连接并包含在演示网页中。如果还设置了 `css` 参数，则 `css` 中的 CSS 将首先包含。

🔗

js: str | Literal[True] | None

默认 = None

作为代码字符串的自定义 js。js 代码将在页面加载时自动执行。为了获得更大的灵活性，请使用 head 参数将 js 插入到 <script> 标签内。

🔗

head: str | None

默认 = None

自定义 HTML 代码，用于插入到演示网页的 head 部分。可用于向页面添加自定义元标签、多个脚本、样式表等。

🔗

head_paths: str | Path | list[str | Path] | None

默认 = None

自定义 HTML 代码作为 pathlib.Path 到 HTML 文件或此类路径的列表。这些 HTML 文件将被读取、连接并包含在演示网页的 head 部分。如果还设置了 `head` 参数，则 `head` 中的 HTML 将首先包含。

队列

gradio.Blocks.queue(···)

描述

通过启用队列，您可以控制用户何时知道他们在队列中的位置，并设置允许的最大事件数。

使用示例

with gr.Blocks() as demo:
    button = gr.Button(label="Generate Image")
    button.click(fn=image_generator, inputs=gr.Textbox(), outputs=gr.Image())
demo.queue(max_size=10)
demo.launch()

🔗

status_update_rate: float | Literal['auto']

默认 = "auto"

如果为 "auto"，则每当作业完成时，队列将向所有客户端发送状态估算。否则，队列将以该参数设置的秒数间隔发送状态。

🔗

api_open: bool | None

默认 = None

如果为 True，后端的 REST 路由将打开，允许直接向这些端点发出的请求跳过队列。

🔗

max_size: int | None

默认 = None

队列在任何给定时刻存储的最大事件数。如果队列已满，则不会添加新事件，用户将收到队列已满的消息。如果为 None，则队列大小将不受限制。

🔗

default_concurrency_limit: int | None | Literal['not_set']

默认值 = "not_set"

用于未指定值的事件侦听器的 `concurrency_limit` 默认值。可以通过环境变量 GRADIO_DEFAULT_CONCURRENCY_LIMIT 进行设置。如果未设置，则默认为 1。

集成

gradio.Blocks.integrate(···)

描述

一种与其他库集成的包罗万象的方法。此方法应在 launch() 之后运行

🔗

comet_ml: <class 'inspect._empty'>

默认 = None

如果提供了 comet_ml Experiment 对象，将与 experiment 集成并出现在 Comet 面板上

🔗

wandb: ModuleType | None

默认 = None

如果提供了 wandb 模块，将与它集成并出现在 WandB 面板上

🔗

mlflow: ModuleType | None

默认 = None

如果提供了 mlflow 模块，将与 experiment 集成并出现在 ML Flow 面板上

加载

gradio.Blocks.load(block, ···)

描述

当 Blocks 在浏览器中初始加载时触发此侦听器。

🔗

block: Block | None

🔗

fn: Callable | 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

默认 = None

定义该端点在 API 文档中如何显示。可以是字符串或 None。如果设置为字符串，则该端点将在 API 文档中以给定名称显示。如果为 None（默认），则使用函数的名称作为 API 端点。

🔗

api_description: str | None | Literal[False]

默认 = None

API 端点的描述。可以是字符串、None 或 False。如果设置为字符串，则该端点将在 API 文档中以给定描述显示。如果为 None，则使用函数的 docstring 作为 API 端点描述。如果为 False，则 API 文档中不会显示任何描述。

🔗

scroll_to_output: bool

默认 = False

完成后是否滚动到输出组件

🔗

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' 和 'outputs' 的值，返回值应为输出组件的值列表。

🔗

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` 的限制。

🔗

api_visibility: Literal['public', 'private', 'undocumented']

默认 = "public"

控制此端点的可见性和可访问性。可以是 "public"（在 API 文档中显示并可由客户端调用）、"private"（在 API 文档中隐藏，不可由客户端调用）或 "undocumented"（在 API 文档中隐藏，但可由客户端通过 gr.load 调用）。如果 fn 为 None，则 api_visibility 将自动设置为 "private"。

🔗

time_limit: int | None

默认 = None

🔗

stream_every: float

默认 = 0.5

🔗

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

默认 = None

此事件监听器的唯一键，用于 @gr.render()。如果设置，此值标识在重渲染时具有相同键的事件为相同的事件。

🔗

validator: Callable | None

默认 = None

可选的验证函数，在主函数运行之前执行。如果提供，此函数将首先使用 queue=False 执行，只有在成功完成后才会调用主函数。验证器接收与主函数相同的输入，并应为每个输入值返回一个 `gr.validate()`。

卸载

gradio.Blocks.unload(fn, ···)

描述

当用户关闭或刷新选项卡时触发此侦听器，结束用户会话。这对于在应用程序关闭时清理资源很有用。

使用示例

import gradio as gr
with gr.Blocks() as demo:
    gr.Markdown("# When you close the tab, hello will be printed to the console")
    demo.unload(lambda: print("hello"))
demo.launch()

🔗

fn: Callable[..., Any]

要运行以清除资源的可调用函数。该函数不应接受任何参数，并且不使用输出。

←

TabbedInterface

渲染

→

构建演示

Blocks 布局

组件

助手

Modals

Routes

其他

Blocks

描述

示例用法

初始化

演示

方法

启动

描述

使用示例

队列

描述

使用示例

集成

描述

加载

描述

卸载

描述

使用示例