stdout_logging.py

# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.

"""SuperBench stdout logging module."""

import sys


class StdLogger:
    """Logger class to enable or disable to redirect STDOUT and STDERR to file."""
    class StdoutLoggerStream:
        """StdoutLoggerStream class which redirect the sys.stdout to file."""
        def __init__(self, filename, rank):
            """Init the class with filename.

            Args:
                filename (str): the path of the file to save the log
                rank (int): the rank id
            """
            self._terminal = sys.stdout
            self._rank = rank
            self._log_file_handler = open(filename, 'a')

        def __getattr__(self, attr):
            """Override __getattr__.

            Args:
                attr (str): Attribute name.

            Returns:
                Any: Attribute value.
            """
            return getattr(self._terminal, attr)

        def write(self, message):
            """Write the message to the stream.

            Args:
                message (str): the message to log.
            """
            message = f'[{self._rank}]: {message}'
            self._terminal.write(message)
            self._log_file_handler.write(message)
            self._log_file_handler.flush()

        def flush(self):
            """Override flush."""
            pass

        def restore(self):
            """Restore sys.stdout and close the file."""
            self._log_file_handler.close()
            sys.stdout = self._terminal

    def add_file_handler(self, filename):
        """Init the class with filename.

        Args:
            filename (str): the path of file to save the log
        """
        self.filename = filename

    def __init__(self):
        """Init the logger."""
        self.logger_stream = None

    def start(self, rank):
        """Start the logger to redirect the sys.stdout to file.

        Args:
            rank (int): the rank id
        """
        self.logger_stream = self.StdoutLoggerStream(self.filename, rank)
        sys.stdout = self.logger_stream
        sys.stderr = sys.stdout

    def stop(self):
        """Restore the sys.stdout to termital."""
        if self.logger_stream is not None:
            self.logger_stream.restore()

    def log(self, message):
        """Write the message into the logger.

        Args:
            message (str): the message to log.
        """
        if self.logger_stream:
            self.logger_stream.write(message)
        else:
            sys.stdout.write(message)


stdout_logger = StdLogger()