Skip to content

Latest commit

 

History

History
25 lines (20 loc) · 1.13 KB

README.md

File metadata and controls

25 lines (20 loc) · 1.13 KB

Stub files for PyAbel

Stub files with type hints for the PyAbel package (master branch). The plan is to integrate them into the PyAbel repository eventually, but for now they are provided here as is.

The Python typing system itself and mypy are still more experimental than mature and don't have enough expressive power to annotate everything properly, but nevertheless might be helpful, and I've tried to do as much as feasible within current limitations (Python 3.11, mypy 1.0.1). Please feel free to report any found issues or suggestions.

Usage

The abel directory structure with *.pyi files can be copied over the PyAbel abel directory structure with its *.py files (the easiest way) or put separately in a place where your type-checking tools can find and recognize it.

(mypi.ini is the mypy configuration file, allow is the stubtest allowlist file used for consistency testing with python3 -m mypy.stubtest ... abel; README.md is this description file.)