组件
File（文件）

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

DuplicateButton（复制按钮）

FileExplorer（文件浏览器）

File（文件）

gradio.File(···)

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

描述

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

行为

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

您的函数应接受其中一种类型

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

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

您的函数应返回其中一种类型

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

初始化

🔗

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

default（默认） = None

要显示的默认文件，以字符串文件路径或URL，或字符串文件路径/URLs列表的形式给出。如果提供了一个函数，该函数将在每次应用程序加载时被调用，以设置此组件的初始值。

🔗

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”返回一个字节对象。

🔗

label: str | I18nData | 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 在一个 Row 中，A 的 scale=2，B 的 scale=1，那么 A 将是 B 的两倍宽。应为整数。scale 适用于 Rows 中，以及 Blocks 中 fill_height=True 的顶级组件。

🔗

min_width: int

default（默认） = 160

最小像素宽度，如果屏幕空间不足以满足此值，将进行换行。如果某个比例值导致此组件的宽度小于 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 | tuple[int | str, ...] | None

default（默认） = None

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

🔗

preserved_by_key: list[str] | str | None

default（默认） = "value"

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

🔗

allow_reordering: bool

default（默认） = False

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

快捷方式

类	接口字符串快捷方式	初始化
`gradio.File`	"file"	使用默认值
`gradio.Files`	"files"	使用 file_count="multiple"（多文件）

事件监听器

描述

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

支持的事件监听器

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

监听器	描述
`File.change(fn, ···)`	当 File 的值发生变化时触发，无论是由于用户输入（例如用户在文本框中输入）还是由于函数更新（例如图像从事件触发器的输出接收到值）。有关仅由用户输入触发的监听器，请参阅 `.input()`。
`File.select(fn, ···)`	当用户选择或取消选择文件时触发的事件监听器。使用事件数据 gradio.SelectData 来传递 `value`，指代文件的标签，以及 `selected`，指代文件的状态。有关如何使用此事件数据，请参阅 EventData 文档。
`File.clear(fn, ···)`	当用户使用组件的清除按钮清除文件时，会触发此监听器。
`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 表示没有并发限制（任何数量的此事件都可以同时运行）。设置为“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。

🔗

time_limit: int | None

default（默认） = None

🔗

stream_every: float

default（默认） = 0.5

🔗

like_user_message: bool

default（默认） = False

🔗

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

default（默认） = None

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

←

DuplicateButton（复制按钮）

FileExplorer（文件浏览器）

→

File（文件）

描述

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

行为

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

您的函数应接受其中一种类型

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

您的函数应返回其中一种类型

初始化

快捷方式

事件监听器

描述

支持的事件监听器

事件参数

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

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

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