WIP: progress dots

asottile · asottile · commit f21257cdbaa9 · 2019-10-19T13:30:13.000-07:00
Based on @chriskuehl's branch here: - chriskuehl@f721305
diff --git a/pre_commit/commands/run.py b/pre_commit/commands/run.py
@@ -110,16 +110,25 @@ def _run_single_hook(classifier, hook, args, skips, cols, use_color):
 
     # Print the hook and the dots first in case the hook takes hella long to
     # run.
-    output.write(
-        get_hook_message(
-            _hook_msg_start(hook, args.verbose), end_len=6, cols=cols,
-        ),
+    msg, num_dots = get_hook_message(
+        _hook_msg_start(hook, args.verbose), end_len=6, cols=cols,
     )
+    output.write(msg)
     sys.stdout.flush()
 
+    dots_printed = [0]
+
+    def progress(perc):
+        dots_to_print = int(round(num_dots * perc))
+
+        sys.stdout.write('.' * (dots_to_print - dots_printed[0]))
+        sys.stdout.flush()
+
+        dots_printed[0] = dots_to_print
+
     diff_before = cmd_output_b('git', 'diff', '--no-ext-diff', retcode=None)
     filenames = tuple(filenames) if hook.pass_filenames else ()
-    retcode, out = hook.run(filenames, use_color)
+    retcode, out = hook.run(filenames, use_color, progress)
     diff_after = cmd_output_b('git', 'diff', '--no-ext-diff', retcode=None)
 
     file_modifications = diff_before != diff_after
diff --git a/pre_commit/languages/all.py b/pre_commit/languages/all.py
@@ -38,14 +38,15 @@
 #         version - A version specified in the hook configuration or 'default'.
 #     """
 #
-# def run_hook(hook, file_args, color):
+# def run_hook(hook, file_args, color, progress):
 #     """Runs a hook and returns the returncode and output of running that
 #     hook.
 #
 #     Args:
 #         hook - `Hook`
 #         file_args - The files to be run
 #         color - whether the hook should be given a pty (when supported)
+#         progress - report progress as a float percentage
 #
 #     Returns:
 #         (returncode, output)
diff --git a/pre_commit/languages/docker.py b/pre_commit/languages/docker.py
@@ -95,7 +95,7 @@ def docker_cmd():  # pragma: windows no cover
     )
 
 
-def run_hook(hook, file_args, color):  # pragma: windows no cover
+def run_hook(hook, file_args, color, 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.
@@ -106,4 +106,6 @@ def run_hook(hook, file_args, color):  # pragma: windows no cover
 
     entry_tag = ('--entrypoint', entry_exe, docker_tag(hook.prefix))
     cmd = docker_cmd() + entry_tag + cmd_rest
-    return helpers.run_xargs(hook, cmd, file_args, color=color)
+    return helpers.run_xargs(
+        hook, cmd, file_args, color=color, progress=progress,
+    )
diff --git a/pre_commit/languages/docker_image.py b/pre_commit/languages/docker_image.py
@@ -12,7 +12,9 @@
 install_environment = helpers.no_install
 
 
-def run_hook(hook, file_args, color):  # pragma: windows no cover
+def run_hook(hook, file_args, color, progress):  # pragma: windows no cover
     assert_docker_available()
     cmd = docker_cmd() + hook.cmd
-    return helpers.run_xargs(hook, cmd, file_args, color=color)
+    return helpers.run_xargs(
+        hook, cmd, file_args, color=color, progress=progress,
+    )
diff --git a/pre_commit/languages/golang.py b/pre_commit/languages/golang.py
@@ -81,6 +81,8 @@ def install_environment(prefix, version, additional_dependencies):
             rmtree(pkgdir)
 
 
-def run_hook(hook, file_args, color):
+def run_hook(hook, file_args, color, progress):
     with in_env(hook.prefix):
-        return helpers.run_xargs(hook, hook.cmd, file_args, color=color)
+        return helpers.run_xargs(
+            hook, hook.cmd, file_args, color=color, progress=progress,
+        )
diff --git a/pre_commit/languages/node.py b/pre_commit/languages/node.py
@@ -78,6 +78,8 @@ def install_environment(
             )
 
 
-def run_hook(hook, file_args, color):  # pragma: windows no cover
+def run_hook(hook, file_args, color, progress):  # pragma: windows no cover
     with in_env(hook.prefix, hook.language_version):
-        return helpers.run_xargs(hook, hook.cmd, file_args, color=color)
+        return helpers.run_xargs(
+            hook, hook.cmd, file_args, color=color, progress=progress,
+        )
diff --git a/pre_commit/languages/python.py b/pre_commit/languages/python.py
@@ -151,9 +151,11 @@ def healthy(prefix, language_version):
             )
         return retcode == 0
 
