Skip to content

Missing Type Annotations #92

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_minimqtt/matcher.py:37
  • adafruit_minimqtt/matcher.py:45
  • adafruit_minimqtt/matcher.py:57
  • adafruit_minimqtt/matcher.py:74
  • adafruit_minimqtt/matcher.py:80
  • adafruit_minimqtt/adafruit_minimqtt.py:76
  • adafruit_minimqtt/adafruit_minimqtt.py:91
  • adafruit_minimqtt/adafruit_minimqtt.py:99
  • adafruit_minimqtt/adafruit_minimqtt.py:108
  • adafruit_minimqtt/adafruit_minimqtt.py:111
  • adafruit_minimqtt/adafruit_minimqtt.py:133
  • adafruit_minimqtt/adafruit_minimqtt.py:207
  • adafruit_minimqtt/adafruit_minimqtt.py:283
  • adafruit_minimqtt/adafruit_minimqtt.py:286
  • adafruit_minimqtt/adafruit_minimqtt.py:325
  • adafruit_minimqtt/adafruit_minimqtt.py:333
  • adafruit_minimqtt/adafruit_minimqtt.py:363
  • adafruit_minimqtt/adafruit_minimqtt.py:373
  • adafruit_minimqtt/adafruit_minimqtt.py:396
  • adafruit_minimqtt/adafruit_minimqtt.py:399
  • adafruit_minimqtt/adafruit_minimqtt.py:409
  • adafruit_minimqtt/adafruit_minimqtt.py:422
  • adafruit_minimqtt/adafruit_minimqtt.py:556
  • adafruit_minimqtt/adafruit_minimqtt.py:638
  • adafruit_minimqtt/adafruit_minimqtt.py:699
  • adafruit_minimqtt/adafruit_minimqtt.py:747
  • adafruit_minimqtt/adafruit_minimqtt.py:768
  • adafruit_minimqtt/adafruit_minimqtt.py:791
  • adafruit_minimqtt/adafruit_minimqtt.py:859
  • adafruit_minimqtt/adafruit_minimqtt.py:869
  • adafruit_minimqtt/adafruit_minimqtt.py:912
  • adafruit_minimqtt/adafruit_minimqtt.py:924
  • adafruit_minimqtt/adafruit_minimqtt.py:939
  • adafruit_minimqtt/adafruit_minimqtt.py:959

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions