Add Python type stub (.pyi) generation for tesseract_decoder#189
Open
dandragona-dev wants to merge 1 commit intoquantumlib:mainfrom
Open
Add Python type stub (.pyi) generation for tesseract_decoder#189dandragona-dev wants to merge 1 commit intoquantumlib:mainfrom
dandragona-dev wants to merge 1 commit intoquantumlib:mainfrom
Conversation
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
3bcfbbc to
697068e
Compare
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
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.
Addresses #154.
Creates python stub file generation script using pybind11-stubgen. This script stores the files under src/tesseract_decoder-stubs. Each .pyi file is auto-generated without any modifications.
Integrates this into CMake and GitHub Workflows. Note that I was not able to successfully cmake this project (even at head without any changes), so consider my changes to CmakeLists.txt as untested (should I just drop them?).
Adds tests to ensure stubfiles exist and are valid python (maybe we can drop the valid python check + symbol expectation, WDYT?). Note that I think there is an issue with the visualizer stubs since
Smaller changes:
a. Adds pybind11-stubgen to the requirements file.
b. Creates src/tesseract_decoder-stubs/ directory to house the .pyi files.
c. Adds comments to the pybind files telling devs to regenerate the stubfiles upon making pybind changes.
Verification:

Unit tests, and just seeing if autocomplete works now:
Autocomplete without stubfiles:
Autocomplete with stubfiles:
