# Tai Sakuma <tai.sakuma@gmail.com>
import time
##__________________________________________________________________||
[docs]class ProgressReporter(object):
"""A progress reporter
This class sends a `ProgressReport` to a progress monitor, e.g.,
`ProgressMonitor` or `BProgressMonitor`, which, for example, uses
the reports to update `ProgressBar` on the screen.
An instance of this class is initialized with a message queue::
reporter = ProgressReporter(queue)
A reporter, an instance of this class, is typically created and
initialized by a progress monitor (`ProgressMonitor` or
`BProgressMonitor`), which keeps the other end of the message
queue. A reporter and a monitor might be running in different
processes.
A report, an instance of `ProgressReport`, can be sent as::
reporter.report(report)
This method can be frequently called multiple times. However,
after sending one report, the reporter wait for a certain
``interval`` (0.1 seconds by default) before sending another
report. Reports received within this interval will be discarded.
The exception for this is the last report. The last report, which
indicates the completion of the task, will be always sent to the
progress monitor regardless of whether it is given within the
interval.
"""
[docs] def __init__(self, queue):
self.queue = queue
self.interval = 0.1 # [second]
self._read_time()
def __repr__(self):
return '{}(queue={!r}, interval={!r})'.format(
self.__class__.__name__,
self.queue,
self.interval
)
def report(self, report):
"""send ``report`` to a progress monitor
Args:
report (ProgressReport): a progress report
"""
if not self._need_to_report(report): return
self._report(report)
def _report(self, report):
self.queue.put(report)
self._read_time()
def _need_to_report(self, report):
if self._time() - self.last_time > self.interval: return True
if report.last(): return True
if report.first(): return True
return False
def _read_time(self): self.last_time = self._time()
def _time(self): return time.time()
##__________________________________________________________________||