[Python] Improve Python stubs generation #2606
Merged
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
Signed-off-by: Bigo <1781140+crisidev@users.noreply.github.com>
crisidev
added
enhancement
|
A new generated diff is ready to view.
A new doc preview is ready to view. |
34 tasks
|
A new generated diff is ready to view.
A new doc preview is ready to view. |
unexge
approved these changes
Apr 20, 2023
...ython/src/main/kotlin/software/amazon/smithy/rust/codegen/server/python/smithy/PythonType.kt
Outdated
Show resolved
Hide resolved
Co-authored-by: Burak <unexge@gmail.com>
|
A new generated diff is ready to view.
A new doc preview is ready to view. |
unexge
added a commit
that referenced
this pull request
Apr 24, 2023
## Motivation and Context This PR improves the Python stubs generation. ## Description The main change is about avoiding to setup a placeholder for the Python module and use the real module name, which allows to generate correct docstrings during codegeneration. We also change the stubs layout on disk, with the main stub entrypoint called `__init__.pyi` instead of `$module_name.pyi`. The README from the Rust runtime crate has been moved completely to the example folder and I run autoformatting and style checks on the Python example code. ---- _By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice._ --------- Signed-off-by: Bigo <1781140+crisidev@users.noreply.github.com> Co-authored-by: Burak <unexge@gmail.com>
rcoh
pushed a commit
that referenced
this pull request
Apr 24, 2023
## Motivation and Context This PR improves the Python stubs generation. ## Description The main change is about avoiding to setup a placeholder for the Python module and use the real module name, which allows to generate correct docstrings during codegeneration. We also change the stubs layout on disk, with the main stub entrypoint called `__init__.pyi` instead of `$module_name.pyi`. The README from the Rust runtime crate has been moved completely to the example folder and I run autoformatting and style checks on the Python example code. ---- _By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice._ --------- Signed-off-by: Bigo <1781140+crisidev@users.noreply.github.com> Co-authored-by: Burak <unexge@gmail.com>
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.
Motivation and Context
This PR improves the Python stubs generation.
Description
The main change is about avoiding to setup a placeholder for the Python module and use the real module name, which allows to generate correct docstrings during codegeneration.
We also change the stubs layout on disk, with the main stub entrypoint called
__init__.pyiinstead of$module_name.pyi.The README from the Rust runtime crate has been moved completely to the example folder and I run autoformatting and style checks on the Python example code.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.