adafruit / adafruit/Adafruit_CircuitPython_miniesptool

Missing Type Annotations

Open
#28 0 comments 0 reactions 0 assignees View on GitHub
documentation Hacktoberfest
Dominant language
Python
Stars
10
Forks
8
PR merge metrics
No merged PRs in 30d

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:

```python
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:

```python
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_miniesptool.py:91
- [ ] adafruit_miniesptool.py:120
- [ ] adafruit_miniesptool.py:131
- [ ] adafruit_miniesptool.py:141
- [ ] adafruit_miniesptool.py:221
- [ ] adafruit_miniesptool.py:238
- [ ] adafruit_miniesptool.py:272
- [ ] adafruit_miniesptool.py:298
- [ ] adafruit_miniesptool.py:320
- [ ] adafruit_miniesptool.py:370
- [ ] adafruit_miniesptool.py:378
- [ ] adafruit_miniesptool.py:387
- [ ] adafruit_miniesptool.py:396
- [ ] adafruit_miniesptool.py:460
- [ ] adafruit_miniesptool.py:467

Contributor guide

No contributing guide indexed for this repository

Research direction

Open adafruit_miniesptool.py at the listed lines and inspect each function signature and its existing imports. Add the missing annotations with the typing import guarded as shown, then run mypy and the repository's pre-commit checks; done means all listed missing-annotation reports are resolved without breaking CircuitPython imports.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
embedded-iot
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
56/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.