-
Notifications
You must be signed in to change notification settings - Fork 179
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Python: Type-stub generation for SSDKs (#2149)
* Initial Python stub generation * Handle default values correctly * Only generate `__init__` for classes that have constructor signatures * Preserve doc comments * Make context class generic * Put type hint into a string to fix runtime error * Run `mypy` on CI * Use `make` to build Python SSDKs while generating diffs * Escape Python types in Rust comments * Only mark class methods with * Sort imports to minimize diffs * Add type annotations for `PySocket` * Dont extend classes from `object` as every class already implicitly extended from `object` * Use `vars` instead of `inspect.getmembers` to skip inherited members of a class * Fix linting issues * Add some tests for stubgen and refactor it * Add type annotations to `PyMiddlewareException` * Fix tests on Python 3.7 Python 3.7 doesn't support reading signatures from `__text_signature__` for non-builtin functions (i.e. C/Rust functions). For testing we're using regular Python syntax for defining signature. * Provide default values for `typing.Optional[T]` types in type-stubs * Update `is_fn_like` to cover more cases * Remove `tools/smithy-rs-tool-common/` * Make `DECORATORS` an array instead of a list * Ignore missing type stub errors for `aiohttp`
- Loading branch information
1 parent
7787cb0
commit c7da1ac
Showing
24 changed files
with
1,412 additions
and
69 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
174 changes: 174 additions & 0 deletions
174
...on/src/main/kotlin/software/amazon/smithy/rust/codegen/server/python/smithy/PythonType.kt
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 |
|---|---|---|
| @@ -0,0 +1,174 @@ | ||
| /* | ||
| * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package software.amazon.smithy.rust.codegen.server.python.smithy | ||
|
|
||
| import software.amazon.smithy.rust.codegen.core.rustlang.RustType | ||
|
|
||
| /** | ||
| * A hierarchy of Python types handled by Smithy codegen. | ||
| * | ||
| * Mostly copied from [RustType] and modified for Python accordingly. | ||
| */ | ||
| sealed class PythonType { | ||
| /** | ||
| * A Python type that contains [member], another [PythonType]. | ||
| * Used to generically operate over shapes that contain other shape. | ||
| */ | ||
| sealed interface Container { | ||
| val member: PythonType | ||
| val namespace: String? | ||
| val name: String | ||
| } | ||
|
|
||
| /** | ||
| * Name refers to the top-level type for import purposes. | ||
| */ | ||
| abstract val name: String | ||
|
|
||
| open val namespace: String? = null | ||
|
|
||
| object None : PythonType() { | ||
| override val name: String = "None" | ||
| } | ||
|
|
||
| object Bool : PythonType() { | ||
| override val name: String = "bool" | ||
| } | ||
|
|
||
| object Int : PythonType() { | ||
| override val name: String = "int" | ||
| } | ||
|
|
||
| object Float : PythonType() { | ||
| override val name: String = "float" | ||
| } | ||
|
|
||
| object Str : PythonType() { | ||
| override val name: String = "str" | ||
| } | ||
|
|
||
| object Any : PythonType() { | ||
| override val name: String = "Any" | ||
| override val namespace: String = "typing" | ||
| } | ||
|
|
||
| data class List(override val member: PythonType) : PythonType(), Container { | ||
| override val name: String = "List" | ||
| override val namespace: String = "typing" | ||
| } | ||
|
|
||
| data class Dict(val key: PythonType, override val member: PythonType) : PythonType(), Container { | ||
| override val name: String = "Dict" | ||
| override val namespace: String = "typing" | ||
| } | ||
|
|
||
| data class Set(override val member: PythonType) : PythonType(), Container { | ||
| override val name: String = "Set" | ||
| override val namespace: String = "typing" | ||
| } | ||
|
|
||
| data class Optional(override val member: PythonType) : PythonType(), Container { | ||
| override val name: String = "Optional" | ||
| override val namespace: String = "typing" | ||
| } | ||
|
|
||
| data class Awaitable(override val member: PythonType) : PythonType(), Container { | ||
| override val name: String = "Awaitable" | ||
| override val namespace: String = "typing" | ||
| } | ||
|
|
||
| data class Callable(val args: kotlin.collections.List<PythonType>, val rtype: PythonType) : PythonType() { | ||
| override val name: String = "Callable" | ||
| override val namespace: String = "typing" | ||
| } | ||
|
|
||
| data class Union(val args: kotlin.collections.List<PythonType>) : PythonType() { | ||
| override val name: String = "Union" | ||
| override val namespace: String = "typing" | ||
| } | ||
|
|
||
| data class Opaque(override val name: String, val rustNamespace: String? = null) : PythonType() { | ||
| // Since Python doesn't have a something like Rust's `crate::` we are using a custom placeholder here | ||
| // and in our stub generation script we will replace placeholder with the real root module name. | ||
| private val pythonRootModulePlaceholder = "__root_module_name__" | ||
|
|
||
| override val namespace: String? = rustNamespace?.split("::")?.joinToString(".") { | ||
| when (it) { | ||
| "crate" -> pythonRootModulePlaceholder | ||
| // In Python, we expose submodules from `aws_smithy_http_server_python` | ||
| // like `types`, `middleware`, `tls` etc. from `__root_module__name` | ||
| "aws_smithy_http_server_python" -> pythonRootModulePlaceholder | ||
| else -> it | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Return corresponding [PythonType] for a [RustType]. | ||
| */ | ||
| fun RustType.pythonType(): PythonType = | ||
| when (this) { | ||
| is RustType.Unit -> PythonType.None | ||
| is RustType.Bool -> PythonType.Bool | ||
| is RustType.Float -> PythonType.Float | ||
| is RustType.Integer -> PythonType.Int | ||
| is RustType.String -> PythonType.Str | ||
| is RustType.Vec -> PythonType.List(this.member.pythonType()) | ||
| is RustType.Slice -> PythonType.List(this.member.pythonType()) | ||
| is RustType.HashMap -> PythonType.Dict(this.key.pythonType(), this.member.pythonType()) | ||
| is RustType.HashSet -> PythonType.Set(this.member.pythonType()) | ||
| is RustType.Reference -> this.member.pythonType() | ||
| is RustType.Option -> PythonType.Optional(this.member.pythonType()) | ||
| is RustType.Box -> this.member.pythonType() | ||
| is RustType.Dyn -> this.member.pythonType() | ||
| is RustType.Opaque -> PythonType.Opaque(this.name, this.namespace) | ||
| // TODO(Constraints): How to handle this? | ||
| // Revisit as part of https://github.com/awslabs/smithy-rs/issues/2114 | ||
| is RustType.MaybeConstrained -> this.member.pythonType() | ||
| } | ||
|
|
||
| /** | ||
| * Render this type, including references and generic parameters. | ||
| * It generates something like `typing.Dict[String, String]`. | ||
| */ | ||
| fun PythonType.render(fullyQualified: Boolean = true): String { | ||
| val namespace = if (fullyQualified) { | ||
| this.namespace?.let { "$it." } ?: "" | ||
| } else "" | ||
| val base = when (this) { | ||
| is PythonType.None -> this.name | ||
| is PythonType.Bool -> this.name | ||
| is PythonType.Float -> this.name | ||
| is PythonType.Int -> this.name | ||
| is PythonType.Str -> this.name | ||
| is PythonType.Any -> this.name | ||
| is PythonType.Opaque -> this.name | ||
| is PythonType.List -> "${this.name}[${this.member.render(fullyQualified)}]" | ||
| is PythonType.Dict -> "${this.name}[${this.key.render(fullyQualified)}, ${this.member.render(fullyQualified)}]" | ||
| is PythonType.Set -> "${this.name}[${this.member.render(fullyQualified)}]" | ||
| is PythonType.Awaitable -> "${this.name}[${this.member.render(fullyQualified)}]" | ||
| is PythonType.Optional -> "${this.name}[${this.member.render(fullyQualified)}]" | ||
| is PythonType.Callable -> { | ||
| val args = this.args.joinToString(", ") { it.render(fullyQualified) } | ||
| val rtype = this.rtype.render(fullyQualified) | ||
| "${this.name}[[$args], $rtype]" | ||
| } | ||
| is PythonType.Union -> { | ||
| val args = this.args.joinToString(", ") { it.render(fullyQualified) } | ||
| "${this.name}[$args]" | ||
| } | ||
| } | ||
| return "$namespace$base" | ||
| } | ||
|
|
||
| /** | ||
| * Renders [PythonType] with proper escaping for Docstrings. | ||
| */ | ||
| fun PythonType.renderAsDocstring(): String = | ||
| this.render() | ||
| .replace("[", "\\[") | ||
| .replace("]", "\\]") |
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
Oops, something went wrong.