Update command line output

Question

My program (which happens to be in Perl, though I don't think this question is Perl-specific) outputs status messages at one point in the program of the form Progress: x/yy where x and yy are a number, like: Progress: 4/38.

I'd like to "overwrite" the previous output when a new status message is printed so I don't fill the screen with status messages. So far, I've tried this:

my $progressString = "Progress\t$counter / " . $total . "\n";
print $progressString;
#do lots of processing, update $counter
my $i = 0;
while ($i < length($progressString)) {
    print "\b";
    ++$i;
}

The backspace character won't print if I include a newline in $progressString. If I leave out the newline, however, the output buffer is never flushed and nothing prints.

What's a good solution for this?

Michael Goldshteyn · Accepted Answer · 2011-02-15 20:56:34Z

13

Use autoflush with STDOUT:

local $| = 1; # Or use IO::Handle; STDOUT->autoflush;

print 'Progress: ';
my $progressString;
while ...
{
  # remove prev progress
  print "\b" x length($progressString) if defined $progressString;
  # do lots of processing, update $counter
  $progressString = "$counter / $total"; # No more newline
  print $progressString; # Will print, because auto-flush is on
  # end of processing
}
print "\n"; # Don't forget the trailing newline

edited Feb 15, 2011 at 20:56

answered Feb 15, 2011 at 20:46

Michael Goldshteyn

74.9k25 gold badges136 silver badges183 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

yavoh Over a year ago

This sort of works. I end up with rather garbled output, such as: 5 / 73 / 70 / 7. I see various garbled forms of the word "Progress" and numbers while the code is running.

yavoh Over a year ago

Something in the processing code is messing with stdout, I think. On its own, your code works. Thanks!

mob · Accepted Answer · 2011-02-15 20:47:54Z

4

Say

$| = 1

somewhere early in your program to turn autoflushing on for the output buffer.

Also consider using "\r" to move the cursor back to the beginning of the line, rather than trying to explicitly count how many spaces you need to move back.

Like you said, don't print out a newline while your progress counter is running or else you will print out your progress on a separate line instead of overwriting the old line.

answered Feb 15, 2011 at 20:47

mob

119k18 gold badges159 silver badges291 bronze badges

Comments

Joel Berger · Accepted Answer · 2011-02-16 05:51:20Z

3

I know it's not quite what you asked for, but possibly better. I happened on this same problem and so rather than deal with it too much went to using Term::ProgressBar which looks nice too.

answered Feb 16, 2011 at 5:51

Joel Berger

20.3k5 gold badges52 silver badges106 bronze badges

Comments

Anthony Agresta · Accepted Answer · 2011-02-15 22:31:26Z

1

I had to tackle something similar to this today. If you don't mind reprinting the entire line, you could do something like this:

print "\n";
while (...) {
     print "\rProgress: $counter / $total";
     # do processing work here
     $counter++;
}
print "\n";

The "\r" character is a carriage return-- it brings the cursor back to the beginning of the line. That way, anything you print out overwrites the previous progress notification's text.

answered Feb 15, 2011 at 22:31

Anthony Agresta

111 bronze badge

Comments

HoldOffHunger · Accepted Answer · 2020-08-26 14:59:53Z

1

You can also use the ANSI escape codes to directly control the cursor. Or you can use Term::ReadKey to do the same thing.

edited Aug 26, 2020 at 14:59

HoldOffHunger

21.3k11 gold badges123 silver badges147 bronze badges

answered Feb 15, 2011 at 23:42

shawnhcorey

3,6111 gold badge17 silver badges20 bronze badges

Collectives™ on Stack Overflow

Update command line output

5 Answers 5

2 Comments

Comments

Comments

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

5 Answers 5

2 Comments

Comments

Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related