progressbar.py

#!/usr/bin/env python
"""
The MIT License

Copyright 2013 Anler Hp <anler86@gmail.com>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

---

progressbar.py

A Python module with a ProgressBar class which can be used to represent a
task's progress in the form of a progress bar and it can be formated in a
basic way.

Here is some basic usage with the default options:

	>>> from progressbar import ProgressBar
	>>> p = ProgressBar()
	>>> print p
	[>............] 0%
	>>> p + 1
	>>> print p
	[=>...........] 10%
	>>> p + 9
	>>> print p
	[============>] 0%

And here another example with different options:

	>>> from progressbar import ProgressBar
	>>> custom_options = {
	...     'end': 100, 
	...     'width': 20, 
	...     'fill': '#',
	...     'format': '%(progress)s%% [%(fill)s%(blank)s]'
	... }
	>>> p = ProgressBar(**custom_options)
	>>> print p
	0% [....................]
	>>> p + 5
	>>> print p
	5% [#...................]
	>>> p + 9
	>>> print p
	100% [####################]
"""
import sys
import time

class ProgressBar(object):
	"""ProgressBar class holds the options of the progress bar.
	The options are:
		start   State from which start the progress. For example, if start is 
				5 and the end is 10, the progress of this state is 50%
		end     State in which the progress has terminated.
		width   --
		fill    String to use for "filled" used to represent the progress
		blank   String to use for "filled" used to represent remaining space.
		format  Format
		incremental
	"""
	def __init__(self, start=0, end=10, width=12, fill='=', blank='.', format='[%(fill)s>%(blank)s] %(progress)s%%', incremental=True):
		super(ProgressBar, self).__init__()

		self.start = start
		self.end = end
		self.width = width
		self.fill = fill
		self.blank = blank
		self.format = format
		self.incremental = incremental
		self.step = 100 / float(width) #fix
		self.reset()

	def __add__(self, increment):
		increment = self._get_progress(increment)
		if 100 > self.progress + increment:
			self.progress += increment
		else:
			self.progress = 100
		return self

	def __str__(self):
		progressed = int(self.progress / self.step) #fix
		fill = progressed * self.fill
		blank = (self.width - progressed) * self.blank
		return self.format % {'fill': fill, 'blank': blank, 'progress': int(self.progress)}

	__repr__ = __str__

	def _get_progress(self, increment):
		return float(increment * 100) / self.end

	def reset(self):
		"""Resets the current progress to the start point"""
		self.progress = self._get_progress(self.start)
		return self


class AnimatedProgressBar(ProgressBar):
	"""Extends ProgressBar to allow you to use it straighforward on a script.
	Accepts an extra keyword argument named `stdout` (by default use sys.stdout)
	and may be any file-object to which send the progress status.
	"""
	def __init__(self, *args, **kwargs):
		super(AnimatedProgressBar, self).__init__(*args, **kwargs)
		self.stdout = kwargs.get('stdout', sys.stdout)

	def show_progress(self):
		if hasattr(self.stdout, 'isatty') and self.stdout.isatty():
			self.stdout.write('\r')
		else:
			self.stdout.write('\n')
		self.stdout.write(str(self))
		self.stdout.flush()


if __name__ == '__main__':
	p = AnimatedProgressBar(end=100, width=80)

	while True:
		p + 5
		p.show_progress()
		time.sleep(0.1)
		if p.progress == 100:
			break
	print() #new line