Missing Type Annotations

[FoamyGuy]

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_framebuf.py:45
• adafruit_framebuf.py:54
• adafruit_framebuf.py:61
• adafruit_framebuf.py:71
• adafruit_framebuf.py:88
• adafruit_framebuf.py:97
• adafruit_framebuf.py:104
• adafruit_framebuf.py:114
• adafruit_framebuf.py:133
• adafruit_framebuf.py:144
• adafruit_framebuf.py:154
• adafruit_framebuf.py:161
• adafruit_framebuf.py:191
• adafruit_framebuf.py:216
• adafruit_framebuf.py:221
• adafruit_framebuf.py:225
• adafruit_framebuf.py:231
• adafruit_framebuf.py:251
• adafruit_framebuf.py:255
• adafruit_framebuf.py:259
• adafruit_framebuf.py:285
• adafruit_framebuf.py:323
• adafruit_framebuf.py:355
• adafruit_framebuf.py:383
• adafruit_framebuf.py:413
• adafruit_framebuf.py:456
• adafruit_framebuf.py:494
• adafruit_framebuf.py:498
• adafruit_framebuf.py:523