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

modularisation

This commit is contained in:
Casper da Costa-Luis 2016-04-03 19:36:56 +01:00
parent bd54ad603e
commit 93de9bb436
3 changed files with 121 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

77
README.rst
View File

@ -27,6 +27,14 @@ Here's what the output looks like:
|Screenshot|
It can also be executed as a module with pipes:
.. code:: sh
$ seq 9999999 | python -m tqdm --unit_scale True | wc -l
10.0Mit [00:02, 3.58Mit/s]
9999999
Overhead is low -- about 60ns per iteration (80ns with ``gui=True``), and is
unit tested against performance regression.
By comparison, the well established
@ -75,7 +83,8 @@ Changelog
---------
The list of all changes is available either on
`Github's Releases <https://github.com/tqdm/tqdm/releases>`_ or on crawlers such as
`Github's Releases <https://github.com/tqdm/tqdm/releases>`_
or on crawlers such as
`allmychanges.com <https://allmychanges.com/p/python/tqdm/>`_.
@ -83,7 +92,7 @@ Usage
-----
``tqdm`` is very versatile and can be used in a number of ways.
The two main ones are given below.
The three main ones are given below.
Iterable-based
~~~~~~~~~~~~~~
@ -136,6 +145,43 @@ but in this case don't forget to ``del`` or ``close()`` at the end:
pbar.close()
Module
~~~~~~
Perhaps the most wonderful use of ``tqdm`` is in a script or in the CLI.
Simply inserting ``python -m tqdm`` between pipes will pass through all
``stdin`` to ``stdout`` while counting lines and printing progress to
``stderr``.
The example below demonstrated counting the number of lines in all python files
in the current directory, with timing information included.
.. code:: sh
$ time find . -name '*.py' -exec cat \{} \; | wc -l
857348
real 0m3.666s
user 0m0.286s
sys 0m3.519s
$ time find . -name '*.py' -exec cat \{} \; | python -m tqdm | wc -l
857349it [00:04, 183288.57it/s]
857348
real 0m4.672s
user 0m1.222s
sys 0m4.436s
Note that the usual arguments for ``tqdm`` can be also be specified.
.. code:: sh
$ find . -name '*.py' -exec cat \{} \; |
python -m tqdm --unit loc --unit_scale True --total 857349 >> /dev/null
100%|███████████████████████████████████| 857K/857K [00:04<00:00, 187Kloc/s]
Documentation
-------------
@ -163,7 +209,7 @@ Parameters
* desc : str, optional
Prefix for the progressbar [default: None].
* total : int, optional
The number of expected iterations. If not given, len(iterable)
The number of expected iterations. If [default: None], len(iterable)
is used if possible. As a last resort, only basic progress
statistics are displayed (no ETA, no progressbar). If `gui` is
True and this parameter needs subsequent updating, specify an
@ -189,14 +235,14 @@ Parameters
Minimum progress update interval, in iterations [default: None].
If specified, will set `mininterval` to 0.
* ascii : bool, optional
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 #`.
* disable : bool
Whether to disable the entire progressbar wrapper
[default: False].
* unit : str, optional
String that will be used to define the unit of each iteration
[default: 'it'].
[default: it].
* unit_scale : bool, optional
If set, the number of iterations will be reduced/scaled
automatically and a metric prefix following the
@ -211,17 +257,18 @@ Parameters
(current/instantaneous speed) [default: 0.3].
* bar_format : str, optional
Specify a custom bar string formatting. May impact performance.
[default: '{l_bar}{bar}{r_bar}'], where l_bar is
If [default: None], will use '{l_bar}{bar}{r_bar}', where l_bar is
'{desc}{percentage:3.0f}%|' and r_bar is
'| {n_fmt}/{total_fmt} [{elapsed_str}<{remaining_str}, {rate_fmt}]'.
Possible vars: bar, n, n_fmt, total, total_fmt, percentage, rate,
rate_fmt, elapsed, remaining, l_bar, r_bar, desc.
Possible vars: bar, n, n_fmt, total, total_fmt, percentage,
rate, rate_fmt, elapsed, remaining, l_bar, r_bar, desc.
* initial : int, optional
The initial counter value. Useful when restarting a progress
bar [default: 0].
* position : int, optional
Specify the line offset to print this bar. Useful to manage
multiple bars at once (eg, from threads).
Specify the line offset to print this bar (starting from 0)
Automatic if [default: None].
Useful to manage multiple bars at once (eg, from threads).
Returns
~~~~~~~
@ -276,8 +323,8 @@ Returns
Examples and Advanced Usage
---------------------------
See the `examples <https://github.com/tqdm/tqdm/tree/master/examples>`__ folder or
import the module and run ``help()``.
See the `examples <https://github.com/tqdm/tqdm/tree/master/examples>`__
folder or import the module and run ``help()``.
Hooks and callbacks
~~~~~~~~~~~~~~~~~~~
@ -364,7 +411,8 @@ for ``DataFrameGroupBy.progress_apply``:
df.groupby(0).progress_apply(lambda x: x**2)
In case you're interested in how this works (and how to modify it for your
own callbacks), see the `examples <https://github.com/tqdm/tqdm/tree/master/examples>`__
own callbacks), see the
`examples <https://github.com/tqdm/tqdm/tree/master/examples>`__
folder or import the module and run ``help()``.
Nested progress bars
@ -542,7 +590,8 @@ To see all options, run:
$ python setup.py make
See the `CONTRIBUTE <https://raw.githubusercontent.com/tqdm/tqdm/master/CONTRIBUTE>`__
See the
`CONTRIBUTE <https://raw.githubusercontent.com/tqdm/tqdm/master/CONTRIBUTE>`__
file for more information.

