Skip to content

Reference ​

This reference documents every public symbol exported from quater.

Prerequisites ​

Use this section after reading Quickstart and Public API. The reference tells you exact names and defaults; the guides show how to design an app.

Public Imports ​

python
from quater import Quater, Request, JSONResponse, Resource

Public symbols:

AreaSymbols
ApplicationQuater, RouteGroup, AppConfig, CORSConfig, __version__
ParametersPath, Query, Body, Form, File, Header, Cookie
RequestRequest, State, FormData, UploadFile
ResourcesResource
ResponsesResponse, JSONResponse, TextResponse, HTMLResponse, BytesResponse, StreamResponse, RedirectResponse, EmptyResponse
AuthAuthConfig, AuthContext, ApprovalRequest, ActionApproval, HTTPError, ImproperlyConfigured, SignedCookieSigner
ObservabilityAccessLogEvent, AccessLogHook, ToolAuditEvent
TestingTestClient, CliTestClient, MCPTestClient, TestResponse

Pages ​

  • Application: app construction, route groups, CORS, and server-facing objects.
  • Parameters: request binding markers.
  • Request: request object, state, headers, query, cookies, and context.
  • Resources: scoped injection.
  • Responses: automatic return conversion and explicit responses.
  • Auth and Security: auth hooks, approval hooks, errors, and signed cookies.
  • Observability: access-log and MCP audit events.
  • Testing: in-process HTTP and MCP test clients.

What Can Go Wrong ​

If a symbol does not appear here, do not treat it as public API. If application code needs an internal import, treat that as a design question before depending on it.

Also See ​

Released under the MIT License.