etatime 3.1.0

A library for tracking, computing, and formatting time estimates. (Based on `tqdm`).

ETA Time

A library for tracking, computing, and formatting time estimates. (Based on tqdm.)

Why?

tqdm is probably the most popular option for Python programmers to show progress in their programs. However, I wasn't happy with the default formatting code options, and wanted something that was easier to read and understand for an average user.

In addition, I wanted to be able to access information like ETA in my code. While tqdm sort of lets you do this, it's not well documented, and you would have to dig through the source code to get the values and formulas you want.

etatime is my answer to this. It's a minimal wrapper around tqdm that adds additional formatting codes and well-documented progress stats tracking.

The time submodule is pretty useful too.

Basic Usage

The main feature of this library is the EtaBar class. This is a wrapper for the tqdm.tqdm class that provides variables which track important ETA state information for use elsewhere in your code.

Additionally, the TimeString class provides methods to format the resultant time objects into human-readable text. This is used inside EtaBar class to add additional bar_format codes.

For more information on the := (walrus) operator, see the documentation.

import time, random
from etatime import EtaBar, TimeString


# Just a placeholder function that takes a random amount of time
def process_item(item):
    time.sleep(random.random())


for item in (eta := EtaBar(range(100))):  # Creates a progress bar which tracks stats
    process_item(item)  # Do your processing here

print(f"Done processing {eta.total_items} items in {TimeString.automatic(eta.elapsed_time, long=True)}!\n")

Here is an example of the sort of output this produces:

 16%|█▌        | (16/100) | R: 0:00:17 | ETA: 3:13:26 AM
 ...
 100%|██████████| (100/100) | R: 0:00:01 | ETA: 3:46:01 AM
Done processing 100 items in 53 seconds!

You can get more verbose information by replacing the for loop with this:

for item in (eta := EtaBar(range(100), bar_format="{l_bar}{bar}{r_barL}")):

Here is an example of the long output:

 13%|█▎        | (13/100) | Remaining: 20 seconds | ETA: 3:12:16 AM US Mountain Standard Time

All keyword arguments other than bar_format get passed directly to tqdm.tqdm. bar_format is pre-processed by etatime in order to inject some new custom formatting codes:

• start: The starting time in short digit format.
• startL: The starting time written out in plain english.
• current: The current (loop start time) time in short digit format.
• currentL: The current (loop start time) time written out in plain english.
• elapsed: The elapsed time in short digit format.
• elapsedL: The elapsed time written out in plain english.
• remaining: The remaining time in short digit format.
• remainingL: The remaining time written out in plain english.
• eta: The ETA time in short digit format.
• etaL: The ETA time written out in plain english.
• r_bar == "| ({n_fmt}/{total_fmt}) | R: {remaining} | ETA: {eta}"
• r_barL == "| ({n_fmt}/{total_fmt}) | Remaining: {remainingL} | ETA: {etaL}"

The following attributes are available for EtaBar instances:

• total_items
• rate
• n
• percent
• start_time
• current_time
• elapsed_time
• remaining_time
• eta_time

Full Documentation