You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
There are missing type annotations for some functions in this library.
The typing module does not exist on CircuitPython devices so the import needs to be wrapped in try/except to catch the error for missing import. There is an example of how that is done here:
Once imported the typing annotations for the argument type(s), and return type(s) can be added to the function signature. Here is an example of a function that has had this done already:
There is also a guide that covers our CI utilities and how to run them locally to ensure they will pass in Github Actions here: https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/check-your-code In particular the pages: Sharing docs on ReadTheDocs and Check your code with pre-commit contain the tools to install and commands to run locally to run the checks.
If you are attempting to resolve this issue and need help, you can post a comment on this issue and tag both @FoamyGuy and @kattni or reach out to us on Discord: https://adafru.it/discord in the #circuitpython-dev channel.
The following locations are reported by mypy to be missing type annotations:
adafruit_epd/mcp_sram.py:24
adafruit_epd/mcp_sram.py:29
adafruit_epd/mcp_sram.py:32
adafruit_epd/mcp_sram.py:46
adafruit_epd/mcp_sram.py:57
adafruit_epd/mcp_sram.py:61
adafruit_epd/mcp_sram.py:71
adafruit_epd/mcp_sram.py:83
adafruit_epd/mcp_sram.py:87
adafruit_epd/mcp_sram.py:92
adafruit_epd/mcp_sram.py:96
adafruit_epd/mcp_sram.py:100
adafruit_epd/epd.py:31
adafruit_epd/epd.py:162
adafruit_epd/epd.py:182
adafruit_epd/epd.py:205
adafruit_epd/epd.py:211
adafruit_epd/epd.py:215
adafruit_epd/epd.py:225
adafruit_epd/epd.py:235
adafruit_epd/epd.py:244
adafruit_epd/epd.py:248
adafruit_epd/epd.py:260
adafruit_epd/epd.py:264
adafruit_epd/epd.py:270
adafruit_epd/epd.py:274
adafruit_epd/epd.py:323
adafruit_epd/epd.py:328
adafruit_epd/epd.py:332
adafruit_epd/epd.py:336
adafruit_epd/uc8151d.py:65
adafruit_epd/uc8151d.py:93
adafruit_epd/uc8151d.py:137
adafruit_epd/uc8151d.py:147
adafruit_epd/ssd1681.py:74
adafruit_epd/ssd1681.py:104
adafruit_epd/ssd1681.py:159
adafruit_epd/ssd1681.py:169
adafruit_epd/ssd1680.py:74
adafruit_epd/ssd1680.py:113
adafruit_epd/ssd1680.py:176
adafruit_epd/ssd1680.py:186
adafruit_epd/ssd1675b.py:79
adafruit_epd/ssd1675b.py:118
adafruit_epd/ssd1675b.py:205
adafruit_epd/ssd1675b.py:215
adafruit_epd/ssd1675.py:53
adafruit_epd/ssd1675.py:92
adafruit_epd/ssd1675.py:163
adafruit_epd/ssd1675.py:173
adafruit_epd/ssd1608.py:59
adafruit_epd/ssd1608.py:83
adafruit_epd/ssd1608.py:141
adafruit_epd/ssd1608.py:149
adafruit_epd/il91874.py:58
adafruit_epd/il91874.py:86
adafruit_epd/il91874.py:152
adafruit_epd/il91874.py:162
adafruit_epd/il0398.py:51
adafruit_epd/il0398.py:79
adafruit_epd/il0398.py:129
adafruit_epd/il0398.py:139
adafruit_epd/il0373.py:50
adafruit_epd/il0373.py:78
adafruit_epd/il0373.py:129
adafruit_epd/il0373.py:139
The text was updated successfully, but these errors were encountered:
There are missing type annotations for some functions in this library.
The
typing
module does not exist on CircuitPython devices so the import needs to be wrapped in try/except to catch the error for missing import. There is an example of how that is done here:Once imported the typing annotations for the argument type(s), and return type(s) can be added to the function signature. Here is an example of a function that has had this done already:
If you are new to Git or Github we have a guide about contributing to our projects here: https://learn.adafruit.com/contribute-to-circuitpython-with-git-and-github
There is also a guide that covers our CI utilities and how to run them locally to ensure they will pass in Github Actions here: https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/check-your-code In particular the pages:
Sharing docs on ReadTheDocs
andCheck your code with pre-commit
contain the tools to install and commands to run locally to run the checks.If you are attempting to resolve this issue and need help, you can post a comment on this issue and tag both @FoamyGuy and @kattni or reach out to us on Discord: https://adafru.it/discord in the
#circuitpython-dev
channel.The following locations are reported by mypy to be missing type annotations:
The text was updated successfully, but these errors were encountered: