Merge pull request #151 from semuconsulting/RC-1.2.42

Rc 1.2.42

.vscode/settings.json

@@ -4,5 +4,5 @@
     "editor.formatOnSave": true,
     "modulename": "${workspaceFolderBasename}",
     "distname": "${workspaceFolderBasename}",
-    "moduleversion": "1.2.41",
+    "moduleversion": "1.2.42",
 }

README.md

@@ -449,9 +449,7 @@ The UBX protocol is principally defined in the modules `ubxtypes_*.py` as a seri
 
 Repeating attribute names are parsed with a two-digit suffix (svid_01, svid_02, etc.). Nested repeating groups are supported. See CFG-VALGET, MON-SPAN, NAV-PVT, NAV-SAT and RXM-RLM by way of examples.
 
-In most cases, a UBX message's content (payload) is uniquely defined by its class, id and mode; accommodating the message simply requires the addition of an appropriate dictionary entry to the relevant `ubxtypes_*.py` module(s).
-
-However, there are a handful of message types which have multiple possible payload definitions for the same class, id and mode. These exceptional message types require dedicated routines in `ubxmessage.py` which examine elements of the payload itself in order to determine the appropriate dictionary definition. This currently applies to the following message types: CFG-NMEA, NAV-RELPOSNED, RXM-PMP, RXM-PMREQ, RXM-RLM, TIM-VCOCAL.
+In most cases, a UBX message's content (payload) is uniquely defined by its class, id and mode; accommodating the message simply requires the addition of an appropriate dictionary entry to the relevant `ubxtypes_*.py` module(s). However, there are a handful of message types which have multiple possible payload variants for the same class, id and mode. These exceptional message types are handled in `ubxvariants.py`, to which any additional variants should be added.
 
 ---
 ## <a name="troubleshoot">Troubleshooting</a>

RELEASE_NOTES.md

@@ -1,5 +1,11 @@
 # pyubx2 Release Notes
 
+### RELEASE 1.2.42
+
+ENHANCEMENTS:
+
+1. Internal refactoring to improve performance and exception handling.
+
 ### RELEASE 1.2.41
 
 ENHANCEMENTS:

docs/pyubx2.rst

@@ -92,6 +92,14 @@ pyubx2.ubxtypes\_set module
    :undoc-members:
    :show-inheritance:
 
+pyubx2.ubxvariants module
+-------------------------
+
+.. automodule:: pyubx2.ubxvariants
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 Module contents
 ---------------
 

pyproject.toml

@@ -7,7 +7,7 @@ name = "pyubx2"
 authors = [{ name = "semuadmin", email = "[email protected]" }]
 maintainers = [{ name = "semuadmin", email = "[email protected]" }]
 description = "UBX protocol parser and generator"
-version = "1.2.41"
+version = "1.2.42"
 license = { file = "LICENSE" }
 readme = "README.md"
 requires-python = ">=3.8"
@@ -33,7 +33,7 @@ classifiers = [
     "Topic :: Scientific/Engineering :: GIS",
 ]
 
-dependencies = ["pynmeagps >= 1.0.36", "pyrtcm >= 1.1.0"]
+dependencies = ["pynmeagps >= 1.0.36", "pyrtcm >= 1.1.1"]
 
 [project.urls]
 homepage = "https://github.com/semuconsulting/pyubx2"

src/pyubx2/_version.py

@@ -8,4 +8,4 @@
 :license: BSD 3-Clause
 """
 
-__version__ = "1.2.41"
+__version__ = "1.2.42"

src/pyubx2/socket_stream.py

@@ -48,7 +48,7 @@ def _recv(self) -> bool:
         try:
             data = self._socket.recv(self._bufsize)
             if len(data) == 0:
-                return False
+                return False  # pragma: no cover
             self._buffer += data
         except (OSError, TimeoutError):
             return False
@@ -100,7 +100,7 @@ def readline(self) -> bytes:
                 if line[-1:] == b"\n":  # LF
                     break
             else:
-                break
+                break  # pragma: no cover
 
         return line