From 7c671ea77f4d7701d0def9a9e17b6c49310ca438 Mon Sep 17 00:00:00 2001 From: Alexis Lee Date: Tue, 10 May 2016 14:38:08 +0100 Subject: [PATCH] Remove 'verbose' option This was already deprecated in Mitaka, we're now working on Newton so I believe it can be removed. Change-Id: I96229438d3a2271c830bcd926326e7b4a94ccac9 --- oslo_log/_options.py | 6 ---- oslo_log/log.py | 18 ++++------- oslo_log/tests/unit/test_log.py | 30 ++++++------------- ...emove-verbose-option-d0d1381e182d1be1.yaml | 3 ++ 4 files changed, 17 insertions(+), 40 deletions(-) create mode 100644 releasenotes/notes/remove-verbose-option-d0d1381e182d1be1.yaml diff --git a/oslo_log/_options.py b/oslo_log/_options.py index aaaf235d..3a751fb3 100644 --- a/oslo_log/_options.py +++ b/oslo_log/_options.py @@ -37,12 +37,6 @@ common_cli_opts = [ mutable=True, help='If set to true, the logging level will be set to ' 'DEBUG instead of the default INFO level.'), - cfg.BoolOpt('verbose', - short='v', - default=True, - help='If set to false, the logging level will be set to ' - 'WARNING instead of the default INFO level.', - deprecated_for_removal=True), ] logging_cli_opts = [ diff --git a/oslo_log/log.py b/oslo_log/log.py index 770bee9b..dabce127 100644 --- a/oslo_log/log.py +++ b/oslo_log/log.py @@ -222,10 +222,8 @@ def _load_log_config(log_config_append): def _mutate_hook(conf, fresh): """Reconfigures oslo.log according to the mutated options.""" - # verbose is deprecated, so I didn't make it mutable, so there's no need to - # test for it here. if (None, 'debug') in fresh: - _refresh_root_level(conf.debug, conf.verbose) + _refresh_root_level(conf.debug) def register_options(conf): @@ -312,23 +310,17 @@ def _find_facility(facility): return getattr(syslog, facility) -def _refresh_root_level(debug, verbose): +def _refresh_root_level(debug): """Set the level of the root logger. - If 'debug' is True, the level will be DEBUG. Otherwise we look at 'verbose' - - if that is True, the level will be INFO. If neither are set, the level - will be WARNING. - - Note the 'verbose' option is deprecated. + If 'debug' is True, the level will be DEBUG. Otherwise the level will be + WARNING. :param debug - :param verbose """ log_root = getLogger(None).logger if debug: log_root.setLevel(logging.DEBUG) - elif verbose: - log_root.setLevel(logging.INFO) else: log_root.setLevel(logging.WARNING) @@ -381,7 +373,7 @@ def _setup_logging_from_conf(conf, project, version): version=version, datefmt=datefmt, config=conf)) - _refresh_root_level(conf.debug, conf.verbose) + _refresh_root_level(conf.debug) for pair in conf.default_log_levels: mod, _sep, level_name = pair.partition('=') diff --git a/oslo_log/tests/unit/test_log.py b/oslo_log/tests/unit/test_log.py index 77f1c7b3..77df9ed8 100644 --- a/oslo_log/tests/unit/test_log.py +++ b/oslo_log/tests/unit/test_log.py @@ -90,13 +90,6 @@ class CommonLoggerTestsMixIn(object): self.log.info("foo", context=_fake_context()) self.assertTrue(True) # didn't raise exception - def test_will_be_verbose_if_verbose_flag_set(self): - self.config(verbose=True) - logger_name = 'test_is_verbose' - log.setup(self.CONF, logger_name) - logger = logging.getLogger(logger_name) - self.assertEqual(logging.INFO, logger.getEffectiveLevel()) - def test_will_be_debug_if_debug_flag_set(self): self.config(debug=True) logger_name = 'test_is_debug' @@ -104,9 +97,9 @@ class CommonLoggerTestsMixIn(object): logger = logging.getLogger(logger_name) self.assertEqual(logging.DEBUG, logger.getEffectiveLevel()) - def test_will_not_be_verbose_if_verbose_flag_not_set(self): - self.config(verbose=False) - logger_name = 'test_is_not_verbose' + def test_will_be_warning_if_debug_flag_not_set(self): + self.config(debug=False) + logger_name = 'test_is_not_debug' log.setup(self.CONF, logger_name) logger = logging.getLogger(logger_name) self.assertEqual(logging.WARNING, logger.getEffectiveLevel()) @@ -272,8 +265,7 @@ class LogLevelTestCase(BaseTestCase): levels.append(warn_level + '=WARN') levels.append(other_level + '=7') levels.append(trace_level + '=TRACE') - self.config(default_log_levels=levels, - verbose=True) + self.config(default_log_levels=levels) log.setup(self.CONF, 'testing') self.log = log.getLogger(info_level) self.log_no_debug = log.getLogger(warn_level) @@ -839,7 +831,7 @@ class FastWatchedFileHandlerTestCase(BaseTestCase): log_path = self._config() logger = log._loggers[None].logger text = 'Hello World!' - logger.info(text) + logger.warning(text) with open(log_path, 'r') as f: file_content = f.read() self.assertTrue(text in file_content) @@ -873,14 +865,12 @@ class ConfigTestCase(test_base.BaseTestCase): log._setup_logging_from_conf(conf, 'test', 'test') self.assertEqual(conf.debug, False) - self.assertEqual(conf.verbose, True) - self.assertEqual(log.INFO, log_root.getEffectiveLevel()) + self.assertEqual(log.WARN, log_root.getEffectiveLevel()) shutil.copy(paths[1], paths[0]) conf.mutate_config_files() self.assertEqual(conf.debug, True) - self.assertEqual(conf.verbose, True) self.assertEqual(log.DEBUG, log_root.getEffectiveLevel()) @@ -893,14 +883,12 @@ class LogConfigOptsTestCase(BaseTestCase): f = six.StringIO() self.CONF([]) self.CONF.print_help(file=f) - for option in ['debug', 'verbose', 'log-config', 'watch-log-file']: + for option in ['debug', 'log-config', 'watch-log-file']: self.assertIn(option, f.getvalue()) - def test_debug_verbose(self): - self.CONF(['--debug', '--verbose']) - + def test_debug(self): + self.CONF(['--debug']) self.assertEqual(self.CONF.debug, True) - self.assertEqual(self.CONF.verbose, True) def test_logging_opts(self): self.CONF([]) diff --git a/releasenotes/notes/remove-verbose-option-d0d1381e182d1be1.yaml b/releasenotes/notes/remove-verbose-option-d0d1381e182d1be1.yaml new file mode 100644 index 00000000..32e2306a --- /dev/null +++ b/releasenotes/notes/remove-verbose-option-d0d1381e182d1be1.yaml @@ -0,0 +1,3 @@ +--- +upgrade: + - The deprecated 'verbose' option has been removed.