Skip to content

Refinements made to the logging outputs as mentioned in issue #89: #91

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
harryswift01 merged 2 commits into from
May 13, 2025
Merged

Refinements made to the logging outputs as mentioned in issue #89: #91

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3cb6bb5
Refinements made to the logging outputs as mentioned in issue #89:
harryswift01 May 13, 2025
8f777bb
Fix to `test_mdanalysis_and_command_loggers_exist` to reflect changes…
harryswift01 May 13, 2025
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
24 changes: 12 additions & 12 deletions CodeEntropy/config/logging_config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,12 +38,12 @@ def __init__(self, folder, log_level=logging.INFO):
"class": "logging.FileHandler",
"filename": os.path.join(log_directory, "program.log"),
"formatter": "detailed",
"level": logging.DEBUG,
"level": log_level,
},
"errorfile": {
"class": "logging.FileHandler",
"filename": os.path.join(log_directory, "program.err"),
"formatter": "detailed",
"formatter": "simple",
"level": logging.ERROR,
},
"commandfile": {
Expand All @@ -56,7 +56,7 @@ def __init__(self, folder, log_level=logging.INFO):
"class": "logging.FileHandler",
"filename": os.path.join(log_directory, "mdanalysis.log"),
"formatter": "detailed",
"level": logging.DEBUG,
"level": log_level,
},
},
"loggers": {
Expand All @@ -66,7 +66,7 @@ def __init__(self, folder, log_level=logging.INFO):
},
"MDAnalysis": {
"handlers": ["mdanalysis_log"],
"level": logging.DEBUG,
"level": log_level,
"propagate": False,
},
"commands": {
Expand All @@ -88,17 +88,17 @@ def update_logging_level(self, log_level):
root_logger = logging.getLogger()
root_logger.setLevel(log_level)
for handler in root_logger.handlers:
if isinstance(handler, logging.FileHandler):
handler.setLevel(logging.DEBUG)
else:
handler.setLevel(logging.INFO)
handler.setLevel(
log_level if isinstance(handler, logging.FileHandler) else logging.INFO
)

# Update all other loggers and their handlers
for logger_name in self.LOGGING["loggers"]:
logger = logging.getLogger(logger_name)
logger.setLevel(log_level)
for handler in logger.handlers:
if isinstance(handler, logging.FileHandler):
handler.setLevel(logging.DEBUG)
else:
handler.setLevel(logging.INFO)
handler.setLevel(
log_level
if isinstance(handler, logging.FileHandler)
else logging.INFO
)
10 changes: 8 additions & 2 deletions tests/test_CodeEntropy/test_logging_config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,11 +65,17 @@ def test_update_logging_level(self):
self.assertEqual(root_logger.level, logging.INFO)

def test_mdanalysis_and_command_loggers_exist(self):
"""Ensure specialized loggers are set up"""
"""Ensure specialized loggers are set up with correct configuration"""
log_level = logging.DEBUG
self.logging_config = LoggingConfig(
folder=self.temp_dir.name, log_level=log_level
)
self.logging_config.setup_logging()

mda_logger = logging.getLogger("MDAnalysis")
cmd_logger = logging.getLogger("commands")
self.assertEqual(mda_logger.level, logging.DEBUG)

self.assertEqual(mda_logger.level, log_level)
self.assertEqual(cmd_logger.level, logging.INFO)
self.assertFalse(mda_logger.propagate)
self.assertFalse(cmd_logger.propagate)
Expand Down