on_error Event

Information about non-fatal errors encountered during file construction.

Syntax

class Check21ErrorEventParams(object):
  @property
  def error_code() -> int: ...
  @property
  def description() -> str: ...

# In class Check21:
@property
def on_error() -> Callable[[Check21ErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[Check21ErrorEventParams], None]) -> None: ...

Remarks

The on_error event is fired to warn the user that it may be operating differently than the user expects. For instance, if the collection_type is set to ctNoDetail, but check detail records are provided in the checks array properties the class will fire this event indicating that the specified checks were ignored.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.