update rotating logger class names

Author: zariiii9003

can/__init__.py

@@ -24,7 +24,7 @@ class CanError(IOError):
 
 from .listener import Listener, BufferedReader, RedirectReader, AsyncBufferedReader
 
-from .io import Logger, SizedRotatingCanLogger, Printer, LogReader, MessageSync
+from .io import Logger, SizedRotatingLogger, Printer, LogReader, MessageSync
 from .io import ASCWriter, ASCReader
 from .io import BLFReader, BLFWriter
 from .io import CanutilsLogReader, CanutilsLogWriter

can/io/__init__.py

@@ -4,7 +4,7 @@
 """
 
 # Generic
-from .logger import Logger, BaseRotatingCanLogger, SizedRotatingCanLogger
+from .logger import Logger, BaseRotatingLogger, SizedRotatingLogger
 from .player import LogReader, MessageSync
 
 # Format specific

can/io/logger.py

@@ -81,7 +81,7 @@ def __new__(cls, filename: Optional[StringPathLike], *args, **kwargs):
             ) from None
 
 
-class BaseRotatingCanLogger(Listener, ABC):
+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`
@@ -224,7 +224,7 @@ def do_rollover(self):
         ...
 
 
-class SizedRotatingCanLogger(BaseRotatingCanLogger):
+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
@@ -237,20 +237,20 @@ class SizedRotatingCanLogger(BaseRotatingCanLogger):
 
     Example::
 
-        from can import Notifier, SizedRotatingCanLogger
+        from can import Notifier, SizedRotatingLogger
         from can.interfaces.vector import VectorBus
 
         bus = VectorBus(channel=[0], app_name="CANape", fd=True)
 
-        logger = SizedRotatingCanLogger(
+        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 SizedRotatingCanLogger currently supports the formats
+    The SizedRotatingLogger currently supports the formats
       * .asc: :class:`can.ASCWriter`
       * .blf :class:`can.BLFWriter`
       * .csv: :class:`can.CSVWriter`
@@ -271,7 +271,7 @@ def __init__(
             The size threshold at which a new log file shall be created. If set to 0, no
             rollover will be performed.
         """
-        super(SizedRotatingCanLogger, self).__init__(*args, **kwargs)
+        super(SizedRotatingLogger, self).__init__(*args, **kwargs)
 
         self.base_filename = os.path.abspath(base_filename)
         self.max_bytes = max_bytes

can/logger.py

@@ -20,7 +20,7 @@
 from datetime import datetime
 
 import can
-from can import Bus, BusState, Logger, SizedRotatingCanLogger
+from can import Bus, BusState, Logger, SizedRotatingLogger
 
 
 def main():
@@ -153,7 +153,7 @@ def main():
     print(f"Can Logger (Started on {datetime.now()})")
 
     if results.file_size:
