Gradio Agents & MCP 黑客马拉松

获奖者
Gradio logo
  1. 组件
  2. UploadButton

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

查看发布历史

←

计时器

视频

→

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("Click to Upload an Image or Video File", file_types=["image", "video"], file_count="multiple") upload_button.upload(upload_file, upload_button, file_output) demo.launch()

描述

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

行为

作为输入组件: 根据 type 和 file_count，将文件作为 str 或 bytes 对象传递，或者作为 str 列表或 bytes 对象列表传递。

你的函数应该接受这些类型中的一种
def predict(
	value: bytes | str | list[bytes] | list[str] | None
)
	...

作为输出组件: 期望一个 str 文件路径或 URL，或者一个文件路径/URL 的 list[str]。

你的函数应该返回这些类型中的一种
def predict(···) -> str | list[str] | None
	...	
	return value

初始化

参数
🔗 
label: str
默认值 = "Upload a File"

按钮上显示的文本。默认为 "Upload a File"。

🔗 
value: str | I18nData | list[str] | Callable | None
默认值 = None

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

🔗 
every: Timer | float | None
默认值 = None

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

🔗 
inputs: Component | list[Component] | set[Component] | None
默认值 = None

如果 `value` 是一个函数，则用作计算 `value` 的输入组件（否则无效）。只要输入改变，`value` 就会重新计算。

🔗 
variant: Literal['primary', 'secondary', 'stop']
默认值 = "secondary"

'primary' 用于主要操作，'secondary' 用于更柔和的风格，'stop' 用于停止按钮。

🔗 
visible: bool
默认值 = True

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

🔗 
size: Literal['sm', 'md', 'lg']
默认值 = "lg"

按钮的大小。可以是 "sm", "md", 或 "lg"。

🔗 
icon: str | None
默认值 = None

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

🔗 
scale: int | None
默认值 = None

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

🔗 
min_width: int | None
默认值 = None

最小像素宽度，如果屏幕空间不足以满足此值，则会换行。如果某个 scale 值导致组件宽度小于 min_width，则 min_width 参数优先被考虑。

🔗 
interactive: bool
默认值 = True

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

🔗 
elem_id: str | None
默认值 = None

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

🔗 
elem_classes: list[str] | str | None
默认值 = None

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

🔗 
render: bool
默认值 = True

如果为 False，组件将不会在 Blocks 上下文中渲染。如果打算现在分配事件监听器但稍后渲染组件，则应使用此选项。

🔗 
key: int | str | tuple[int | str, ...] | None
默认值 = None

在 gr.render 中，重新渲染时具有相同 key 的组件被视为同一组件，而不是新组件。在 'preserved_by_key' 中设置的属性在重新渲染时不会重置。

🔗 
preserved_by_key: list[str] | str | None
默认值 = "value"

此组件构造函数中的参数列表。在 gr.render() 函数内部，如果一个组件以相同的 key 重新渲染，则这些（且仅这些）参数将在 UI 中保留（如果它们已被用户或事件监听器更改），而不是根据构造函数中提供的值重新渲染。

🔗 
type: Literal['filepath', 'binary']
默认值 = "filepath"

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

🔗 
file_count: Literal['single', 'multiple', 'directory']
默认值 = "single"

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

🔗 
file_types: list[str] | None
默认值 = None

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

快捷方式

类 接口字符串快捷方式 初始化

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"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()

事件监听器

描述

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

支持的事件监听器

UploadButton 组件支持以下事件监听器。每个事件监听器接受相同的参数，这些参数列在下面的事件参数表中。

监听器 描述

UploadButton.click(fn, ···)

当 UploadButton 被点击时触发。

UploadButton.upload(fn, ···)

当用户向 UploadButton 上传文件时触发此监听器。

事件参数

参数
🔗 
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 | Literal[False]
默认值 = None

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

🔗 
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

可选的前端 js 方法，在运行 'fn' 之前运行。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。

🔗 
show_api: bool
默认值 = True

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

🔗 
time_limit: int | None
默认值 = None
🔗 
stream_every: float
默认值 = 0.5
🔗 
like_user_message: bool
默认值 = False
🔗 
key: int | str | tuple[int | str, ...] | None
默认值 = None

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

←

计时器

视频

→