组件
DateTime

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

Dataset

DownloadButton

DateTime

gradio.DateTime(···)

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

描述

用于选择日期和（可选）时间的组件。

行为

作为输入组件: 将文本值作为 `str` 传递到函数中。

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

def predict(
	value: float | datetime | str | None
)
	...

作为输出组件: 期望一个日期时间元组对。

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

def predict(···) -> float | datetime | str | None
	...	
	return value

初始化

🔗

value: float | str | datetime | None

default = None

日期时间的默认值。

🔗

include_time: bool

default = True

如果为 True，组件将包含时间选择。如果为 False，则仅提供日期选择。

🔗

type: Literal['timestamp', 'datetime', 'string']

default = "timestamp"

值的类型。可以是 "timestamp"、"datetime" 或 "string"。如果为 "timestamp"，则该值将是一个数字，表示自 epoch 以来的开始和结束日期（以秒为单位）。如果为 "datetime"，则该值将是一个 datetime 对象。如果为 "string"，则该值将是用户输入的日期。

🔗

timezone: str | None

default = None

用于时间戳的时区，例如 "US/Pacific" 或 "Europe/Paris"。如果为 None，则时区将为本地时区。

🔗

label: str | None

default = None

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

🔗

show_label: bool | None

default = None

如果为 True，将显示标签。

🔗

info: str | None

default = None

附加组件描述，显示在标签下方，字体较小。支持 markdown / HTML 语法。

🔗

every: float | None

default = None

如果 `value` 是可调用的，则在客户端连接打开时，每隔 'every' 秒运行该函数。否则无效。可以通过此组件的 .load_event 属性访问该事件（例如，取消它）。

🔗

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 参数。

🔗

visible: bool

default = True

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

🔗

interactive: bool | None

default = None

🔗

elem_id: str | None

default = None

🔗

elem_classes: list[str] | str | None

default = None

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

🔗

render: bool

default = True

如果为 False，组件将不会在 Blocks 上下文中呈现。如果目的是现在分配事件侦听器，但稍后呈现组件，则应使用此选项。

🔗

key: int | str | None

default = None

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

快捷方式

类	Interface 字符串快捷方式	初始化
`gradio.DateTime`	"datetime"	使用默认值

事件侦听器

描述

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

支持的事件侦听器

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

侦听器	描述
`DateTime.change(fn, ···)`	当 DateTime 的值因用户输入（例如，用户在文本框中键入内容）或函数更新（例如，图像从事件触发器的输出接收值）而更改时触发。有关仅由用户输入触发的侦听器，请参阅 `.input()`。
`DateTime.submit(fn, ···)`	当用户在 DateTime 获得焦点时按下 Enter 键时，将触发此侦听器。

事件参数

🔗

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。

🔗