组件
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

默认值 = "**/*"

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

🔗

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

默认值 = None

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

🔗

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

默认值 = "multiple"

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

🔗

root_dir: str | Path

默认值 = "."

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

🔗

ignore_glob: str | None

默认值 = None

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

🔗

label: str | I18nData | None

默认值 = None

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

🔗

every: Timer | float | None

默认值 = None

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

🔗

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

默认值 = None

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

🔗

show_label: bool | None

默认值 = None

如果为 True，将显示标签。

🔗

container: bool

默认值 = True

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

🔗

scale: int | None

默认值 = None

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

🔗

min_width: int

默认值 = 160

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

🔗

height: int | str | None

默认值 = None

文件组件的最大高度，如果传递数字则以像素为单位指定，如果传递字符串则以 CSS 单位指定。如果上传的文件超出高度限制，将出现滚动条。

🔗

max_height: int | str | None

默认值 = 500

🔗

min_height: int | str | None

默认值 = None

🔗

interactive: bool | None

默认值 = None

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

🔗

visible: bool

默认值 = True

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

🔗

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 中被保留（如果它们已被用户或事件监听器更改），而不是根据构造函数中提供的值重新渲染。

快捷方式

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

事件监听器

描述

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

支持的事件监听器

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

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

事件参数

🔗

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

在运行 'fn' 之前可选运行的前端 js 方法。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 应用程序的“查看 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()。如果设置，当键相同时，此值将标识事件在重新渲染之间是相同的。

←

File

Gallery

→

FileExplorer

描述

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

行为

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

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

作为输出组件: 期望函数返回一个文件路径的 str，或由文件路径组成的 list[str]。

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

初始化

快捷方式

事件监听器

描述

支持的事件监听器

事件参数

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

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