-    def run_hook(hook, file_args, color):
+    def run_hook(hook, file_args, color, progress):
         with in_env(hook.prefix, hook.language_version):
-            return helpers.run_xargs(hook, hook.cmd, file_args, color=color)
+            return helpers.run_xargs(
+                hook, hook.cmd, file_args, color=color, progress=progress,
+            )
 
     def install_environment(prefix, version, additional_dependencies):
         additional_dependencies = tuple(additional_dependencies)
diff --git a/pre_commit/languages/ruby.py b/pre_commit/languages/ruby.py
@@ -124,6 +124,8 @@ def install_environment(
             )
 
 
-def run_hook(hook, file_args, color):  # pragma: windows no cover
+def run_hook(hook, file_args, color, progress):  # pragma: windows no cover
     with in_env(hook.prefix, hook.language_version):
-        return helpers.run_xargs(hook, hook.cmd, file_args, color=color)
+        return helpers.run_xargs(
+            hook, hook.cmd, file_args, color=color, progress=progress,
+        )
diff --git a/pre_commit/languages/rust.py b/pre_commit/languages/rust.py
@@ -89,6 +89,8 @@ def install_environment(prefix, version, additional_dependencies):
             )
 
 
-def run_hook(hook, file_args, color):
+def run_hook(hook, file_args, color, progress):
     with in_env(hook.prefix):
-        return helpers.run_xargs(hook, hook.cmd, file_args, color=color)
+        return helpers.run_xargs(
+            hook, hook.cmd, file_args, color=color, progress=progress,
+        )
diff --git a/pre_commit/languages/script.py b/pre_commit/languages/script.py
@@ -9,7 +9,9 @@
 install_environment = helpers.no_install
 
 
-def run_hook(hook, file_args, color):
+def run_hook(hook, file_args, color, progress):
     cmd = hook.cmd
     cmd = (hook.prefix.path(cmd[0]),) + cmd[1:]
-    return helpers.run_xargs(hook, cmd, file_args, color=color)
+    return helpers.run_xargs(
+        hook, cmd, file_args, color=color, progress=progress,
+    )
diff --git a/pre_commit/languages/swift.py b/pre_commit/languages/swift.py
@@ -51,6 +51,8 @@ def install_environment(
         )
 
 
-def run_hook(hook, file_args, color):  # pragma: windows no cover
+def run_hook(hook, file_args, color, progress):  # pragma: windows no cover
     with in_env(hook.prefix):
-        return helpers.run_xargs(hook, hook.cmd, file_args, color=color)
+        return helpers.run_xargs(
+            hook, hook.cmd, file_args, color=color, progress=progress,
+        )
diff --git a/pre_commit/languages/system.py b/pre_commit/languages/system.py
@@ -9,5 +9,7 @@
 install_environment = helpers.no_install
 
 
