组件
UploadButton

Gradio 新手？从这里开始：入门指南

Timer

Video

UploadButton

gradio.UploadButton(···)

import gradio as gr def upload_file(files): file_paths = [file.name for file in files] return file_paths with gr.Blocks() as demo: file_output = gr.File() upload_button = gr.UploadButton("点击上传图片或视频文件", file_types=["image", "video"], file_count="multiple") upload_button.upload(upload_file, upload_button, file_output) demo.launch()

描述

用于创建上传按钮，点击后允许用户上传满足指定文件类型的文件，或者通用文件（如果未设置 file_type）。

行为

作为输入组件: 传递文件作为 `str` 或 `bytes` 对象，或者 `str` 列表或 `bytes` 对象列表，具体取决于 `type` 和 `file_count`。

您的函数应接受以下类型之一

def predict(
	value: bytes | str | list[bytes] | list[str] | None
)
	...

作为输出组件: 期望 `str` 文件路径或 URL，或 `list[str]` 文件路径/URL 列表。

您的函数应返回以下类型之一

def predict(···) -> str | list[str] | None
	...	
	return value

初始化

🔗

label: str

default = "Upload a File"

按钮上显示的文本。默认为“上传文件”。

🔗

value: str | list[str] | Callable | None

default = None

默认上传的文件或文件列表。

🔗

every: Timer | float | None

default = None

如果 `value` 是函数，则持续调用 `value` 以重新计算（否则无效）。可以提供一个 Timer，其刻度重置 `value`，或者提供一个浮点数，作为重置 Timer 的固定间隔。

🔗

inputs: Component | list[Component] | set[Component] | None

default = None

如果 `value` 是函数，则用作计算 `value` 的输入的组件（否则无效）。每当输入发生更改时，都会重新计算 `value`。

🔗

variant: Literal['primary', 'secondary', 'stop']

default = "secondary"

“primary”表示主要行动号召，“secondary”表示更柔和的样式，“stop”表示停止按钮。

🔗

visible: bool

default = True

如果为 False，组件将被隐藏。

🔗

size: Literal['sm', 'md', 'lg']

default = "lg"

按钮的大小。可以是“sm”、“md”或“lg”。

🔗

icon: str | None

default = None

要在按钮内显示的图标文件的 URL 或路径。如果为 None，则不显示图标。

🔗

scale: int | None

default = None

相对于相邻组件的相对大小。例如，如果组件 A 和 B 在同一行中，并且 A 的 scale=2，而 B 的 scale=1，则 A 的宽度是 B 的两倍。应为整数。scale 应用于行，以及 Blocks 中 fill_height=True 的顶级组件。

🔗

min_width: int | None

default = None

最小像素宽度，如果屏幕空间不足以满足此值，则会换行。如果某个 scale 值导致此组件比 min_width 更窄，则首先遵循 min_width 参数。

🔗

interactive: bool

default = True

如果为 False，则 UploadButton 将处于禁用状态。

🔗

elem_id: str | None

default = None

一个可选字符串，用作此组件在 HTML DOM 中的 id。可用于定位 CSS 样式。

🔗

elem_classes: list[str] | str | None

default = None

一个可选的字符串列表，用作此组件在 HTML DOM 中的类。可用于定位 CSS 样式。

🔗

render: bool

default = True

如果为 False，则组件不会在 Blocks 上下文中呈现。如果目的是现在分配事件侦听器，但稍后呈现组件，则应使用此选项。

🔗

key: int | str | None

default = None

如果已分配，将用于在重新渲染时假定身份。在重新渲染中具有相同 key 的组件将保留其值。

🔗

type: Literal['filepath', 'binary']

default = "filepath"

组件返回的值的类型。“file”返回一个临时文件对象，其基本名称与上传的文件相同，可以通过 file_obj.name 检索其完整路径，“binary”返回一个 bytes 对象。

🔗

file_count: Literal['single', 'multiple', 'directory']

default = "single"

如果为 single，则允许用户上传一个文件。如果为“multiple”，则用户上传多个文件。如果为“directory”，则用户上传所选目录中的所有文件。对于“multiple”或“directory”的情况，返回类型将是每个文件的列表。

🔗

file_types: list[str] | None

default = None

要上传的文件类型列表。“file”允许上传任何文件，“image”仅允许上传图像文件，“audio”仅允许上传音频文件，“video”仅允许上传视频文件，“text”仅允许上传文本文件。

