Skip to content
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.

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

Add typing #92

Merged
merged 8 commits into from
Oct 30, 2021
Merged

Add typing #92

merged 8 commits into from
Oct 30, 2021

Conversation

tekktrik
Copy link
Member

I believe I typed this correctly. Was a little unsure of using the CircuitPython "_typing" library.

@tekktrik
Copy link
Member Author

Addressed issues from pre-commit check

Copy link
Member

@gamblor21 gamblor21 left a comment

Choose a reason for hiding this comment

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

Good work. I didn't test it on actual hardware and noted a couple things I saw.

adafruit_ht16k33/ht16k33.py Show resolved Hide resolved
adafruit_ht16k33/ht16k33.py Outdated Show resolved Hide resolved
adafruit_ht16k33/matrix.py Outdated Show resolved Hide resolved
@tekktrik
Copy link
Member Author

Thanks @gamblor21 and @FoamyGuy for the helpful feedback! Appreciate the help for a new contributor. Just resubmitted with changes per review comments.

@tekktrik
Copy link
Member Author

It actually just kicked back on building the docs, was it because it failed importing '_typing' so it never imported I2C?

@tekktrik
Copy link
Member Author

Actually, rereading the documentation, is '_typing' actually a real library. or should I create a Union named ReadableBuffer within the import instead?

@FoamyGuy
Copy link
Contributor

Actually, rereading the documentation, is '_typing' actually a real library. or should I create a Union named ReadableBuffer within the import instead?

Im not familiar with _typing not sure if it's a real module or not, but I don't think it's one that we've used for any of these so far.

I'm not certain where the ReadableBuffer import should come from though.

I'll take a look into this one and see if I can figure out the right way to import it to make the sphinx build happier. But it's likely I won't be able to get to it until tomorrow evening.

@tekktrik
Copy link
Member Author

Much appreciated! Let me know when you determine how to do it!

@tekktrik
Copy link
Member Author

Awesome, changes made!

@FoamyGuy
Copy link
Contributor

Try adding pillow to the requirements.txt file. I think that should make sphinx recognize the Image object.

@tekktrik
Copy link
Member Author

Awesome, thanks for all the help

@FoamyGuy
Copy link
Contributor

It wants an extra empty line at the end of requirements.txt as well. (picky CI). Thanks for working through the issues.

@tekktrik
Copy link
Member Author

Haha no worries, thanks for all the help!

Copy link
Contributor

@FoamyGuy FoamyGuy left a comment

Choose a reason for hiding this comment

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

Looks good to me. Thank you @tekktrik

@FoamyGuy FoamyGuy merged commit 97c5c58 into adafruit:main Oct 30, 2021
@tekktrik tekktrik mentioned this pull request Nov 2, 2021
52 tasks
adafruit-adabot added a commit to adafruit/Adafruit_CircuitPython_Bundle that referenced this pull request Nov 3, 2021
Updating https://github.com/adafruit/Adafruit_CircuitPython_74HC595 to 1.3.1 from 1.3.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_74HC595#19 from tekktrik/feature/add-typing
  > fix branch name on conduct link
  > add docs link to readme
  > Globally disabled consider-using-f-string pylint check
  > Moved default branch to main
  > Moved CI to Python 3.7
  > Added help text and problem matcher
  > Added pull request template

Updating https://github.com/adafruit/Adafruit_CircuitPython_AM2320 to 1.2.8 from 1.2.7:
  > Merge pull request adafruit/Adafruit_CircuitPython_AM2320#22 from tylercrumpton/add-type-hints
  > add docs link to readme
  > Globally disabled consider-using-f-string pylint check
  > Moved default branch to main
  > Moved CI to Python 3.7
  > Added help text and problem matcher
  > Added pull request template

Updating https://github.com/adafruit/Adafruit_CircuitPython_DHT to 3.6.3 from 3.6.2:
  > Merge pull request adafruit/Adafruit_CircuitPython_DHT#76 from tylercrumpton/add-type-hints
  > add docs link to readme