44
tqdm/__main__.py Normal file
View File

@ -0,0 +1,44 @@
from tqdm import tqdm
from docopt import docopt
import sys
import re
def cast(val, typ):
if val == 'None':
return None
if typ == 'bool':
return str(val) == 'True'
# try:
return eval(typ + '("' + str(val) + '")')
# except:
# # print val, typ
# if val == 'special':
# return 'whatever... just an example'
# else:
# return eval(typ + '()')
RE_OPTS = re.compile(r' {8}(\w+)\s{2,}:\s*(str|int|float|bool)', flags=re.M)
# RE_OPTS_SOME = re.compile(r' {8}(\w+) : (str|int|float)', flags=re.M)
# RE_OPTS_BOOL = re.compile(r' {8}(\w+) : bool', flags=re.M)
d = tqdm.__init__.__doc__
opt_types = dict(RE_OPTS.findall(d))
# d = RE_OPTS_SOME.sub(r' --\1=<v> ', d)
# d = RE_OPTS_BOOL.sub(r' --\1=<v> ', d)
d = RE_OPTS.sub(r' --\1=<v> : \2', d)
d = d[d.find(' --desc='):d.find('Returns\n')]
__doc__ = 'Usage:\n\ttqdm [--help | options]\n\nOptions:\n' + d
opts = docopt(__doc__)
try:
for opt in opt_types:
opt_types[opt] = cast(opts['--' + opt], opt_types[opt])
for i in tqdm(sys.stdin, **opt_types):
sys.stdout.write(i)
except:
sys.stderr.write(__doc__ + '\n')
for i in sys.stdin:
sys.stdout.write(i)

14
tqdm/_tqdm.py
View File

@ -297,7 +297,7 @@ class tqdm(object):
desc : str, optional
Prefix for the progressbar [default: None].
total : int, optional
The number of expected iterations. If not given, len(iterable)
The number of expected iterations. If [default: None], len(iterable)
is used if possible. As a last resort, only basic progress
statistics are displayed (no ETA, no progressbar). If `gui` is
True and this parameter needs subsequent updating, specify an
@ -321,15 +321,16 @@ class tqdm(object):
Maximum progress update interval, in seconds [default: 10.0].
miniters : int, optional
Minimum progress update interval, in iterations [default: None].
If specified, will set `mininterval` to 0.
ascii : bool, optional
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 #`.
disable : bool
Whether to disable the entire progressbar wrapper
[default: False].
unit : str, optional
String that will be used to define the unit of each iteration
[default: 'it'].
[default: it].
unit_scale : bool, optional
If set, the number of iterations will be reduced/scaled
automatically and a metric prefix following the
@ -344,7 +345,7 @@ class tqdm(object):
(current/instantaneous speed) [default: 0.3].
bar_format : str, optional
Specify a custom bar string formatting. May impact performance.
[default: '{l_bar}{bar}{r_bar}'], where l_bar is
If [default: None], will use '{l_bar}{bar}{r_bar}', where l_bar is
'{desc}{percentage:3.0f}%|' and r_bar is
'| {n_fmt}/{total_fmt} [{elapsed_str}<{remaining_str}, {rate_fmt}]'.
Possible vars: bar, n, n_fmt, total, total_fmt, percentage,
@ -353,12 +354,13 @@ class tqdm(object):
The initial counter value. Useful when restarting a progress
bar [default: 0].
position : int, optional
Specify the line offset to print this bar [default: 0].
Specify the line offset to print this bar (starting from 0)
Automatic if [default: None].
Useful to manage multiple bars at once (eg, from threads).
gui : bool, optional
WARNING: internal parameter - do not use.
Use tqdm_gui(...) instead. If set, will attempt to use
matplotlib animations for a graphical output [default: false].
matplotlib animations for a graphical output [default: False].
Returns
-------