Docs/Manipuladores e erros

Páginas de erro

Uma solicitação que falha ainda deve responder como o resto do seu site: uma página com suas próprias palavras para um visitante, a mesma falha que JSON para um cliente API. Nexy responde a ambas e um arquivo substitui cada resposta.

Esta página é o mapa: qual arquivo responde qual status e como fazer o primeiro. As páginas de uma pasta obtêm sua própria página.

Uma falha, duas respostas

a request that fails
      │
      ├── a browser (Accept: text/html)              ──►  an HTML page
      └── an API client (Accept: application/json)   ──►  {"detail": "…"}  with the same status

the HTML page
      ├── the deepest folder of the URL that holds a file   ──►  your file
      └── no folder of the chain holds one                 ──►  the built-in page

Sua primeira página

Crie src/routes/notfound.nexy e escreva o que um visitante deve ler:

---metadata = {"title": "Page not found"}---<h1>Page not found</h1><p>The page moved or never existed. <a href="/">Back home</a>.</p>

Salve e peça uma URL que nada serve:

curl -i -H "Accept: text/html" http://localhost:3000/nowhere# HTTP/1.1 404 Not Found

O arquivo na raiz das rotas responde a todo o projeto; uma cópia em uma pasta responde apenas a essa pasta e mantém o resto como está. Sem nenhum arquivo, o Nexy exibe sua página com estilo integrado.

Qual arquivo responde

Deixe uma página ou responda do código

redirect, permanentRedirect, notFound, forbidden e unauthorized levantam uma exceção HTTP, então a mesma chamada funciona em uma página .nexy, um manipulador de API, um controlador modular, um guarda e um dependencies.py. Eles têm os mesmos nomes no cliente (@nexy/client).

---from nexy import notFound, redirect from src.posts import find slug: prop[str]post = find(slug)if post is None:    notFound()if post.moved_to:    redirect(post.moved_to)---<h1>{{ post.title }}</h1>

Um redirecionamento responde com o cabeçalho Location e sem página, também para um cliente API. Construa o destino a partir de valores em que você confia: um redirect(request.query_params["next"]) envia visitantes para onde o link indicar. Um destino com quebra de linha é recusado.

Um guarda protege uma pasta inteira:

from nexy import unauthorizedfrom nexy.http import Request  def require_login(request: Request) -> None:    if not request.session.get("user"):        unauthorized(scheme="Bearer")  dependencies = [require_login]

HTML ou JSON

A mesma exceção responde de forma diferente dependendo de quem pergunta:

• Um navegador (Accept: text/html) obtém uma página HTML. O detalhe tem escape de HTML, portanto, uma mensagem criada a partir da entrada do usuário não pode injetar marcação.
• Um cliente que solicita JSON e não uma página (Accept: application/json) obtém {"detail": "..."} com o mesmo código de status.

from nexy.http import HTTPException  async def GET(id: int):    if id > 100:        raise HTTPException(status_code=403, detail="Out of range")    return {"id": id}

curl -H "Accept: application/json" http://localhost:3000/api/items/500# {"detail":"Out of range"}

Exceções não tratadas

Uma exceção de que nada tratado é registrado uma vez, com exceção de onde veio e o código ao seu redor, e respondido de acordo com o modo.

  x ZeroDivisionError: division by zero  GET /boom  ref fe6a5217    at src/routes/boom.py:2 in GET       1 | def GET():       2 |     return {"a": 1 / 0}

A referência são oito caracteres, novos para cada falha. Um visitante pode citá-lo e você encontrará o rastreamento pesquisando-o no log. Nem a exceção nem o código chegam ao visitante em produção. Um errors.nexy personalizado substitui apenas a página; a linha de log permanece.

Erros de validação

Um cabeçalho, parâmetro de consulta ou campo de corpo ausente responde 422 com o corpo JSON de FastAPI, para cada cliente. Consulte Validação e erros.

Próximas etapas

• Páginas de erro por pasta: um 404, 403 ou 401 de sua preferência em uma pasta
• Rotas dinâmicas
• Rotas de API
• Teste

Copiar a página como Markdown Editar no GitHub