Skip to content

Add types hints to the Python module#756

Merged
bcoconni merged 14 commits intoJSBSim-Team:masterfrom
bcoconni:python_types3
Nov 1, 2022
Merged

Add types hints to the Python module#756
bcoconni merged 14 commits intoJSBSim-Team:masterfrom
bcoconni:python_types3

Conversation

@bcoconni
Copy link
Member

As per @Dobid's feature request in issue #750, this PR adds type hints for the JSBSim Python module.

After the merge of this PR types hints will be added to the Python module as per the PEP 561 – Distributing and Packaging Type Information. Basically this means that types stubs (i.e. files *.pyi and py.typed) are generated by the stubgen utility from the mypy project and included in the wheels that are built by our CI workflow.

Fixes #750.

@codecov
Copy link

codecov bot commented Oct 31, 2022

Codecov Report

Merging #756 (8043704) into master (7b3f31a) will not change coverage.
The diff coverage is n/a.

❗ Current head 8043704 differs from pull request most recent head e707e06. Consider uploading reports for the commit e707e06 to get more accurate results

@@           Coverage Diff           @@
##           master     #756   +/-   ##
=======================================
  Coverage   22.48%   22.48%           
=======================================
  Files         167      167           
  Lines       19138    19138           
=======================================
  Hits         4304     4304           
  Misses      14834    14834           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@bcoconni bcoconni changed the title Add types hints for the Python module Add types hints to the Python module Oct 31, 2022
@bcoconni bcoconni merged commit fb7161a into JSBSim-Team:master Nov 1, 2022
@bcoconni bcoconni deleted the python_types3 branch November 1, 2022 16:13
bcoconni added a commit to bcoconni/jsbsim that referenced this pull request Nov 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Python type information for pylance autocompletion

1 participant