Improve logging output of CommandPool.run()

xolox · May 24, 2015 · 13a869a · 13a869a
1 parent 62051e3
commit 13a869a
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 5 deletions.
diff --git a/executor/__init__.py b/executor/__init__.py
@@ -60,7 +60,7 @@
 )
 
 # Semi-standard module versioning.
-__version__ = '2.2.1'
+__version__ = '2.2.2'
 
 # Initialize a logger.
 logger = logging.getLogger(__name__)

diff --git a/executor/concurrent.py b/executor/concurrent.py
@@ -22,7 +22,7 @@
 from executor.writable_property import default_property
 
 # External dependencies.
-from humanfriendly import Spinner, Timer
+from humanfriendly import pluralize, Spinner, Timer
 
 # Initialize a logger.
 logger = logging.getLogger(__name__)
@@ -125,16 +125,23 @@ def run(self):
         """
         # Start spawning processes to execute the commands.
         timer = Timer()
-        logger.debug("Preparing to run %i commands with a concurrency of %i ..", self.num_commands, self.concurrency)
+        logger.debug("Preparing to run %s with a concurrency of %i ..",
+                     pluralize(self.num_commands, "command"),
+                     self.concurrency)
         with Spinner(timer=timer) as spinner:
             while not self.is_finished:
                 self.spawn()
                 self.collect()
-                spinner.step(label="Waiting for %i/%i commands" % (self.num_commands - self.num_finished, self.num_commands))
+                label_format = "Waiting for %i/%i %s"
+                waiting_for = self.num_commands - self.num_finished
+                commands_pluralized = "command" if self.num_commands == 1 else "commands"
+                spinner.step(label=label_format % (waiting_for, self.num_commands, commands_pluralized))
                 spinner.sleep()
         # Collect the output and return code of any commands not yet collected.
         self.collect()
-        logger.debug("Finished running %i commands in %s.", self.num_commands, timer)
+        logger.debug("Finished running %s in %s.",
+                     pluralize(self.num_commands, "command"),
+                     timer)
         # Report the results to the caller.
         return dict(self.commands)