Add FFI type hinting #436
Merged
Add FFI type hinting #436
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit adds mypy to the pre-commit hooks. This is executed through `hatch` as mypy needs to be able to find and parse dependencies in hatch's virtual environment. Signed-off-by: JP-Ellis <josh@jpellis.me>
JP-Ellis
added
difficulty:easy
The C extension module `_ffi` is now minimally typed with `pyi` files. It provides typing for the `ffi` class which holds a number of utility functions such as `ffi.string`, `ffi.cast`, `ffi.new`, etc. The `lib` class is also annotated within the `pyi` file, but this merely means that the type checking does not complain about calls to `lib.pactffi_*` functions. As part of this commit, the `StringResult` has been refactored to ensure that it works better with the type checker. Signed-off-by: JP-Ellis <josh@jpellis.me>
JP-Ellis
force-pushed
the
feat/ffi-typing
branch
from
4f29504
to
589204a
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
📝 Summary
_ffi.pyifile annotating the functions exposed by_ffi.cpython-*.soStringResult)As part of this PR, the following related work has been added:
🚨 Breaking Changes🔥 Motivation
The Rust FFI is wrapped by the Python CFFI package and a
_ffi.cpython-*.sobinary library is created. The binary library functions at runtime as a Python module, but obviously cannot be edited to add type hinting.Instead, it is possible to add a
_ffi.pyifile which provides type hinting in a separate file to the core implementation irrespective of whether the implementation being a Python text file, or a binary library.🔨 Test Plan
Done as part of the pre-commit hook
🔗 Related issues/PRs