openzgy.api.ProgressWithDots Class Reference

Simple progress bar. More...

Public Member Functions
def	__init__ (self, length=51, outfile=sys.stderr)
def	__call__ (self, done, total)

Detailed Description

Simple progress bar.

Progress bar that writes dots (51 by default) to standard output.
This can be user as-is for simple command line apps, or you can use
the source code as an example on how to write your own.

The default of 51 dots will print one dot at startup and then one
additional dot for each 2% work done.

If you are using this to write to the cloud a file that is smaller
than ~10 GB then the progress bar will probably move in larger
jumps. Because writing to a cloud back-end uses very large buffers.
Most cloud back-ends cannot report progress inside a "write block".

When passing a progress reporter to a function, make sure you do not
pass the class itself. You need to create an instance of it.

---

The documentation for this class was generated from the following file:

• openzgy/api.py