adafruit / adafruit/Adafruit_CircuitPython_PyPortal
Missing Type Annotations
- Dominant language
- Python
- Stars
- 46
- Forks
- 56
- 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_pyportal/network.py:75
- [ ] adafruit_pyportal/network.py:117
- [ ] adafruit_pyportal/network.py:139
- [ ] adafruit_pyportal/peripherals.py:52
- [ ] adafruit_pyportal/peripherals.py:129
- [ ] adafruit_pyportal/peripherals.py:143
- [ ] adafruit_pyportal/peripherals.py:176
- [ ] adafruit_pyportal/graphics.py:43
- [ ] adafruit_pyportal/graphics.py:50
- [ ] adafruit_pyportal/\_\_init\_\_.py:95
- [ ] adafruit_pyportal/\_\_init\_\_.py:273
- [ ] adafruit_pyportal/\_\_init\_\_.py:297
Contributor guide
No contributing guide indexed for this repository
Research direction
Start with the listed functions in adafruit_pyportal/network.py, peripherals.py, graphics.py, and __init__.py, and review the existing wrap_text_to_pixels example plus the CI guidance. Add the missing argument and return annotations while guarding the typing import for CircuitPython, then run mypy and the documented pre-commit checks until all listed locations pass.
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
- 45/100