错误

raise gradio.Error("An error occurred 💥!", duration=5)

描述

此类允许您向用户传递自定义错误消息。您可以通过在代码中任何地方抛出 `gr.Error("自定义消息")` 来实现，当该行代码执行时，自定义消息将以模态框的形式出现在演示界面上。

您可以使用 `duration` 参数控制错误消息的显示时长。如果设置为 `None`，消息将永久显示，直到用户关闭。如果设置为数字，则将显示相应秒数。

您还可以通过设置 `visible=False` 来隐藏错误模态框，使其不在 UI 中显示。

下方演示了不同 `duration` 值如何控制错误、信息和警告消息的显示。您可以在此处查看代码。

modal_control

示例用法

import gradio as gr
def divide(numerator, denominator):
    if denominator == 0:
        raise gr.Error("Cannot divide by zero!")
gr.Interface(divide, ["number", "number"], "number").launch()

初始化

🔗

message: str

默认值 = "Error raised."

向用户显示的错误消息。可以是 HTML，将在模态框中渲染。

🔗

duration: float | None

默认值 = 10

错误消息的显示时长（秒）。如果为 None 或 0，错误消息将一直显示，直到用户关闭。

🔗

visible: bool

默认值 = True

错误消息是否在 UI 中显示。

🔗

title: str

默认值 = "Error"

显示在错误模态框顶部的标题。

🔗

print_exception: bool

默认值 = True

错误发生时是否将错误追踪打印到控制台。

演示

import gradio as gr def calculator(num1, operation, num2): if operation == "add": return num1 + num2 elif operation == "subtract": return num1 - num2 elif operation == "multiply": return num1 * num2 elif operation == "divide": if num2 == 0: raise gr.Error("不能除以零！") return num1 / num2 demo = gr.Interface( calculator, [ "number", gr.Radio(["add", "subtract", "multiply", "divide"]), "number" ], "number", examples=[ [45, "add", 3], [3.14, "divide", 2], [144, "multiply", 2.5], [0, "subtract", 1.2], ], title="玩具计算器", description="这是一个简单的玩具计算器。", ) if __name__ == "__main__": demo.launch()

import gradio as gr

def calculator(num1, operation, num2):
    if operation == "add":
        return num1 + num2
    elif operation == "subtract":
        return num1 - num2
    elif operation == "multiply":
        return num1 * num2
    elif operation == "divide":
        if num2 == 0:
            raise gr.Error("Cannot divide by zero!")
        return num1 / num2

demo = gr.Interface(
    calculator,
    [
        "number",
        gr.Radio(["add", "subtract", "multiply", "divide"]),
        "number"
    ],
    "number",
    examples=[
        [45, "add", 3],
        [3.14, "divide", 2],
        [144, "multiply", 2.5],
        [0, "subtract", 1.2],
    ],
    title="Toy Calculator",
    description="Here's a sample toy calculator.",
)

if __name__ == "__main__":
    demo.launch()

import gradio as gr def failure(): raise gr.Error("这应该会失败！") def exception(): raise ValueError("出错了") def success(): return True def warning_fn(): gr.Warning("这是一条警告！") def info_fn(): gr.Info("这是一些信息") with gr.Blocks() as demo: gr.Markdown("用于成功事件触发的 E2E 测试。then 事件在聊天机器人 E2E 测试中涵盖。" "同时测试状态模态框是否显示。") with gr.Row(): result = gr.Textbox(label="结果") result_2 = gr.Textbox(label="连续事件") with gr.Row(): success_btn = gr.Button(value="触发成功") success_btn_2 = gr.Button(value="触发连续成功") failure_btn = gr.Button(value="触发失败") failure_exception = gr.Button(value="触发带有 ValueError 的失败") with gr.Row(): trigger_warning = gr.Button(value="触发警告") trigger_info = gr.Button(value="触发信息") success_btn_2.click(success, None, None).success(lambda: "第一个事件已触发", None, result).success(lambda: "连续事件已触发", None, result_2) success_btn.click(success, None, None).success(lambda: "成功事件已触发", inputs=None, outputs=result) failure_btn.click(failure, None, None).success(lambda: "不应被触发", inputs=None, outputs=result) failure_exception.click(exception, None, None) trigger_warning.click(warning_fn, None, None) trigger_info.click(info_fn, None, None) if __name__ == "__main__": demo.launch(show_error=True)

import gradio as gr

def failure():
    raise gr.Error("This should fail!")

def exception():
    raise ValueError("Something went wrong")

def success():
    return True

def warning_fn():
    gr.Warning("This is a warning!")

def info_fn():
    gr.Info("This is some info")

with gr.Blocks() as demo:
    gr.Markdown("Used in E2E tests of success event trigger. The then event covered in chatbot E2E tests."
                " Also testing that the status modals show up.")
    with gr.Row():
        result = gr.Textbox(label="Result")
        result_2 = gr.Textbox(label="Consecutive Event")
    with gr.Row():
        success_btn = gr.Button(value="Trigger Success")
        success_btn_2 = gr.Button(value="Trigger Consecutive Success")
        failure_btn = gr.Button(value="Trigger Failure")
        failure_exception = gr.Button(value="Trigger Failure With ValueError")
    with gr.Row():
        trigger_warning = gr.Button(value="Trigger Warning")
        trigger_info = gr.Button(value="Trigger Info")

        success_btn_2.click(success, None, None).success(lambda: "First Event Trigered", None, result).success(lambda: "Consecutive Event Triggered", None, result_2)
        success_btn.click(success, None, None).success(lambda: "Success event triggered", inputs=None, outputs=result)
        failure_btn.click(failure, None, None).success(lambda: "Should not be triggered", inputs=None, outputs=result)
        failure_exception.click(exception, None, None)
        trigger_warning.click(warning_fn, None, None)
        trigger_info.click(info_fn, None, None)

if __name__ == "__main__":
    demo.launch(show_error=True)

←

set_static_paths

Info（信息）

→