Skip to content

Commit 6769016

Browse files
zariiii9003zariiii9003
committed
update rotating logger class names
1 parent 9a3a41e commit 6769016

6 files changed

Lines changed: 41 additions & 41 deletions

File tree

‎can/__init__.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ class CanError(IOError):
2424

2525
from .listener import Listener, BufferedReader, RedirectReader, AsyncBufferedReader
2626

27-
from .io import Logger, SizedRotatingCanLogger, Printer, LogReader, MessageSync
27+
from .io import Logger, SizedRotatingLogger, Printer, LogReader, MessageSync
2828
from .io import ASCWriter, ASCReader
2929
from .io import BLFReader, BLFWriter
3030
from .io import CanutilsLogReader, CanutilsLogWriter

‎can/io/__init__.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"""
55

66
# Generic
7-
from .logger import Logger, BaseRotatingCanLogger, SizedRotatingCanLogger
7+
from .logger import Logger, BaseRotatingLogger, SizedRotatingLogger
88
from .player import LogReader, MessageSync
99

1010
# Format specific

‎can/io/logger.py‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ def __new__(cls, filename: Optional[StringPathLike], *args, **kwargs):
8181
) from None
8282

8383

84-
class BaseRotatingCanLogger(Listener, ABC):
84+
class BaseRotatingLogger(Listener, ABC):
8585
"""
8686
Base class for rotating CAN loggers. This class is not meant to be
8787
instantiated directly. Subclasses must implement the `should_rollover`
@@ -224,7 +224,7 @@ def do_rollover(self):
224224
...
225225

226226

227-
class SizedRotatingCanLogger(BaseRotatingCanLogger):
227+
class SizedRotatingLogger(BaseRotatingLogger):
228228
"""Log CAN messages to a sequence of files with a given maximum size.
229229
230230
The logger creates a log file with the given `base_filename`. When the
@@ -237,20 +237,20 @@ class SizedRotatingCanLogger(BaseRotatingCanLogger):
237237
238238
Example::
239239
240-
from can import Notifier, SizedRotatingCanLogger
240+
from can import Notifier, SizedRotatingLogger
241241
from can.interfaces.vector import VectorBus
242242
243243
bus = VectorBus(channel=[0], app_name="CANape", fd=True)
244244
245-
logger = SizedRotatingCanLogger(
245+
logger = SizedRotatingLogger(
246246
base_filename="my_logfile.asc",
247247
max_bytes=5 * 1024 ** 2, # =5MB
248248
)
249249
logger.rollover_count = 23 # start counter at 23
250250
251251
notifier = Notifier(bus=bus, listeners=[logger])
252252
253-
The SizedRotatingCanLogger currently supports the formats
253+
The SizedRotatingLogger currently supports the formats
254254
* .asc: :class:`can.ASCWriter`
255255
* .blf :class:`can.BLFWriter`
256256
* .csv: :class:`can.CSVWriter`
@@ -271,7 +271,7 @@ def __init__(
271271
The size threshold at which a new log file shall be created. If set to 0, no
272272
rollover will be performed.
273273
"""
274-
super(SizedRotatingCanLogger, self).__init__(*args, **kwargs)
274+
super(SizedRotatingLogger, self).__init__(*args, **kwargs)
275275

276276
self.base_filename = os.path.abspath(base_filename)
277277
self.max_bytes = max_bytes

‎can/logger.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
from datetime import datetime
2121

2222
import can
23-
from can import Bus, BusState, Logger, SizedRotatingCanLogger
23+
from can import Bus, BusState, Logger, SizedRotatingLogger
2424

2525

2626
def main():
@@ -153,7 +153,7 @@ def main():
153153
print(f"Can Logger (Started on {datetime.now()})")
154154

