acme.etc.Types.Result

class documentation

class Result:

This class represents the generic return state for many functions. It main contain the general result, a status code, values, resources etc.

Class Method	`exceptionToResult`	Transform a Python exception to a result.
Method	`prepareResultFromRequest`	Copy the necessary fields from an original request. Existing fields will not be overwritten.
Method	`toData`	Return the result data as a string or bytes or JSON.
Class Variable	`data`	Data.
Class Variable	`dbg`	Optional debug message.
Class Variable	`embeddedRequest`	Optional embedded `CSERequest`.
Class Variable	`resource`	Resource instance.
Instance Variable	`request`	Optional `CSERequest`.

@classmethod

def exceptionToResult(self, e: Exception) -> Result: ¶

Transform a Python exception to a result.

Returns
`Result`	Result object, with "rsc" set to internal server error, and "dbg" to the exception message.

def prepareResultFromRequest(self, originalRequest: CSERequest) -> Result: ¶

Copy the necessary fields from an original request. Existing fields will not be overwritten.

This can be used to prepare a response from a request.

Parameters
originalRequest:`CSERequest`	The original request to copy from.

Returns
`Result`	Self.

def toData(self, ct: ContentSerializationType | None = None) -> str | bytes | JSON: ¶

Return the result data as a string or bytes or JSON.

Parameters
ct:`ContentSerializationType \| None`	The content serialization type to use. If not given, the default serialization type is used.

Returns
`str \| bytes \| JSON`	The result data as a string or bytes or JSON.

data: Any | Sequence[Any] | tuple | JSON | str = ¶

Data.

dbg: str | None = ¶

Optional debug message.

embeddedRequest: CSERequest | None = ¶

Optional embedded CSERequest.

resource: Resource | JSON = ¶

Resource instance.

request: CSERequest | None = ¶

Optional CSERequest.