Add type annotations #86
Conversation
adafruit_gps.py
Outdated
| @@ -91,49 +99,49 @@ def _parse_degrees(nmea_data): | |||
| return degrees + minutes # return parsed string in the format dddmmmmmm | |||
There was a problem hiding this comment.
Might be worth updating the comment here, it mentions that a parsed string is returned, but it does appear to be an int same as it's annotated now.
There was a problem hiding this comment.
I ended up just removing it since the comments below the function definition say it's "a pure degrees value". I think that's clear between that, the other comments, and the type annotation, but happy to change to improve clarity. Good catch!
| # This function loses precision with float32 | ||
| x = data[index] / 1000000 | ||
| if data[index + 1].lower() == neg: | ||
| x *= -1.0 | ||
| return x | ||
|
|
||
|
|
||
| def _read_int_degrees(data, index, neg): | ||
| def _read_int_degrees(data: List[float], index: int, neg: str) -> float: | ||
| deg = data[index] // 1000000 | ||
| minutes = data[index] % 1000000 / 10000 | ||
| if data[index + 1].lower() == neg: | ||
| deg *= -1 | ||
| return (deg, minutes) |
There was a problem hiding this comment.
This return looks like it would be a tuple to me instead of float
There was a problem hiding this comment.
Whoops, thanks for catching!
adafruit_gps.py
Outdated
| *, | ||
| address: int = _GPSI2C_DEFAULT_ADDRESS, | ||
| debug: bool = False, | ||
| timeout: float = 5, |
There was a problem hiding this comment.
should timeout allow int or float Or maybe have it's default value changed to 5.0 instead?
There was a problem hiding this comment.
It seems only to be used with time.monotonic() so float is a valid input. I'm in favor of changing to 5.0 if that helps makes that clearer.
Updating https://github.com/adafruit/Adafruit_CircuitPython_ESP_ATcontrol to 0.8.0 from 0.7.0: > Merge pull request adafruit/Adafruit_CircuitPython_ESP_ATcontrol#63 from bablokb/fix-retries Updating https://github.com/adafruit/Adafruit_CircuitPython_GPS to 3.10.5 from 3.10.4: > Merge pull request adafruit/Adafruit_CircuitPython_GPS#86 from tekktrik/doc/add-typing Updating https://github.com/adafruit/Adafruit_CircuitPython_INA260 to 1.3.11 from 1.3.10: > Merge pull request adafruit/Adafruit_CircuitPython_INA260#21 from gpongelli/patch-3 Updating https://github.com/adafruit/Adafruit_CircuitPython_LIS331 to 1.0.13 from 1.0.12: > Merge pull request adafruit/Adafruit_CircuitPython_LIS331#6 from tcfranks/main Updating https://github.com/adafruit/Adafruit_CircuitPython_turtle to 2.2.11 from 2.2.10: > Merge pull request adafruit/Adafruit_CircuitPython_turtle#31 from shulltronics/cpython-compatibility
Resolves #68