-        logger = SizedRotatingCanLogger(
+        logger = SizedRotatingLogger(
             base_filename=results.log_file, max_bytes=results.file_size
         )
     else:

doc/listeners.rst

@@ -75,10 +75,10 @@ create log files with different file types of the messages received.
 .. autoclass:: can.Logger
     :members:
 
-.. autoclass:: can.io.BaseRotatingCanLogger
+.. autoclass:: can.io.BaseRotatingLogger
     :members:
 
-.. autoclass:: can.SizedRotatingCanLogger
+.. autoclass:: can.SizedRotatingLogger
     :members:
 
 

test/test_rotating_loggers.py

@@ -15,10 +15,10 @@
 from .data.example_data import generate_message
 
 
-class TestBaseRotatingCanLogger:
+class TestBaseRotatingLogger:
     @staticmethod
     def _get_instance(*args, **kwargs):
-        class SubClass(can.io.BaseRotatingCanLogger):
+        class SubClass(can.io.BaseRotatingLogger):
             """Subclass that implements abstract methods for testing."""
 
             def should_rollover(self, msg):
@@ -30,25 +30,25 @@ def do_rollover(self):
         return SubClass(*args, **kwargs)
 
     def test_import(self):
-        assert hasattr(can.io, "BaseRotatingCanLogger")
+        assert hasattr(can.io, "BaseRotatingLogger")
 
     def test_attributes(self):
-        assert issubclass(can.io.BaseRotatingCanLogger, can.Listener)
-        assert hasattr(can.io.BaseRotatingCanLogger, "supported_writers")
-        assert hasattr(can.io.BaseRotatingCanLogger, "namer")
-        assert hasattr(can.io.BaseRotatingCanLogger, "rotator")
-        assert hasattr(can.io.BaseRotatingCanLogger, "rollover_count")
-        assert hasattr(can.io.BaseRotatingCanLogger, "writer")
-        assert hasattr(can.io.BaseRotatingCanLogger, "rotation_filename")
-        assert hasattr(can.io.BaseRotatingCanLogger, "rotate")
-        assert hasattr(can.io.BaseRotatingCanLogger, "on_message_received")
-        assert hasattr(can.io.BaseRotatingCanLogger, "get_new_writer")
-        assert hasattr(can.io.BaseRotatingCanLogger, "stop")
-        assert hasattr(can.io.BaseRotatingCanLogger, "should_rollover")
-        assert hasattr(can.io.BaseRotatingCanLogger, "do_rollover")
+        assert issubclass(can.io.BaseRotatingLogger, can.Listener)
+        assert hasattr(can.io.BaseRotatingLogger, "supported_writers")
+        assert hasattr(can.io.BaseRotatingLogger, "namer")
+        assert hasattr(can.io.BaseRotatingLogger, "rotator")
+        assert hasattr(can.io.BaseRotatingLogger, "rollover_count")
+        assert hasattr(can.io.BaseRotatingLogger, "writer")
+        assert hasattr(can.io.BaseRotatingLogger, "rotation_filename")
+        assert hasattr(can.io.BaseRotatingLogger, "rotate")
+        assert hasattr(can.io.BaseRotatingLogger, "on_message_received")
+        assert hasattr(can.io.BaseRotatingLogger, "get_new_writer")
+        assert hasattr(can.io.BaseRotatingLogger, "stop")
+        assert hasattr(can.io.BaseRotatingLogger, "should_rollover")
+        assert hasattr(can.io.BaseRotatingLogger, "do_rollover")
 
     def test_supported_writers(self):
-        supported_writers = can.io.BaseRotatingCanLogger.supported_writers
+        supported_writers = can.io.BaseRotatingLogger.supported_writers
         assert supported_writers[".asc"] == can.ASCWriter
         assert supported_writers[".blf"] == can.BLFWriter
         assert supported_writers[".csv"] == can.CSVWriter
@@ -198,25 +198,25 @@ def test_on_message_received(self):
             logger_instance.stop()
 
 
-class TestSizedRotatingCanLogger:
+class TestSizedRotatingLogger:
     def test_import(self):
-        assert hasattr(can.io, "SizedRotatingCanLogger")
-        assert hasattr(can, "SizedRotatingCanLogger")
+        assert hasattr(can.io, "SizedRotatingLogger")
+        assert hasattr(can, "SizedRotatingLogger")
 
     def test_attributes(self):
-        assert issubclass(can.SizedRotatingCanLogger, can.io.BaseRotatingCanLogger)
-        assert hasattr(can.SizedRotatingCanLogger, "supported_writers")
-        assert hasattr(can.SizedRotatingCanLogger, "namer")
-        assert hasattr(can.SizedRotatingCanLogger, "rotator")
-        assert hasattr(can.SizedRotatingCanLogger, "should_rollover")
-        assert hasattr(can.SizedRotatingCanLogger, "do_rollover")
+        assert issubclass(can.SizedRotatingLogger, can.io.BaseRotatingLogger)
+        assert hasattr(can.SizedRotatingLogger, "supported_writers")
+        assert hasattr(can.SizedRotatingLogger, "namer")
+        assert hasattr(can.SizedRotatingLogger, "rotator")
+        assert hasattr(can.SizedRotatingLogger, "should_rollover")
+        assert hasattr(can.SizedRotatingLogger, "do_rollover")
 
     def test_create_instance(self):
         base_filename = "mylogfile.ASC"
         max_bytes = 512
 
         with tempfile.TemporaryDirectory() as temp_dir:
-            logger_instance = can.SizedRotatingCanLogger(
+            logger_instance = can.SizedRotatingLogger(
                 base_filename=os.path.join(temp_dir, base_filename), max_bytes=max_bytes
             )
             assert Path(logger_instance.base_filename).name == base_filename
@@ -231,7 +231,7 @@ def test_should_rollover(self):
         max_bytes = 512
 
         with tempfile.TemporaryDirectory() as temp_dir:
-            logger_instance = can.SizedRotatingCanLogger(
+            logger_instance = can.SizedRotatingLogger(
                 base_filename=os.path.join(temp_dir, base_filename), max_bytes=max_bytes
             )
             msg = generate_message(0x123)
@@ -256,7 +256,7 @@ def test_logfile_size(self):
         msg = generate_message(0x123)
 
         with tempfile.TemporaryDirectory() as temp_dir:
-            logger_instance = can.SizedRotatingCanLogger(
+            logger_instance = can.SizedRotatingLogger(
                 base_filename=os.path.join(temp_dir, base_filename), max_bytes=max_bytes
             )
             for _ in range(128):