组件
FileExplorer

初次使用 Gradio? 从这里开始: 快速开始

File

Gallery

FileExplorer

gradio.FileExplorer(···)

描述

创建一个文件浏览器组件，允许用户浏览托管 Gradio 应用程序的机器上的文件。作为输入组件，它还允许用户选择文件作为函数的输入，而作为输出组件，它显示选定的文件。

行为

作为输入组件: 根据 file_count，将选定的文件或目录作为 `str` 路径（相对于 `root`）或 `list[str}` 传递。

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

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

作为输出组件: 期望函数返回文件路径的 `str` 路径，或包含文件路径的 `list[str]`。

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

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

初始化

🔗

glob: str

default = "**/*"

用于选择要显示文件的 glob 样式模式，例如 "*" 匹配所有文件，"*.png" 匹配所有 .png 文件，"**/*.txt" 匹配任何子目录中的任何 .txt 文件等。默认值递归匹配所有文件和文件夹。有关更多信息，请参阅 Python glob 文档：https://docs.pythonlang.cn/3/library/glob.html。

🔗

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

default = None

组件首次加载时要显示为“已选择”的文件（或文件列表，取决于 `file_count` 参数）。如果提供了可调用对象，则将在应用程序加载时调用它以设置组件的初始值。如果未提供，则不显示已选择的文件。

🔗

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

default = "multiple"

是否允许选择单个或多个文件。如果为“single”，组件将返回单个绝对文件路径作为字符串。如果为“multiple”，组件将返回绝对文件路径列表作为字符串列表。

🔗

root_dir: str | Path

default = "."

用于选择文件的根目录路径。如果未提供，则默认为当前工作目录。

🔗

ignore_glob: str | None

default = None

将用于从列表中排除文件的 glob 样式、区分大小写的模式。例如，“*.py” 将从列表中排除所有 .py 文件。有关更多信息，请参阅 Python glob 文档：https://docs.pythonlang.cn/3/library/glob.html。

🔗

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 应用于行，以及 fill_height=True 的 Blocks 中的顶级组件。

🔗

min_width: int

default = 160

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

🔗

height: int | str | None

default = None

文件组件的最大高度，如果传递数字，则以像素为单位指定；如果传递字符串，则以 CSS 单位指定。如果上传的文件超过高度所能容纳的数量，则会出现滚动条。

🔗

max_height: int | str | None

default = 500

🔗

min_height: int | str | None

default = None

🔗

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

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

快捷方式

类	接口字符串快捷方式	初始化
`gradio.FileExplorer`	"fileexplorer"	使用默认值

事件监听器

描述

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

支持的事件监听器

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

监听器	描述
`FileExplorer.change(fn, ···)`

事件参数

🔗

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。

🔗