-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #24 from Muream/improve-stubs-part-two
Improve stubs part two
- Loading branch information
Showing
4 changed files
with
210 additions
and
49 deletions.
There are no files selected for viewing
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 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 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,32 +1,115 @@ | ||
| import inspect | ||
| from itertools import count | ||
| import sys | ||
| import time | ||
|
|
||
| import cmdc | ||
| import pybind11_stubgen | ||
|
|
||
| STUBS_LOCATION = "build/cmdc.pyi" | ||
|
|
||
| print("Generating stubs") | ||
| t0 = time.time() | ||
|
|
||
| module = pybind11_stubgen.ModuleStubsGenerator("cmdc") | ||
| module.write_setup_py = False | ||
| class InvalidSignatureError(Exception): | ||
| """Raised when one or more signatures are invalid.""" | ||
|
|
||
|
|
||
| class UnnamedArgumentError(Exception): | ||
| """Raised when one or more signatures contain unnamed arguments.""" | ||
|
|
||
|
|
||
| def cleanup_imports(content): | ||
| """Remove any classes accidentally imported as modules. | ||
| This is a fix for this bug: | ||
| https://github.com/sizmailov/pybind11-stubgen/issues/36 | ||
| Some classes with nested classes get imported when they shouldn't, breaking | ||
| leaving them breaks autocomplete | ||
| """ | ||
|
|
||
| classes = [] | ||
| for name, obj in inspect.getmembers(cmdc, inspect.isclass): | ||
| classes.append(name) | ||
|
|
||
| # also include any class that might be defined inside of another class. | ||
| # these are actually the ones that are causing issues. | ||
| for sub_name, _ in inspect.getmembers(obj, inspect.isclass): | ||
| classes.append(sub_name) | ||
|
|
||
| for class_name in classes: | ||
| content = content.replace("import {}\n".format(class_name), "") | ||
|
|
||
| return content | ||
|
|
||
|
|
||
| def count_unnamed_args(lines): | ||
| """Count all the signatures that have unnamed arguments. | ||
| This ignores property setters as these will always have unnamed arguments. | ||
| """ | ||
|
|
||
| print("(1) Parsing module..") | ||
| unnamed_signatures = [] | ||
| for line in lines: | ||
| if "arg0" in line and "setter" not in previous_line: | ||
| unnamed_signatures.append(line) | ||
| previous_line = line | ||
|
|
||
| module.parse() | ||
| if unnamed_signatures: | ||
| print("These signatures contain unnamed arguments:") | ||
| for signature in unnamed_signatures: | ||
| print(f" {signature.strip(' ')}") | ||
|
|
||
| t1 = time.time() | ||
| print("(1) Finished in {0:0.3} s".format(t1-t0)) | ||
| print("(1) ----------------------------") | ||
| return len(unnamed_signatures) | ||
|
|
||
| print("(2) Writing stubs..") | ||
|
|
||
| with open(STUBS_LOCATION, "w") as handle: | ||
| def main(): | ||
| print("Generating stubs") | ||
| t0 = time.time() | ||
|
|
||
| module = pybind11_stubgen.ModuleStubsGenerator(cmdc) | ||
| module.write_setup_py = False | ||
|
|
||
| print("(1) Parsing module..") | ||
|
|
||
| module.parse() | ||
|
|
||
| invalid_signatures_count = pybind11_stubgen.FunctionSignature.n_invalid_signatures | ||
| if invalid_signatures_count > 0: | ||
| raise InvalidSignatureError( | ||
| f"Module contains {invalid_signatures_count} invalid signature(s)" | ||
| ) | ||
|
|
||
| t1 = time.time() | ||
| print("(1) Finished in {0:0.3} s".format(t1 - t0)) | ||
| print("(1) ----------------------------") | ||
|
|
||
| print("(2) Generating stubs content..") | ||
|
|
||
| lines = module.to_lines() | ||
| unnamed_args_count = count_unnamed_args(lines) | ||
|
|
||
| if unnamed_args_count > 0: | ||
| raise UnnamedArgumentError( | ||
| f"Module contains {unnamed_args_count} signatures with unnamed arguments." | ||
| ) | ||
|
|
||
| content = "\n".join(module.to_lines()) | ||
| content = cleanup_imports(content) | ||
|
|
||
| t2 = time.time() | ||
| print(f"(2) Finished in {t2 - t1:0.3} s") | ||
| print("f(2) ----------------------------") | ||
|
|
||
| print("(3) Writing stubs file..") | ||
|
|
||
| with open(STUBS_LOCATION, "w") as handle: | ||
| handle.write(content) | ||
|
|
||
| handle.write(content) | ||
| t3 = time.time() | ||
| print(f"(3) Finished in {t3 - t2:0.3} s") | ||
| print("(3) ----------------------------") | ||
|
|
||
| t2 = time.time() | ||
| print("(2) Finished in {0:0.3} s".format(t2-t1)) | ||
| print("(2) ----------------------------") | ||
| print(f"Succesfully created .{STUBS_LOCATION} in {t3 - t0:0.3} s") | ||
|
|
||
| print("Succesfully created .{0} in {1:0.3} s".format(STUBS_LOCATION, t2-t0)) | ||
|
|
||
| if __name__ == "__main__": | ||
| main() |
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