Fix a few type hints #34
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
FoamyGuy
reviewed
Apr 7, 2025
Myoldmopar
commented
Apr 8, 2025
| @@ -29,14 +29,15 @@ | |||
| from typing_extensions import Literal | |||
| from circuitpython_typing import WriteableBuffer | |||
| from adafruit_onewire.bus import OneWireBus # pylint: disable=ungrouped-imports | |||
| from adafruit_onewire.device import OneWireAddress | |||
There was a problem hiding this comment.
New import only for type hinting, so it is inside the try block.
| except ImportError: | ||
| pass | ||
|
|
||
| _CONVERT = b"\x44" | ||
| _RD_SCRATCH = b"\xBE" | ||
| _WR_SCRATCH = b"\x4E" | ||
| _CONVERSION_TIMEOUT = const(1) | ||
| RESOLUTION = (9, 10, 11, 12) | ||
| RESOLUTION: tuple[Literal[9, 10, 11, 12], ...] = (9, 10, 11, 12) |
There was a problem hiding this comment.
Declares RESOLUTION as a tuple where each value is in the set (9, 10, 11, 12). This allows IDEs and type checkers to more strictly validate the values being accessed inside this tuple variable.
| @@ -74,7 +75,7 @@ class DS18X20: | |||
|
|
|||
| """ | |||
|
|
|||
| def __init__(self, bus: OneWireBus, address: int) -> None: | |||
| def __init__(self, bus: OneWireBus, address: OneWireAddress) -> None: | |||
There was a problem hiding this comment.
The main fix here - it's not an int, it's a OneWireAddress instance.
| @@ -84,7 +85,7 @@ def __init__(self, bus: OneWireBus, address: int) -> None: | |||
| raise ValueError("Incorrect family code in device address.") | |||
|
|
|||
| @property | |||
| def temperature(self): | |||
| def temperature(self) -> float: | |||
There was a problem hiding this comment.
Minor tweak, this returns a float for the temperature.
|
Let me know if there's anything else needed here, otherwise I think it's ready to go. Thanks! |
FoamyGuy
approved these changes
Apr 8, 2025
adafruit-adabot
added a commit
to adafruit/Adafruit_CircuitPython_Bundle
that referenced
this pull request
Apr 9, 2025
Updating https://github.com/adafruit/Adafruit_CircuitPython_DS18X20 to 1.4.4 from 1.4.3: > Merge pull request adafruit/Adafruit_CircuitPython_DS18X20#34 from Myoldmopar/FixTypeHint
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR fixes three type hints:
OneWireAddress. I importedOneWireAddressand updated the type hint.temperatureproperty was not type hinted, so I addedfloatmypy, I picked up that theRESOLUTIONtuple could be improved. As it is now, it is just a tuple of ints, not constrained to 9, 10, 11, 12. And thus, theresolutionproperties were not being strictly typed. I added a type hint toRESOLUTIONso that each entry in thetupleis constrained to the values 9, 10, 11, 12, and now it's more strictly typing that property.If you need me to add more explanation, change anything, or pull any of the changes back out, I'm happy to do it. I'm not planning on setting up a full dev environment to run the CI suite locally, so I'll watch to see any results.
Thanks!
Fixes #33