Skip to content

Log Manager

This page contains documentation for the Date Manager package which is curated with frequently used datetime methods, modules in a simpler way.

Frequent logs operations using methods provided.

Modules exported by this package:

  • log_manager: Provide several frequently used logs operations.

Package Details

This module allows the user to make log operations.

Examples:

>>> from log_manager.log_manager import LogManager
>>> log_manager = LogManager()

>>> log_manager.info("This is an informational message.")
>>> log_manager.error("An error occurred!")
>>> log_manager.debug("This is just an informational message.")
>>> log_manager.warning("Important message.")
>>> log_manager.critical("Critical Issue occurred.")

The module contains the following methods:

  • __init__(log_file, log_level, log_name) - creates the instance of the class.
  • info(msg) - logs the informational message.
  • error(msg) - logs the error message.
  • warning(msg) - logs the warning message.
  • debug(msg) - logs the debug message.
  • critical(msg) - logs the critical message.

LogManager

Source code in log_manager\log_manager.py 
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
class LogManager:
    def __init__(self, log_file: str = './Custom-Python_Tools.log', log_level: int = logging.DEBUG, log_name: str = 'LogManager') -> None:
        """
        Initialize the LogManager class.

        Args:
            log_file: The name of the log file.
            log_level: The logging level.
            log_name: The logging name.
        """
        self.log_file = log_file
        self.log_level = log_level
        self.logger = logging.getLogger(log_name)
        self.logger.setLevel(self.log_level)

        formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')

        file_handler = logging.FileHandler(self.log_file)
        file_handler.setLevel(self.log_level)
        file_handler.setFormatter(formatter)

        console_handler = logging.StreamHandler()
        console_handler.setLevel(self.log_level)
        console_handler.setFormatter(formatter)

        self.logger.addHandler(file_handler)
        self.logger.addHandler(console_handler)

    def info(self, message: str) -> None:
        """Log a message with severity 'INFO'.

        Args:
            message: The message to log.

        Returns:
            None
        """
        self.logger.info(message)

    def debug(self, message: str) -> None:
        """Log a message with severity 'DEBUG'.

        Args:
            message (str): The message to log.

        Returns:
            None
        """
        self.logger.debug(message)

    def warning(self, message: str) -> None:
        """Log a message with severity 'WARNING'.

        Args:
            message (str): The message to log.

        Returns:
            None
        """
        self.logger.warning(message)

    def error(self, message: str) -> None:
        """Log a message with severity 'ERROR'.

        Args:
            message (str): The message to log.

        Returns:
            None
        """
        self.logger.error(message)

    def critical(self, message: str) -> None:
        """Log a message with severity 'CRITICAL'.

        Args:
            message (str): The message to log.

        Returns:
            None
        """
        self.logger.critical(message)

__init__(log_file='./Custom-Python_Tools.log', log_level=logging.DEBUG, log_name='LogManager')

Initialize the LogManager class.

Parameters:

Name Type Description Default
log_file str

The name of the log file.

 './Custom-Python_Tools.log'
log_level int

The logging level.

 DEBUG
log_name str

The logging name.

 'LogManager'
Source code in log_manager\log_manager.py 
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
def __init__(self, log_file: str = './Custom-Python_Tools.log', log_level: int = logging.DEBUG, log_name: str = 'LogManager') -> None:
    """
    Initialize the LogManager class.

    Args:
        log_file: The name of the log file.
        log_level: The logging level.
        log_name: The logging name.
    """
    self.log_file = log_file
    self.log_level = log_level
    self.logger = logging.getLogger(log_name)
    self.logger.setLevel(self.log_level)

    formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')

    file_handler = logging.FileHandler(self.log_file)
    file_handler.setLevel(self.log_level)
    file_handler.setFormatter(formatter)

    console_handler = logging.StreamHandler()
    console_handler.setLevel(self.log_level)
    console_handler.setFormatter(formatter)

    self.logger.addHandler(file_handler)
    self.logger.addHandler(console_handler)

critical(message)

Log a message with severity 'CRITICAL'.

Parameters:

Name Type Description Default
message str

The message to log.

 required

Returns:

Type Description
None

None
Source code in log_manager\log_manager.py 
102
103
104
105
106
107
108
109
110
111
def critical(self, message: str) -> None:
    """Log a message with severity 'CRITICAL'.

    Args:
        message (str): The message to log.

    Returns:
        None
    """
    self.logger.critical(message)

debug(message)

Log a message with severity 'DEBUG'.

Parameters:

Name Type Description Default
message str

The message to log.

 required

Returns:

Type Description
None

None
Source code in log_manager\log_manager.py 
69
70
71
72
73
74
75
76
77
78
def debug(self, message: str) -> None:
    """Log a message with severity 'DEBUG'.

    Args:
        message (str): The message to log.

    Returns:
        None
    """
    self.logger.debug(message)

error(message)

Log a message with severity 'ERROR'.

Parameters:

Name Type Description Default
message str

The message to log.

 required

Returns:

Type Description
None

None
Source code in log_manager\log_manager.py 
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
def error(self, message: str) -> None:
    """Log a message with severity 'ERROR'.

    Args:
        message (str): The message to log.

    Returns:
        None
    """
    self.logger.error(message)

info(message)

Log a message with severity 'INFO'.

Parameters:

Name Type Description Default
message str

The message to log.

 required

Returns:

Type Description
None

None
Source code in log_manager\log_manager.py 
58
59
60
61
62
63
64
65
66
67
def info(self, message: str) -> None:
    """Log a message with severity 'INFO'.

    Args:
        message: The message to log.

    Returns:
        None
    """
    self.logger.info(message)

warning(message)

Log a message with severity 'WARNING'.

Parameters:

Name Type Description Default
message str

The message to log.

 required

Returns:

Type Description
None

None
Source code in log_manager\log_manager.py 
80
81
82
83
84
85
86
87
88
89
def warning(self, message: str) -> None:
    """Log a message with severity 'WARNING'.

    Args:
        message (str): The message to log.

    Returns:
        None
    """
    self.logger.warning(message)