组件
文件

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

DuplicateButton

FileExplorer

文件

gradio.File(···)

import gradio as gr with gr.Blocks() as demo: gr.File() demo.launch()

描述

创建一个文件组件，允许上传一个或多个通用文件（当用作输入时）或显示通用文件或 URL 以供下载（作为输出）。
演示：zip_files, zip_to_json

行为

作为输入组件: 将文件作为 `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

初始化

🔗

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

default = None

要显示的默认文件，以 str 文件路径或 URL，或 str 文件路径/URL 列表的形式给出。如果提供函数，则每次加载应用程序时都会调用该函数以设置此组件的初始值。

🔗

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

default = "single"

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

🔗

file_types: list[str] | None

default = None

要上传的文件扩展名或文件类型列表（例如 ['image', '.json', '.mp4']）。"file" 允许上传任何文件，"image" 仅允许上传图像文件，"audio" 仅允许上传音频文件，"video" 仅允许上传视频文件，"text" 仅允许上传文本文件。

🔗

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

default = "filepath"

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

🔗

label: str | None

default = None

此组件的标签。显示在组件上方，如果此组件有示例表，则也用作标题。如果为 None 且在 `gr.Interface` 中使用，则标签将是此组件分配到的参数的名称。

🔗

every: Timer | float | None

default = None

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

🔗

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

default = None

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

🔗

show_label: bool | None

default = None

如果为 True，将显示标签。

🔗

container: bool

default = True

如果为 True，则将组件放置在容器中 - 在边框周围提供一些额外的填充。

🔗

scale: int | None

default = None

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

🔗

min_width: int

default = 160

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

🔗

height: int | str | float | None

default = None

当未上传文件时，文件组件的默认高度，或当文件存在时，文件组件的最大高度。如果传递数字，则以像素为单位指定，如果传递字符串，则以 CSS 单位指定。如果上传的文件多于高度可以容纳的文件，则会出现滚动条。

🔗

interactive: bool | None

default = None

如果为 True，将允许用户上传文件；如果为 False，则只能用于显示文件。如果未提供，则根据组件是用作输入还是输出进行推断。

🔗

visible: bool

default = True

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

🔗

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

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

🔗

allow_reordering: bool

default = False

如果为 True，将允许用户通过拖放重新排序上传的文件。

快捷方式

类	Interface 字符串快捷方式	初始化
`gradio.File`	"file"	使用默认值
`gradio.Files`	"files"	使用 file_count="multiple"

事件监听器

描述

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

支持的事件监听器

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

监听器	描述
`File.change(fn, ···)`	当 File 的值由于用户输入（例如，用户在文本框中键入）或函数更新（例如，图像接收来自事件触发器的值）而更改时触发。有关仅由用户输入触发的侦听器，请参阅 `.input()`。
`File.select(fn, ···)`	用户选择或取消选择 File 时的事件侦听器。使用事件数据 gradio.SelectData 来传递 `value`，该值引用 File 的标签，以及 `selected`，该值引用 File 的状态。请参阅 EventData 文档，了解如何使用此事件数据
`File.clear(fn, ···)`	当用户使用组件的清除按钮清除 File 时，将触发此侦听器。
`File.upload(fn, ···)`	当用户将文件上传到 File 中时，将触发此侦听器。
`File.delete(fn, ···)`	当用户从 File 中删除项目时，将触发此侦听器。使用事件数据 gradio.DeletedFileData 来传递 `value`，该值引用作为 FileData 实例删除的文件。请参阅 EventData 文档，了解如何使用此事件数据
`File.download(fn, ···)`	当用户从 File 下载文件时，将触发此侦听器。使用事件数据 gradio.DownloadData 来传递有关已下载文件的信息，作为 FileData 对象。请参阅 EventData 文档，了解如何使用此事件数据

事件参数

🔗

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。

🔗