Skip to content

Add type annotations #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
May 2, 2022
Merged

Add type annotations #10

merged 1 commit into from
May 2, 2022

Conversation

tekktrik
Copy link
Member

Resolves #9 by adding type annotations!

@tekktrik tekktrik requested a review from a team April 28, 2022 14:44
tammymakesthings
tammymakesthings reviewed May 1, 2022
View reviewed changes
Copy link

@tammymakesthings tammymakesthings left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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!

adafruit_tpa2016.py
@@ -32,6 +32,12 @@
from adafruit_register.i2c_bits import RWBits
from adafruit_register.i2c_bit import RWBit

try:
import typing # pylint: disable=unused-import
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
FoamyGuy approved these changes May 2, 2022
View reviewed changes
Copy link
Contributor

@FoamyGuy FoamyGuy left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me. Thanks @tekktrik, and @tammymakesthings for looking over it.

@FoamyGuy FoamyGuy merged commit 33b2cc8 into main May 2, 2022
adafruit-adabot added a commit to adafruit/Adafruit_CircuitPython_Bundle that referenced this pull request May 3, 2022
@adafruit-adabot
Automated update by Adabot (adafruit/adabot@131849a)
517780a 
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
Reviewers

@tammymakesthings tammymakesthings tammymakesthings left review comments

@FoamyGuy FoamyGuy FoamyGuy approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Missing Type Annotations
3 participants
@tekktrik @tammymakesthings @FoamyGuy