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 Nov 03 07:19:11 UTC 2024

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

- 597 bytes

- Viewed (0)

github.com/tiangolo/fastapi

fastapi/exceptions.py

        FastAPI,
        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 Nov 03 07:19:11 UTC 2024

- Last Modified: Tue Apr 02 02:48:51 UTC 2024

- 4.9K 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 Nov 03 07:19:11 UTC 2024

- Last Modified: Sun Oct 27 21:51:55 UTC 2024

- 1.1K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs_src/websockets/tutorial002.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 Nov 03 07:19:11 UTC 2024

- Last Modified: Sun Nov 13 16:10:54 UTC 2022

- 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 Nov 03 07:19:11 UTC 2024

- 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 Nov 03 07:19:11 UTC 2024

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

- 2.7K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs_src/websockets/tutorial002_an.py

from typing import Union

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

app = FastAPI()

html = """
<!DOCTYPE html>
<html>
    <head>
        <title>Chat</title>
    </head>
    <body>
        <h1>WebSocket Chat</h1>

Registered: Sun Nov 03 07:19:11 UTC 2024

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

- 2.8K 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 Nov 03 07:19:11 UTC 2024

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

- 2.8K bytes

- Viewed (0)

github.com/tiangolo/fastapi

docs/em/docs/advanced/websockets.md

* `Query`

👫 👷 🎏 🌌 🎏 FastAPI 🔗/*➡ 🛠️*:

```Python hl_lines="66-77  76-91"
{!../../docs_src/websockets/tutorial002.py!}
```

/// info

👉 *️⃣ ⚫️ 🚫 🤙 ⚒ 🔑 🤚 `HTTPException`, ↩️ 👥 🤚 `WebSocketException`.

👆 💪 ⚙️ 📪 📟 ⚪️➡️ <a href="https://tools.ietf.org/html/rfc6455#section-7.4.1" class="external-link" target="_blank">☑ 📟 🔬 🔧</a>.

///

### 🔄 *️⃣ ⏮️ 🔗

🚥 👆 📁 📛 `main.py`, 🏃 👆 🈸 ⏮️:

Registered: Sun Nov 03 07:19:11 UTC 2024

- Last Modified: Sun Oct 06 20:36:54 UTC 2024

- 4.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 Nov 03 07:19:11 UTC 2024

- Last Modified: Thu Oct 31 12:20:59 UTC 2024

- 5.7K bytes

- Viewed (0)

Search Options