-def run_hook(hook, file_args, color):
-    return helpers.run_xargs(hook, hook.cmd, file_args, color=color)
+def run_hook(hook, file_args, color, progress):
+    return helpers.run_xargs(
+        hook, hook.cmd, file_args, color=color, progress=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
@@ -100,9 +100,9 @@ def install(self):
         # Write our state to indicate we're installed
         _write_state(self.prefix, venv, _state(self.additional_dependencies))
 
-    def run(self, file_args, color):
+    def run(self, file_args, color, progress):
         lang = languages[self.language]
-        return lang.run_hook(self, file_args, color)
+        return lang.run_hook(self, file_args, color, progress)
 
     @classmethod
     def create(cls, src, prefix, dct):
diff --git a/pre_commit/xargs.py b/pre_commit/xargs.py
@@ -112,6 +112,7 @@ def xargs(cmd, varargs, **kwargs):
     color = kwargs.pop('color', False)
     negate = kwargs.pop('negate', False)
     target_concurrency = kwargs.pop('target_concurrency', 1)
+    progress = kwargs.pop('progress', lambda _: None)
     max_length = kwargs.pop('_max_length', _get_platform_max_length())
     cmd_fn = cmd_output_p if color else cmd_output_b
     retcode = 0
@@ -125,15 +126,17 @@ def xargs(cmd, varargs, **kwargs):
     partitions = partition(cmd, varargs, target_concurrency, max_length)
 
     def run_cmd_partition(run_cmd):
-        return cmd_fn(
+        ret = cmd_fn(
             *run_cmd, retcode=None, stderr=subprocess.STDOUT, **kwargs
         )
+        return ret, len(run_cmd) - len(cmd)
 
     threads = min(len(partitions), target_concurrency)
     with _thread_mapper(threads) as thread_map:
         results = thread_map(run_cmd_partition, partitions)
 
-        for proc_retcode, proc_out, _ in results:
+        total_processed = 0
+        for (proc_retcode, proc_out, _), processed in results:
             # This is *slightly* too clever so I'll explain it.
             # First the xor boolean table:
             #     T | F |
@@ -146,5 +149,7 @@ def run_cmd_partition(run_cmd):
             # code. Otherwise, the returncode is unchanged.
             retcode |= bool(proc_retcode) ^ negate
             stdout += proc_out
+            total_processed += processed
+            progress(float(total_processed) / len(varargs))
 
     return retcode, stdout

Original file line number	Diff line number	Diff line change
`@@ -38,14 +38,15 @@`
`38`	`38`	`# version - A version specified in the hook configuration or 'default'.`
`39`	`39`	`# """`
`40`	`40`	`#`
`41`		`-# def run_hook(hook, file_args, color):`
	`41`	`+# def run_hook(hook, file_args, color, progress):`
`42`	`42`	`# """Runs a hook and returns the returncode and output of running that`
`43`	`43`	`# hook.`
`44`	`44`	`#`
`45`	`45`	`# Args:`
`46`	`46`	# hook - `Hook`
`47`	`47`	`# file_args - The files to be run`
`48`	`48`	`# color - whether the hook should be given a pty (when supported)`
	`49`	`+# progress - report progress as a float percentage`
`49`	`50`	`#`
`50`	`51`	`# Returns:`
`51`	`52`	`# (returncode, output)`
Original file line number	Diff line number	Diff line change
`@@ -78,6 +78,8 @@ def install_environment(`
`78`	`78`	`)`
`79`	`79`
`80`	`80`
`81`		`-def run_hook(hook, file_args, color): # pragma: windows no cover`
	`81`	`+def run_hook(hook, file_args, color, progress): # pragma: windows no cover`
`82`	`82`	`with in_env(hook.prefix, hook.language_version):`
`83`		`- return helpers.run_xargs(hook, hook.cmd, file_args, color=color)`
	`83`	`+ return helpers.run_xargs(`
	`84`	`+ hook, hook.cmd, file_args, color=color, progress=progress,`
	`85`	`+ )`
Original file line number	Diff line number	Diff line change
`@@ -124,6 +124,8 @@ def install_environment(`
`124`	`124`	`)`
`125`	`125`
`126`	`126`
`127`		`-def run_hook(hook, file_args, color): # pragma: windows no cover`
	`127`	`+def run_hook(hook, file_args, color, progress): # pragma: windows no cover`
`128`	`128`	`with in_env(hook.prefix, hook.language_version):`
`129`		`- return helpers.run_xargs(hook, hook.cmd, file_args, color=color)`
	`129`	`+ return helpers.run_xargs(`
	`130`	`+ hook, hook.cmd, file_args, color=color, progress=progress,`
	`131`	`+ )`
Original file line number	Diff line number	Diff line change
`@@ -89,6 +89,8 @@ def install_environment(prefix, version, additional_dependencies):`
`89`	`89`	`)`
`90`	`90`
`91`	`91`
`92`		`-def run_hook(hook, file_args, color):`
	`92`	`+def run_hook(hook, file_args, color, progress):`
`93`	`93`	`with in_env(hook.prefix):`
`94`		`- return helpers.run_xargs(hook, hook.cmd, file_args, color=color)`
	`94`	`+ return helpers.run_xargs(`
	`95`	`+ hook, hook.cmd, file_args, color=color, progress=progress,`
	`96`	`+ )`