mirror of
https://github.com/rocky-linux/peridot.git
synced 2024-11-25 14:41:26 +00:00
122 lines
4.2 KiB
Markdown
122 lines
4.2 KiB
Markdown
# Multi Progress Bar
|
|
|
|
[](https://pkg.go.dev/github.com/vbauerster/mpb/v7)
|
|
[](https://travis-ci.org/vbauerster/mpb)
|
|
[](https://goreportcard.com/report/github.com/vbauerster/mpb)
|
|
[](https://www.paypal.me/vbauerster)
|
|
|
|
**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](https://github.com/VividCortex/ewma) based ETA, Percentage, Bytes counter
|
|
- **Decorator's width sync**: Synchronized decorator's width among multiple bars
|
|
|
|
## Usage
|
|
|
|
#### [Rendering single bar](_examples/singleBar/main.go)
|
|
|
|
```go
|
|
package main
|
|
|
|
import (
|
|
"math/rand"
|
|
"time"
|
|
|
|
"github.com/vbauerster/mpb/v7"
|
|
"github.com/vbauerster/mpb/v7/decor"
|
|
)
|
|
|
|
func main() {
|
|
// initialize progress container, with custom width
|
|
p := mpb.New(mpb.WithWidth(64))
|
|
|
|
total := 100
|
|
name := "Single Bar:"
|
|
// adding a single bar, which will inherit container's width
|
|
bar := p.Add(int64(total),
|
|
// progress bar filler with customized style
|
|
mpb.NewBarFiller(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](_examples/multiBars/main.go)
|
|
|
|
```go
|
|
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), "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)
|
|
bar.Increment()
|
|
// we need to call DecoratorEwmaUpdate to fulfill ewma decorator's contract
|
|
bar.DecoratorEwmaUpdate(time.Since(start))
|
|
}
|
|
}()
|
|
}
|
|
// Waiting for passed &wg and for all bars to complete and flush
|
|
p.Wait()
|
|
```
|
|
|
|
#### [Dynamic total](_examples/dynTotal/main.go)
|
|
|
|
|
|
|
|
#### [Complex example](_examples/complex/main.go)
|
|
|
|
|
|
|
|
#### [Bytes counters](_examples/io/main.go)
|
|
|
|
|