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_midi/midi_message.py:33
- adafruit_midi/midi_message.py:44
- adafruit_midi/midi_message.py:100
- adafruit_midi/midi_message.py:112
- adafruit_midi/midi_message.py:135
- adafruit_midi/midi_message.py:158
- adafruit_midi/midi_message.py:201
- adafruit_midi/midi_message.py:283
- adafruit_midi/midi_message.py:301
- adafruit_midi/midi_message.py:319
- adafruit_midi/system_exclusive.py:40
- adafruit_midi/system_exclusive.py:54
- adafruit_midi/program_change.py:35
- adafruit_midi/program_change.py:45
- adafruit_midi/polyphonic_key_pressure.py:37
- adafruit_midi/polyphonic_key_pressure.py:50
- adafruit_midi/pitch_bend.py:36
- adafruit_midi/pitch_bend.py:52
- adafruit_midi/note_on.py:38
- adafruit_midi/note_on.py:51
- adafruit_midi/note_off.py:38
- adafruit_midi/note_off.py:55
- adafruit_midi/mtc_quarter_frame.py:48
- adafruit_midi/mtc_quarter_frame.py:64
- adafruit_midi/control_change.py:37
- adafruit_midi/control_change.py:50
- adafruit_midi/channel_pressure.py:35
- adafruit_midi/channel_pressure.py:45
- adafruit_midi/__init__.py:55
- adafruit_midi/__init__.py:90
- adafruit_midi/__init__.py:107
- adafruit_midi/__init__.py:143
- adafruit_midi/__init__.py:164