Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 33 additions & 3 deletions ovos_utils/log.py
Original file line number Diff line number Diff line change
Expand Up @@ -131,8 +131,29 @@ def create_logger(cls, name, tostdout=True):
@classmethod
def set_level(cls, level):
cls.level = level
for l in cls._loggers:
cls._loggers[l].setLevel(level)
for logger_name in cls._loggers:
cls._loggers[logger_name].setLevel(level)

@classmethod
def is_enabled_for(cls, level: int) -> bool:
"""Return whether a record at ``level`` would be emitted.

``LOG.level`` accepts the same integer and named levels as the stdlib
logger. Unknown names deliberately fall through as enabled so the
existing logger configuration path still raises its normal error.
"""
if logging.root.manager.disable >= level:
return False
configured = cls.level
if isinstance(configured, int):
threshold = configured
else:
threshold = logging.getLevelName(str(configured).upper())
if not isinstance(threshold, int):
return True
if threshold == logging.NOTSET:
threshold = logging.root.getEffectiveLevel()
return level >= threshold
Comment thread
coderabbitai[bot] marked this conversation as resolved.

@classmethod
def _get_real_logger(cls):
Expand Down Expand Up @@ -170,22 +191,32 @@ def _get_real_logger(cls):

@classmethod
def info(cls, *args, **kwargs):
if not cls.is_enabled_for(logging.INFO):
return
cls._get_real_logger().info(*args, **kwargs)

@classmethod
def debug(cls, *args, **kwargs):
if not cls.is_enabled_for(logging.DEBUG):
Comment thread
goldyfruit marked this conversation as resolved.
return
cls._get_real_logger().debug(*args, **kwargs)

@classmethod
def warning(cls, *args, **kwargs):
if not cls.is_enabled_for(logging.WARNING):
return
cls._get_real_logger().warning(*args, **kwargs)

@classmethod
def error(cls, *args, **kwargs):
if not cls.is_enabled_for(logging.ERROR):
return
cls._get_real_logger().error(*args, **kwargs)

@classmethod
def exception(cls, *args, **kwargs):
if not cls.is_enabled_for(logging.ERROR):
return
cls._get_real_logger().exception(*args, **kwargs)


Expand Down Expand Up @@ -358,7 +389,6 @@ def get_log_path(service: str, directories: Optional[List[str]] = None) \

from ovos_utils.xdg_utils import xdg_state_home
try:
from ovos_config import Configuration
from ovos_config.meta import get_xdg_base
except ImportError:
xdg_base = os.environ.get("OVOS_CONFIG_BASE_FOLDER", "mycroft")
Expand Down
75 changes: 73 additions & 2 deletions test/unittests/test_log.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
import shutil
import unittest
import importlib
import logging

from os.path import join, dirname, isdir, isfile
from unittest.mock import patch, Mock
Expand Down Expand Up @@ -54,8 +55,9 @@ def test_log(self):
log_file = join(LOG.base_path, f"{LOG.name}.log")
self.assertFalse(isfile(log_file))
LOG.info("This won't print")
self.assertTrue(isfile(log_file))
self.assertFalse(isfile(log_file))
LOG.warning("This will print")
self.assertTrue(isfile(log_file))
with open(log_file) as f:
lines = f.readlines()
self.assertEqual(len(lines), 1)
Expand Down Expand Up @@ -106,6 +108,75 @@ def test_log(self):
self.assertEqual(len(lines), 1)
self.assertTrue(lines[0].endswith("99\n"))

def test_disabled_levels_skip_call_site_resolution(self):
from ovos_utils.log import LOG

cases = [
("debug", logging.DEBUG, logging.INFO),
("info", logging.INFO, logging.WARNING),
("warning", logging.WARNING, logging.ERROR),
("error", logging.ERROR, logging.CRITICAL),
("exception", logging.ERROR, logging.CRITICAL),
]
for method_name, _record_level, configured_level in cases:
with self.subTest(method=method_name), \
patch.object(LOG, "level", configured_level), \
patch.object(LOG, "_get_real_logger") as get_logger:
getattr(LOG, method_name)("not emitted")
get_logger.assert_not_called()

def test_enabled_levels_keep_existing_logger_path(self):
from ovos_utils.log import LOG

cases = [
("debug", logging.DEBUG),
("info", logging.INFO),
("warning", logging.WARNING),
("error", logging.ERROR),
("exception", logging.ERROR),
]
for method_name, configured_level in cases:
logger = Mock()
with self.subTest(method=method_name), \
patch.object(LOG, "level", configured_level), \
patch.object(LOG, "_get_real_logger",
return_value=logger):
getattr(LOG, method_name)("emitted: %s", "value")
getattr(logger, method_name).assert_called_once_with(
"emitted: %s", "value")

def test_is_enabled_for_accepts_named_and_numeric_levels(self):
from ovos_utils.log import LOG

with patch.object(LOG, "level", "DEBUG"):
self.assertTrue(LOG.is_enabled_for(logging.DEBUG))
with patch.object(LOG, "level", "INFO"):
self.assertFalse(LOG.is_enabled_for(logging.DEBUG))
self.assertTrue(LOG.is_enabled_for(logging.WARNING))
with patch.object(LOG, "level", logging.ERROR):
self.assertFalse(LOG.is_enabled_for(logging.WARNING))
self.assertTrue(LOG.is_enabled_for(logging.ERROR))

def test_is_enabled_for_honors_global_disable(self):
from ovos_utils.log import LOG

original_disable = logging.root.manager.disable
try:
logging.disable(logging.CRITICAL)
with patch.object(LOG, "level", "DEBUG"):
self.assertFalse(LOG.is_enabled_for(logging.DEBUG))
finally:
logging.disable(original_disable)

def test_is_enabled_for_uses_effective_root_level_for_notset(self):
from ovos_utils.log import LOG

with patch.object(LOG, "level", logging.NOTSET), \
patch.object(logging.root, "getEffectiveLevel",
return_value=logging.INFO):
self.assertFalse(LOG.is_enabled_for(logging.DEBUG))
self.assertTrue(LOG.is_enabled_for(logging.WARNING))

@patch("ovos_utils.log.get_logs_config")
@patch("ovos_config.Configuration.set_config_watcher")
def test_init_service_logger(self, set_config_watcher, log_config):
Expand Down Expand Up @@ -166,7 +237,7 @@ def test_deprecated_decorator(self, create_logger):
self.assertIn('test_log', log_msg, log_msg)
self.assertIn('imported deprecation', log_msg, log_msg)

test_class = Deprecated()
Deprecated()
log_msg = log_warning.call_args[0][0]
self.assertIn('version=0.2.0', log_msg, log_msg)
self.assertIn('Class Deprecated', log_msg, log_msg)
Expand Down
Loading