[Feature] Info logs to console and debug logs to file

[rahul-tuli]

Before this PR, the streamhandler was not created properly because filehandler is also a streamhandler; thus info logs were not printed to console:

Test Code:

from sparseml.core import LoggerManager

def run():
    logger_manager = LoggerManager()
    logging_method_names = ["info", "debug", "critical", "error", "warning"]
    
    get_method_string = lambda method_name: f"{method_name} tag"
    get_method_tag = lambda method_name: f"{method_name} message"
    
    for method_name in logging_method_names:
        # will fail if method does not exist
        method = getattr(logger_manager, method_name)
        method(string=get_method_string(method_name), tag=get_method_tag(method_name))


run()

Output initially(without this PR) :

python local.py                                                                            (info-logs-to-console-everything-to-file|✚1…2⚑4)
Logging all SparseML modifier-level logs to sparse_logs/28-11-2023_14.32.47.log
2023-11-28 14:32:47 sparseml.core.logger INFO     Logging all SparseML modifier-level logs to sparse_logs/28-11-2023_14.32.47.log

Output now(with this PR):

python local.py                                                                            (info-logs-to-console-everything-to-file|✚1…2⚑4)
Logging all SparseML modifier-level logs to sparse_logs/28-11-2023_14.32.47.log
2023-11-28 14:32:47 sparseml.core.logger INFO     Logging all SparseML modifier-level logs to sparse_logs/28-11-2023_14.32.47.log
python info message step None: info tag
python critical message step None: critical tag
python error message step None: error tag
python warning message step None: warning tag

Now everything above debug logs is outputted to the console.

The log file still contains all logs (including debug logs)
file contents:

Logging all SparseML modifier-level logs to sparse_logs/28-11-2023_14.40.14.log
python info message step None: info tag
python debug message [None - 1701200414.3932433]: debug tag
python critical message step None: critical tag
python error message step None: error tag
python warning message step None: warning tag

A pytest to check this behavior:

import logging

from sparseml.core.logger import LoggerManager


def test_only_info_logs_are_sent_to_stdout(capsys):
    logger_manager = LoggerManager()

    # set propagate to True to ensure that
    # logs are sent to capsys
    for logger in logger_manager.loggers:
        assert logger.logger.hasHandlers()
        logger.logger.propagate = True

    logging_method_names = ["info", "debug", "critical", "error", "warning"]

    get_method_string = lambda method_name: f"{method_name} tag"
    get_method_tag = lambda method_name: f"{method_name} message"

    for method_name in logging_method_names:
        # will fail if method does not exist
        method = getattr(logger_manager, method_name)
        method(string=get_method_string(method_name), tag=get_method_tag(method_name))

    console_output = capsys.readouterr().err

    # debug logs not should be sent to stdout
    assert get_method_tag("debug") not in console_output

    for method_name in logging_method_names:
        if method_name == "debug":
            continue
        assert get_method_tag(method_name) in console_output
        assert get_method_string(method_name) in console_output

    # all logs should be sent to file
    for logger in logger_manager.loggers:
        _logger = logger.logger
        if any(
            isinstance(file_handler := handler, logging.FileHandler)
            for handler in _logger.handlers
        ):
            log_file_content = open(file_handler.baseFilename, "r").read().strip()

            assert all(
                get_method_tag(method_name) in log_file_content
                and get_method_string(method_name) in log_file_content
                for method_name in logging_method_names
            )

Pytest output:

pytest -vv tests/sparseml/core/test_logger_file_and_stdout.py   


====================================================== 1 passed, 104 warnings in 3.90s =======================================================

Unfortunately I could not add this pytest into the main repo, due to some capsys issue where when this test was run in conjunction with other tests the capsys output was empty. But when run standalone this test passes (proof is above) (It's probably related to proper setups and teardowns of loggers b/w tests)

---

• To see the specific tasks where the Asana app for GitHub is being used, see below:
  • https://app.asana.com/0/0/1205848552255653