Add a -q (quiet) option to tox (tox-dev#682)

* Add a -q (quiet) option to tox Sometimes the output of tox in addition to the output of the command(s) tox is running can be a overwhelming and confusing. Allowing users to silence tox's output is incredibly useful in focusing on the command(s)'s output. Resolves tox-dev#256 * Add a changelog item and add myself to contributors * Rephrase our changelog item and fixup change Use a class to contain named constants to replace all the magic numbers used in the reporter. Further, rename the parsed values from the command-line.

Author: sigmavirus24

CONTRIBUTORS

@@ -20,6 +20,7 @@ Eugene Yunak
 Fernando L. Pereira
 Hazal Ozturk
 Henk-Jaap Wagenaar
+Ian Stapleton Cordasco
 Igor Duarte Cardoso
 Ionel Maries Cristian
 Itxaka Serrano

changelog/256.feature.rst

@@ -0,0 +1,5 @@
+Add a ``-q`` option to progressively silence tox's output. For each time you specify ``-q`` to tox,
+the output provided by tox reduces. This option allows you to see only your command output without
+the default verbosity of what tox is doing. This also counter-acts usage of ``-v``. For example,
+running ``tox -v -q ...`` will provide you with the default verbosity. ``tox -vv -q`` is equivalent
+to ``tox -v``. By @sigmavirus24

tests/test_config.py

@@ -1550,11 +1550,21 @@ def test_notest(self, newconfig):
 
  def test_verbosity(self, newconfig):
  config = newconfig([], "")
- assert config.option.verbosity == 0
+ assert config.option.verbose_level == 0
  config = newconfig(["-v"], "")
- assert config.option.verbosity == 1
+ assert config.option.verbose_level == 1
  config = newconfig(["-vv"], "")
- assert config.option.verbosity == 2
+ assert config.option.verbose_level == 2
+
+ @pytest.mark.parametrize('args, expected', [
+ ([], 0),
+ (["-q"], 1),
+ (["-qq"], 2),
+ (["-qqq"], 3),
+ ])
+ def test_quiet(self, args, expected, newconfig):
+ config = newconfig(args, "")
+ assert config.option.quiet_level == expected
 
  def test_substitution_jenkins_default(self, tmpdir,
  monkeypatch, newconfig):

tox/config.py

@@ -355,9 +355,11 @@ def tox_addoption(parser):
  help="show help about options")
  parser.add_argument("--help-ini", "--hi", action="store_true", dest="helpini",
  help="show help about ini-names")
- parser.add_argument("-v", action='count', dest="verbosity", default=0,
+ parser.add_argument("-v", action='count', dest="verbose_level", default=0,
  help="increase verbosity of reporting output. -vv mode turns off "
  "output redirection for package installation")
+ parser.add_argument("-q", action="count", dest="quiet_level", default=0,
+ help="progressively silence reporting output.")
  parser.add_argument("--showconfig", action="store_true",
  help="show configuration information for all environments. ")
  parser.add_argument("-l", "--listenvs", action="store_true",

tox/session.py

@@ -230,6 +230,14 @@ def _popen(self, args, cwd, stdout, stderr, env=None):
  stdout=stdout, stderr=stderr, env=env)
 
 
+class Verbosity(object):
+ DEBUG = 2
+ INFO = 1
+ DEFAULT = 0
+ QUIET = -1
+ EXTRA_QUIET = -2
+
+
 class Reporter(object):
  actionchar = "-"
 
@@ -241,9 +249,10 @@ def __init__(self, session):
  @property
  def verbosity(self):
  if self.session:
- return self.session.config.option.verbosity
+ return (self.session.config.option.verbose_level -
+ self.session.config.option.quiet_level)
  else:
- return 2
+ return Verbosity.DEBUG
 
  def logpopen(self, popen, env):
  """ log information about the action.popen() created process. """
@@ -266,10 +275,11 @@ def logaction_finish(self, action):
  delattr(action, '_starttime')
 
  def startsummary(self):
- self.tw.sep("_", "summary")
+ if self.verbosity >= Verbosity.QUIET:
+ self.tw.sep("_", "summary")
 
  def info(self, msg):
- if self.verbosity >= 2:
+ if self.verbosity >= Verbosity.DEBUG:
  self.logline(msg)
 
  def using(self, msg):
@@ -293,28 +303,31 @@ def good(self, msg):
  self.logline(msg, green=True)
 
  def warning(self, msg):
- self.logline("WARNING:" + msg, red=True)
+ if self.verbosity >= Verbosity.QUIET:
+ self.logline("WARNING:" + msg, red=True)
 
  def error(self, msg):
- self.logline("ERROR: " + msg, red=True)
+ if self.verbosity >= Verbosity.QUIET:
+ self.logline("ERROR: " + msg, red=True)
 
  def skip(self, msg):
- self.logline("SKIPPED:" + msg, yellow=True)
+ if self.verbosity >= Verbosity.QUIET:
+ self.logline("SKIPPED:" + msg, yellow=True)
 
  def logline(self, msg, **opts):
  self._reportedlines.append(msg)
  self.tw.line("%s" % msg, **opts)
 
  def verbosity0(self, msg, **opts):
- if self.verbosity >= 0:
+ if self.verbosity >= Verbosity.DEFAULT:
  self.logline("%s" % msg, **opts)
 
  def verbosity1(self, msg, **opts):
- if self.verbosity >= 1:
+ if self.verbosity >= Verbosity.INFO:
  self.logline("%s" % msg, **opts)
 
  def verbosity2(self, msg, **opts):
- if self.verbosity >= 2:
+ if self.verbosity >= Verbosity.DEBUG:
  self.logline("%s" % msg, **opts)
 
  # def log(self, msg):
@@ -378,12 +391,13 @@ def newaction(self, venv, msg, *args):
 
  def runcommand(self):
  self.report.using("tox-%s from %s" % (tox.__version__, tox.__file__))
+ verbosity = (self.report.verbosity > Verbosity.DEFAULT)
  if self.config.option.showconfig:
  self.showconfig()
  elif self.config.option.listenvs:
- self.showenvs(all_envs=False, description=self.config.option.verbosity > 0)
+ self.showenvs(all_envs=False, description=verbosity)
  elif self.config.option.listenvs_all:
- self.showenvs(all_envs=True, description=self.config.option.verbosity > 0)
+ self.showenvs(all_envs=True, description=verbosity)
  else:
  return self.subcommand_test()