Raise appropriate error message when append is not possible (#1361)

* Raise appropriate error messages when SqliteWriter is requested to roll
- Handle "append" by adding **options to SqlWriter
- Check logger instance for SqliteWriter in rotating logger setup
  and raise appropriate error.

* Change **options to **kwargs in can/io/sqlite.py

Co-authored-by: zariiii9003 <[email protected]>

* Better error handling for Sqlite rollover and append option

* Add type to **kwargs in asc

* Raise type error rather than exception so tests pass

* Changes to kwargs lookup and rolling log unavailability

* Updates based on black and mypy feedback

* Reformat exception by black

* Handle multiple suffixes in exception

* Replace ValueError with TypeError

* Update append test to handle ValueError

Co-authored-by: zariiii9003 <[email protected]>

Author: j-c-cook

can/io/asc.py

@@ -352,6 +352,7 @@ def __init__(
         self,
         file: Union[StringPathLike, TextIO],
         channel: int = 1,
+        **kwargs: Any,
     ) -> None:
         """
         :param file: a path-like object or as file-like object to write to
@@ -360,6 +361,11 @@ def __init__(
         :param channel: a default channel to use when the message does not
                         have a channel set
         """
+        if kwargs.get("append", False):
+            raise ValueError(
+                f"{self.__class__.__name__} is currently not equipped to "
+                f"append messages to an existing file."
+            )
         super().__init__(file, mode="w")
 
         self.channel = channel

can/io/logger.py

@@ -14,6 +14,7 @@
 from typing_extensions import Literal
 from pkg_resources import iter_entry_points
 
+import can.io
 from ..message import Message
 from ..listener import Listener
 from .generic import BaseIOHandler, FileIOMessageWriter, MessageWriter
@@ -227,8 +228,8 @@ def _get_new_writer(self, filename: StringPathLike) -> FileIOMessageWriter:
             return cast(FileIOMessageWriter, logger)
         else:
             raise Exception(
-                "The Logger corresponding to the arguments is not a FileIOMessageWriter or "
-                "can.Printer"
+                f"The log format \"{''.join(pathlib.Path(filename).suffixes[-2:])}"
+                f'" is not supported by {self.__class__.__name__}'
             )
 
     def stop(self) -> None:

can/io/sqlite.py

@@ -8,7 +8,7 @@
 import threading
 import logging
 import sqlite3
-from typing import Generator
+from typing import Generator, Any
 
 from can.listener import BufferedReader
 from can.message import Message
@@ -128,7 +128,9 @@ class SqliteWriter(MessageWriter, BufferedReader):
     MAX_BUFFER_SIZE_BEFORE_WRITES = 500
     """Maximum number of messages to buffer before writing to the database"""
 
-    def __init__(self, file: StringPathLike, table_name: str = "messages") -> None:
+    def __init__(
+        self, file: StringPathLike, table_name: str = "messages", **kwargs: Any
+    ) -> None:
         """
         :param file: a `str` or path like object that points
                      to the database file to use
@@ -137,6 +139,11 @@ def __init__(self, file: StringPathLike, table_name: str = "messages") -> None:
         .. warning:: In contrary to all other readers/writers the Sqlite handlers
                      do not accept file-like objects as the `file` parameter.
         """
+        if kwargs.get("append", False):
+            raise ValueError(
+                f"The append argument should not be used in "
+                f"conjunction with the {self.__class__.__name__}."
+            )
         super().__init__(file=None)
         self.table_name = table_name
         self._db_filename = file

test/logformats_test.py

@@ -311,7 +311,7 @@ def test_append_mode(self):
         # use append mode for second half
         try:
             writer = self.writer_constructor(self.test_file_name, append=True)
-        except TypeError as e:
+        except ValueError as e:
             # maybe "append" is not a formal parameter (this is the case for SqliteWriter)
             try:
                 writer = self.writer_constructor(self.test_file_name)