Skip to content

Missing Type Annotations #17

Closed
Closed
@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_boardtest/boardtest_voltage_monitor.py:48
  • adafruit_boardtest/boardtest_uart.py:49
  • adafruit_boardtest/boardtest_spi.py:67
  • adafruit_boardtest/boardtest_spi.py:88
  • adafruit_boardtest/boardtest_spi.py:116
  • adafruit_boardtest/boardtest_spi.py:136
  • adafruit_boardtest/boardtest_sd_cd.py:44
  • adafruit_boardtest/boardtest_sd.py:60
  • adafruit_boardtest/boardtest_led.py:45
  • adafruit_boardtest/boardtest_led.py:80
  • adafruit_boardtest/boardtest_i2c.py:54
  • adafruit_boardtest/boardtest_i2c.py:69
  • adafruit_boardtest/boardtest_i2c.py:89
  • adafruit_boardtest/boardtest_i2c.py:106
  • adafruit_boardtest/boardtest_gpio.py:46
  • adafruit_boardtest/boardtest_gpio.py:55
  • adafruit_boardtest/boardtest_gpio.py:61
  • adafruit_boardtest/boardtest_gpio.py:82

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