"""
See the :class:`Logger` class.
"""
import os
import pathlib
from abc import ABC, abstractmethod
from datetime import datetime
from typing import Optional, Callable
from pkg_resources import iter_entry_points
from can.typechecking import StringPathLike
from ..message import Message
from ..listener import Listener
from .generic import BaseIOHandler, FileIOMessageWriter
from .asc import ASCWriter
from .blf import BLFWriter
from .canutils import CanutilsLogWriter
from .csv import CSVWriter
from .sqlite import SqliteWriter
from .printer import Printer
[docs]class Logger(BaseIOHandler, Listener): # pylint: disable=abstract-method
"""
Logs CAN messages to a file.
The format is determined from the file format 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`
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 = {
".asc": ASCWriter,
".blf": BLFWriter,
".csv": CSVWriter,
".db": SqliteWriter,
".log": CanutilsLogWriter,
".txt": Printer,
}
@staticmethod
def __new__(cls, filename: Optional[StringPathLike], *args, **kwargs):
"""
: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()
try:
return Logger.message_writers[suffix](filename, *args, **kwargs)
except KeyError:
raise ValueError(
f'No write support for this unknown log format "{suffix}"'
) from None
[docs]class BaseRotatingLogger(Listener, ABC):
"""
Base class for rotating CAN loggers. This class is not meant to be
instantiated directly. Subclasses must implement the `should_rollover`
and `do_rollover` methods according to their rotation strategy.
The rotation behavior can be further customized by the user by setting
the `namer` and `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`.
:attr Optional[Callable] namer:
If this attribute is set to a callable, the rotation_filename() method
delegates to this callable. The parameters passed to the callable are
those passed to rotation_filename().
:attr Optional[Callable] rotator:
If this attribute is set to a callable, the rotate() method delegates
to this callable. The parameters passed to the callable are those
passed to rotate().
:attr int rollover_count:
An integer counter to track the number of rollovers.
:attr FileIOMessageWriter writer:
This attribute holds an instance of a writer class which manages the
actual file IO.
"""
supported_writers = {
".asc": ASCWriter,
".blf": BLFWriter,
".csv": CSVWriter,
".log": CanutilsLogWriter,
".txt": Printer,
}
namer: Optional[Callable] = None
rotator: Optional[Callable] = None
rollover_count: int = 0
_writer: Optional[FileIOMessageWriter] = None
def __init__(self, *args, **kwargs):
self.writer_args = args
self.writer_kwargs = kwargs
@property
def writer(self) -> FileIOMessageWriter:
if not self._writer:
raise ValueError("Attempt to access writer failed.")
return self._writer
[docs] def rotation_filename(self, default_name: 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 '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):
result = default_name
else:
result = self.namer(default_name)
return result
[docs] def rotate(self, source: StringPathLike, dest: StringPathLike):
"""When rotating, rotate the current log.
The default implementation calls the '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)
[docs] def on_message_received(self, msg: Message):
"""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)
[docs] def get_new_writer(self, filename: StringPathLike):
"""Instantiate a new writer.
: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.
"""
suffix = pathlib.Path(filename).suffix.lower()
try:
writer_class = self.supported_writers[suffix]
except KeyError:
raise ValueError(
f'Log format with suffix"{suffix}" is '
f"not supported by {self.__class__.__name__}."
)
else:
self._writer = writer_class(
filename, *self.writer_args, **self.writer_kwargs
)
[docs] def stop(self):
"""Stop handling new messages.
Carry out any final tasks to ensure
data is persisted and cleanup any open resources.
"""
self.writer.stop()
[docs] @abstractmethod
def should_rollover(self, msg: Message) -> bool:
"""Determine if the rollover conditions are met."""
...
[docs] @abstractmethod
def do_rollover(self):
"""Perform rollover."""
...
[docs]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 ´namer´ and `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`
The log files may be incomplete until `stop()` is called due to buffering.
"""
def __init__(
self, base_filename: StringPathLike, max_bytes: int = 0, *args, **kwargs
):
"""
: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(SizedRotatingLogger, self).__init__(*args, **kwargs)
self.base_filename = os.path.abspath(base_filename)
self.max_bytes = max_bytes
self.get_new_writer(self.base_filename)
[docs] 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
[docs] def do_rollover(self):
if self.writer:
self.writer.stop()
sfn = self.base_filename
dfn = self.rotation_filename(self._default_name())
self.rotate(sfn, dfn)
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)