Updated example

Updates to tests and stricter timezone requirements
Alter the dbc load to support both file-like and path-like objects

Author: Magnus Aagaard Sørensen

.coveragerc

@@ -0,0 +1,10 @@
+[run]
+source =
+    can_decoder
+    tests
+
+[paths]
+source =
+    src/can_decoder
+    */site-packages/can_decoder
+

.gitattributes

@@ -1,3 +1,4 @@
 *.mf4 filter=lfs diff=lfs merge=lfs -text
 *.MF4 filter=lfs diff=lfs merge=lfs -text
 *.dbc filter=lfs diff=lfs merge=lfs -text
+can_decoder/_version.py export-subst

.gitignore

@@ -1,6 +1,10 @@
-__pycache__
-.idea
-build
-can_decoder.egg-info
-dist
+/__pycache__/
+/.idea/
+/.pytest_cache/
+/.tox/
+/build/
+/can_decoder.egg-info/
+/dist/
+/htmlcov/
 
+/.coverage

MANIFEST.in

@@ -0,0 +1,2 @@
+include versioneer.py
+include can_decoder/_version.py

can_decoder/DBCLoader.py

@@ -1,15 +1,14 @@
-from typing import Dict
-
 import canmatrix
 
 from os import PathLike
+from typing import Union, BinaryIO
 
 from can_decoder.Frame import Frame
 from can_decoder.Signal import Signal
 from can_decoder.SignalDB import SignalDB
 
 
-def load_dbc(dbc_file: PathLike, *args, **kwargs):
+def load_dbc(dbc_file: Union[str, PathLike, BinaryIO], *args, **kwargs):
     """From a DBC file, load a set of frames and signals for conversion.
     
     :param dbc_file:    Path to a DBC file.
@@ -22,9 +21,12 @@ def load_dbc(dbc_file: PathLike, *args, **kwargs):
     # If a custom attribute is requested, determine the name here.
     use_custom_attribute = kwargs.get("use_custom_attribute", None)
 
-    # Load the file using canmatrix.
-    with open(dbc_file, "rb") as handle:
-        dbc = canmatrix.formats.load_flat(handle, "dbc")
+    # Attempt to determine the type of the input. Check for file-like first, attempt to use as a path second.
+    if all(hasattr(dbc_file, attr) for attr in ("seek", "read", "readline")):
+        dbc = canmatrix.formats.load_flat(dbc_file, "dbc")
+    else:
+        with open(dbc_file, "rb") as handle:
+            dbc = canmatrix.formats.load_flat(handle, "dbc")
 
     # Create a new DB instance.
     result = SignalDB(protocol=dbc.attribute("ProtocolType", None))
@@ -89,7 +91,7 @@ def load_dbc(dbc_file: PathLike, *args, **kwargs):
                         break
 
                 if multiplexer_signal is None:
-                    raise RuntimeError("Could not find multiplexor")
+                    raise RuntimeError("Could not find multiplexer")
 
                 # Find all depending signals.
                 multiplexer_signal.signals = multiplexed[multiplexer_name]

can_decoder/DecoderBase.py

@@ -3,6 +3,7 @@
 
 import numpy as np
 
+from can_decoder.exceptions.DataSizeMismatch import DataSizeMismatch
 from can_decoder.Signal import Signal
 from can_decoder.SignalDB import SignalDB
 
@@ -21,7 +22,7 @@ def get_supported_protocols(cls) -> List[Optional[str]]:
 
         :return:    List of supported protocols.
         """
-        raise NotImplementedError("")
+        raise NotImplementedError("")  # pragma: no cover
 
     @classmethod
     def _extract_signal_bits(cls, signal: Signal, data: np.ndarray) -> np.ndarray:
@@ -84,7 +85,7 @@ def _decode_signal_raw(cls, signal: Signal, data: np.ndarray) -> np.ndarray:
         # Construct the corresponding unsigned datatype.
         signal_single_datatype = "<u{}".format(signal_size_in_bytes)
 
-        if len(signal_data.shape) == 0:
+        if len(signal_data.shape) == 1:
             # Frames with one dimension are simple to handle.
             new_shape = signal_data.shape[0]
         elif signal_size_in_bytes in (3, 5, 6, 7):
@@ -105,10 +106,13 @@ def _decode_signal_raw(cls, signal: Signal, data: np.ndarray) -> np.ndarray:
             signal_data = expanded_data
             new_shape = next_size * data.shape[0]
         else:
-            new_shape = signal_size_in_bytes * data.shape[0]
+            new_shape = (data.shape[0], signal_size_in_bytes)
 
         # Reshape to a single dimension.
-        reshaped_data = signal_data.reshape(new_shape)
+        try:
+            reshaped_data = signal_data.reshape(new_shape)
+        except ValueError as e:
+            raise DataSizeMismatch()
 
         # Interpret as single datatype.
         data_return = reshaped_data.view(dtype=signal_single_datatype)

can_decoder/SignalDB.py

@@ -1,19 +1,16 @@
-from collections import defaultdict
 from typing import Optional
 
 from can_decoder.Frame import Frame
 
 
 class SignalDB(object):
-    _protocol = None  # type: Optional[str]
-    frames = defaultdict()
-    
     def __init__(self, protocol: Optional[str] = None):
         """Create a new signal database, with a pre-defined protocol.
         
         :param protocol: Protocol to associate with the database.
         """
         self._protocol = protocol
+        self.frames = {}
         pass
 
     @property

can_decoder/__init__.py

@@ -1,11 +1,26 @@
-from can_decoder.dataframe import DataFrameDecoder
-from can_decoder.iterator import IteratorDecoder, decoded_signal
+from can_decoder.exceptions import *
+from can_decoder.iterator import IteratorDecoder, DecodedSignal
 
 from can_decoder.Frame import Frame
 from can_decoder.Signal import Signal
 from can_decoder.SignalDB import SignalDB
 
 try:
-    from can_decoder.DBCLoader import load_dbc
+    from can_decoder.dataframe import DataFrameDecoder
 except ModuleNotFoundError:
     pass
+
+try:
+    import warnings
+
+    with warnings.catch_warnings():
+        warnings.filterwarnings("ignore", category=DeprecationWarning)
+        warnings.filterwarnings("ignore", category=SyntaxWarning)
+        
+        from can_decoder.DBCLoader import load_dbc
+except ModuleNotFoundError:
+    pass
+
+from ._version import get_versions
+__version__ = get_versions()["version"]
+del get_versions