Add a progress bar

chriskuehl · chriskuehl · commit f7213054ac78 · 2017-07-28T11:05:50.000-07:00
diff --git a/pre_commit/commands/run.py b/pre_commit/commands/run.py
@@ -103,17 +103,29 @@ def _run_single_hook(hook, repo, args, skips, cols):
 
     # Print the hook and the dots first in case the hook takes hella long to
     # run.
-    output.write(get_hook_message(
+    msg, num_dots = get_hook_message(
         _hook_msg_start(hook, args.verbose), end_len=6, cols=cols,
-    ))
+    )
+    output.write(msg)
     sys.stdout.flush()
 
     diff_before = cmd_output(
         'git', 'diff', '--no-ext-diff', retcode=None, encoding=None,
     )
+    dots_printed = [0]
+    def report_progress(progress):
+        dots_to_print = int(round(num_dots * progress))
+
+        for _ in range(dots_to_print - dots_printed[0]):
+            sys.stdout.write('.')
+            sys.stdout.flush()
+
+        dots_printed[0] = dots_to_print
+
     retcode, stdout, stderr = repo.run_hook(
         hook,
         tuple(filenames) if hook['pass_filenames'] else (),
+        report_progress,
     )
     diff_after = cmd_output(
         'git', 'diff', '--no-ext-diff', retcode=None, encoding=None,
diff --git a/pre_commit/languages/docker.py b/pre_commit/languages/docker.py
@@ -77,7 +77,7 @@ def install_environment(
         os.mkdir(directory)
 
 
-def run_hook(repo_cmd_runner, hook, file_args):  # pragma: windows no cover
+def run_hook(repo_cmd_runner, hook, file_args, report_progress):  # pragma: windows no cover
     assert_docker_available()
     # Rebuild the docker image in case it has gone missing, as many people do
     # automated cleanup of docker images.
@@ -96,4 +96,4 @@ def run_hook(repo_cmd_runner, hook, file_args):  # pragma: windows no cover
         docker_tag(repo_cmd_runner),
     ) + cmd_rest
 
-    return xargs(cmd, file_args)
+    return xargs(cmd, file_args, report_progress)
diff --git a/pre_commit/languages/golang.py b/pre_commit/languages/golang.py
@@ -70,6 +70,6 @@ def install_environment(repo_cmd_runner, version, additional_dependencies):
         rmtree(repo_cmd_runner.path(directory, 'pkg'))
 
 
-def run_hook(repo_cmd_runner, hook, file_args):
+def run_hook(repo_cmd_runner, hook, file_args, report_progress):
     with in_env(repo_cmd_runner):
-        return xargs(helpers.to_cmd(hook), file_args)
+        return xargs(helpers.to_cmd(hook), file_args, report_progress)
diff --git a/pre_commit/languages/node.py b/pre_commit/languages/node.py
@@ -61,6 +61,6 @@ def install_environment(
             )
 
 
-def run_hook(repo_cmd_runner, hook, file_args):  # pragma: windows no cover
+def run_hook(repo_cmd_runner, hook, file_args, report_progress):  # pragma: windows no cover
     with in_env(repo_cmd_runner, hook['language_version']):
-        return xargs(helpers.to_cmd(hook), file_args)
+        return xargs(helpers.to_cmd(hook), file_args, report_progress)
diff --git a/pre_commit/languages/pcre.py b/pre_commit/languages/pcre.py
@@ -17,10 +17,10 @@ def install_environment(repo_cmd_runner, version, additional_dependencies):
     raise AssertionError('Cannot install pcre repo.')
 
 
-def run_hook(repo_cmd_runner, hook, file_args):
+def run_hook(repo_cmd_runner, hook, file_args, report_progress):
     # For PCRE the entry is the regular expression to match
     cmd = (GREP, '-H', '-n', '-P') + tuple(hook['args']) + (hook['entry'],)
 
     # Grep usually returns 0 for matches, and nonzero for non-matches so we
     # negate it here.
-    return xargs(cmd, file_args, negate=True)
+    return xargs(cmd, file_args, report_progress, negate=True)
diff --git a/pre_commit/languages/python.py b/pre_commit/languages/python.py
@@ -130,6 +130,6 @@ def install_environment(repo_cmd_runner, version, additional_dependencies):
             )
 
 
-def run_hook(repo_cmd_runner, hook, file_args):
+def run_hook(repo_cmd_runner, hook, file_args, report_progress):
     with in_env(repo_cmd_runner, hook['language_version']):
-        return xargs(helpers.to_cmd(hook), file_args)
+        return xargs(helpers.to_cmd(hook), file_args, report_progress)
diff --git a/pre_commit/languages/ruby.py b/pre_commit/languages/ruby.py
@@ -130,6 +130,6 @@ def install_environment(
             )
 
 
-def run_hook(repo_cmd_runner, hook, file_args):  # pragma: windows no cover
+def run_hook(repo_cmd_runner, hook, file_args, report_progress):  # pragma: windows no cover
     with in_env(repo_cmd_runner, hook['language_version']):
-        return xargs(helpers.to_cmd(hook), file_args)
+        return xargs(helpers.to_cmd(hook), file_args, report_progress)
diff --git a/pre_commit/languages/script.py b/pre_commit/languages/script.py
@@ -14,7 +14,7 @@ def install_environment(repo_cmd_runner, version, additional_dependencies):
     raise AssertionError('Cannot install script repo.')
 
 
-def run_hook(repo_cmd_runner, hook, file_args):
+def run_hook(repo_cmd_runner, hook, file_args, report_progress):
     cmd = helpers.to_cmd(hook)
     cmd = (repo_cmd_runner.prefix_dir + cmd[0],) + cmd[1:]
