-
Notifications
You must be signed in to change notification settings - Fork 0
/
log.py
167 lines (138 loc) · 4.33 KB
/
log.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
"""Provides methods for logging to a file and a stream."""
import logging
import time
class ErrorMessage(object):
"""
Class for storing custom messages in exceptions.
"""
def __init__(self, str):
self._str = str
def __str__(self):
return self._str
class Log(object):
"""
Provides methods for writing log messages of various levels to file and
stream handlers.
"""
_MESSAGE_FORMAT = "%(asctime)s\t%(levelname)s\t%(message)s"
_MESSAGE_DATE_FORMAT = "%H:%M"
_FILENAME_DATE_FORMAT = "%Y-%m-%d"
_FILENAME_EXTENSION = ".log"
def __init__(self, folder, level=logging.INFO):
"""
Initialize logger. Create and attach logging handlers. Create log file.
Parameters
----------
folder : powl.filesystem.Folder
Folder where the log file will be stored.
level : int, optional
Optional log level of the handlers based on logging.<Levels>.
"""
self._logger = logging.getLogger(__name__)
formatter = logging.Formatter(
self._MESSAGE_FORMAT,
self._MESSAGE_DATE_FORMAT)
date = time.strftime(self._FILENAME_DATE_FORMAT, time.localtime())
filename = date + self._FILENAME_EXTENSION
fileobject = folder.get_file(filename)
stream_handler = logging.StreamHandler()
stream_handler.setLevel(level)
stream_handler.setFormatter(formatter)
self._logger.addHandler(stream_handler)
file_handler = logging.FileHandler(fileobject.path)
file_handler.setLevel(level)
file_handler.setFormatter(formatter)
self._logger.addHandler(file_handler)
def critical(self, message, *args, **kwargs):
"""
Log a critical message.
Parameters
----------
message : string:
Message to log.
args : list
Arguments to be merged into message.
kwargs : dict
Arguments used for user defined attributes.
"""
self._logger.critical(message, *args, **kwargs)
def debug(self, message, *args, **kwargs):
"""
Log a debug message.
Parameters
----------
message : string:
Message to log.
args : list
Arguments to be merged into message.
kwargs : dict
Arguments used for user defined attributes.
"""
self._logger.debug(message, *args, **kwargs)
def error(self, message, *args, **kwargs):
"""
Log an error message.
Parameters
----------
message : string:
Message to log.
args : list
Arguments to be merged into message.
kwargs : dict
Arguments used for user defined attributes.
"""
self._logger.error(message, *args, **kwargs)
def info(self, message, *args, **kwargs):
"""
Log an info message.
Parameters
----------
message : string:
Message to log.
args : list
Arguments to be merged into message.
kwargs : dict
Arguments used for user defined attributes.
"""
self._logger.info(message, *args, **kwargs)
def warning(self, message, *args, **kwargs):
"""
Log a warning message.
Parameters
----------
message : string:
Message to log.
args : list
Arguments to be merged into message.
kwargs : dict
Arguments used for user defined attributes.
"""
self._logger.warning(message, *args, **kwargs)
def add_error_message(exception, message):
"""
Embeds an error message into an exception that can be retrieved by
try_get_error_message().
Parameters
----------
exception : Exception
message : str, ErrorMessage
"""
if isinstance(message, ErrorMessage):
exception.args += (message,)
else:
exception.args += (ErrorMessage(message),)
def try_get_error_message(exception):
"""
Trys to get an error message embedded in an exception.
Parameters
----------
exception : Exception
Returns
-------
str
"""
messages = [m for m in exception.args if isinstance(m, ErrorMessage)]
if len(messages) > 0:
return str(messages[0])
else:
return ""