WebSocketException - Code Search

fastapi/exceptions.py

from typing import Annotated, Any, TypedDict

from annotated_doc import Doc
from pydantic import BaseModel, create_model
from starlette.exceptions import HTTPException as StarletteHTTPException
from starlette.exceptions import WebSocketException as StarletteWebSocketException


class EndpointContext(TypedDict, total=False):
    function: str
    path: str
    file: str
    line: int


class HTTPException(StarletteHTTPException):
    """

Created: Sun Apr 05 07:19:11 GMT 2026

- Last Modified: Wed Feb 11 18:41:21 GMT 2026

- 7.3K bytes

- Click Count (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

Created: Sun Apr 05 07:19:11 GMT 2026

- Last Modified: Wed Apr 01 16:21:01 GMT 2026

- 1.1K bytes

- Click Count (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)">

Created: Sun Apr 05 07:19:11 GMT 2026

- Last Modified: Fri Feb 27 12:34:37 GMT 2026

- 2.7K bytes

- Click Count (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)">

Created: Sun Apr 05 07:19:11 GMT 2026

- Last Modified: Fri Feb 27 12:34:37 GMT 2026

- 2.8K bytes

- Click Count (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`。

您可以使用[规范中定义的有效代码](https://tools.ietf.org/html/rfc6455#section-7.4.1)。

///

### 尝试带有依赖项的 WebSockets { #try-the-websockets-with-dependencies }

运行你的应用程序：

<div class="termy">

Created: Sun Apr 05 07:19:11 GMT 2026

- Last Modified: Fri Mar 20 17:06:37 GMT 2026

- 5.4K bytes

- Click Count (0)

github.com/tiangolo/fastapi

docs/zh-hant/docs/advanced/websockets.md

* `Path`
* `Query`

它們的運作方式與其他 FastAPI 端點/*路徑操作* 相同：

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

/// info

因為這是 WebSocket，拋出 `HTTPException` 並沒有意義，因此我們改為拋出 `WebSocketException`。

你可以使用規範中定義的[有效關閉代碼](https://tools.ietf.org/html/rfc6455#section-7.4.1)之一。

///

### 用依賴試用 WebSocket { #try-the-websockets-with-dependencies }

執行你的應用：

<div class="termy">

Created: Sun Apr 05 07:19:11 GMT 2026

- Last Modified: Fri Mar 20 17:05:38 GMT 2026

- 5.2K bytes

- Click Count (0)

github.com/tiangolo/fastapi

docs/en/docs/advanced/websockets.md

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

/// info

As this is a WebSocket it doesn't really make sense to raise an `HTTPException`, instead we raise a `WebSocketException`.

You can use a closing code from the [valid codes defined in the specification](https://tools.ietf.org/html/rfc6455#section-7.4.1).

///

Created: Sun Apr 05 07:19:11 GMT 2026

- Last Modified: Sat Mar 07 09:29:03 GMT 2026

- 5.3K bytes

- Click Count (0)

github.com/tiangolo/fastapi

docs/ja/docs/advanced/websockets.md

これらは、他のFastAPI エンドポイント/*path operations* の場合と同じように機能します。

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

/// info | 情報

これはWebSocketであるため、`HTTPException` を発生させることはあまり意味がありません。代わりに `WebSocketException` を発生させます。

クロージングコードは、[仕様で定義された有効なコード](https://tools.ietf.org/html/rfc6455#section-7.4.1)の中から使用することができます。

///

### 依存関係を用いてWebSocketsを試してみる { #try-the-websockets-with-dependencies }

アプリケーションを実行します。

Created: Sun Apr 05 07:19:11 GMT 2026

- Last Modified: Fri Mar 20 14:07:17 GMT 2026

- 6.8K bytes

- Click Count (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 [códigos válidos definidos na especificação](https://tools.ietf.org/html/rfc6455#section-7.4.1).

///

Created: Sun Apr 05 07:19:11 GMT 2026

- Last Modified: Thu Mar 19 18:20:43 GMT 2026

- 5.6K bytes

- Click Count (0)

github.com/tiangolo/fastapi

docs/uk/docs/advanced/websockets.md

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

/// info

Оскільки це WebSocket, не має сенсу піднімати `HTTPException`, натомість ми піднімаємо `WebSocketException`.

Ви можете використати код закриття з [чинних кодів, визначених у специфікації](https://tools.ietf.org/html/rfc6455#section-7.4.1).

///

Created: Sun Apr 05 07:19:11 GMT 2026

- Last Modified: Thu Mar 19 18:27:41 GMT 2026

- 7.9K bytes

- Click Count (0)

Search Options