Индикатор выполнения командной строки в PHP - PullRequest
33 голосов
/ 23 января 2010

В настоящее время я пытаюсь добавить индикатор выполнения в сценарий командной строки и пробовал различные решения (включая Zend и Console_ProgressBar). Проблема, которая у них обоих общая, заключается в том, что индикатор выполнения не прилипает к нижней части окна, поскольку во время выполнения сценария выводятся новые строки и другая информация.

Есть ли способ сохранить индикатор выполнения в нижней части терминала, но при этом иметь возможность выводить другую информацию во время работы скрипта?

[Изменить]

Я понял это:

Вместо того, чтобы выводить напрямую в STDOUT, я фактически получаю вывод внутри переменной, стираю экран с помощью echo chr(27) . '[2J', а затем выводю в STDOUT содержимое переменной, а затем добавляю индикатор выполнения.

Надеюсь, это имеет смысл:)

Ответы [ 4 ]

74 голосов
/ 24 марта 2012

Это хороший индикатор прогресса для cli:

http://snipplr.com/view/29548/

<?php

/*

Copyright (c) 2010, dealnews.com, Inc.
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

 * Redistributions of source code must retain the above copyright notice,
   this list of conditions and the following disclaimer.
 * Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.
 * Neither the name of dealnews.com, Inc. nor the names of its contributors
   may be used to endorse or promote products derived from this software
   without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.

 */

/**
 * show a status bar in the console
 * 
 * <code>
 * for($x=1;$x<=100;$x++){
 * 
 *     show_status($x, 100);
 * 
 *     usleep(100000);
 *                           
 * }
 * </code>
 *
 * @param   int     $done   how many items are completed
 * @param   int     $total  how many items are to be done total
 * @param   int     $size   optional size of the status bar
 * @return  void
 *
 */

function show_status($done, $total, $size=30) {

    static $start_time;

    // if we go over our bound, just ignore it
    if($done > $total) return;

    if(empty($start_time)) $start_time=time();
    $now = time();

    $perc=(double)($done/$total);

    $bar=floor($perc*$size);

    $status_bar="\r[";
    $status_bar.=str_repeat("=", $bar);
    if($bar<$size){
        $status_bar.=">";
        $status_bar.=str_repeat(" ", $size-$bar);
    } else {
        $status_bar.="=";
    }

    $disp=number_format($perc*100, 0);

    $status_bar.="] $disp%  $done/$total";

    $rate = ($now-$start_time)/$done;
    $left = $total - $done;
    $eta = round($rate * $left, 2);

    $elapsed = $now - $start_time;

    $status_bar.= " remaining: ".number_format($eta)." sec.  elapsed: ".number_format($elapsed)." sec.";

    echo "$status_bar  ";

    flush();

    // when done, send a newline
    if($done == $total) {
        echo "\n";
    }

}

?>
39 голосов
/ 26 ноября 2014

