Add typing #19

tekktrik · 2021-10-26T18:03:08Z

Addresses Issue #18

Changes from black

gamblor21 · 2021-10-27T22:37:04Z

adafruit_74hc595.py

@@ -28,6 +28,7 @@
 import digitalio
 import adafruit_bus_device.spi_device as spi_device

+


You will have to import the values being typed against, e.g. microcontroller.Pin in a try block like can be seen in the issue. For another example see: adafruit/Adafruit_CircuitPython_NeoPixel@eab2911

I believe it will also be required for ReadableBuffer.

Got it, thanks for the feedback! I'll resubmit with those imports.

@gamblor21 - It's giving me a failure for pylint because of the unused typing module. Any advice on how to proceed? Will using those imports eat up too much RAM, or should I just remove the try statement in this case?

I think Foamyguy answered this below with the pylint ignore comment? And I do not see the imports would eat away at RAM. I'm guessing in almost all cases if you import the library that requires those types, you will require the imports as well. Sorry was busy the last couple days so didn't reply right away.

FoamyGuy · 2021-10-28T00:43:35Z

adafruit_74hc595.py

@@ -28,6 +28,14 @@
 import digitalio
 import adafruit_bus_device.spi_device as spi_device

+try:
+    import typing


We can add a pylint ignore comment for this import.

import typing # pylint: disable=unused-import

The importing module doesn't get used from the rest of code, but it does serve the purpose of determining if the environment has typing.

tekktrik · 2021-10-28T13:36:41Z

I believe I'm going to have the same issue with '_typing' as I just mentioned in adafruit/Adafruit_CircuitPython_HT16K33#92 so I'll update both at the same time!

FoamyGuy · 2021-10-28T13:46:02Z

Once we figure out the solution for HT16K33 we can apply the same thing here.

FoamyGuy · 2021-10-30T21:36:07Z

adafruit_74hc595.py

@@ -131,14 +148,14 @@ def gpio(self):
        return self._gpio

    @gpio.setter
-    def gpio(self, val):
+    def gpio(self, val: ReadableBuffer):


We can use bytearray here instead of ReadableBuffer I think.

tekktrik · 2021-10-30T21:59:48Z

Made those changes. Also changed some things around after running pylint, I think it was just how spi_device gets imported.

FoamyGuy · 2021-10-30T22:20:05Z

This one will need formatted with Black code formatter again. There is a guide page that shows how to set up a tool called pre-commit to check all of the CI checks locally if you are interested in trying that out:
https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/check-your-code

tekktrik · 2021-10-30T22:21:47Z

Oh awesome, yeah, thanks

tekktrik · 2021-10-30T22:23:37Z

Is there a way to get the pylint examples to not fail on pre-commit? Is it because I work on windows that I get "Executable /usr/bin/env not found"?

FoamyGuy · 2021-10-30T22:28:16Z

I'm not sure. I don't think I've seen that error specifically. Does that happen when you run pre-commit run -all-files or pre-commit install? or something different.

It does look like it's passing now though 🎉

adafruit_74hc595.py

tekktrik · 2021-10-30T22:32:02Z

I get it on pre-commit run --all-files and also when I try to commit with it installed via pre-commit install

FoamyGuy · 2021-10-30T22:35:52Z

I get it on pre-commit run --all-files and also when I try to commit with it installed via pre-commit install

I don't have much experience with running the tools on Windows. Maybe try asing in the #circuitpython-dev channel on the discord: https://adafru.it/discord someone there may have more insight into that error.

tekktrik · 2021-10-30T22:36:54Z

Got it, thank you for all the help for a newbie!

FoamyGuy

Looks good to me. Thank you @tekktrik !

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 "

tekktrik added 2 commits October 26, 2021 14:00

Add typing

a39d006

Post pre-commit

ec1b921

Changes from black

kattni requested review from FoamyGuy, gamblor21 and KeithTheEE October 27, 2021 20:45

gamblor21 requested changes Oct 27, 2021

View reviewed changes

Made changes requested in review

0e2fbac

tekktrik mentioned this pull request Oct 28, 2021

Add typing and required imports adafruit/Adafruit_CircuitPython_PCF8523#24

Merged

FoamyGuy reviewed Oct 28, 2021

View reviewed changes

FoamyGuy added the hacktoberfest-accepted label Oct 28, 2021

FoamyGuy reviewed Oct 30, 2021

View reviewed changes

tekktrik added 2 commits October 30, 2021 17:58

Fix import per lint recommendations

5584df4

Correct gpio setter's val to be of type "byetarray"

08b0ecf

Reformatted via black (pre-commit)

a226483

FoamyGuy reviewed Oct 30, 2021

View reviewed changes

adafruit_74hc595.py Outdated Show resolved Hide resolved

Correct spi argument to type SPI

c4d7fe2

FoamyGuy approved these changes Oct 30, 2021

View reviewed changes

FoamyGuy merged commit b8b3618 into adafruit:main Oct 30, 2021

tekktrik mentioned this pull request Nov 2, 2021

Missing Type Annotations #18

Closed

9 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add typing #19

Add typing #19

tekktrik commented Oct 26, 2021

gamblor21 Oct 27, 2021

tekktrik Oct 28, 2021

tekktrik Oct 28, 2021

gamblor21 Oct 29, 2021

FoamyGuy Oct 28, 2021

tekktrik commented Oct 28, 2021

FoamyGuy commented Oct 28, 2021

FoamyGuy Oct 30, 2021

tekktrik commented Oct 30, 2021

FoamyGuy commented Oct 30, 2021

tekktrik commented Oct 30, 2021

tekktrik commented Oct 30, 2021

FoamyGuy commented Oct 30, 2021

tekktrik commented Oct 30, 2021

FoamyGuy commented Oct 30, 2021

tekktrik commented Oct 30, 2021

FoamyGuy left a comment

		@@ -28,6 +28,7 @@
		import digitalio
		import adafruit_bus_device.spi_device as spi_device

Add typing #19

Add typing #19

Conversation

tekktrik commented Oct 26, 2021

gamblor21 Oct 27, 2021

Choose a reason for hiding this comment

tekktrik Oct 28, 2021

Choose a reason for hiding this comment

tekktrik Oct 28, 2021

Choose a reason for hiding this comment

gamblor21 Oct 29, 2021

Choose a reason for hiding this comment

FoamyGuy Oct 28, 2021

Choose a reason for hiding this comment

tekktrik commented Oct 28, 2021

FoamyGuy commented Oct 28, 2021

FoamyGuy Oct 30, 2021

Choose a reason for hiding this comment

tekktrik commented Oct 30, 2021

FoamyGuy commented Oct 30, 2021

tekktrik commented Oct 30, 2021

tekktrik commented Oct 30, 2021

FoamyGuy commented Oct 30, 2021

tekktrik commented Oct 30, 2021

FoamyGuy commented Oct 30, 2021

tekktrik commented Oct 30, 2021

FoamyGuy left a comment

Choose a reason for hiding this comment