Source code for menpo.visualize.textutils

from __future__ import division, print_function
from collections import deque
from datetime import datetime
import sys
from time import time

[docs]def progress_bar_str(percentage, bar_length=20, bar_marker='=', show_bar=True): r""" Returns an `str` of the specified progress percentage. The percentage is represented either in the form of a progress bar or in the form of a percentage number. It can be combined with the :func:`print_dynamic` function. Parameters ---------- percentage : `float` The progress percentage to be printed. It must be in the range ``[0, 1]``. bar_length : `int`, optional Defines the length of the bar in characters. bar_marker : `str`, optional Defines the marker character that will be used to fill the bar. show_bar : `bool`, optional If ``True``, the `str` includes the bar followed by the percentage, e.g. ``'[===== ] 50%'`` If ``False``, the `str` includes only the percentage, e.g. ``'50%'`` Returns ------- progress_str : `str` The progress percentage string that can be printed. Raises ------ ValueError ``percentage`` is not in the range ``[0, 1]`` ValueError ``bar_length`` must be an integer >= ``1`` ValueError ``bar_marker`` must be a string of length 1 Examples -------- This for loop: :: n_iters = 2000 for k in range(n_iters): print_dynamic(progress_bar_str(float(k) / (n_iters-1))) prints a progress bar of the form: :: [============= ] 68% """ if percentage < 0: raise ValueError("percentage is not in the range [0, 1]") elif percentage > 1: percentage = 1 if not isinstance(bar_length, int) or bar_length < 1: raise ValueError("bar_length must be an integer >= 1") if not isinstance(bar_marker, str) or len(bar_marker) != 1: raise ValueError("bar_marker must be a string of length 1") # generate output string if show_bar: str_param = "[%-" + str(bar_length) + "s] %d%%" bar_percentage = int(percentage * bar_length) return str_param % (bar_marker * bar_percentage, percentage * 100) else: return "%d%%" % (percentage * 100)
[docs]def bytes_str(num): r""" Converts bytes to a human readable format. For example: :: print_bytes(12345) returns '12.06 KB' print_bytes(123456789) returns '117.74 MB' Parameters ---------- num : `int` The size in bytes. Raises ------ ValueError num must be int >= 0 """ if not isinstance(num, int) or num < 0: raise ValueError("num must be int >= 0") for x in ['bytes', 'KB', 'MB', 'GB']: if num < 1024.0: return "{0:3.2f} {1:s}".format(num, x) num /= 1024.0 return "{0:3.2f} {1:s}".format(num, 'TB')