IPWorks ZIP 2020 Python Edition

Questions / Feedback?

on_error Event

Information about non-fatal errors.

Syntax

class Bzip2ErrorEventParams(object):
  @property
  def description() -> str: ...
  @property
  def error_code() -> int: ...
  @property
  def index() -> int: ...
  @property
  def filename() -> str: ...
  @property
  def ignore() -> bool: ...
  @ignore.setter
  def ignore(value) -> None: ...

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

Remarks

The on_error event is fired when non-fatal errors occur during compression or decompression. Note that if this event is fired during decompression this may indicate that the archive is corrupt.

By default these errors will cause the component to fail with an exception. The exception may be overridden by setting Ignore to true. This will cause the error to be ignored, the file will be skipped if necessary, and the class will continue operation.

ErrorCode will correspond to one of the following errors:

1Bad or missing CRC-32 checksum.
2Failed to set creation date of a file.
111Can't open file for read (skipping).

Description contains a textual description of the error. Index and Filename contain the array index (where appropriate) and filename of the file being processed at the time of the error.

 
 
Copyright (c) 2021 /n software inc. - All rights reserved.
IPWorks ZIP 2020 Python Edition - Version 20.0 [Build 7720]