progressbar.py

Progress bar and terminal width functions for Bladerunner.

This file is part of Bladerunner.

Copyright (c) 2013, Activision Publishing, Inc. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
• Neither the name of Activision Publishing, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

class bladerunner.progressbar.ProgressBar(total_updates, options=None)

A simple textual progress bar.

clear()

Clears the progress bar from the screen and resets the cursor.

setup()

Prints an empty progress bar to the screen.

update()

Updates self.counter by 1 and prints the new progress bar.

bladerunner.progressbar.cmd_line_arguments(args)

Sets up argparse for the command line demo.

bladerunner.progressbar.cmd_line_help(name)

Overrides argparse’s help.

bladerunner.progressbar.get_term_width()

Tries to get the current terminal width, returns 80 if it cannot.

credit for this function: http://stackoverflow.com/a/566752

bladerunner.progressbar.rounded(number, round_to)

Internal function for rounding numbers.

Args:

number: an integer round_to: an integer want the number to be rounded towards

Returns:

number, rounded to the nearest round_to