skip to navigation
skip to content

Pbar 1.0

Progress bar to watch file size

A class to show a progress bar of a certain file.
It will display progress up to 100%.

from Pbar import Pbar
myfile = Pbar(pfile="/tmp/somefile", size='25.9kb, timeout=20')

The above example will watch the file '/tmp/somefile' and display
the progress up to 25.9kb. If the file does not exist within 20
seconds then it will raise an exception.

Example (using fork to get the file):
from Pbar import Pbar
import os
url = ''
child = os.fork()
if child == 0:
os.system('wget %s -q -O /tmp/somefile' %url)
myfile = Pbar(pfile='/tmp/somefile', size='120mb', timeout=10)

Required args: pfile, size
+ pfile:
String (path to file). The file to watch.
+ size:
String of number with denomination. (e.g. 100mb).
The expected total size of the file. e.g. '2gb'. (Valid sizes = b, kb, mb, gb).

Optional args: timeout, show_size_progress
+ timeout:
Integer. The timeout (in seconds) Pbar will wait for the file
to exist once show_progress() has been called. This
is useful if you are waiting for the file to get created.
The default is 5 seconds.
+ show_size_progress:
Boolean. Default is False. Setting this to true
will change the output from showing 'File: and Current size:'
to showing the 'current size of total size'. This way is not
File Type Py Version Uploaded on Size
Pbar-1.0.tar.gz (md5) "dumb" binary any 2013-07-25 2KB