IPWorks OpenPGP 2020 Python Edition

Questions / Feedback?

on_progress Event

Fired as progress is made.

Syntax

class OpenPGPProgressEventParams(object):
  @property
  def bytes_processed() -> int: ...
  @property
  def percent_processed() -> int: ...
  @property
  def operation() -> int: ...
  @property
  def is_eof() -> bool: ...
  @is_eof.setter
  def is_eof(value) -> None: ...

# In class OpenPGP:
@property
def on_progress() -> Callable[[OpenPGPProgressEventParams], None]: ...
@on_progress.setter
def on_progress(event_hook: Callable[[OpenPGPProgressEventParams], None]) -> None: ...

Remarks

This event is fired automatically as data is processed by the class.

The PercentProcessed parameter indicates the current status of the operation.

The BytesProcessed parameter holds the total number of bytes processed so far.

The Operation parameter is only applicable when either ReadFromProgressEvent or WriteToProgressEvent is set to True. This parameter defines whether a Read or Write operation is required. If the configuration settings are not set this parameter will always return 0. Possible values are:

0None
1Read
2Write

The IsEOF parameter is only applicable when either ReadFromProgressEvent or WriteToProgressEvent is set to True. This parameter defines whether the Read or Write operation is complete. When the Operation is Read (1) this parameter must be set to indicate that all data has been supplied to the class. When the Operation is Write (2) this value may be queried to determine when all data has been processed.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks OpenPGP 2020 Python Edition - Version 20.0 [Build 8161]