RC 1.1.20

RELEASE_NOTES.md

@@ -1,5 +1,12 @@
 # pygnssutils
 
+### RELEASE 1.1.20
+
+FIXES:
+
+1. Fix to gnssreader to return `GNSSStreamError` rather than `ValueError` for unrecognised protocol.
+1. Fix typo in gnssntripclient CLI args.
+
 ### RELEASE 1.1.19
 
 ENHANCEMENTS:

src/pygnssutils/__init__.py

@@ -10,7 +10,7 @@
 from pyubxutils.ubxsimulator import UBXSimulator
 
 from pygnssutils._version import __version__
-from pygnssutils.exceptions import GNSSStreamError, ParameterError
+from pygnssutils.exceptions import GNSSError, GNSSStreamError, ParameterError
 from pygnssutils.globals import *
 from pygnssutils.gnssmqttclient import GNSSMQTTClient
 from pygnssutils.gnssntripclient import GNSSNTRIPClient

src/pygnssutils/_version.py

@@ -8,4 +8,4 @@
 :license: BSD 3-Clause
 """
 
-__version__ = "1.1.19"
+__version__ = "1.1.20"

src/pygnssutils/exceptions.py

@@ -13,5 +13,13 @@ class ParameterError(Exception):
     """Parameter Error Class."""
 
 
-class GNSSStreamError(Exception):
-    """Generic Stream Error Class."""
+class GNSSError(Exception):
+    """
+    Master GNSS Error Class.
+
+    Any other GNSS exceptions defined here should inherit from this.
+    """
+
+
+class GNSSStreamError(GNSSError):
+    """Generic GNSS Stream Error Class."""

src/pygnssutils/gnssntripclient_cli.py

@@ -105,7 +105,7 @@ def main():
         type=int,
         choices=[0, 1],
         default=0,
-    ),
+    )
     ap.add_argument(
         "-I",
         "--ipprot",

src/pygnssutils/gnssreader.py

@@ -76,6 +76,8 @@
     UBXTypeError,
 )
 
+from pygnssutils.exceptions import GNSSStreamError
+
 NMEA_PROTOCOL = 1
 """NMEA Protocol"""
 UBX_PROTOCOL = 2
@@ -88,10 +90,6 @@
 """RTCM3 Protocol"""
 
 
-class StreamError(Exception):
-    """Stream Error Class."""
-
-
 class GNSSReader:
     """
     GNSSReader class.
@@ -246,7 +244,7 @@ def read(self) -> tuple:
                         continue
                 # unrecognised protocol header
                 else:
-                    raise ValueError(f"Unknown protocol header {bytehdr}.")
+                    raise GNSSStreamError(f"Unknown protocol header {bytehdr}.")
 
             except EOFError:
                 return (None, None)
@@ -271,7 +269,7 @@ def read(self) -> tuple:
                 QGCParseError,
                 QGCStreamError,
                 QGCTypeError,
-                StreamError,
+                GNSSStreamError,
             ) as err:
                 if self._quitonerror:
                     self._do_error(err)
@@ -434,7 +432,7 @@ def _read_bytes(self, size: int) -> bytes:
         if len(data) == 0:  # EOF
             raise EOFError()
         if 0 < len(data) < size:  # truncated stream
-            raise StreamError(
+            raise GNSSStreamError(
                 "Serial stream terminated unexpectedly. "
                 f"{size} bytes requested, {len(data)} bytes returned."
             )
@@ -453,7 +451,7 @@ def _read_line(self) -> bytes:
         if len(data) == 0:
             raise EOFError()  # pragma: no cover
         if data[-1:] != b"\x0a":  # truncated stream
-            raise StreamError(
+            raise GNSSStreamError(
                 "Serial stream terminated unexpectedly. "
                 f"Line requested, {len(data)} bytes returned."
             )