Updating https://github.com/adafruit/Adafruit_CircuitPython_HT16K33 to 4.1.6 from 4.1.5:
  > Merge pull request adafruit/Adafruit_CircuitPython_HT16K33#92 from tekktrik/feature/add-typing
  > add docs link to readme
  > Globally disabled consider-using-f-string pylint check
  > Moved default branch to main
  > Moved CI to Python 3.7
  > Added help text and problem matcher
  > Added pull request template
  > "Increase duplicate code check threshold "

Updating https://github.com/adafruit/Adafruit_CircuitPython_PM25 to 2.1.5 from 2.1.4:
  > Merge pull request adafruit/Adafruit_CircuitPython_PM25#20 from process1183/type_annotations
  > add docs link to readme
  > Globally disabled consider-using-f-string pylint check
  > Moved default branch to main
  > Moved CI to Python 3.7
  > Added help text and problem matcher
  > Added pull request template

Updating https://github.com/adafruit/Adafruit_CircuitPython_SSD1305 to 1.3.7 from 1.3.6:
  > Merge pull request adafruit/Adafruit_CircuitPython_SSD1305#14 from tylercrumpton/add-type-hints
  > add docs link to readme
  > Globally disabled consider-using-f-string pylint check
  > Moved default branch to main
  > Moved CI to Python 3.7
  > Added help text and problem matcher
  > Added pull request template
  > "Increase duplicate code check threshold "

Updating https://github.com/adafruit/Adafruit_CircuitPython_ST7735R to 1.5.1 from 1.5.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_ST7735R#27 from FoamyGuy/type_info
  > add docs link to readme
  > Globally disabled consider-using-f-string pylint check

Updating https://github.com/adafruit/Adafruit_CircuitPython_WS2801 to 0.10.7 from 0.10.6:
  > Merge pull request adafruit/Adafruit_CircuitPython_WS2801#23 from rhooper/main
  > fix branch name in conduct link
  > add docs link to readme
  > Globally disabled consider-using-f-string pylint check
  > Moved default branch to main
  > Moved CI to Python 3.7
  > Added help text and problem matcher
  > Added pull request template
  > "Increase duplicate code check threshold "

Updating https://github.com/adafruit/Adafruit_CircuitPython_Display_Notification to 0.9.5 from 0.9.4:
  > Merge pull request adafruit/Adafruit_CircuitPython_Display_Notification#9 from tekktrik/fix/add-blinka-requirement
  > add docs link to readme
  > Globally disabled consider-using-f-string pylint check
  > Moved default branch to main
  > Moved CI to Python 3.7
  > Added help text and problem matcher
  > Added pull request template
  > "Increase duplicate code check threshold "

Updating https://github.com/adafruit/Adafruit_CircuitPython_LED_Animation to 2.5.7 from 2.5.6:
  > Merge pull request adafruit/Adafruit_CircuitPython_LED_Animation#84 from rhooper/sparkle-mask
  > Merge pull request adafruit/Adafruit_CircuitPython_LED_Animation#78 from plugowski/master
  > add docs link to readme

Updating https://github.com/adafruit/Adafruit_CircuitPython_Logging to 3.7.0 from 1.2.9:
  > Merge pull request adafruit/Adafruit_CircuitPython_Logging#22 from tekktrik/feature/add-file-handler

Updating https://github.com/adafruit/Adafruit_CircuitPython_Waveform to 1.3.7 from 1.3.6:
  > Merge pull request adafruit/Adafruit_CircuitPython_Waveform#22 from rhooper/main
  > add docs link to readme
  > Globally disabled consider-using-f-string pylint check
  > Moved default branch to main
  > Moved CI to Python 3.7
  > Added help text and problem matcher
  > Added pull request template
  > "Increase duplicate code check threshold "

Updating https://github.com/adafruit/Adafruit_CircuitPython_WSGI to 1.1.5 from 1.1.4:
  > Merge pull request adafruit/Adafruit_CircuitPython_WSGI#10 from rhooper/main
  > fix branch name in conduct link
  > add docs link to readme
  > Globally disabled consider-using-f-string pylint check
  > Moved default branch to main
  > Moved CI to Python 3.7
  > Added help text and problem matcher
  > Added pull request template
  > "Increase duplicate code check threshold "
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants