-
Notifications
You must be signed in to change notification settings - Fork 597
/
logger.py
354 lines (281 loc) · 11.8 KB
/
logger.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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
"""
See the :class:`Logger` class.
"""
import os
import pathlib
from abc import ABC, abstractmethod
from datetime import datetime
import gzip
from typing import Any, Optional, Callable, Type, Tuple, cast, Dict
from types import TracebackType
from typing_extensions import Literal
from pkg_resources import iter_entry_points
from ..message import Message
from ..listener import Listener
from .generic import BaseIOHandler, FileIOMessageWriter, MessageWriter
from .asc import ASCWriter
from .blf import BLFWriter
from .canutils import CanutilsLogWriter
from .csv import CSVWriter
from .sqlite import SqliteWriter
from .printer import Printer
from ..typechecking import StringPathLike, FileLike, AcceptedIOType
class Logger(MessageWriter): # pylint: disable=abstract-method
"""
Logs CAN messages to a file.
The format is determined from the file suffix which can be one of:
* .asc: :class:`can.ASCWriter`
* .blf :class:`can.BLFWriter`
* .csv: :class:`can.CSVWriter`
* .db: :class:`can.SqliteWriter`
* .log :class:`can.CanutilsLogWriter`
* .txt :class:`can.Printer`
Any of these formats can be used with gzip compression by appending
the suffix .gz (e.g. filename.asc.gz). However, third-party tools might not
be able to read these files.
The **filename** may also be *None*, to fall back to :class:`can.Printer`.
The log files may be incomplete until `stop()` is called due to buffering.
.. note::
This class itself is just a dispatcher, and any positional and keyword
arguments are passed on to the returned instance.
"""
fetched_plugins = False
message_writers: Dict[str, Type[MessageWriter]] = {
".asc": ASCWriter,
".blf": BLFWriter,
".csv": CSVWriter,
".db": SqliteWriter,
".log": CanutilsLogWriter,
".txt": Printer,
}
@staticmethod
def __new__( # type: ignore
cls: Any, filename: Optional[StringPathLike], *args: Any, **kwargs: Any
) -> MessageWriter:
"""
:param filename: the filename/path of the file to write to,
may be a path-like object or None to
instantiate a :class:`~can.Printer`
:raises ValueError: if the filename's suffix is of an unknown file type
"""
if filename is None:
return Printer(*args, **kwargs)
if not Logger.fetched_plugins:
Logger.message_writers.update(
{
writer.name: writer.load()
for writer in iter_entry_points("can.io.message_writer")
}
)
Logger.fetched_plugins = True
suffix = pathlib.PurePath(filename).suffix.lower()
file_or_filename: AcceptedIOType = filename
if suffix == ".gz":
suffix, file_or_filename = Logger.compress(filename)
try:
return Logger.message_writers[suffix](file_or_filename, *args, **kwargs)
except KeyError:
raise ValueError(
f'No write support for this unknown log format "{suffix}"'
) from None
@staticmethod
def compress(filename: StringPathLike) -> Tuple[str, FileLike]:
"""
Return the suffix and io object of the decompressed file.
File will automatically recompress upon close.
"""
real_suffix = pathlib.Path(filename).suffixes[-2].lower()
mode = "ab" if real_suffix == ".blf" else "at"
return real_suffix, gzip.open(filename, mode)
def on_message_received(self, msg: Message) -> None:
pass
class BaseRotatingLogger(Listener, BaseIOHandler, ABC):
"""
Base class for rotating CAN loggers. This class is not meant to be
instantiated directly. Subclasses must implement the :attr:`should_rollover`
and `do_rollover` methods according to their rotation strategy.
The rotation behavior can be further customized by the user by setting
the :attr:`namer` and :attr:`rotator` attributes after instantiating the subclass.
These attributes as well as the methods `rotation_filename` and `rotate`
and the corresponding docstrings are carried over from the python builtin
`BaseRotatingHandler`.
Subclasses must set the `_writer` attribute upon initialization.
:attr namer:
If this attribute is set to a callable, the :meth:`rotation_filename` method
delegates to this callable. The parameters passed to the callable are
those passed to :meth:`rotation_filename`.
:attr rotator:
If this attribute is set to a callable, the :meth:`rotate` method delegates
to this callable. The parameters passed to the callable are those
passed to :meth:`rotate`.
:attr rollover_count:
An integer counter to track the number of rollovers.
"""
namer: Optional[Callable[[StringPathLike], StringPathLike]] = None
rotator: Optional[Callable[[StringPathLike, StringPathLike], None]] = None
rollover_count: int = 0
def __init__(self, *args: Any, **kwargs: Any) -> None:
Listener.__init__(self)
BaseIOHandler.__init__(self, None)
self.writer_args = args
self.writer_kwargs = kwargs
# Expected to be set by the subclass
self._writer: FileIOMessageWriter = None # type: ignore
@property
def writer(self) -> FileIOMessageWriter:
"""This attribute holds an instance of a writer class which manages the actual file IO."""
return self._writer
def rotation_filename(self, default_name: StringPathLike) -> StringPathLike:
"""Modify the filename of a log file when rotating.
This is provided so that a custom filename can be provided.
The default implementation calls the :attr:`namer` attribute of the
handler, if it's callable, passing the default name to
it. If the attribute isn't callable (the default is `None`), the name
is returned unchanged.
:param default_name:
The default name for the log file.
"""
if not callable(self.namer):
return default_name
return self.namer(default_name)
def rotate(self, source: StringPathLike, dest: StringPathLike) -> None:
"""When rotating, rotate the current log.
The default implementation calls the :attr:`rotator` attribute of the
handler, if it's callable, passing the source and dest arguments to
it. If the attribute isn't callable (the default is `None`), the source
is simply renamed to the destination.
:param source:
The source filename. This is normally the base
filename, e.g. `"test.log"`
:param dest:
The destination filename. This is normally
what the source is rotated to, e.g. `"test_#001.log"`.
"""
if not callable(self.rotator):
if os.path.exists(source):
os.rename(source, dest)
else:
self.rotator(source, dest)
def on_message_received(self, msg: Message) -> None:
"""This method is called to handle the given message.
:param msg:
the delivered message
"""
if self.should_rollover(msg):
self.do_rollover()
self.rollover_count += 1
self.writer.on_message_received(msg)
def _get_new_writer(self, filename: StringPathLike) -> FileIOMessageWriter:
"""Instantiate a new writer.
.. note::
The :attr:`self.writer` should be closed prior to calling this function.
:param filename:
Path-like object that specifies the location and name of the log file.
The log file format is defined by the suffix of `filename`.
:return:
An instance of a writer class.
"""
logger = Logger(filename, *self.writer_args, **self.writer_kwargs)
if isinstance(logger, FileIOMessageWriter):
return logger
elif isinstance(logger, Printer) and logger.file is not None:
return cast(FileIOMessageWriter, logger)
else:
raise Exception(
"The Logger corresponding to the arguments is not a FileIOMessageWriter or "
"can.Printer"
)
def stop(self) -> None:
"""Stop handling new messages.
Carry out any final tasks to ensure
data is persisted and cleanup any open resources.
"""
self.writer.stop()
def __enter__(self) -> "BaseRotatingLogger":
return self
def __exit__(
self,
exc_type: Optional[Type[BaseException]],
exc_val: Optional[BaseException],
exc_tb: Optional[TracebackType],
) -> Literal[False]:
return self._writer.__exit__(exc_type, exc_val, exc_tb)
@abstractmethod
def should_rollover(self, msg: Message) -> bool:
"""Determine if the rollover conditions are met."""
@abstractmethod
def do_rollover(self) -> None:
"""Perform rollover."""
class SizedRotatingLogger(BaseRotatingLogger):
"""Log CAN messages to a sequence of files with a given maximum size.
The logger creates a log file with the given `base_filename`. When the
size threshold is reached the current log file is closed and renamed
by adding a timestamp and the rollover count. A new log file is then
created and written to.
This behavior can be customized by setting the :attr:`namer` and
:attr:`rotator` attribute.
Example::
from can import Notifier, SizedRotatingLogger
from can.interfaces.vector import VectorBus
bus = VectorBus(channel=[0], app_name="CANape", fd=True)
logger = SizedRotatingLogger(
base_filename="my_logfile.asc",
max_bytes=5 * 1024 ** 2, # =5MB
)
logger.rollover_count = 23 # start counter at 23
notifier = Notifier(bus=bus, listeners=[logger])
The SizedRotatingLogger currently supports the formats
* .asc: :class:`can.ASCWriter`
* .blf :class:`can.BLFWriter`
* .csv: :class:`can.CSVWriter`
* .log :class:`can.CanutilsLogWriter`
* .txt :class:`can.Printer` (if pointing to a file)
.. note::
The :class:`can.SqliteWriter` is not supported yet.
The log files on disk may be incomplete due to buffering until
:meth:`~can.Listener.stop` is called.
"""
def __init__(
self,
base_filename: StringPathLike,
*args: Any,
max_bytes: int = 0,
**kwargs: Any,
) -> None:
"""
:param base_filename:
A path-like object for the base filename. The log file format is defined by
the suffix of `base_filename`.
:param max_bytes:
The size threshold at which a new log file shall be created. If set to 0, no
rollover will be performed.
"""
super().__init__(*args, **kwargs)
self.base_filename = os.path.abspath(base_filename)
self.max_bytes = max_bytes
self._writer = self._get_new_writer(self.base_filename)
def should_rollover(self, msg: Message) -> bool:
if self.max_bytes <= 0:
return False
if self.writer.file.tell() >= self.max_bytes:
return True
return False
def do_rollover(self) -> None:
if self.writer:
self.writer.stop()
sfn = self.base_filename
dfn = self.rotation_filename(self._default_name())
self.rotate(sfn, dfn)
self._writer = self._get_new_writer(self.base_filename)
def _default_name(self) -> StringPathLike:
"""Generate the default rotation filename."""
path = pathlib.Path(self.base_filename)
new_name = (
path.stem
+ "_"
+ datetime.now().strftime("%Y-%m-%dT%H%M%S")
+ "_"
+ f"#{self.rollover_count:03}"
+ path.suffix
)
return str(path.parent / new_name)