155155
if results.file_size:
156-
logger = SizedRotatingCanLogger(
156+
logger = SizedRotatingLogger(
157157
base_filename=results.log_file, max_bytes=results.file_size
158158
)
159159
else:

‎doc/listeners.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,10 +75,10 @@ create log files with different file types of the messages received.
7575
.. autoclass:: can.Logger
7676
:members:
7777

78-
.. autoclass:: can.io.BaseRotatingCanLogger
78+
.. autoclass:: can.io.BaseRotatingLogger
7979
:members:
8080

81-
.. autoclass:: can.SizedRotatingCanLogger
81+
.. autoclass:: can.SizedRotatingLogger
8282
:members:
8383

8484

‎test/test_rotating_loggers.py‎

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@
1515
from .data.example_data import generate_message
1616

1717

18-
class TestBaseRotatingCanLogger:
18+
class TestBaseRotatingLogger:
1919
@staticmethod
2020
def _get_instance(*args, **kwargs):
21-
class SubClass(can.io.BaseRotatingCanLogger):
21+
class SubClass(can.io.BaseRotatingLogger):
2222
"""Subclass that implements abstract methods for testing."""
2323

2424
def should_rollover(self, msg):
@@ -30,25 +30,25 @@ def do_rollover(self):
3030
return SubClass(*args, **kwargs)
3131

3232
def test_import(self):
33-
assert hasattr(can.io, "BaseRotatingCanLogger")
33+
assert hasattr(can.io, "BaseRotatingLogger")
3434

3535
def test_attributes(self):
36-
assert issubclass(can.io.BaseRotatingCanLogger, can.Listener)
37-
assert hasattr(can.io.BaseRotatingCanLogger, "supported_writers")
38-
assert hasattr(can.io.BaseRotatingCanLogger, "namer")
39-
assert hasattr(can.io.BaseRotatingCanLogger, "rotator")
40-
assert hasattr(can.io.BaseRotatingCanLogger, "rollover_count")
41-
assert hasattr(can.io.BaseRotatingCanLogger, "writer")
42-
assert hasattr(can.io.BaseRotatingCanLogger, "rotation_filename")
43-
assert hasattr(can.io.BaseRotatingCanLogger, "rotate")
44-
assert hasattr(can.io.BaseRotatingCanLogger, "on_message_received")
45-
assert hasattr(can.io.BaseRotatingCanLogger, "get_new_writer")
46-
assert hasattr(can.io.BaseRotatingCanLogger, "stop")
47-
assert hasattr(can.io.BaseRotatingCanLogger, "should_rollover")
48-
assert hasattr(can.io.BaseRotatingCanLogger, "do_rollover")
36+
assert issubclass(can.io.BaseRotatingLogger, can.Listener)
37+
assert hasattr(can.io.BaseRotatingLogger, "supported_writers")
38+
assert hasattr(can.io.BaseRotatingLogger, "namer")
39+
assert hasattr(can.io.BaseRotatingLogger, "rotator")
40+
assert hasattr(can.io.BaseRotatingLogger, "rollover_count")
41+
assert hasattr(can.io.BaseRotatingLogger, "writer")
42+
assert hasattr(can.io.BaseRotatingLogger, "rotation_filename")
43+
assert hasattr(can.io.BaseRotatingLogger, "rotate")
44+
assert hasattr(can.io.BaseRotatingLogger, "on_message_received")
45+
assert hasattr(can.io.BaseRotatingLogger, "get_new_writer")
46+
assert hasattr(can.io.BaseRotatingLogger, "stop")
47+
assert hasattr(can.io.BaseRotatingLogger, "should_rollover")
48+
assert hasattr(can.io.BaseRotatingLogger, "do_rollover")
4949

5050
def test_supported_writers(self):
51-
supported_writers = can.io.BaseRotatingCanLogger.supported_writers
51+
supported_writers = can.io.BaseRotatingLogger.supported_writers
5252
assert supported_writers[".asc"] == can.ASCWriter
5353
assert supported_writers[".blf"] == can.BLFWriter
5454
assert supported_writers[".csv"] == can.CSVWriter
@@ -198,25 +198,25 @@ def test_on_message_received(self):
198198
logger_instance.stop()
199199

200200

201-
class TestSizedRotatingCanLogger:
201+
class TestSizedRotatingLogger:
202202
def test_import(self):
203-
assert hasattr(can.io, "SizedRotatingCanLogger")
204-
assert hasattr(can, "SizedRotatingCanLogger")
203+
assert hasattr(can.io, "SizedRotatingLogger")
204+
assert hasattr(can, "SizedRotatingLogger")
205205

206206
def test_attributes(self):
207-
assert issubclass(can.SizedRotatingCanLogger, can.io.BaseRotatingCanLogger)
208-
assert hasattr(can.SizedRotatingCanLogger, "supported_writers")
209-
assert hasattr(can.SizedRotatingCanLogger, "namer")
210-
assert hasattr(can.SizedRotatingCanLogger, "rotator")
211-
assert hasattr(can.SizedRotatingCanLogger, "should_rollover")
212-
assert hasattr(can.SizedRotatingCanLogger, "do_rollover")
207+
assert issubclass(can.SizedRotatingLogger, can.io.BaseRotatingLogger)
208+
assert hasattr(can.SizedRotatingLogger, "supported_writers")
209+
assert hasattr(can.SizedRotatingLogger, "namer")
210+
assert hasattr(can.SizedRotatingLogger, "rotator")
211+
assert hasattr(can.SizedRotatingLogger, "should_rollover")
212+
assert hasattr(can.SizedRotatingLogger, "do_rollover")
213213

214214
def test_create_instance(self):
215215
base_filename = "mylogfile.ASC"
216216
max_bytes = 512
217217

218218
with tempfile.TemporaryDirectory() as temp_dir:
219-
logger_instance = can.SizedRotatingCanLogger(
219+
logger_instance = can.SizedRotatingLogger(
220220
base_filename=os.path.join(temp_dir, base_filename), max_bytes=max_bytes
221221
)
222222
assert Path(logger_instance.base_filename).name == base_filename
@@ -231,7 +231,7 @@ def test_should_rollover(self):
231231
max_bytes = 512
232232

233233
with tempfile.TemporaryDirectory() as temp_dir:
234-
logger_instance = can.SizedRotatingCanLogger(
234+
logger_instance = can.SizedRotatingLogger(
235235
base_filename=os.path.join(temp_dir, base_filename), max_bytes=max_bytes
236236
)
237237
msg = generate_message(0x123)
@@ -256,7 +256,7 @@ def test_logfile_size(self):
256256
msg = generate_message(0x123)
257257

258258
with tempfile.TemporaryDirectory() as temp_dir:
259-
logger_instance = can.SizedRotatingCanLogger(
259+
logger_instance = can.SizedRotatingLogger(
260260
base_filename=os.path.join(temp_dir, base_filename), max_bytes=max_bytes
261261
)
262262
for _ in range(128):

0 commit comments

Comments
 (0)