Rename sqlreader for consistency. Closes #229

Author: hardbyte

can/__init__.py

@@ -22,7 +22,7 @@ class CanError(IOError):
 from can.io import BLFReader, BLFWriter
 from can.io import CanutilsLogReader, CanutilsLogWriter
 from can.io import CSVWriter
-from can.io import SqliteWriter, SqlReader
+from can.io import SqliteWriter, SqliteReader
 
 from can.util import set_logging_level
 

can/io/__init__.py

@@ -9,5 +9,5 @@
 from .asc import ASCWriter, ASCReader
 from .blf import BLFReader, BLFWriter
 from .csv import CSVWriter
-from .sqlite import SqlReader, SqliteWriter
+from .sqlite import SqliteReader, SqliteWriter
 from .stdout import Printer

can/io/player.py

@@ -5,7 +5,7 @@
 from .asc import ASCReader
 from .log import CanutilsLogReader
 from .blf import BLFReader
-from .sqlite import SqlReader
+from .sqlite import SqliteReader
 
 log = logging.getLogger('can.io.player')
 
@@ -35,7 +35,7 @@ def __new__(cls, other, filename):
         if filename.endswith(".blf"):
             return BLFReader(filename)
         if filename.endswith(".db"):
-            return SqlReader(filename)
+            return SqliteReader(filename)
         if filename.endswith(".asc"):
             return ASCReader(filename)
         if filename.endswith(".log"):

can/io/sqlite.py

@@ -19,20 +19,20 @@
     buffer = memoryview
 
 
-class SqlReader:
+class SqliteReader:
     """
     Reads recorded CAN messages from a simple SQL database.
 
     This class can be iterated over or used to fetch all messages in the
-    database with :meth:`~SqlReader.read_all`.
+    database with :meth:`~SqliteReader.read_all`.
 
     Calling len() on this object might not run in constant time.
     """
 
     _SELECT_ALL_COMMAND = "SELECT * FROM messages"
 
     def __init__(self, filename):
-        log.debug("Starting SqlReader with %s", filename)
+        log.debug("Starting SqliteReader with %s", filename)
         self.conn = sqlite3.connect(filename)
         self.cursor = self.conn.cursor()
 
@@ -46,7 +46,7 @@ def _create_frame_from_db_tuple(frame_data):
     def __iter__(self):
         log.debug("Iterating through messages from sql db")
         for frame_data in self.cursor.execute(self._SELECT_ALL_COMMAND):
-            yield SqlReader._create_frame_from_db_tuple(frame_data)
+            yield SqliteReader._create_frame_from_db_tuple(frame_data)
 
     def __len__(self):
         # this might not run in constant time
@@ -63,6 +63,10 @@ def close(self):
         self.conn.close()
 
 
+# Backward compatibility
+SqlReader = SqliteReader
+
+
 class SqliteWriter(BufferedReader):
     """Logs received CAN data to a simple SQL database.
 

test/listener_test.py

@@ -38,7 +38,7 @@ def testClassesImportable(self):
         self.assertTrue(hasattr(can, 'CanutilsLogWriter'))
         self.assertTrue(hasattr(can, 'CanutilsLogReader'))
 
-        self.assertTrue(hasattr(can, 'SqlReader'))
+        self.assertTrue(hasattr(can, 'SqliteReader'))
         self.assertTrue(hasattr(can, 'SqliteWriter'))
 
         self.assertTrue(hasattr(can, 'Printer'))

test/logformats_test.py

@@ -150,7 +150,7 @@ class TestSqlFileFormat(unittest.TestCase):
     """Tests can.SqliteWriter and can.SqliteReader"""
 
     def test_writer_and_reader(self):
-        _test_writer_and_reader(self, can.SqliteWriter, can.SqlReader,
+        _test_writer_and_reader(self, can.SqliteWriter, can.SqliteReader,
                                 sleep_time=can.SqliteWriter.MAX_TIME_BETWEEN_WRITES,
                                 check_comments=False)