10000 Missing Type Annotations · Issue #25 · adafruit/Adafruit_CircuitPython_ATECC · GitHub
[go: up one dir, main page]
Skip to content

Missing Type Annotations #25

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.

Sign up for GitHub

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

Jump to bottom
Closed
29 tasks
FoamyGuy opened this issue Sep 27, 2021 · 3 comments · Fixed by #31
Closed
29 tasks

Missing Type Annotations #25

FoamyGuy opened this issue Sep 27, 2021 · 3 comments · Fixed by #31
Assignees
@tekktrik
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers 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_atecc/adafruit_atecc_asn1.py:41
  • adafruit_atecc/adafruit_atecc_asn1.py:94
  • adafruit_atecc/adafruit_atecc_asn1.py:110
  • adafruit_atecc/adafruit_atecc_asn1.py:129
  • adafruit_atecc/adafruit_atecc_asn1.py:136
  • adafruit_atecc/adafruit_atecc_asn1.py:148
  • adafruit_atecc/adafruit_atecc_asn1.py:160
  • adafruit_atecc/adafruit_atecc_asn1.py:185
  • adafruit_atecc/adafruit_atecc_asn1.py:194
  • adafruit_atecc/adafruit_atecc.py:56
  • adafruit_atecc/adafruit_atecc.py:153
  • adafruit_atecc/adafruit_atecc.py:247
  • adafruit_atecc/adafruit_atecc.py:259
  • adafruit_atecc/adafruit_atecc.py:275
  • adafruit_atecc/adafruit_atecc.py:308
  • adafruit_atecc/adafruit_atecc.py:330
  • adafruit_atecc/adafruit_atecc.py:351
  • adafruit_atecc/adafruit_atecc.py:384
  • adafruit_atecc/adafruit_atecc.py:399
  • adafruit_atecc/adafruit_atecc.py:421
  • adafruit_atecc/adafruit_atecc.py:439
  • adafruit_atecc/adafruit_atecc.py:452
  • adafruit_atecc/adafruit_atecc.py:464
  • adafruit_atecc/adafruit_atecc.py:475
  • adafruit_atecc/adafruit_atecc.py:487
  • adafruit_atecc/adafruit_atecc.py:499
  • adafruit_atecc/adafruit_atecc.py:533
  • adafruit_atecc/adafruit_atecc.py:558
  • adafruit_atecc/adafruit_atecc_cert_util.py:58
@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
@tekktrik
Copy link
Member
tekktrik commented May 1, 2022

On a related note, it looks like the doc strings need to be updated! I see a few type errors in the Sphinx params as well as opportunities to use circuitpython_typing types! I was going to address this but not sure I can without importing the module, so doing it at the same time would help.

@tekktrik tekktrik self-assigned this May 2, 2022
@tekktrik
Copy link
Member
tekktrik commented May 2, 2022

Taking this one, I'll do it while I am refactoring this library!

@adafruit-adabot adafruit-adabot added the Hacktoberfest DigitalOcean's Hacktoberfest label Sep 29, 2022
@brass75
Copy link
brass75 commented Apr 24, 2023

Taking this one.

@brass75 brass75 mentioned this issue Apr 24, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@tekktrik tekktrik

Labels
documentation Improvements or additions to documentation good first issue Good for newcomers Hacktoberfest DigitalOcean's Hacktoberfest
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Improve type hints and docstrings brass75/Adafruit_CircuitPython_ATECC
4 participants
@brass75 @FoamyGuy @adafruit-adabot @tekktrik
0