on_decryption_password_needed Event

Requests a decryption password, when needed.

Syntax

class ArchiveReaderDecryptionPasswordNeededEventParams(object):
  @property
  def password_target() -> str: ...
  @property
  def cancel() -> bool: ...
  @cancel.setter
  def cancel(value) -> None: ...

# In class ArchiveReader:
@property
def on_decryption_password_needed() -> Callable[[ArchiveReaderDecryptionPasswordNeededEventParams], None]: ...
@on_decryption_password_needed.setter
def on_decryption_password_needed(event_hook: Callable[[ArchiveReaderDecryptionPasswordNeededEventParams], None]) -> None: ...

Remarks

Class fires this event when it needs a password to decrypt the archive. Subscribe to this event if you expect to process encrypted archives.

Inside the event handler, please assign the correct password to decryption_password property, or set Cancel parameter to true to terminate the processing.