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

默认值 = None

日期时间默认值。

🔗

include_time: bool

默认值 = True

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

🔗

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

默认值 = "timestamp"

值的类型。可以是 "timestamp"、"datetime" 或 "string"。如果为 "timestamp"，值将是表示纪元秒数中开始和结束日期的数字。如果为 "datetime"，值将是一个 datetime 对象。如果为 "string"，值将是用户输入的日期。

🔗

timezone: str | None

默认值 = None

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

🔗

label: str | I18nData | None

默认值 = None

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

🔗

show_label: bool | None

默认值 = None

如果为 True，将显示标签。

🔗

info: str | I18nData | None

默认值 = None

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

🔗

every: float | None

默认值 = None

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

🔗

scale: int | None

默认值 = None

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

🔗

min_width: int

默认值 = 160

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

🔗

visible: bool

默认值 = True

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

🔗

interactive: bool | None

默认值 = None

🔗

elem_id: str | None

默认值 = None

🔗

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.DateTime`	"datetime"	使用默认值

事件监听器

描述

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

支持的事件监听器

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

监听器	描述
`DateTime.change(fn, ···)`	当 DateTime 的值发生变化时触发，原因可能是用户输入（例如用户在文本框中输入）或函数更新（例如图像从事件触发器的输出接收值）。有关仅由用户输入触发的监听器，请参阅 `.input()`。
`DateTime.submit(fn, ···)`	当用户在 DateTime 聚焦时按下 Enter 键时触发此监听器。

事件参数

🔗

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()。如果设置，当键相同时，此值会将事件标识为跨重新渲染相同的事件。

←

Dataset

DownloadButton

→

DateTime

描述

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

行为

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

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

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

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

初始化

快捷方式

事件监听器

描述

支持的事件监听器

事件参数

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