WebSocketException - Code Search

docs/en/docs/reference/exceptions.md

# Exceptions - `HTTPException` and `WebSocketException`

These are the exceptions that you can raise to show errors to the client.

When you raise an exception, as would happen with normal Python, the rest of the execution is aborted. This way you can raise these exceptions from anywhere in the code to abort a request and show the error to the client.

You can use:

* `HTTPException`
* `WebSocketException`

Registered: Sun Dec 28 07:19:09 UTC 2025

- Last Modified: Thu Apr 18 19:53:19 UTC 2024

- 597 bytes

- Viewed (0)

github.com/tiangolo/fastapi

fastapi/init.py

from .background import BackgroundTasks as BackgroundTasks
from .datastructures import UploadFile as UploadFile
from .exceptions import HTTPException as HTTPException
from .exceptions import WebSocketException as WebSocketException
from .param_functions import Body as Body
from .param_functions import Cookie as Cookie
from .param_functions import Depends as Depends
from .param_functions import File as File

Registered: Sun Dec 28 07:19:09 UTC 2025

- Last Modified: Sat Dec 27 15:19:50 UTC 2025

- 1.1K bytes

- Viewed (0)

github.com/tiangolo/fastapi

fastapi/exceptions.py

        WebSocket,
        WebSocketException,
        status,
    )

    app = FastAPI()

    @app.websocket("/items/{item_id}/ws")
    async def websocket_endpoint(
        *,
        websocket: WebSocket,
        session: Annotated[str | None, Cookie()] = None,
        item_id: str,
    ):
        if session is None:
            raise WebSocketException(code=status.WS_1008_POLICY_VIOLATION)

Registered: Sun Dec 28 07:19:09 UTC 2025

- Last Modified: Sat Dec 27 12:54:56 UTC 2025

- 6.8K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs_src/websockets/tutorial002_py39.py

from typing import Union

from fastapi import (
    Cookie,
    Depends,
    FastAPI,
    Query,
    WebSocket,
    WebSocketException,
    status,
)
from fastapi.responses import HTMLResponse

app = FastAPI()

html = """
<!DOCTYPE html>
<html>
    <head>
        <title>Chat</title>
    </head>
    <body>
        <h1>WebSocket Chat</h1>
        <form action="" onsubmit="sendMessage(event)">

Registered: Sun Dec 28 07:19:09 UTC 2025

- Last Modified: Wed Dec 17 20:41:43 UTC 2025

- 2.8K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs_src/websockets/tutorial002_an_py310.py

from typing import Annotated

from fastapi import (
    Cookie,
    Depends,
    FastAPI,
    Query,
    WebSocket,
    WebSocketException,
    status,
)
from fastapi.responses import HTMLResponse

app = FastAPI()

html = """
<!DOCTYPE html>
<html>
    <head>
        <title>Chat</title>
    </head>
    <body>
        <h1>WebSocket Chat</h1>
        <form action="" onsubmit="sendMessage(event)">

Registered: Sun Dec 28 07:19:09 UTC 2025

- Last Modified: Sat Mar 18 12:29:59 UTC 2023

- 2.8K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs_src/websockets/tutorial002_py310.py

from fastapi import (
    Cookie,
    Depends,
    FastAPI,
    Query,
    WebSocket,
    WebSocketException,
    status,
)
from fastapi.responses import HTMLResponse

app = FastAPI()

html = """
<!DOCTYPE html>
<html>
    <head>
        <title>Chat</title>
    </head>
    <body>
        <h1>WebSocket Chat</h1>
        <form action="" onsubmit="sendMessage(event)">

Registered: Sun Dec 28 07:19:09 UTC 2025

- Last Modified: Sat Mar 18 12:29:59 UTC 2023

- 2.7K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs_src/websockets/tutorial002_an_py39.py

from typing import Annotated, Union

from fastapi import (
    Cookie,
    Depends,
    FastAPI,
    Query,
    WebSocket,
    WebSocketException,
    status,
)
from fastapi.responses import HTMLResponse

app = FastAPI()

html = """
<!DOCTYPE html>
<html>
    <head>
        <title>Chat</title>
    </head>
    <body>
        <h1>WebSocket Chat</h1>
        <form action="" onsubmit="sendMessage(event)">

Registered: Sun Dec 28 07:19:09 UTC 2025

- Last Modified: Sat Mar 18 12:29:59 UTC 2023

- 2.8K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs/pt/docs/advanced/websockets.md

{* ../../docs_src/websockets/tutorial002_an_py310.py hl[68:69,82] *}

/// info | Informação

Como isso é um WebSocket, não faz muito sentido levantar uma `HTTPException`, em vez disso levantamos uma `WebSocketException`.

Você pode usar um código de fechamento dos <a href="https://tools.ietf.org/html/rfc6455#section-7.4.1" class="external-link" target="_blank">códigos válidos definidos na especificação</a>.

///

Registered: Sun Dec 28 07:19:09 UTC 2025

- Last Modified: Wed Dec 17 20:41:43 UTC 2025

- 6K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs/zh/docs/advanced/websockets.md

* `Path`
* `Query`

它们的工作方式与其他 FastAPI 端点/ *路径操作* 相同：

{* ../../docs_src/websockets/tutorial002_an_py310.py hl[68:69,82] *}

/// info

由于这是一个 WebSocket，抛出 `HTTPException` 并不是很合理，而是抛出 `WebSocketException`。

您可以使用<a href="https://tools.ietf.org/html/rfc6455#section-7.4.1" class="external-link" target="_blank">规范中定义的有效代码</a>。

///

### 尝试带有依赖项的 WebSockets

如果您的文件名为 `main.py`，请使用以下命令运行应用程序：

Registered: Sun Dec 28 07:19:09 UTC 2025

- Last Modified: Sat Oct 11 17:48:49 UTC 2025

- 5.1K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs/es/docs/advanced/websockets.md

{* ../../docs_src/websockets/tutorial002_an_py310.py hl[68:69,82] *}

/// info | Información

Como esto es un WebSocket no tiene mucho sentido lanzar un `HTTPException`, en su lugar lanzamos un `WebSocketException`.

Puedes usar un código de cierre de los <a href="https://tools.ietf.org/html/rfc6455#section-7.4.1" class="external-link" target="_blank">códigos válidos definidos en la especificación</a>.

///

Registered: Sun Dec 28 07:19:09 UTC 2025

- Last Modified: Wed Dec 17 20:41:43 UTC 2025

- 5.9K bytes

- Viewed (0)

Search Options