快捷方式

类	Interface 字符串快捷方式	初始化
`gradio.UploadButton`	"uploadbutton"	使用默认值

演示

from pathlib import Path import gradio as gr def upload_file(filepath): name = Path(filepath).name return [gr.UploadButton(visible=False), gr.DownloadButton(label=f"下载 {name}", value=filepath, visible=True)] def download_file(): return [gr.UploadButton(visible=True), gr.DownloadButton(visible=False)] with gr.Blocks() as demo: gr.Markdown("首先上传一个文件，然后你就可以下载它了（但只能下载一次！）") with gr.Row(): u = gr.UploadButton("上传文件", file_count="single") d = gr.DownloadButton("下载文件", visible=False) u.upload(upload_file, u, [u, d]) d.click(download_file, None, [u, d]) if __name__ == "__main__": demo.launch()

from pathlib import Path
import gradio as gr

def upload_file(filepath):
    name = Path(filepath).name
    return [gr.UploadButton(visible=False), gr.DownloadButton(label=f"Download {name}", value=filepath, visible=True)]

def download_file():
    return [gr.UploadButton(visible=True), gr.DownloadButton(visible=False)]

with gr.Blocks() as demo:
    gr.Markdown("First upload a file and and then you'll be able download it (but only once!)")
    with gr.Row():
        u = gr.UploadButton("Upload a file", file_count="single")
        d = gr.DownloadButton("Download the file", visible=False)

    u.upload(upload_file, u, [u, d])
    d.click(download_file, None, [u, d])

if __name__ == "__main__":
    demo.launch()

import gradio as gr def upload_file(files): file_paths = [file.name for file in files] return file_paths with gr.Blocks() as demo: file_output = gr.File() upload_button = gr.UploadButton("点击上传文件", file_types=["image", "video"], file_count="multiple") upload_button.upload(upload_file, upload_button, file_output) demo.launch()

import gradio as gr

def upload_file(files):
    file_paths = [file.name for file in files]
    return file_paths

with gr.Blocks() as demo:
    file_output = gr.File()
    upload_button = gr.UploadButton("Click to Upload a File", file_types=["image", "video"], file_count="multiple")
    upload_button.upload(upload_file, upload_button, file_output)

demo.launch()

事件侦听器

描述

事件侦听器允许您响应用户与 Gradio Blocks 应用程序中定义的 UI 组件的交互。当用户与元素交互时（例如更改滑块值或上传图像），将调用一个函数。

支持的事件侦听器

UploadButton 组件支持以下事件侦听器。每个事件侦听器都采用相同的参数，这些参数在下面的事件参数表中列出。

侦听器	描述
`UploadButton.click(fn, ···)`	当 UploadButton 被点击时触发。
`UploadButton.upload(fn, ···)`	当用户将文件上传到 UploadButton 时触发此侦听器。

事件参数

🔗

fn: Callable | None | Literal['decorator']

default = "decorator"

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

🔗

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

default = None

用作输入的 gradio.components 列表。如果函数不接受任何输入，则应为空列表。

🔗

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

default = None

用作输出的 gradio.components 列表。如果函数不返回任何输出，则应为空列表。

🔗

api_name: str | None | Literal[False]

default = None

定义端点在 API 文档中的显示方式。可以是字符串、None 或 False。如果设置为字符串，则端点将以给定的名称在 API 文档中公开。如果为 None（默认），则函数的名称将用作 API 端点。如果为 False，则端点不会在 API 文档中公开，下游应用程序（包括 `gr.load` 此应用程序的应用程序）将无法使用此事件。

🔗

scroll_to_output: bool

default = False

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

🔗

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

default = "full"

事件运行时如何显示进度动画：“full”显示一个覆盖输出组件区域的微调器，以及右上角的一个运行时显示，“minimal”仅显示运行时显示，“hidden”不显示任何进度动画

🔗

show_progress_on: Component | list[Component] | None

default = None

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

🔗

queue: bool

default = True

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

🔗

batch: bool

default = False

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

🔗

max_batch_size: int

default = 4

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

🔗

preprocess: bool

default = True

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

🔗

postprocess: bool

default = True

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

🔗

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

default = None

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

🔗

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

default = None

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

🔗

js: str | Literal[True] | None

default = None

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

🔗

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

default = "default"

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

🔗

concurrency_id: str | None

default = None

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

🔗

show_api: bool

default = True

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

🔗