Description
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:
try:
from typing import List, Tuple
except ImportError:
pass
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:
def wrap_text_to_pixels(
string: str, max_width: int, font=None, indent0: str = "", indent1: str = ""
) -> List[str]:
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
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_fona/adafruit_fona_network.py:23
- adafruit_fona/adafruit_fona_network.py:42
- adafruit_fona/adafruit_fona_socket.py:22
- adafruit_fona/adafruit_fona_socket.py:28
- adafruit_fona/adafruit_fona_socket.py:38
- adafruit_fona/adafruit_fona_socket.py:53
- adafruit_fona/adafruit_fona_socket.py:62
- adafruit_fona/adafruit_fona_socket.py:80
- adafruit_fona/adafruit_fona_socket.py:110
- adafruit_fona/adafruit_fona_socket.py:120
- adafruit_fona/adafruit_fona_socket.py:138
- adafruit_fona/adafruit_fona_socket.py:147
- adafruit_fona/adafruit_fona_socket.py:212
- adafruit_fona/adafruit_fona.py:68
- adafruit_fona/adafruit_fona.py:209
- adafruit_fona/adafruit_fona.py:357
- adafruit_fona/adafruit_fona.py:393
- adafruit_fona/adafruit_fona.py:397
- adafruit_fona/adafruit_fona.py:412
- adafruit_fona/adafruit_fona.py:445
- adafruit_fona/adafruit_fona.py:482
- adafruit_fona/adafruit_fona.py:508
- adafruit_fona/adafruit_fona.py:541
- adafruit_fona/adafruit_fona.py:577
- adafruit_fona/adafruit_fona.py:621
- adafruit_fona/adafruit_fona.py:636
- adafruit_fona/adafruit_fona.py:666
- adafruit_fona/adafruit_fona.py:689
- adafruit_fona/adafruit_fona.py:730
- adafruit_fona/adafruit_fona.py:753
- adafruit_fona/adafruit_fona.py:777
- adafruit_fona/adafruit_fona.py:809
- adafruit_fona/adafruit_fona.py:819
- adafruit_fona/adafruit_fona.py:833
- adafruit_fona/adafruit_fona.py:850
- adafruit_fona/adafruit_fona.py:874
- adafruit_fona/adafruit_fona.py:910
- adafruit_fona/adafruit_fona.py:936
- adafruit_fona/adafruit_fona.py:954
- adafruit_fona/adafruit_fona.py:968
- adafruit_fona/fona_3g.py:42
- adafruit_fona/fona_3g.py:46
- adafruit_fona/fona_3g.py:62
- adafruit_fona/fona_3g.py:95
- adafruit_fona/fona_3g.py:153
- adafruit_fona/fona_3g.py:161
- adafruit_fona/fona_3g.py:201
- adafruit_fona/fona_3g.py:239
- adafruit_fona/fona_3g.py:257
- adafruit_fona/fona_3g.py:298