Rust implementation of Python command line progress bar tool tqdm.

Yiheng Du

Last update: Dec 7, 2022

Related tags

Command-line tqdm

Overview

tqdm

Rust implementation of Python command line progress bar tool tqdm.

From original documentation:

tqdm derives from the Arabic word taqaddum (تقدّم) which can mean "progress," and is an abbreviation for "I love you so much" in Spanish (te quiero demasiado).

Instantly make your loops show a smart progress meter - just wrap any iterable with tqdm(iterable), and you're done!

This crate provides a wrapper Iterator. It controls multiple progress bars when next is called.

Most traits are bypassed with auto-dereference, so original methods can be called with no overhead.

Usage

Just wrap anything that implements the Iterator trait with tqdm

use tqdm::tqdm;
for i in tqdm(0..10000) {
  ...

 76%|███████████████▉     | 7618/10000 [00:09<00:03, 782.14it/s]

Expose trait to allow method chaining

use tqdm::Iter;
for i in (0..).take(10000).tqdm().style("balloon") {
  ...

 47%|**********.          | 4792/10000 [00:06<00:06, 783.39it/s]

Multi-threading is also supported!

use tqdm::tqdm;
use std::thread;
for t in (0..3) {
  thread::spawn(move || {
    for i in tqdm(0..).style(...) {
      ...

 38%|##########0               | 77/200 [00:00<00:01, 83.24it/s]
 77%|████████████████████      | 77/100 [00:00<00:00, 83.24it/s]
 19%|*****.                    | 77/400 [00:00<00:03, 83.24it/s]

For more usage, please refer to doc

Command-line HTTP client for sending a POST request to specified URI on each stdin line.

line2httppost Simple tool to read lines from stdin and post each line as separate POST request to a specified URL (TCP connection is reused though). G

3 Jan 3, 2023

FTL Rust Demangler is a command-line tool for demangling symbol names that are mangled with the Rust convention

FTL Rust Demangler is a command-line tool for demangling symbol names that are mangled with the Rust convention. It takes a mangled symbol name as input and returns the demangled name

7 Mar 30, 2023

A tool crate to quickly build rust command line application.

Falsework A tool crate to quickly build rust command line application.

103 Dec 12, 2022

Command line tool for cheap and efficient email automation written in Rust

Pigeon Pigeon is a command line tool for automating your email workflow in a cheap and efficient way. Utilize your most efficient dev tools you are al

57 Nov 20, 2022

Command-line tool to generate Rust code for Google Cloud Spanner

nene nene is a command-line tool to generate Rust code for Google Cloud Spanner. nene uses database schema to generate code by using Information Schem

3 Dec 7, 2021

A standalone Command Line Interface debugging tool for The Witcher 3 written in Rust

A standalone Command Line Interface debugging tool for The Witcher 3 written in Rust. This tool is intended for Witcher 3 modders who make mainly scri

5 Apr 20, 2022

A command line tool, manage your hundreds of repository, written with Rust

4 Aug 16, 2022

A Rust command line tool to simplify embedded development and deployment.

Bobbin-CLI bobbin-cli is a tool designed to make it easy to build, deploy, test and debug embedded devices using a unified CLI. bobbin-cli understands

110 Dec 25, 2022

A command line tool and Rust library for working with recombination maps.

RecMap library (and command line tool) for reading and working with recombination maps in Rust A RecMap object can be created from reading in a HapMap

5 Feb 11, 2024

Comments

Inconvenient behaviour in for loops
It is a common pattern in Python to wrap the iterator in a for loop with tqdm like so:

for _ in tqdm(iter): ...

This Rust version of tqdm advances the progress bar when calling .next(), which makes sense in principle.

However, say the iterator is trivially fast (like a Vec) and the slow computation is within the for loop, then the progress bar will tick from 0 to 1 almost immediately, and take a lot longer to go from 1 to 2 and so on. This causes the ETA to be vastly underestimated since it is artificially reduced by that first false iteration.

The original tqdm seems to somehow avoid this, it stays at zero until the first for loop has completed. Is there a clean way to address this flaw in such a common pattern?
opened by oersted 3
fix docs on how to specify styles
It looked like this part of the modification was not applied to the README, so I fixed it .

https://github.com/mrlazy1708/tqdm/commit/674cce1b669fc79e67669a153d2d56d5c686858a#diff-b1a35a68f14e696205874893c07fd24fdb88882b47c23cc0e0c80a30c7d53759R296-R317

If it looks OK, please merge it in.

Thanks for maintaining this crate 😄.
opened by Kanatani28 1
print progress to stderr instead of stdout

changed all instances of stdout to stderr

I think this is the better default behavior as it's the default behavior of the python-tqdm relevant source, and as explained why here

a follow-up PR I want to open will be to add file to the config struct so we could configure the destination of the progress bar instead. But I will wait for your approval first.

thank you for maintaining this crate 😄

opened by MeitarR 1

Owner

Yiheng Du

GitHub https://crates.io/crates/tqdm

interactcli-rs is a command-line program framework used to solve the problem of the integration of command-line and interactive modes, including functions such as unification of command-line interactive modes and sub-command prompts. The framework integrates clap and shellwords.

interactcli-rs 简体中文 interactcli-rs is a command-line program framework used to solve the problem of the integration of command-line and interactive mo