adafruit-circuitpython-gps 3.11.7__tar.gz → 3.11.9__tar.gz

{adafruit_circuitpython_gps-3.11.7 → adafruit_circuitpython_gps-3.11.9}/.pre-commit-config.yaml

@@ -10,7 +10,7 @@ repos:
       - id: end-of-file-fixer
       - id: trailing-whitespace
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.3.4
+    rev: v0.15.8
     hooks:
       - id: ruff-format
       - id: ruff

{adafruit_circuitpython_gps-3.11.7 → adafruit_circuitpython_gps-3.11.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: adafruit-circuitpython-gps
-Version: 3.11.7
+Version: 3.11.9
 Summary: CircuitPython library for GPS modules.
 Author-email: Adafruit Industries <circuitpython@adafruit.com>
 License-Expression: MIT

{adafruit_circuitpython_gps-3.11.7 → adafruit_circuitpython_gps-3.11.9}/adafruit_circuitpython_gps.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: adafruit-circuitpython-gps
-Version: 3.11.7
+Version: 3.11.9
 Summary: CircuitPython library for GPS modules.
 Author-email: Adafruit Industries <circuitpython@adafruit.com>
 License-Expression: MIT

{adafruit_circuitpython_gps-3.11.7 → adafruit_circuitpython_gps-3.11.9}/adafruit_gps.py

@@ -40,7 +40,7 @@ try:
 except ImportError:
     pass
 
-__version__ = "3.11.7"
+__version__ = "3.11.9"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_GPS.git"
 
 
@@ -89,6 +89,22 @@ _SENTENCE_PARAMS = (
 # Internal helper parsing functions.
 # These handle input that might be none or null and return none instead of
 # throwing errors.
+def _split_decimal(nmea_data: str) -> Tuple[Optional[str], str]:
+    # Split a numeric NMEA field into its integer and fractional digits.
+    # Returns (None, "") if either part is missing or non-numeric. The
+    # fractional part is optional; some receivers omit it entirely.
+    dot = nmea_data.find(".")
+    if dot == -1:
+        int_part, minutes_decimal = nmea_data, "0"
+    else:
+        int_part, minutes_decimal = nmea_data[:dot], nmea_data[dot + 1 :]
+        if not minutes_decimal:
+            minutes_decimal = "0"
+    if not int_part.isdigit() or not minutes_decimal.isdigit():
+        return None, ""
+    return int_part, minutes_decimal
+
+
 def _parse_degrees(nmea_data: str) -> int:
     # Parse a NMEA lat/long data pair 'dddmm.mmmm' into a pure degrees value.
     # Where ddd is the degrees, mm.mmmm is the minutes.
@@ -97,10 +113,12 @@ def _parse_degrees(nmea_data: str) -> int:
     # To avoid losing precision handle degrees and minutes separately
     # Return the final value as an integer. Further functions can parse
     # this into a float or separate parts to retain the precision
-    raw = nmea_data.split(".")
-    degrees = int(raw[0]) // 100 * 1000000  # the ddd
-    minutes = int(raw[0]) % 100  # the mm.
-    minutes += int(f"{raw[1][:4]:0<4}") / 10000
+    int_part, minutes_decimal = _split_decimal(nmea_data)
+    if int_part is None:
+        return None
+    degrees = int(int_part) // 100 * 1000000  # the ddd
+    minutes = int(int_part) % 100  # the mm.
+    minutes += int(f"{minutes_decimal[:4]:0<4}") / 10000
     minutes = int((minutes * 1000000) / 60)
     return degrees + minutes
 
@@ -125,6 +143,8 @@ def _parse_str(nmea_data: str) -> str:
 
 def _read_degrees(data: List[float], index: int, neg: str) -> float:
     # This function loses precision with float32
+    if data[index] is None or data[index + 1] is None:
+        return None
     x = data[index] / 1000000
     if data[index + 1].lower() == neg:
         x *= -1.0
@@ -136,12 +156,14 @@ def _read_deg_mins(data: List[str], index: int, neg: str) -> Tuple[int, float]:
     # longitudes, which makes parsing tricky:
     # for latitudes: ddmm,mmmm (0 - 7 decimal places, not zero padded)
     # for longitudes: dddmm,mmmm (0 - 7 decimal places, not zero padded)
-    if "." in data[index]:
-        int_part, minutes_decimal = data[index].split(".")
-    else:
-        int_part, minutes_decimal = data[index], 0
+    if data[index] is None or len(data[index]) < 3:
+        return None, None
 
     # we need to parse from right to left, minutes can only have 2 digits
+    int_part, minutes_decimal = _split_decimal(data[index])
+    if int_part is None or len(int_part) < 3:
+        return None, None
+
     minutes_int = int_part[-2:]
     # the rest must be degrees which are either 2 or 3 digits
     deg = int(int_part[:-2])
@@ -161,7 +183,8 @@ def _parse_talker(data_type: bytes) -> Tuple[bytes, bytes]:
     return (data_type[:2], data_type[2:])
 
 
-def _parse_data(sentence_type: int, data: List[str]) -> Optional[List]:
+def _parse_data(sentence_type: int, data: List[str]) -> Optional[List]:  # noqa: PLR0911
+    # PLR0911: each early return is a distinct, self-documenting rejection reason ...
     """Parse sentence data for the specified sentence type and
     return a list of parameters in the correct format, or return None.
     """
@@ -196,8 +219,14 @@ def _parse_data(sentence_type: int, data: List[str]) -> Optional[List]:
                 else:
                     params.append(dti)
             elif pti == "d":
-                # A number parseable as degrees
-                params.append(_parse_degrees(dti))
+                # A number parseable as degrees.
+                # Required field so unparseable or empty should reject whole sentence.
+                if nothing:
+                    return None
+                parsed_degrees = _parse_degrees(dti)
+                if parsed_degrees is None:
+                    return None
+                params.append(parsed_degrees)
             elif pti == "D":
                 # A number parseable as degrees or Nothing
                 if nothing:
@@ -490,11 +519,32 @@ class GPS:
         data_type = sentence[1:delimiter]
         return (data_type, sentence[delimiter + 1 :])
 
+    @staticmethod
+    def _parse_hhmmss(time_utc: Optional[str]) -> Optional[Tuple[int, int, int]]:
+        # Parse an NMEA hhmmss(.sss) field into (hours, mins, secs).
+        # Returns None if the field is absent, short, or non-numeric.
+        if time_utc is None or len(time_utc) < 6 or not time_utc[0:6].isdigit():
+            return None
+        return (int(time_utc[0:2]), int(time_utc[2:4]), int(time_utc[4:6]))
+
+    @staticmethod
+    def _parse_ddmmyy(date: Optional[str]) -> Optional[Tuple[int, int, int]]:
+        # Parse an NMEA ddmmyy field into (day, month, year).
+        # Returns None if the field is absent, short, or non-numeric.
+        if date is None or len(date) < 6 or not date[0:6].isdigit():
+            return None
+        return (int(date[0:2]), int(date[2:4]), 2000 + int(date[4:6]))
+
     def _update_timestamp_utc(self, time_utc: str, date: Optional[str] = None) -> None:
-        hours = int(time_utc[0:2])
-        mins = int(time_utc[2:4])
-        secs = int(time_utc[4:6])
-        if date is None:
+        parsed_time = self._parse_hhmmss(time_utc)
+        if parsed_time is None:
+            # Malformed time field; leave the previous timestamp untouched.
+            return
+        hours, mins, secs = parsed_time
+
+        parsed_date = self._parse_ddmmyy(date)
+        if parsed_date is None:
+            # No usable date field; carry forward the date we already have.
             if self.timestamp_utc is None:
                 day, month, year = 0, 0, 0
             else:
@@ -502,9 +552,7 @@ class GPS:
                 month = self.timestamp_utc.tm_mon
                 year = self.timestamp_utc.tm_year
         else:
-            day = int(date[0:2])
-            month = int(date[2:4])
-            year = 2000 + int(date[4:6])
+            day, month, year = parsed_date
 
         self.timestamp_utc = time.struct_time((year, month, day, hours, mins, secs, 0, 0, -1))
 

{adafruit_circuitpython_gps-3.11.7 → adafruit_circuitpython_gps-3.11.9}/pyproject.toml

@@ -12,7 +12,7 @@ requires = [
 [project]
 name = "adafruit-circuitpython-gps"
 description = "CircuitPython library for GPS modules."
-version = "3.11.7"
+version = "3.11.9"
 readme = "README.rst"
 authors = [
     {name = "Adafruit Industries", email = "circuitpython@adafruit.com"}

{adafruit_circuitpython_gps-3.11.7 → adafruit_circuitpython_gps-3.11.9}/tests/adafruit_gps_test.py

@@ -301,7 +301,7 @@ def test_GPS_send_command_with_checksum(capsys):
     gps.send_command(command=b"$PMTK001,314,3\r\n", add_checksum=True)
     out, err = capsys.readouterr()
     assert not err
-    assert out == ("b'$'" "b'$PMTK001,314,3\\r\\n'" "b'*'" "b'15'" "b'\\r\\n'")
+    assert out == ("b'$'b'$PMTK001,314,3\\r\\n'b'*'b'15'b'\\r\\n'")
 
 
 def test_GPS_send_command_without_checksum(capsys):
@@ -309,7 +309,7 @@ def test_GPS_send_command_without_checksum(capsys):
     gps.send_command(command=b"$PMTK001,314,3\r\n", add_checksum=False)
     out, err = capsys.readouterr()
     assert not err
-    assert out == ("b'$'" "b'$PMTK001,314,3\\r\\n'" "b'\\r\\n'")
+    assert out == ("b'$'b'$PMTK001,314,3\\r\\n'b'\\r\\n'")
 
 
 def test_GPS_update_from_GLL():