Add PEP 561 type stubs (.pyi) for oqs package #110
Conversation
This file contains hidden or 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
The following files have been added: - oqs/py.typed: Marker file for PEP 561 compliance. - oqs/__init__.pyi: Stub for the main package entry point. - oqs/oqs.pyi: Stubs for core OQS functionalities (KeyEncapsulation, Signature, related functions, and exceptions). - oqs/rand.pyi: Stubs for random number generation functions. Signed-off-by: M-AlNoaimi <[email protected]>
… attributes & Removed init stub to be more flexible (when making edits directly down the line). Signed-off-by: M-AlNoaimi <[email protected]>
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.
This PR adds in PEP 561 compliant type stub files, enabling static type checking when using of
liboqs-pythondirectly.Note: Initially, the fork started with a
__init__.pyibut that would mean manually re-exporting (at least according to Mypy being set to strict), so leaving it out would give a bit more flexibility, but it can be added back if it's needed. 😄