Gradio Agents & MCP 黑客马拉松

获奖者
Gradio logo
  1. 组件
  2. LoginButton

Gradio 新手?从这里开始: 入门

查看 发布历史

LoginButton

gradio.LoginButton(···)

描述

创建一个按钮,使用 OAuth 将用户重定向到 Hugging Face 登录。如果在 Blocks 上下文中创建,它将添加一个事件来检查用户是否已登录并相应地更新按钮文本。如果在 Blocks 上下文之外创建,请调用 LoginButton.activate() 方法来添加事件。

行为

作为输入组件: (很少使用)当按钮被点击时,对应于按钮标签的 str

你的函数应该接受以下类型之一
def predict(
	value: str | None
)
	...

作为输出组件: 对应于按钮标签的字符串

你的函数应该返回以下类型之一
def predict(···) -> str | None
	...	
	return value

初始化

参数
🔗
value: str
默认 = "Sign in with Hugging Face"
🔗
logout_value: str
默认 = "Logout ({})"

用户登录时显示的文本。字符串应包含用户名的占位符和登出提示,例如“登出 ({})”。

🔗
every: Timer | float | None
默认 = None
🔗
inputs: Component | list[Component] | set[Component] | None
默认 = None
🔗
variant: Literal['primary', 'secondary', 'stop', 'huggingface']
默认 = "huggingface"
🔗
size: Literal['sm', 'md', 'lg']
默认 = "lg"
🔗
icon: str | Path | None
默认 = "/home/runner/work/gradio/gradio/gradio/icons/huggingface-logo.svg"
🔗
visible: bool
默认 = True
🔗
interactive: bool
默认 = True
🔗
elem_id: str | None
默认 = None
🔗
elem_classes: list[str] | str | None
默认 = None
🔗
render: bool
默认 = True
🔗
key: int | str | tuple[int | str, ...] | None
默认 = None
🔗
preserved_by_key: list[str] | str | None
默认 = "value"
🔗
scale: int | None
默认 = None
🔗
min_width: int | None
默认 = None

快捷方式

接口字符串快捷方式 初始化

gradio.LoginButton

"loginbutton"

使用默认值

事件监听器

描述

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

支持的事件监听器

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

监听器 描述

LoginButton.click(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

可选的前端 js 方法,在运行 'fn' 之前执行。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() 中使用的唯一键。如果设置,此值在键相同时,标识事件在重新渲染时是相同的。