OperationResult Class

Represents the result of an operation.

This class encapsulates the success or failure state of an operation along with any associated errors.

Constructor

OperationResult()

Name	Description
succeeded Required
errors	Default value: None

__init__	Initialize a new instance of the OperationResult class.
__new__
failed	Create an OperationResult indicating a failed operation.
success	Return an OperationResult indicating a successful operation.

Initialize a new instance of the OperationResult class.

__init__(succeeded: bool, errors: List[OperationError] | None = None)

Name	Description
succeeded Required	bool Flag indicating whether the operation succeeded.
errors	List[OperationError] \| None Optional list of errors that occurred during the operation. Default value: None

__new__(**kwargs)

Create an OperationResult indicating a failed operation.

static failed(*errors: OperationError) -> OperationResult

Name	Description
*errors Required	OperationError Variable number of OperationError instances.

Type	Description
OperationResult	An OperationResult indicating a failed operation.

Return an OperationResult indicating a successful operation.

static success() -> OperationResult

Type	Description
OperationResult	An OperationResult indicating a successful operation.

Get the list of errors that occurred during the operation.

Note

This property returns a defensive copy of the internal error list

to prevent external modifications, which is especially important for

protecting the singleton instance returned by success().

Type	Description
List[OperationError]	A copy of the list of operation errors.

Get a flag indicating whether the operation succeeded.

Type	Description
bool	True if the operation succeeded, otherwise False.