使用Python进行Sublime Text的进度条

Question

我在MacOSX上使用强大的Sublime Text 3编辑器来运行python代码。我想显示for循环的进度条，以及以下命令：

sys.stdout.write('\rProgress : %03.2f %%' % (100*float(i)/(N)))
sys.flush()

不会按预期（\r）清除输出窗口中先前打印的行，但会生成N行：

Progress : 0.25 %
Progress : 0.50 %
Progress : 0.75 %
Progress : 1.00 %
Progress : 1.25 %
Progress : 1.50 %
Progress : 1.75 %
Progress : 2.00 %
Progress : 2.25 %
Progress : 2.50 %
...

阅读起来并不是很好 - 我得出结论，输出窗口可能是只读的。

有没有人建议改善Sublime Text中进度条的使用？

Answer 1

看一下sublime.py，我们发现flush方法实际上什么都不做：

class _LogWriter:
    def flush(self):
        pass

    def write(self, s):
        sublime_api.log_message(s)

sys.stdout = _LogWriter()
sys.stderr = _LogWriter()

但是我不建议将控制台用于用户输出。通常使用输出面板/视图或状态消息。

状态消息更易于使用，但功能较弱。 sergioFC在his answer中证明了这一点。

这演示了如何使用输出面板。它非常灵活，但您必须编写自己的文本命令来插入文本。这是必要的，因为您需要一个编辑对象来更改视图的内容。

import sublime
import sublime_plugin


class MyInsertProgressBarCommand(sublime_plugin.TextCommand):
    def run(self, edit, value):
        view = self.view
        width, _ = view.viewport_extent()
        em_width = view.em_width()
        # the number of columns are the width divided by the width of a char
        # subtract two to add a little border
        columns = int(width / em_width) - 2

        # subtract two, because we surround it with [ and ]
        bar_length = columns - 2
        # calculate the size of the filled and the remaining part
        filled_length = int(bar_length * value / 100)
        remaining_length = bar_length - filled_length
        # assemble the string for the progress bar
        text = "[{0}{1}]\n".format("=" * filled_length, "." * remaining_length)
        # add the text for the percentages
        if value >= 100:
            percentage_text = "finished!"
        else:
            percentage_text = "{:3.2f} %".format(value)
        text += " " * (columns - len(percentage_text)) + percentage_text

        # replace the content of the view
        view.replace(edit, sublime.Region(0, view.size()), text)
        # reset sels
        view.sel().clear()
        view.sel().add(sublime.Region(0, 0))


class ProgressBarCommand(sublime_plugin.WindowCommand):
    def run(self):
        self.window.create_output_panel("progess_bar")
        self.window.run_command("show_panel", {"panel": "output.progess_bar"})

        def test_progress_bar():
            import random
            test_progress_bar.value += 2 * random.random()
            if test_progress_bar.value >= 100:
                self.finish_progress()
                return
            self.show_progress(test_progress_bar.value)

            sublime.set_timeout(test_progress_bar, 100)
        test_progress_bar.value = 0

        sublime.set_timeout_async(test_progress_bar, 1)

    def show_progress(self, progess):
        view = self.window.find_output_panel("progess_bar")
        view.run_command("my_insert_progress_bar", {"value": progess})

    def finish_progress(self):
        self.show_progress(100)
        sublime.set_timeout(self._destroy, 5000)

    def _destroy(self):
        self.window.destroy_output_panel("progess_bar")

输出：

Answer 2

作为另一种替代解决方案，您可以使用状态栏。设置状态栏消息时，将清除上一个文本。 包控件在安装包时也使用状态栏。

示例：

import sublime, sublime_plugin
import time

class ExampleCommand(sublime_plugin.WindowCommand):
    def run(self, args):
        sublime.set_timeout_async(self.test,1)

    def test(self):
        i=80
        while i <= 100:
            sublime.status_message('%03.2f %%' % i)
            time.sleep(0.15)
            i+=0.25
        sublime.status_message('100% Stackoverflow!')

Answer 3

您可以使用以下方式创建可视进度条：

• mdpopups库
• sublime.set_timeout或sublime.set_timeout_async （参见：Sublime Module）

演示：

代码：

@ GitHub

（通过在命令调色板中键入Progress Bar Demo来运行插件）

注意：

有一个css file可以控制mdpopups的样式。 出于某种原因，color属性没有任何效果。

此外，mdpopups.show_popup的{​​{1}}参数需要location才能在插入符号位置设置弹出窗口。 否则，我不确定-1如何影响弹出窗口，因为它只需要一个整数值。

我在下面的帖子中询问了这些问题：

[Proof Of Concept] Visual Progress Bar

Answer 4

您可能正在寻找的是一种使输出不会消耗多行的方法。您可以打印\b（退格符）与之前打印的字符一样多次。我写这个作为一个例子：

（Python 2.7.6）

from __future__ import print_function
import time, sys

for i in range(1, 6):
    print(i, end='')
    sys.stdout.flush()
    time.sleep(0.5)
    print('\b', end='')

尝试运行它，您可以根据自己的需要进行调整。

Answer 5

您可以使用进度条库。位于此处：https://pypi.python.org/pypi/progressbar/2.3-dev

您也可以从easy_install安装它，只需输入：easy_install progressbar

使用示例：

如果你想要简单的进度条，没有关于功能的信息：

from progressbar import *
from time import sleep

progress = ProgressBar()
for i in progress(range(80)):
  sleep(0.01)

否则，如果您希望进度条包含有关功能的信息：

from progressbar import *
from time import sleep

widgets = ['Something: ', Percentage(), ' ', Bar(marker=RotatingMarker()),
           ' ', ETA(), ' ', FileTransferSpeed()]
pbar = ProgressBar(widgets=widgets, maxval=10000000).start()
for i in range(1000000):
  # do something
  pbar.update(10*i+1)
  sleep(0.000001)
pbar.finish()

Answer 6

不幸的是，这在Sublime的输出面板中是不可能的。该面板不是真正的控制台或终端，除其他差异外，不会解释转义序列，例如\r和\b（\n 正确解释，但是）。如果您想了解它的确切运作方式，请安装PackageResourceViewer，然后打开Packages/Default/exec.py。

为了使其发挥作用，您需要创建一个新的build system以在终端中运行它。由于OS X的变幻莫测，您需要创建两个文件。第一个是shell脚本：

#!/bin/sh
osascript -e '    
  on run parameters        
    tell application "Terminal"            
      activate            
      do script with command "/path/to/python " & parameters        
    end tell    
  end run
' $@

使用/path/to（或python）的实际路径更改python3。将其保存在PythonTerminal.sh的任意位置。接下来，选择 Tools -> Build System -> New Build System 并粘贴以下内容：

{
    "cmd": ["/bin/sh /path/to/Python3Terminal.sh \"$file\""],
    "file_regex": "^[ ]*File \"(...*?)\", line ([0-9]*)",
    "selector": "source.python",
    "shell": true
}

再次，将/path/to更改为PythonTerminal.sh的实际路径。将文件另存为Packages/User/PythonTerminal.sublime-build（保存时应自动打开正确的目录）。

最后，选择 Tools -> Build System -> PythonTerminal ，切换到您的Python文件，然后使用⌘ B 进行构建。将打开一个新的终端窗口，您的进度条应该运行。