ECNClientError

Part of Exceptions in the Python API reference.

Related guidance: reference/exceptions, how-to/troubleshooting.

Runnable examples: preflight.py.

from picogrid_ecn_client import ECNClientError

Base exception for all failures crossing the public client boundary.

class ECNClientError(Exception): ...

Source · exceptions.py

Hierarchy: ECNClientError

__init__

Initialize a redacted public client error.

def __init__(
    message: object,
    *,
    code: str | None = None,
    operation: str | None = None,
    status_code: int | None = None,
    details: Mapping[str, object] | None = None,
    secrets: tuple[str, ...] = (),
) -> None

Parameters

Name	Type	Default	Description
message	object	—	Failure message to redact and expose.
code	str | None	None	Optional stable error code overriding :attr:default_code.
operation	str | None	None	Optional client operation that failed.
status_code	int | None	None	Optional status value associated with the failure.
details	Mapping[str, object] | None	None	Optional detail values copied and redacted into strings.
secrets	tuple[str, …]	()	Additional exact values to remove from public text.

Source · exceptions.py

message

Redacted human-readable failure message.

message: str

Source · exceptions.py

code

Stable machine-readable failure code.

code: str

Source · exceptions.py

operation

Client operation that failed, when identified.

operation: str | None

Source · exceptions.py

status_code

Status value associated with the failure, when available.

status_code: int | None

Source · exceptions.py

details

Secret-safe string details associated with the failure.

details: dict[str, str]

Source · exceptions.py

default_code

Stable fallback code used when an instance does not provide one.

default_code: str

Source · exceptions.py