Skip to content

Missing Type Annotations #46

@FoamyGuy

Description

@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_is31fl3731/__init__.py:95
  • adafruit_is31fl3731/__init__.py:101
  • adafruit_is31fl3731/__init__.py:114
  • adafruit_is31fl3731/__init__.py:127
  • adafruit_is31fl3731/__init__.py:134
  • adafruit_is31fl3731/__init__.py:142
  • adafruit_is31fl3731/__init__.py:163
  • adafruit_is31fl3731/__init__.py:171
  • adafruit_is31fl3731/__init__.py:193
  • adafruit_is31fl3731/__init__.py:221
  • adafruit_is31fl3731/__init__.py:237
  • adafruit_is31fl3731/__init__.py:241
  • adafruit_is31fl3731/__init__.py:260
  • adafruit_is31fl3731/__init__.py:273
  • adafruit_is31fl3731/__init__.py:303
  • adafruit_is31fl3731/__init__.py:308
  • adafruit_is31fl3731/__init__.py:343
  • adafruit_is31fl3731/scroll_phat_hd.py:40
  • adafruit_is31fl3731/rgbmatrix5x5.py:44
  • adafruit_is31fl3731/rgbmatrix5x5.py:64
  • adafruit_is31fl3731/matrix_11x7.py:39
  • adafruit_is31fl3731/matrix_11x7.py:43
  • adafruit_is31fl3731/matrix.py:40
  • adafruit_is31fl3731/led_shim.py:39
  • adafruit_is31fl3731/led_shim.py:43
  • adafruit_is31fl3731/led_shim.py:63
  • adafruit_is31fl3731/keybow2040.py:42
  • adafruit_is31fl3731/keybow2040.py:65
  • adafruit_is31fl3731/charlie_wing.py:40
  • adafruit_is31fl3731/charlie_bonnet.py:41

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions