Rooba
/
tqdm
mirror of https://github.com/tqdm/tqdm.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

help(tqdm) fits into 80-char terminal

This commit is contained in:
Casper da Costa-Luis 2015-11-28 20:27:43 +00:00
parent 9f37ac5b5e
commit 4d9ec57cd9
2 changed files with 23 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.rst
View File

@ -84,8 +84,8 @@ Parameters
* desc : str, optional * desc : str, optional
Prefix for the progressbar [default: None]. Prefix for the progressbar [default: None].
* total : int, optional * total : int, optional
The number of expected iterations. If not given, len(iterable) is The number of expected iterations. If not given, len(iterable)
used if possible. As a last resort, only basic progress is used if possible. As a last resort, only basic progress
statistics are displayed (no ETA, no progressbar). If `gui` is statistics are displayed (no ETA, no progressbar). If `gui` is
True and this parameter needs subsequent updating, specify an True and this parameter needs subsequent updating, specify an
initial arbitrary large positive integer, e.g. int(9e9). initial arbitrary large positive integer, e.g. int(9e9).
@ -97,10 +97,10 @@ Parameters
[default: sys.stderr]. Uses `file.write(str)` and `file.flush()` [default: sys.stderr]. Uses `file.write(str)` and `file.flush()`
methods. methods.
* ncols : int, optional * ncols : int, optional
The width of the entire output message. If specified, dynamically The width of the entire output message. If specified,
resizes the progressbar to stay within this bound. If dynamically resizes the progressbar to stay within this bound.
[default: None], attempts to use environment width. The fallback If [default: None], attempts to use environment width. The
is a meter width of 10 and no limit for the counter and fallback is a meter width of 10 and no limit for the counter and
statistics. If 0, will not print any meter (only stats). statistics. If 0, will not print any meter (only stats).
* mininterval : float, optional * mininterval : float, optional
Minimum progress update interval, in seconds [default: 0.1]. Minimum progress update interval, in seconds [default: 0.1].
@ -113,7 +113,8 @@ Parameters
If [default: None] or false, use unicode (smooth blocks) to fill If [default: None] or false, use unicode (smooth blocks) to fill
the meter. The fallback is to use ASCII characters `1-9 #`. the meter. The fallback is to use ASCII characters `1-9 #`.
* disable : bool * disable : bool
Whether to disable the entire progressbar wrapper [default: False]. Whether to disable the entire progressbar wrapper
[default: False].
* unit : str, optional * unit : str, optional
String that will be used to define the unit of each iteration String that will be used to define the unit of each iteration
[default: 'it']. [default: 'it'].

28
tqdm/_tqdm.py
View File

@ -79,8 +79,8 @@ def format_meter(n, total, elapsed, ncols=None, prefix='', ascii=False,
n : int n : int
Number of finished iterations. Number of finished iterations.
total : int total : int
The expected total number of iterations. If meaningless (), only basic The expected total number of iterations. If meaningless (), only
progress statistics are displayed (no ETA). basic progress statistics are displayed (no ETA).
elapsed : float elapsed : float
Number of seconds passed since start. Number of seconds passed since start.
ncols : int, optional ncols : int, optional
@ -100,7 +100,8 @@ def format_meter(n, total, elapsed, ncols=None, prefix='', ascii=False,
If set, the number of iterations will printed with an appropriate If set, the number of iterations will printed with an appropriate
SI metric prefix (K = 10^3, M = 10^6, etc.) [default: False]. SI metric prefix (K = 10^3, M = 10^6, etc.) [default: False].
rate : float, optional rate : float, optional
Manual override for iteration rate. If [default: None], uses n/elapsed. Manual override for iteration rate.
If [default: None], uses n/elapsed.
Returns Returns
------- -------
@ -221,8 +222,8 @@ class tqdm(object):
desc : str, optional desc : str, optional
Prefix for the progressbar [default: None]. Prefix for the progressbar [default: None].
total : int, optional total : int, optional
The number of expected iterations. If not given, len(iterable) is The number of expected iterations. If not given, len(iterable)
used if possible. As a last resort, only basic progress is used if possible. As a last resort, only basic progress
statistics are displayed (no ETA, no progressbar). If `gui` is statistics are displayed (no ETA, no progressbar). If `gui` is
True and this parameter needs subsequent updating, specify an True and this parameter needs subsequent updating, specify an
initial arbitrary large positive integer, e.g. int(9e9). initial arbitrary large positive integer, e.g. int(9e9).
@ -234,10 +235,10 @@ class tqdm(object):
[default: sys.stderr]. Uses `file.write(str)` and `file.flush()` [default: sys.stderr]. Uses `file.write(str)` and `file.flush()`
methods. methods.
ncols : int, optional ncols : int, optional
The width of the entire output message. If specified, dynamically The width of the entire output message. If specified,
resizes the progressbar to stay within this bound. If dynamically resizes the progressbar to stay within this bound.
[default: None], attempts to use environment width. The fallback If [default: None], attempts to use environment width. The
is a meter width of 10 and no limit for the counter and fallback is a meter width of 10 and no limit for the counter and
statistics. If 0, will not print any meter (only stats). statistics. If 0, will not print any meter (only stats).
mininterval : float, optional mininterval : float, optional
Minimum progress update interval, in seconds [default: 0.1]. Minimum progress update interval, in seconds [default: 0.1].
@ -249,7 +250,8 @@ class tqdm(object):
If [default: None] or false, use unicode (smooth blocks) to fill If [default: None] or false, use unicode (smooth blocks) to fill
the meter. The fallback is to use ASCII characters `1-9 #`. the meter. The fallback is to use ASCII characters `1-9 #`.
disable : bool disable : bool
Whether to disable the entire progressbar wrapper [default: False]. Whether to disable the entire progressbar wrapper
[default: False].
unit : str, optional unit : str, optional
String that will be used to define the unit of each iteration String that will be used to define the unit of each iteration
[default: 'it']. [default: 'it'].
@ -266,9 +268,9 @@ class tqdm(object):
(ignored in GUI mode). Ranges from 0 (average speed) to 1 (ignored in GUI mode). Ranges from 0 (average speed) to 1
(current/instantaneous speed) [default: 0.3]. (current/instantaneous speed) [default: 0.3].
gui : bool, optional gui : bool, optional
WARNING: internal paramer - do not use. Use tqdm_gui(...) instead. WARNING: internal paramer - do not use.
If set, will attempt to use matplotlib animations for a Use tqdm_gui(...) instead. If set, will attempt to use
graphical output [default: false]. matplotlib animations for a graphical output [default: false].
Returns Returns
------- -------