Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing Type Annotations #51

Open
54 tasks
FoamyGuy opened this issue Sep 27, 2021 · 0 comments
Open
54 tasks

Missing Type Annotations #51

FoamyGuy opened this issue Sep 27, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation Hacktoberfest DigitalOcean's Hacktoberfest

Comments

@FoamyGuy
Copy link
Contributor

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_portalbase/network.py:87
  • adafruit_portalbase/network.py:117
  • adafruit_portalbase/network.py:126
  • adafruit_portalbase/network.py:149
  • adafruit_portalbase/network.py:161
  • adafruit_portalbase/network.py:170
  • adafruit_portalbase/network.py:223
  • adafruit_portalbase/network.py:251
  • adafruit_portalbase/network.py:319
  • adafruit_portalbase/network.py:375
  • adafruit_portalbase/network.py:409
  • adafruit_portalbase/network.py:426
  • adafruit_portalbase/network.py:442
  • adafruit_portalbase/network.py:458
  • adafruit_portalbase/network.py:484
  • adafruit_portalbase/network.py:494
  • adafruit_portalbase/network.py:503
  • adafruit_portalbase/network.py:534
  • adafruit_portalbase/network.py:541
  • adafruit_portalbase/network.py:563
  • adafruit_portalbase/network.py:611
  • adafruit_portalbase/network.py:630
  • adafruit_portalbase/wifi_esp32s2.py:42
  • adafruit_portalbase/wifi_esp32s2.py:54
  • adafruit_portalbase/wifi_esp32s2.py:69
  • adafruit_portalbase/wifi_esp32s2.py:103
  • adafruit_portalbase/wifi_coprocessor.py:45
  • adafruit_portalbase/wifi_coprocessor.py:78
  • adafruit_portalbase/wifi_coprocessor.py:85
  • adafruit_portalbase/wifi_coprocessor.py:94
  • adafruit_portalbase/graphics.py:44
  • adafruit_portalbase/graphics.py:66
  • adafruit_portalbase/graphics.py:112
  • adafruit_portalbase/__init__.py:59
  • adafruit_portalbase/__init__.py:100
  • adafruit_portalbase/__init__.py:117
  • adafruit_portalbase/__init__.py:130
  • adafruit_portalbase/__init__.py:140
  • adafruit_portalbase/__init__.py:216
  • adafruit_portalbase/__init__.py:272
  • adafruit_portalbase/__init__.py:286
  • adafruit_portalbase/__init__.py:294
  • adafruit_portalbase/__init__.py:302
  • adafruit_portalbase/__init__.py:315
  • adafruit_portalbase/__init__.py:336
  • adafruit_portalbase/__init__.py:356
  • adafruit_portalbase/__init__.py:359
  • adafruit_portalbase/__init__.py:390
  • adafruit_portalbase/__init__.py:409
  • adafruit_portalbase/__init__.py:413
  • adafruit_portalbase/__init__.py:423
  • adafruit_portalbase/__init__.py:432
  • adafruit_portalbase/__init__.py:441
  • adafruit_portalbase/__init__.py:458
@FoamyGuy FoamyGuy added good first issue Good for newcomers documentation Improvements or additions to documentation labels Sep 27, 2021
@adafruit-adabot adafruit-adabot added the Hacktoberfest DigitalOcean's Hacktoberfest label Oct 26, 2021
@FoamyGuy FoamyGuy removed the Hacktoberfest DigitalOcean's Hacktoberfest label Nov 4, 2021
@adafruit-adabot adafruit-adabot added the Hacktoberfest DigitalOcean's Hacktoberfest label Sep 29, 2022
@FoamyGuy FoamyGuy removed the good first issue Good for newcomers label Jul 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation Hacktoberfest DigitalOcean's Hacktoberfest
Projects
None yet
Development

No branches or pull requests

2 participants