mirror of https://github.com/tqdm/tqdm.git
108 lines
3.3 KiB
Python
108 lines
3.3 KiB
Python
"""An example of wrapping manual tqdm updates for `urllib` reporthook.
|
|
See also: tqdm_requests.py.
|
|
|
|
# `urllib.urlretrieve` documentation
|
|
> If present, the hook function will be called once
|
|
> on establishment of the network connection and once after each block read
|
|
> thereafter. The hook will be passed three arguments; a count of blocks
|
|
> transferred so far, a block size in bytes, and the total size of the file.
|
|
|
|
Usage:
|
|
tqdm_wget.py [options]
|
|
|
|
Options:
|
|
-h, --help
|
|
Print this help message and exit
|
|
-u URL, --url URL : string, optional
|
|
The url to fetch.
|
|
[default: https://caspersci.uk.to/matryoshka.zip]
|
|
-o FILE, --output FILE : string, optional
|
|
The local file path in which to save the url [default: /dev/null].
|
|
"""
|
|
|
|
from os import devnull
|
|
|
|
from docopt import docopt
|
|
import urllib
|
|
from tqdm.auto import tqdm
|
|
|
|
|
|
def my_hook(t):
|
|
"""Wraps tqdm instance.
|
|
|
|
Don't forget to close() or __exit__()
|
|
the tqdm instance once you're done with it (easiest using `with` syntax).
|
|
|
|
Example
|
|
-------
|
|
|
|
>>> with tqdm(...) as t:
|
|
... reporthook = my_hook(t)
|
|
... urllib.urlretrieve(..., reporthook=reporthook)
|
|
|
|
"""
|
|
last_b = [0]
|
|
|
|
def update_to(b=1, bsize=1, tsize=None):
|
|
"""
|
|
b : int, optional
|
|
Number of blocks transferred so far [default: 1].
|
|
bsize : int, optional
|
|
Size of each block (in tqdm units) [default: 1].
|
|
tsize : int, optional
|
|
Total size (in tqdm units). If [default: None] or -1,
|
|
remains unchanged.
|
|
"""
|
|
if tsize not in (None, -1):
|
|
t.total = tsize
|
|
displayed = t.update((b - last_b[0]) * bsize)
|
|
last_b[0] = b
|
|
return displayed
|
|
|
|
return update_to
|
|
|
|
|
|
class TqdmUpTo(tqdm):
|
|
"""Alternative Class-based version of the above.
|
|
|
|
Provides `update_to(n)` which uses `tqdm.update(delta_n)`.
|
|
|
|
Inspired by [twine#242](https://github.com/pypa/twine/pull/242),
|
|
[here](https://github.com/pypa/twine/commit/42e55e06).
|
|
"""
|
|
|
|
def update_to(self, b=1, bsize=1, tsize=None):
|
|
"""
|
|
b : int, optional
|
|
Number of blocks transferred so far [default: 1].
|
|
bsize : int, optional
|
|
Size of each block (in tqdm units) [default: 1].
|
|
tsize : int, optional
|
|
Total size (in tqdm units). If [default: None] remains unchanged.
|
|
"""
|
|
if tsize is not None:
|
|
self.total = tsize
|
|
return self.update(b * bsize - self.n) # also sets self.n = b * bsize
|
|
|
|
|
|
opts = docopt(__doc__)
|
|
|
|
eg_link = opts['--url']
|
|
eg_file = eg_link.replace('/', ' ').split()[-1]
|
|
eg_out = opts['--output'].replace("/dev/null", devnull)
|
|
# with tqdm(unit='B', unit_scale=True, unit_divisor=1024, miniters=1,
|
|
# desc=eg_file) as t: # all optional kwargs
|
|
# urllib.urlretrieve(eg_link, filename=eg_out,
|
|
# reporthook=my_hook(t), data=None)
|
|
with TqdmUpTo(unit='B', unit_scale=True, unit_divisor=1024, miniters=1,
|
|
desc=eg_file) as t: # all optional kwargs
|
|
urllib.urlretrieve(eg_link, filename=eg_out, reporthook=t.update_to,
|
|
data=None)
|
|
t.total = t.n
|
|
|
|
# Even simpler progress by wrapping the output file's `write()`
|
|
with tqdm.wrapattr(open(eg_out, "wb"), "write",
|
|
miniters=1, desc=eg_file) as fout:
|
|
for chunk in urllib.urlopen(eg_link):
|
|
fout.write(chunk)
|