-    return xargs(cmd, file_args)
+    return xargs(cmd, file_args, report_progress)
diff --git a/pre_commit/languages/swift.py b/pre_commit/languages/swift.py
@@ -50,6 +50,6 @@ def install_environment(
         ))
 
 
-def run_hook(repo_cmd_runner, hook, file_args):  # pragma: windows no cover
+def run_hook(repo_cmd_runner, hook, file_args, report_progress):  # pragma: windows no cover
     with in_env(repo_cmd_runner):
-        return xargs(helpers.to_cmd(hook), file_args)
+        return xargs(helpers.to_cmd(hook), file_args, report_progress)
diff --git a/pre_commit/languages/system.py b/pre_commit/languages/system.py
@@ -14,5 +14,5 @@ def install_environment(repo_cmd_runner, version, additional_dependencies):
     raise AssertionError('Cannot install system repo.')
 
 
-def run_hook(repo_cmd_runner, hook, file_args):
-    return xargs(helpers.to_cmd(hook), file_args)
+def run_hook(repo_cmd_runner, hook, file_args, report_progress):
+    return xargs(helpers.to_cmd(hook), file_args, report_progress)
diff --git a/pre_commit/output.py b/pre_commit/output.py
@@ -54,7 +54,10 @@ def get_hook_message(
         )
 
     if end_len:
-        return start + '.' * (cols - len(start) - end_len - 1)
+        num_dots = cols - len(start) - end_len - 1
+        if end_msg is None:
+            return start, num_dots
+        return start + '.' * num_dots
     else:
         return '{}{}{}{}\n'.format(
             start,
diff --git a/pre_commit/repository.py b/pre_commit/repository.py
@@ -177,7 +177,7 @@ def require_installed(self):
             _install_all(self._venvs, self.repo_config['repo'])
             self.__installed = True
 
-    def run_hook(self, hook, file_args):
+    def run_hook(self, hook, file_args, report_status):
         """Run a hook.
 
         :param dict hook:
@@ -187,7 +187,7 @@ def run_hook(self, hook, file_args):
         language_name = hook['language']
         deps = hook['additional_dependencies']
         cmd_runner = self._cmd_runner_from_deps(language_name, deps)
-        return languages[language_name].run_hook(cmd_runner, hook, file_args)
+        return languages[language_name].run_hook(cmd_runner, hook, file_args, report_status)
 
 
 class LocalRepository(Repository):
diff --git a/pre_commit/xargs.py b/pre_commit/xargs.py
@@ -7,7 +7,7 @@
 
 # Limit used previously to avoid "xargs ... Bad file number" on windows
 # This is slightly less than the posix mandated minimum
-MAX_LENGTH = 4000
+MAX_LENGTH = 500
 
 
 class ArgumentTooLongError(RuntimeError):
@@ -33,17 +33,17 @@ def partition(cmd, varargs, _max_length=MAX_LENGTH):
             raise ArgumentTooLongError(arg)
         else:
             # We've exceeded the length, yield a command
-            ret.append(cmd + tuple(ret_cmd))
+            ret.append(tuple(ret_cmd))
             ret_cmd = []
             total_len = len(' '.join(cmd))
             varargs.append(arg)
 
-    ret.append(cmd + tuple(ret_cmd))
+    ret.append(tuple(ret_cmd))
 
     return tuple(ret)
 
 
-def xargs(cmd, varargs, **kwargs):
+def xargs(cmd, varargs, report_progress, **kwargs):
     """A simplified implementation of xargs.
 
     negate: Make nonzero successful and zero a failure
@@ -58,7 +58,10 @@ def xargs(cmd, varargs, **kwargs):
     except parse_shebang.ExecutableNotFoundError as e:
         return e.to_output()
 
+    total = 0
     for run_cmd in partition(cmd, varargs, **kwargs):
+        total += len(run_cmd)
+        run_cmd = cmd + run_cmd
         proc_retcode, proc_out, proc_err = cmd_output(
             *run_cmd, encoding=None, retcode=None
         )
@@ -76,4 +79,7 @@ def xargs(cmd, varargs, **kwargs):
         stdout += proc_out
         stderr += proc_err
 
+        if report_progress is not None:
+            report_progress(float(total) / len(varargs))
+
     return retcode, stdout, stderr

Original file line number	Diff line number	Diff line change
`@@ -61,6 +61,6 @@ def install_environment(`
`61`	`61`	`)`
`62`	`62`
`63`	`63`
`64`		`-def run_hook(repo_cmd_runner, hook, file_args): # pragma: windows no cover`
	`64`	`+def run_hook(repo_cmd_runner, hook, file_args, report_progress): # pragma: windows no cover`
`65`	`65`	`with in_env(repo_cmd_runner, hook['language_version']):`
`66`		`- return xargs(helpers.to_cmd(hook), file_args)`
	`66`	`+ return xargs(helpers.to_cmd(hook), file_args, report_progress)`
Original file line number	Diff line number	Diff line change
`@@ -130,6 +130,6 @@ def install_environment(repo_cmd_runner, version, additional_dependencies):`
`130`	`130`	`)`
`131`	`131`
`132`	`132`
`133`		`-def run_hook(repo_cmd_runner, hook, file_args):`
	`133`	`+def run_hook(repo_cmd_runner, hook, file_args, report_progress):`
`134`	`134`	`with in_env(repo_cmd_runner, hook['language_version']):`
`135`		`- return xargs(helpers.to_cmd(hook), file_args)`
	`135`	`+ return xargs(helpers.to_cmd(hook), file_args, report_progress)`