pycharmers.utils.monitor_utils module

pycharmers.utils.monitor_utils.progress_reporthook_create(filename='', bar_width=20, verbose=True)

Create Progress reporthook for urllib.request.urlretrieve

Returns

The reporthook which is a callable that accepts a block number, a read size, and the total file size of the URL target.

Parameters

• filename (str) – Downloading filename.

• bar_width (int) – The width of progress bar.

Examples

>>> import urllib
>>> from pycharmers.utils import progress_reporthook_create
>>> urllib.request.urlretrieve(url="hoge.zip", filename="hoge.zip", reporthook=progress_reporthook_create(filename="hoge.zip"))
hoge.zip        1.5%[--------------------] 21.5[s] 8.0[GB/s]    eta 1415.1[s]

class pycharmers.utils.monitor_utils.ProgressMonitor(max_iter, verbose=1, barname='', **kwargs)

Bases: object

Monitor the loop progress.

max_iter

Maximum number of iterations.

Type

int

digit

The number of digit of max_iter (= len(str(max_iter)) )

Type

int

verbose

Determine the output method. 0 is silent, 1 is progress bar and metrics, and 2 is only progress bar.

Type

int

barname

Barname.

Type

str

histories

The histories.

Type

dict

iter

The current number of iterations.

Type

int

prev_length

The number of characters in the previous output.

Type

int

prev_nrows

The number of rows in the previous output.

Type

int

start_time

current time in seconds since the Epoch. ( time.time() )

Type

int

verbose	report
0	silent
1	bar and metrics
2	only bar
else	bar and metrics

Examples

>>> from pycharmers.utils import ProgressMonitor
>>> max_iter = 100
>>> monitor = ProgressMonitor(max_iter=max_iter, verbose=1, barname="NAME")
>>> for it in range(max_iter):
>>>     monitor.report(it, loop=it+1)
>>> monitor.remove()
NAME 100/100[####################]100.00% - 0.010[s]  loop: 100

write(string)

Use ASCI to output progress beautifully.

• \033[0J : Delete all strings after the cursor (including the following lines).

• \033[nF : Moves the cursor up n lines and then moves to the beginning of that line.

Parameters

string – String to output.

Todo

Determine nrows according to the previous output result.

progress(it)

Create a progress.

Parameters

it (int) – Thr current iteration number.

Returns

Thr current progress.

Return type

str

report_silent(it, **metrics)

report method when verbose == 0

report_only_prograss_bar(it, **metrics)

report method when verbose == 2

report_progress_bar_and_metrics(it, **metrics)

report method when verbose == 1

remove()

Do the necessary processing at the end.