No Description

Vladimir Bauer 314158faaf v8.1.4 1 month ago
.github a32f62cfae same on hook as in lint 2 months ago
_examples 314158faaf v8.1.4 1 month ago
_svg 2d1b96cfa9 go mod init 3 years ago
cwriter fa18081b09 separate Writer struct 2 months ago
decor 61c927b0da FormatMsg vars refactoring 1 month ago
internal 82e7b4075e drop internal predicate 11 months ago
.gitignore 33cbe2c2cc gitignore 5 years ago
README.md 59024a8cf8 add lint badge 2 months ago
UNLICENSE d9cdda900c License change to Unlicense 3 years ago
bar.go e2694387f8 defer close(sync), cb may panic 1 month ago
bar_filler.go 579e87486f minor: drop param names 2 months ago
bar_filler_bar.go 06615caa71 minor: fields toggle 1 month ago
bar_filler_nop.go 33ac0fb026 refactoring: nop filler 2 months ago
bar_filler_spinner.go 665a8a56a0 refactoring: spinner filler 2 months ago
bar_option.go 529a634280 don't recover in bar.render, handle error if any 2 months ago
bar_test.go 7db018c3ea remove obsolete tests 2 months ago
barbench_test.go 46f322f3b8 minor: barbench refactoring 2 months ago
container_option.go 206e3b9062 minor: rename rr to refreshRate 2 months ago
decorators_test.go 208ad3ad4b wait wor syncWidth before next render 2 months ago
doc.go d9cdda900c License change to Unlicense 3 years ago
draw_test.go 63556178b2 use stat.Completed in BarFiller 1 month ago
example_test.go 43846d39af update ewma examples 2 months ago
export_test.go 208ad3ad4b wait wor syncWidth before next render 2 months ago
go.mod cca8a06c5c go get golang.org/x/sys 1 month ago
go.sum cca8a06c5c go get golang.org/x/sys 1 month ago
priority_queue.go 11d342b48a Correct PopCompletedMode with multiple bars 4 months ago
progress.go e2694387f8 defer close(sync), cb may panic 1 month ago
progress_test.go 208ad3ad4b wait wor syncWidth before next render 2 months ago
proxyreader.go d4d94991e9 address issue #117 2 months ago
proxyreader_test.go 10915d59da minor: refactoring names 2 months ago
proxywriter.go d4d94991e9 address issue #117 2 months ago
proxywriter_test.go 0f72572715 minor: r as io.Reader 2 months ago

README.md

Multi Progress Bar

GoDoc Test status Lint status

mpb is a Go lib for rendering progress bars in terminal applications.

Features

  • Multiple Bars: Multiple progress bars are supported
  • Dynamic Total: Set total while bar is running
  • Dynamic Add/Remove: Dynamically add or remove bars
  • Cancellation: Cancel whole rendering process
  • Predefined Decorators: Elapsed time, ewma based ETA, Percentage, Bytes counter
  • Decorator's width sync: Synchronized decorator's width among multiple bars

Usage

Rendering single bar

package main

import (
    "math/rand"
    "time"

    "github.com/vbauerster/mpb/v8"
    "github.com/vbauerster/mpb/v8/decor"
)

func main() {
    // initialize progress container, with custom width
    p := mpb.New(mpb.WithWidth(64))

    total := 100
    name := "Single Bar:"
    // create a single bar, which will inherit container's width
    bar := p.New(int64(total),
        // BarFillerBuilder with custom style
        mpb.BarStyle().Lbound("╢").Filler("▌").Tip("▌").Padding("░").Rbound("╟"),
        mpb.PrependDecorators(
            // display our name with one space on the right
            decor.Name(name, decor.WC{W: len(name) + 1, C: decor.DidentRight}),
            // replace ETA decorator with "done" message, OnComplete event
            decor.OnComplete(
                decor.AverageETA(decor.ET_STYLE_GO, decor.WC{W: 4}), "done",
            ),
        ),
        mpb.AppendDecorators(decor.Percentage()),
    )
    // simulating some work
    max := 100 * time.Millisecond
    for i := 0; i < total; i++ {
        time.Sleep(time.Duration(rand.Intn(10)+1) * max / 10)
        bar.Increment()
    }
    // wait for our bar to complete and flush
    p.Wait()
}

Rendering multiple bars

    var wg sync.WaitGroup
    // passed wg will be accounted at p.Wait() call
    p := mpb.New(mpb.WithWaitGroup(&wg))
    total, numBars := 100, 3
    wg.Add(numBars)

    for i := 0; i < numBars; i++ {
        name := fmt.Sprintf("Bar#%d:", i)
        bar := p.AddBar(int64(total),
            mpb.PrependDecorators(
                // simple name decorator
                decor.Name(name),
                // decor.DSyncWidth bit enables column width synchronization
                decor.Percentage(decor.WCSyncSpace),
            ),
            mpb.AppendDecorators(
                // replace ETA decorator with "done" message, OnComplete event
                decor.OnComplete(
                    // ETA decorator with ewma age of 60
                    decor.EwmaETA(decor.ET_STYLE_GO, 60, decor.WCSyncWidth), "done",
                ),
            ),
        )
        // simulating some work
        go func() {
            defer wg.Done()
            rng := rand.New(rand.NewSource(time.Now().UnixNano()))
            max := 100 * time.Millisecond
            for i := 0; i < total; i++ {
                // start variable is solely for EWMA calculation
                // EWMA's unit of measure is an iteration's duration
                start := time.Now()
                time.Sleep(time.Duration(rng.Intn(10)+1) * max / 10)
                // we need to call EwmaIncrement to fulfill ewma decorator's contract
                bar.EwmaIncrement(time.Since(start))
            }
        }()
    }
    // wait for passed wg and for all bars to complete and flush
    p.Wait()

Dynamic total

dynamic total

Complex example

complex

Bytes counters

byte counters