-
-
Notifications
You must be signed in to change notification settings - Fork 186
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Multiple progressbars and spinners support (#544)
- Loading branch information
1 parent
3ffa822
commit a6d54ab
Showing
12 changed files
with
302 additions
and
35 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
package main | ||
|
||
import ( | ||
"github.com/pterm/pterm" | ||
"time" | ||
) | ||
|
||
func main() { | ||
multi := pterm.DefaultMultiPrinter | ||
|
||
spinner1, _ := pterm.DefaultSpinner.WithWriter(multi.NewWriter()).Start("Spinner 1") | ||
spinner2, _ := pterm.DefaultSpinner.WithWriter(multi.NewWriter()).Start("Spinner 2") | ||
pb1, _ := pterm.DefaultProgressbar.WithTotal(100).WithWriter(multi.NewWriter()).Start("Progressbar 1") | ||
pb2, _ := pterm.DefaultProgressbar.WithTotal(100).WithWriter(multi.NewWriter()).Start("Progressbar 2") | ||
pb3, _ := pterm.DefaultProgressbar.WithTotal(100).WithWriter(multi.NewWriter()).Start("Progressbar 3") | ||
pb4, _ := pterm.DefaultProgressbar.WithTotal(100).WithWriter(multi.NewWriter()).Start("Progressbar 4") | ||
pb5, _ := pterm.DefaultProgressbar.WithTotal(100).WithWriter(multi.NewWriter()).Start("Progressbar 5") | ||
|
||
multi.Start() | ||
|
||
// Randomly increment progress bars for demo purposes. | ||
for i := 1; i <= 100; i++ { | ||
pb1.Increment() | ||
|
||
if i%2 == 0 { | ||
pb2.Add(3) | ||
} | ||
|
||
if i%5 == 0 { | ||
pb3.Increment() | ||
} | ||
|
||
if i%10 == 0 { | ||
pb4.Increment() | ||
} | ||
|
||
if i%3 == 0 { | ||
pb5.Increment() | ||
} | ||
|
||
if i%50 == 0 { | ||
spinner1.Success("Spinner 1 is done!") | ||
} | ||
|
||
if i%60 == 0 { | ||
spinner2.Fail("Spinner 2 failed!") | ||
} | ||
|
||
time.Sleep(time.Millisecond * 50) | ||
} | ||
|
||
multi.Stop() | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
package main | ||
|
||
import ( | ||
"github.com/pterm/pterm" | ||
"time" | ||
) | ||
|
||
func main() { | ||
multi := pterm.DefaultMultiPrinter | ||
|
||
pb1, _ := pterm.DefaultProgressbar.WithTotal(100).WithWriter(multi.NewWriter()).Start("Progressbar 1") | ||
pb2, _ := pterm.DefaultProgressbar.WithTotal(100).WithWriter(multi.NewWriter()).Start("Progressbar 2") | ||
pb3, _ := pterm.DefaultProgressbar.WithTotal(100).WithWriter(multi.NewWriter()).Start("Progressbar 3") | ||
pb4, _ := pterm.DefaultProgressbar.WithTotal(100).WithWriter(multi.NewWriter()).Start("Progressbar 4") | ||
pb5, _ := pterm.DefaultProgressbar.WithTotal(100).WithWriter(multi.NewWriter()).Start("Progressbar 5") | ||
|
||
multi.Start() | ||
|
||
// Randomly increment progress bars for demo purposes. | ||
for i := 1; i <= 100; i++ { | ||
pb1.Increment() | ||
|
||
if i%2 == 0 { | ||
pb2.Add(3) | ||
} | ||
|
||
if i%5 == 0 { | ||
pb3.Increment() | ||
} | ||
|
||
if i%10 == 0 { | ||
pb4.Increment() | ||
} | ||
|
||
if i%3 == 0 { | ||
pb5.Increment() | ||
} | ||
|
||
time.Sleep(time.Millisecond * 50) | ||
} | ||
|
||
multi.Stop() | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
package main | ||
|
||
import ( | ||
"github.com/pterm/pterm" | ||
"time" | ||
) | ||
|
||
func main() { | ||
multi := pterm.DefaultMultiPrinter | ||
|
||
spinner1, _ := pterm.DefaultSpinner.WithWriter(multi.NewWriter()).Start("Spinner 1") | ||
spinner2, _ := pterm.DefaultSpinner.WithWriter(multi.NewWriter()).Start("Spinner 2") | ||
spinner3, _ := pterm.DefaultSpinner.WithWriter(multi.NewWriter()).Start("Spinner 3") | ||
|
||
multi.Start() | ||
|
||
time.Sleep(time.Millisecond * 1000) | ||
spinner1.Success("Spinner 1 is done!") | ||
time.Sleep(time.Millisecond * 750) | ||
spinner2.Fail("Spinner 2 failed!") | ||
time.Sleep(time.Millisecond * 500) | ||
spinner3.Warning("Spinner 3 has a warning!") | ||
|
||
multi.Stop() | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,124 @@ | ||
package pterm | ||
|
||
import ( | ||
"atomicgo.dev/schedule" | ||
"bytes" | ||
"io" | ||
"os" | ||
"strings" | ||
"time" | ||
) | ||
|
||
var DefaultMultiPrinter = MultiPrinter{ | ||
printers: []LivePrinter{}, | ||
Writer: os.Stdout, | ||
UpdateDelay: time.Millisecond * 200, | ||
|
||
buffers: []*bytes.Buffer{}, | ||
area: DefaultArea, | ||
} | ||
|
||
type MultiPrinter struct { | ||
IsActive bool | ||
Writer io.Writer | ||
UpdateDelay time.Duration | ||
|
||
printers []LivePrinter | ||
buffers []*bytes.Buffer | ||
area AreaPrinter | ||
} | ||
|
||
// SetWriter sets the writer for the AreaPrinter. | ||
func (p *MultiPrinter) SetWriter(writer io.Writer) { | ||
p.Writer = writer | ||
} | ||
|
||
// WithWriter returns a fork of the MultiPrinter with a new writer. | ||
func (p MultiPrinter) WithWriter(writer io.Writer) *MultiPrinter { | ||
p.Writer = writer | ||
return &p | ||
} | ||
|
||
// WithUpdateDelay returns a fork of the MultiPrinter with a new update delay. | ||
func (p MultiPrinter) WithUpdateDelay(delay time.Duration) *MultiPrinter { | ||
p.UpdateDelay = delay | ||
return &p | ||
} | ||
|
||
func (p *MultiPrinter) NewWriter() io.Writer { | ||
buf := bytes.NewBufferString("") | ||
p.buffers = append(p.buffers, buf) | ||
return buf | ||
} | ||
|
||
// getString returns all buffers appended and separated by a newline. | ||
func (p *MultiPrinter) getString() string { | ||
var buffer bytes.Buffer | ||
for _, b := range p.buffers { | ||
s := b.String() | ||
s = strings.Trim(s, "\n") | ||
|
||
parts := strings.Split(s, "\r") // only get the last override | ||
s = parts[len(parts)-1] | ||
|
||
// check if s is empty, if so get one part before, repeat until not empty | ||
for s == "" { | ||
parts = parts[:len(parts)-1] | ||
s = parts[len(parts)-1] | ||
} | ||
|
||
s = strings.Trim(s, "\n\r") | ||
buffer.WriteString(s) | ||
buffer.WriteString("\n") | ||
} | ||
return buffer.String() | ||
} | ||
|
||
func (p *MultiPrinter) Start() (*MultiPrinter, error) { | ||
p.IsActive = true | ||
for _, printer := range p.printers { | ||
printer.GenericStart() | ||
} | ||
|
||
schedule.Every(p.UpdateDelay, func() bool { | ||
if !p.IsActive { | ||
return false | ||
} | ||
|
||
p.area.Update(p.getString()) | ||
|
||
return true | ||
}) | ||
|
||
return p, nil | ||
} | ||
|
||
func (p *MultiPrinter) Stop() (*MultiPrinter, error) { | ||
p.IsActive = false | ||
for _, printer := range p.printers { | ||
printer.GenericStop() | ||
} | ||
time.Sleep(time.Millisecond * 20) | ||
p.area.Update(p.getString()) | ||
p.area.Stop() | ||
|
||
return p, nil | ||
} | ||
|
||
// GenericStart runs Start, but returns a LivePrinter. | ||
// This is used for the interface LivePrinter. | ||
// You most likely want to use Start instead of this in your program. | ||
func (p MultiPrinter) GenericStart() (*LivePrinter, error) { | ||
p2, _ := p.Start() | ||
lp := LivePrinter(p2) | ||
return &lp, nil | ||
} | ||
|
||
// GenericStop runs Stop, but returns a LivePrinter. | ||
// This is used for the interface LivePrinter. | ||
// You most likely want to use Stop instead of this in your program. | ||
func (p MultiPrinter) GenericStop() (*LivePrinter, error) { | ||
p2, _ := p.Stop() | ||
lp := LivePrinter(p2) | ||
return &lp, nil | ||
} |
Oops, something went wrong.