Exceptions

from nexus.exceptions import …

Every exception the SDK can raise.

All of them derive from NexusError, so except NexusError is always enough to contain the SDK:

from nexus import NexusError

try:
    nexus.push.send_to_user("u_1", title="Hi")
except NexusError as exc:
    log.warning("nexus unavailable: %s", exc)

NexusErrorCopy Anchor Link

Base class for every Nexus SDK failure.

Extends Exception.

ConfigurationErrorCopy Anchor Link

The SDK was configured wrongly (missing API key, bad base URL, ...).

Extends NexusError, ValueError.

TransportErrorCopy Anchor Link

A network-level failure: DNS, connection refused, TLS, timeout.

The original exception, when there was one, is available as __cause__.

Extends NexusError.

ApiErrorCopy Anchor Link

A non-2xx response from the Nexus API.

The API answers failures with {"error": {"code", "message", "details"}}; those three fields are exposed as code, the exception message, and details.

Extends NexusError.

ApiErrorCopy Anchor Link

ApiError(message, *, status, code=None, details=None, method=None, path=None, body=None)

Parameters

AuthenticationErrorCopy Anchor Link

401 — the API key is missing, malformed, or revoked.

Extends ApiError.

PermissionDeniedErrorCopy Anchor Link

403 — the key is valid but not allowed to do this.

Extends ApiError.

NotFoundErrorCopy Anchor Link

404 — no such resource in this environment.

Extends ApiError.

ValidationErrorCopy Anchor Link

400/422 — the request body failed server-side validation.

Extends ApiError.

RateLimitErrorCopy Anchor Link

429 — too many requests. retry_after is in seconds when sent.

Extends ApiError.

RateLimitErrorCopy Anchor Link

RateLimitError(*args, retry_after=None, **kwargs)

Parameters

ServerErrorCopy Anchor Link

5xx — the Nexus API failed. Safe to retry idempotent calls.

Extends ApiError.

FunctionsCopy Anchor Link

api_error_for()Copy Anchor Link

def api_error_for(status, payload, *, method=None, path=None, raw=None, headers=None) -> ApiError

Build the most specific ApiError subclass for a response.

Parameters

Returns ApiError