Add typestubs - Githubissues

vsergeev / python-periphery

A pure Python 2/3 library for peripheral I/O (GPIO, LED, PWM, SPI, I2C, MMIO, Serial) in Linux.

MIT License

519 stars 139 forks source link

Add typestubs #59

Closed AussieSeaweed closed 1 year ago

AussieSeaweed commented 1 year ago

Resolves #47. Relates to python/typeshed#10023.

Akuli commented 1 year ago

A couple thoughts:

Separate stub files are annoying, but the least bad option if this project still needs to support Python 2.
The stubs are not checked in any way when someone makes a PR. You probably want to at least run mypy in github actions, maybe also flake8 with the flake8-pyi plugin (the stubs contain # noqa comments to ignore some of its warnings).

vsergeev commented 1 year ago

Thanks. I agree it's not as ideal as having the types inlined. I think python-periphery will probably drop Python 2.7 support in 3.0.0 and fully migrate to a Python 3 library.

I'll get this into the 2.4.0 release soon with a couple of amendments to accommodate the new GPIO changes. I'll add mypy type checking to the Travis CI as well.