Другие ответы кажутся слишком сложными. Мое решение состоит в том, чтобы просто повторить \ 033 [0G escape-последовательность перед следующим обновлением, и он переместит курсор назад в начало.

function progressBar($done, $total) {
    $perc = floor(($done / $total) * 100);
    $left = 100 - $perc;
    $write = sprintf("\033[0G\033[2K[%'={$perc}s>%-{$left}s] - $perc%% - $done/$total", "", "");
    fwrite(STDERR, $write);
}

При первом вызове функции выводится индикатор выполнения, а при каждом последующем вызове последняя строка перезаписывается новой строкой выполнения.

EDIT: Я изменил echoing \ r на escape-последовательность \ 033 [0G, и теперь она должна работать как в OSX, так и в Linux / Unix.

РЕДАКТИРОВАТЬ 2: Исправлена ​​возможная ошибка в строке 3 согласно предложению @tbjers.

РЕДАКТИРОВАТЬ 3: Обновлено с новой версией, которая печатает в STDERR, а теперь и на GitHub: https://github.com/MacroMan/PHPTerminalProgressBar

4 голосов
/ 25 июля 2014

Это улучшение предыдущего ответа, которое обрабатывает изменения размера терминала и использует 2 строки вместо 1. Первая строка - это информация, такая как время / процент, вторая строка - индикатор выполнения.

<?
/*

Copyright (c) 2010, dealnews.com, Inc.
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

 * Redistributions of source code must retain the above copyright notice,
   this list of conditions and the following disclaimer.
 * Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.
 * Neither the name of dealnews.com, Inc. nor the names of its contributors
   may be used to endorse or promote products derived from this software
   without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.

 */

/**
 * show a status bar in the console
 *
 * <code>
 * for($x=1;$x<=100;$x++){
 *
 *     show_status($x, 100);
 *
 *     usleep(100000);
 *
 * }
 * </code>
 *
 * @param   int     $done   how many items are completed
 * @param   int     $total  how many items are to be done total
 * @param   int     $size   optional size of the status bar
 * @return  void
 *
 */

function show_status($done, $total, $size=30, $lineWidth=-1) {
    if($lineWidth <= 0){
        $lineWidth = $_ENV['COLUMNS'];
    }

    static $start_time;

    // to take account for [ and ]
    $size -= 3;
    // if we go over our bound, just ignore it
    if($done > $total) return;

    if(empty($start_time)) $start_time=time();
    $now = time();

    $perc=(double)($done/$total);

    $bar=floor($perc*$size);

    // jump to the begining
    echo "\r";
    // jump a line up
    echo "\x1b[A";

    $status_bar="[";
    $status_bar.=str_repeat("=", $bar);
    if($bar<$size){
        $status_bar.=">";
        $status_bar.=str_repeat(" ", $size-$bar);
    } else {
        $status_bar.="=";
    }

    $disp=number_format($perc*100, 0);

    $status_bar.="]";
    $details = "$disp%  $done/$total";

    $rate = ($now-$start_time)/$done;
    $left = $total - $done;
    $eta = round($rate * $left, 2);

    $elapsed = $now - $start_time;


    $details .= " " . formatTime($eta)." ". formatTime($elapsed);

    $lineWidth--;
    if(strlen($details) >= $lineWidth){
        $details = substr($details, 0, $lineWidth-1);
    }
    echo "$details\n$status_bar";

    flush();

    // when done, send a newline
    if($done == $total) {
        echo "\n";
    }

}

Я не знаю, почему у приведенного выше кода есть лицензия, я просто копирую ее, чтобы быть в безопасности. Ниже приведен код без лицензии. Бесплатно использовать для любых целей.

function formatTime($sec){
    if($sec > 100){
        $sec /= 60;
        if($sec > 100){
            $sec /= 60;
            return number_format($sec) . " hr";
        }
        return number_format($sec) . " min";
    }
    return number_format($sec) . " sec";
}


class Timer {
    public $time;
    function __construct(){
        $this->start();
    }
    function start($offset=0){
        $this->time = microtime(true) + $offset;
    }
    function seconds(){
        return microtime(true) - $this->time;
    }
};


// We need this to limit the frequency of the progress bar. Or else it
// hugely slows down the app.
class FPSLimit {
    public $frequency;
    public $maxDt;
    public $timer;
    function __construct($freq){
        $this->setFrequency($freq);
        $this->timer = new Timer();
        $this->timer->start();
    }
    function setFrequency($freq){
        $this->frequency = $freq;
        $this->maxDt = 1.0/$freq;
    }
    function frame(){
        $dt = $this->timer->seconds();
        if($dt > $this->maxDt){
            $this->timer->start($dt - $this->maxDt);
            return true;
        }
        return false;
    }
};

class Progress {
    // generic progress class to update different things
    function update($units, $total){}
}

class SimpleProgress extends Progress {
    private $cols;
    private $limiter;
    private $units;
    private $total;

    function __construct(){
        // change the fps limit as needed
        $this->limiter = new FPSLimit(10);
        echo "\n";
    }

    function __destruct(){
        $this->draw();
    }

    function updateSize(){
        // get the number of columns
        $this->cols = exec("tput cols");
    }

    function draw(){
        $this->updateSize();
        show_status($this->units, $this->total, $this->cols, $this->cols);
    }

    function update($units, $total){
        $this->units = $units;
        $this->total = $total;
        if(!$this->limiter->frame())
            return;
        $this->draw();
    }
}


// example

$tasks = rand() % 700 + 600;
$done = 0;

$progress = new SimpleProgress();

for($done = 0; $done <= $tasks; $done++){
    usleep((rand() % 127)*100);
    $progress->update($done, $tasks);
}
2 голосов
/ 19 марта 2018

Следующее относится к машинам Unix .

Цель состоит в том, чтобы получить текущие итоговые столбцы терминала. (используя tput)

Это база, готовая к расширению.

 #!/usr/bin/php
 <?php

 @ob_start();

 $shell = system("tput cols");

 @ob_end_clean();

 for( $i= 0 ; $i < $shell ; $i++ ){ echo "█"; usleep(100000); } 

enter image description here

Действия ob здесь, чтобы скрыть stdout из tput.

Допустим, вы хотите, чтобы индикатор выполнения соответствовал прогрессу вашей задачи.

Просто разделите оставшееся время в секундах на количество столбцов.

Вы можете получить микросекунды, поэтому лучше использовать usleep.

Таким образом, индикатор выполнения всегда будет соответствовать ширине пользовательской оболочки, в том числе при изменении размера.

Чтобы сделать то же самое в чистом bash:

for ((i=0; i<$(tput cols); i++)); do echo -e "█\c" ;done

Это показывает главную особенность php echo: он не добавляет новую строку, в то время как bash echo делает.

При использовании циклов, скажем, для проверки условия в интервалах, Еще один приятный способ предупредить о текущей активности - текстовые эффекты .

Следующее использование strtoupper и код ANSI обратное видео .

#!/usr/bin/php
<?php
$iloop = "0"; /* Outside the loop */
while (true){  
  $warn = "Program running hold on!!\r";
  if (strlen($warn) === $iloop+1){
    $iloop = "0";
  }
  $warn = str_split($warn);
  $iloop++;
  $warn[$iloop] = "\033[35;2m\e[0m".strtoupper($warn[$iloop]);
  echo " \033[7m".implode($warn);
  usleep(90000);
}

Выход:

enter image description here

Некоторым может понравиться версия для вечеринки, полученная путем итерации кодов ANSI.

#!/usr/bin/php
<?php
$iloop = "0"; /* Outside the loop */
while (true){    
for ($i=0;$i<=109;$i++){
  $warn = "Program running hold on!!\r";
  if (strlen($warn) === $iloop+1){
    $iloop = "0";
  }
  $warn = str_split($warn);
  $iloop++;
  $warn[$iloop] = "\033[$i;7m".strtoupper($warn[$iloop]);
  echo " \033[7m".implode($warn);
  usleep(90000);
}}

enter image description here

Подробнее о ANSI кодах: https://stackoverflow.com/a/48365998/2494754

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...