Add typing, small refactoring #10
Conversation
I think there's more room for improvement but I didn't want to make any drastic changes
|
After working on some other libraries, I see the purpose of the |
|
To help clear that misunderstanding up, as well as provide an example of it's use, I changed it from |
|
If the change from |
| ("ONE_SHOT", 0, 0, None), | ||
| ("RATE_1_HZ", 1, 1, None), | ||
| ("RATE_7_HZ", 2, 7, None), | ||
| ("RATE_12_5_HZ", 3, 12.5, None), |
There was a problem hiding this comment.
Did these Nones serve any purpose previously?
There was a problem hiding this comment.
My understanding from other libraries that do this is the store the resolution or LSB. As an example, if an option changes the sensitivity of a sensor to the equivalent of 8 bits, this would be 0.0039. So it's just that it doesn't here because it changes rate, not anything where the value of a "unit" of it changes, if that makes sense.
There was a problem hiding this comment.
Did you run it with a device? Seems okay to me. But want to try to make sure it won't cause IndexError anywhere ifi we can. I don't have one of these sensors.
There was a problem hiding this comment.
I don't think I did, I don't think I own this sensor. The other libraries use it in calculations (calculating temperature using the LSB value and digital value, like from ADC) but it never seemed to be used in communication with the sensor. Happy to find a sensor and test with it if you'd like!
There was a problem hiding this comment.
Turns out the HTS221 is out of stock on Adafruit and Digi-Key with no restock date :/ depreciated maybe?
There was a problem hiding this comment.
The simple test gives:
Traceback (most recent call last):
File "code.py", line 10, in <module>
File "adafruit_hts221.py", line 189, in __init__
File "adafruit_hts221.py", line 269, in data_rate
AttributeError: data_rate must be a `Rate`
I put fixes in the review.
Co-authored-by: Neradoc <[email protected]>
Co-authored-by: Neradoc <[email protected]>
Co-authored-by: Neradoc <[email protected]>
|
Changes made, thank you so much! |
|
Seems all good now, no issue in my tests. |
Updating https://github.com./adafruit/Adafruit_CircuitPython_DRV2605 to 1.2.0 from 1.1.13: > Merge pull request adafruit/Adafruit_CircuitPython_DRV2605#29 from tekktrik/doc/typing-and-documentation > Merge pull request adafruit/Adafruit_CircuitPython_DRV2605#28 from tekktrik/feature/add-eight-slot > update rtd py version Updating https://github.com./adafruit/Adafruit_CircuitPython_HTS221 to 1.1.7 from 1.1.6: > Merge pull request adafruit/Adafruit_CircuitPython_HTS221#10 from tekktrik/feature/add-typing > update rtd py version Updating https://github.com./adafruit/Adafruit_CircuitPython_PCA9685 to 3.4.0 from 3.3.9: > Merge pull request adafruit/Adafruit_CircuitPython_PCA9685#42 from tekktrik/doc/add-typing > Merge pull request adafruit/Adafruit_CircuitPython_PCA9685#43 from tekktrik/feature/add-mode2-reg > update rtd py version Updating https://github.com./adafruit/Adafruit_CircuitPython_Wiznet5k to 1.12.0 from 1.11.2: > Merge pull request adafruit/Adafruit_CircuitPython_Wiznet5k#49 from AdamCummick/main Updating https://github.com./adafruit/Adafruit_CircuitPython_AVRprog to 1.4.2 from 1.4.1: > Merge pull request adafruit/Adafruit_CircuitPython_AVRprog#31 from aarontusko/fix-write_fuses-busy_wait Updating https://github.com./adafruit/Adafruit_CircuitPython_OneWire to 1.2.8 from 1.2.7: > Merge pull request adafruit/Adafruit_CircuitPython_OneWire#24 from tekktrik/doc/add-typing > update rtd py version Updating https://github.com./adafruit/Adafruit_CircuitPython_PIOASM to 0.5.4 from 0.5.3: > Merge pull request adafruit/Adafruit_CircuitPython_PIOASM#34 from dannystaple/mov_operators Updating https://github.com./adafruit/Adafruit_CircuitPython_Requests to 1.10.5 from 1.10.4: > Merge pull request adafruit/Adafruit_CircuitPython_Requests#94 from kevincon/fix-93 Updating https://github.com./adafruit/Adafruit_CircuitPython_Waveform to 1.3.9 from 1.3.8: > update rtd py version
Addresses Issue #9 but found some minor improvements that would make typing more clear as well as remove what seemed like unused parts of the code. The only change from the perspective of function input and output is that
add_values()now only needs two arguments, but that function is run by the module on import, not a user.If its a good idea, I can try and do some more refactoring, but I didn't want to change too much for the scope of this pull request.