logger: Prevent adding multiple handlers

Fix #1365
This commit is contained in:
Mr. Outis
2018-12-04 22:33:06 -06:00
parent 1ed42237c1
commit b3b2c97f4b
2 changed files with 29 additions and 9 deletions
+7
View File
@@ -59,6 +59,9 @@ class Logger(object):
def filter(self, record):
return record.levelno <= logging.WARNING
if Logger._already_initialized():
return
sh_out = logging.StreamHandler(sys.stdout)
sh_out.setFormatter(logging.Formatter(Logger.FMT))
sh_out.setLevel(logging.DEBUG)
@@ -243,3 +246,7 @@ class Logger(object):
)
print(box)
@staticmethod
def _already_initialized():
return bool(Logger.logger().handlers)
+22 -9
View File
@@ -47,9 +47,16 @@ class TestLogger(TestDvc):
# This is not a tty, so it should not colorize anything
self.assertEqual(msg, name)
def test_handlers(self):
Logger.init()
Logger.init()
self.assertEqual(len(Logger.logger().handlers), 2)
@patch('dvc.logger.Logger._already_initialized', return_value=False)
@patch('sys.stderr', new_callable=StringIO)
@patch('sys.stdout', new_callable=StringIO)
def test_stderr(self, mock_stdout, mock_stderr):
def test_stderr(self, mock_stdout, mock_stderr, mock_logger):
error_message = 'error msg'
Logger.init()
Logger.error(error_message)
@@ -59,9 +66,10 @@ class TestLogger(TestDvc):
'are always happy to help!\n'.format(error_message),
mock_stderr.getvalue())
@patch('dvc.logger.Logger._already_initialized', return_value=False)
@patch('sys.stderr', new_callable=StringIO)
@patch('sys.stdout', new_callable=StringIO)
def test_stdout(self, mock_stdout, mock_stderr):
def test_stdout(self, mock_stdout, mock_stderr, mock_logger):
non_error_message = 'non-error message'
Logger.init()
Logger.info(non_error_message)
@@ -71,39 +79,42 @@ class TestLogger(TestDvc):
class TestLoggerException(TestDvc):
@patch('dvc.logger.Logger._already_initialized', return_value=False)
@patch('sys.stderr', new_callable=StringIO)
@patch('sys.stdout', new_callable=StringIO)
def test_empty_err_msg(self, mock_stdout, mock_stderr):
def test_empty_err_msg(self, mock_stdout, mock_stderr, mock_logger):
from dvc.exceptions import DvcException
Logger.init()
exc_msg = 'msg'
Logger.error("", exc=DvcException(exc_msg))
self.assertEqual('', mock_stdout.getvalue())
self.assertEqual('Error: {}\n\nHaving any troubles? '
'Hit us up at dvc.org/support, we '
'are always happy to help!\n'.format(exc_msg),
mock_stderr.getvalue())
@patch('dvc.logger.Logger._already_initialized', return_value=False)
@patch('sys.stderr', new_callable=StringIO)
@patch('sys.stdout', new_callable=StringIO)
def test_empty_exc_msg(self, mock_stdout, mock_stderr):
def test_empty_exc_msg(self, mock_stdout, mock_stderr, mock_logger):
from dvc.exceptions import DvcException
Logger.init()
err_msg = 'msg'
Logger.error(err_msg, exc=DvcException(""))
self.assertEqual('', mock_stdout.getvalue())
self.assertEqual('Error: {}\n\nHaving any troubles? '
'Hit us up at dvc.org/support, we '
'are always happy to help!\n'.format(err_msg),
mock_stderr.getvalue())
@patch('dvc.logger.Logger._already_initialized', return_value=False)
@patch('sys.stderr', new_callable=StringIO)
@patch('sys.stdout', new_callable=StringIO)
def test_msg_and_exc(self, mock_stdout, mock_stderr):
def test_msg_and_exc(self, mock_stdout, mock_stderr, mock_logger):
from dvc.exceptions import DvcException
Logger.init()
@@ -126,17 +137,19 @@ class TestLoggerQuiet(TestDvc):
verbose = False
CmdBase._set_loglevel(A())
@patch('dvc.logger.Logger._already_initialized', return_value=False)
@patch('sys.stderr', new_callable=StringIO)
@patch('sys.stdout', new_callable=StringIO)
def test_progress(self, mock_stdout, mock_stderr):
def test_progress(self, mock_stdout, mock_stderr, mock_logger):
from dvc.progress import progress
progress.update_target('target', 50, 100)
self.assertEqual('', mock_stdout.getvalue())
self.assertEqual('', mock_stderr.getvalue())
@patch('dvc.logger.Logger._already_initialized', return_value=False)
@patch('sys.stderr', new_callable=StringIO)
@patch('sys.stdout', new_callable=StringIO)
def test_box(self, mock_stdout, mock_stderr):
def test_box(self, mock_stdout, mock_stderr, mock_logger):
Logger.box('message')
self.assertEqual('', mock_stdout.getvalue())
self.assertEqual('', mock_stderr.getvalue())