Add type annotations #10
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
tammymakesthings
left a comment
tammymakesthings
left a comment
There was a problem hiding this comment.
I've reviewed this PR and checked that all the type annotations seem to match up with the expected types. Other than the question about whether we actually need to import the typing module at all, this PR looks good to me!
| from adafruit_register.i2c_bit import RWBit | ||
|
|
||
| try: | ||
| import typing # pylint: disable=unused-import |
There was a problem hiding this comment.
Does the typing module actually need to be imported? Other than the busio.I2C type hint, all the other type hints refer to built-in Python types, so do we actually need anything from the typing module?
Contributor
There was a problem hiding this comment.
it's not used by the code specifically. But it serves the purpose of raising the exception to prevent the imports that come after it from happening on the microcontrollers.
FoamyGuy
approved these changes
May 2, 2022
Contributor
There was a problem hiding this comment.
Looks good to me. Thanks @tekktrik, and @tammymakesthings for looking over it.
adafruit-adabot
added a commit
to adafruit/Adafruit_CircuitPython_Bundle
that referenced
this pull request
May 3, 2022
Updating https://github.com/adafruit/Adafruit_CircuitPython_AHTx0 to 1.0.11 from 1.0.10: > Merge pull request adafruit/Adafruit_CircuitPython_AHTx0#13 from sabadam32/fix_typeing_9 > change discord badge > Patch: Replaced discord badge image > Update .gitignore > Update Black to latest. Updating https://github.com/adafruit/Adafruit_CircuitPython_LSM6DS to 4.5.0 from 4.4.3: > Merge pull request adafruit/Adafruit_CircuitPython_LSM6DS#56 from Edrig/main > change discord badge > Patch: Replaced discord badge image > Updated gitignore Updating https://github.com/adafruit/Adafruit_CircuitPython_MONSTERM4SK to 0.3.3 from 0.3.2: > Merge pull request adafruit/Adafruit_CircuitPython_MONSTERM4SK#12 from Neradoc/patch-1 > change discord badge > Patch: Replaced discord badge image > Updated gitignore > Update Black to latest. > Fixed readthedocs build > Consolidate Documentation sections of README Updating https://github.com/adafruit/Adafruit_CircuitPython_RGB_Display to 3.10.14 from 3.10.13: > Merge pull request adafruit/Adafruit_CircuitPython_RGB_Display#107 from FoamyGuy/debounce_buttons_gif_example > change discord badge Updating https://github.com/adafruit/Adafruit_CircuitPython_SI5351 to 1.3.0 from 1.2.11: > Merge pull request adafruit/Adafruit_CircuitPython_SI5351#27 from mfhepp/inverted_outputs > change discord badge > Patch: Replaced discord badge image > Updated gitignore > Update Black to latest. > Fixed readthedocs build > Consolidate Documentation sections of README Updating https://github.com/adafruit/Adafruit_CircuitPython_ST7789 to 1.5.8 from 1.5.7: > Merge pull request adafruit/Adafruit_CircuitPython_ST7789#32 from rmblau/main > change discord badge > Patch: Replaced discord badge image > Updated gitignore > Update Black to latest. Updating https://github.com/adafruit/Adafruit_CircuitPython_TPA2016 to 1.1.8 from 1.1.7: > Merge pull request adafruit/Adafruit_CircuitPython_TPA2016#10 from adafruit/doc/add-typing > change discord badge > Patch: Replaced discord badge image > Updated gitignore > Update Black to latest. > Fixed readthedocs build > Consolidate Documentation sections of README Updating https://github.com/adafruit/Adafruit_CircuitPython_AdafruitIO to 5.6.6 from 5.6.5: > Merge pull request adafruit/Adafruit_CircuitPython_AdafruitIO#90 from Vsaggiomo/main > change discord badge > Patch: Replaced discord badge image > Updated gitignore Updating https://github.com/adafruit/Adafruit_CircuitPython_binascii to 1.2.10 from 1.2.9: > Merge pull request adafruit/Adafruit_CircuitPython_binascii#15 from tekktrik/dod/typing-correction-just-blinka > change discord badge > Patch: Replaced discord badge image > Update .gitignore > Update Black to latest. Updating https://github.com/adafruit/Adafruit_CircuitPython_BLE_Radio to 0.5.2 from 0.5.1: > Merge pull request adafruit/Adafruit_CircuitPython_BLE_Radio#23 from ktkinsey37/typing > change discord badge > Patch: Replaced discord badge image > Update .gitignore > Update Black to latest. Updating https://github.com/adafruit/Adafruit_CircuitPython_BLE_BerryMed_Pulse_Oximeter to 2.0.9 from 2.0.8: > Merge pull request adafruit/Adafruit_CircuitPython_BLE_BerryMed_Pulse_Oximeter#10 from awordforthat/add-type-annotations > change discord badge > Patch: Replaced discord badge image > Update .gitignore > Update Black to latest. > Fixed readthedocs build > Consolidate Documentation sections of README Updating https://github.com/adafruit/Adafruit_CircuitPython_BLE_Magic_Light to 0.9.11 from 0.9.10: > Merge pull request adafruit/Adafruit_CircuitPython_BLE_Magic_Light#10 from ktkinsey37/typing > change discord badge > Patch: Replaced discord badge image > Update .gitignore > Update Black to latest. > Fixed readthedocs build > Consolidate Documentation sections of README Updating https://github.com/adafruit/Adafruit_CircuitPython_PIOASM to 0.7.1 from 0.7.0: > Merge pull request adafruit/Adafruit_CircuitPython_PIOASM#41 from jepler/pulsegroup > Merge pull request adafruit/Adafruit_CircuitPython_PIOASM#42 from jepler/diverse-integers > change discord badge > Patch: Replaced discord badge image > Update .gitignore Updating https://github.com/adafruit/Adafruit_CircuitPython_PyBadger to 3.7.0 from 3.6.4: > Merge pull request adafruit/Adafruit_CircuitPython_PyBadger#58 from adafruit/updates > change discord badge > Patch: Replaced discord badge image > Update .gitignore
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.
Resolves #9 by adding type annotations!