Type functions decorated by @pulumi.getter
#15865
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
Changelog[uncommitted] (2024-04-05)Bug Fixes
|
Frassle
approved these changes
Apr 5, 2024
This commit strengthens the type of the `@pulumi.getter` decorator so
that tools like Pyright infer the type of the decorated function
correctly. Prior to this, decorated properties could be inferred as
having the type `Any`. This is particularly troublesome when using
methods such as `apply`:
```python
x = random.RandomString("x", ...)
y = x.result.apply(lambda value: f"y-{value}")
```
Here, `x.result` having the type `Any` means that `value` will end up
being `Unknown`, providing no useful type information inside the lambda.
With this commit, `result` will correctly be inferred as having the type
`Output[str]`, and thus `value` will be typed as `str`.
github-merge-queue bot
pushed a commit
that referenced
this pull request
Apr 11, 2024
Tentative changelog: ### Features - [cli] Support always fully qualifying stack names in CLI output [#15857](#15857) - [cli] Add --no-plugins and --no-dependencies to `pulumi install` [#15910](#15910) - [docs] Implement Java constructor syntax examples [#15805](#15805) - [sdk/nodejs] Make TypeScript and ts-node optional peer dependencies to allow using user specified versions [#15622](#15622) - [sdk/{nodejs,python}] Allow apply to have unknown values during updates [#15898](#15898) - [sdk/python] Adds 'typeChecker' runtime option to the Python language host [#15725](#15725) ### Bug Fixes - [auto] Tolerate missing stack and bookkeeping files in ProgramTest. [#15863](#15863) - [cli] Fix a panic when user's home directory could not be looked up [#15872](#15872) - [cli] Fix some commands that didn't respect `--disable-integrity-checking` - [programgen/dotnet] Removes trailing whitespace from emitted DependsOn resource option expressions [#15892](#15892) - [auto/go] Avoid flakyness when reading the event log from pulumi commands [#15856](#15856) - [sdk/go] Fix Provider and Providers options in Go transform functions [#15885](#15885) - [sdk/nodejs] Handle serialization of aliases for well known native functions [#15873](#15873) - [sdk/nodejs] Correctly serialise functions whose code would make use of reserved identifiers [#15879](#15879) - [sdk/nodejs] Serialize function values obtained from Function.bind [#15887](#15887) - [sdk/python] Improve types of getters in Python SDK [#15865](#15865) - [sdkgen/{dotnet,go}] Fixes SDK-generation when referencing shared types in config variables [#15772](#15772) ### Miscellaneous - [sdk/nodejs] Update builtin module list for function serialization [#15830](#15830) - [sdk/nodejs] Set package.json engines to node >= 18 [#15845](#15845)
Merged
github-merge-queue bot
pushed a commit
that referenced
this pull request
Apr 12, 2024
### Features - [cli] Support always fully qualifying stack names in CLI output [#15857](#15857) - [cli] Add --no-plugins and --no-dependencies to `pulumi install` [#15910](#15910) - [docs] Implement Java constructor syntax examples [#15805](#15805) - [sdk/nodejs] Make TypeScript and ts-node optional peer dependencies to allow using user specified versions [#15622](#15622) - [sdk/{nodejs,python}] Allow apply to have unknown values during updates [#15898](#15898) - [sdk/python] Adds 'typeChecker' runtime option to the Python language host [#15725](#15725) ### Bug Fixes - [auto] Tolerate missing stack and bookkeeping files in ProgramTest. [#15863](#15863) - [cli] Fix a panic when user's home directory could not be looked up [#15872](#15872) - [cli] Fix some commands that didn't respect `--disable-integrity-checking` [#15911](#15911) - [programgen/dotnet] Removes trailing whitespace from emitted DependsOn resource option expressions [#15892](#15892) - [auto/go] Avoid flakyness when reading the event log from pulumi commands [#15856](#15856) - [sdk/go] Fix Provider and Providers options in Go transform functions [#15885](#15885) - [sdk/nodejs] Handle serialization of aliases for well known native functions [#15873](#15873) - [sdk/nodejs] Correctly serialise functions whose code would make use of reserved identifiers [#15879](#15879) - [sdk/nodejs] Serialize function values obtained from Function.bind [#15887](#15887) - [sdk/python] Improve types of getters in Python SDK [#15865](#15865) - [sdkgen/{dotnet,go}] Fixes SDK-generation when referencing shared types in config variables [#15772](#15772) ### Miscellaneous - [sdk/nodejs] Update builtin module list for function serialization [#15830](#15830) - [sdk/nodejs] Set package.json engines to node >= 18 [#15845](#15845)
Merged
github-merge-queue bot
pushed a commit
that referenced
this pull request
Apr 15, 2024
### Features
- [auto/{go,nodejs,python}] Add support for continue-on-error parameter
of the destroy command to the Automation API
[#15921](#15921)
- [cli] Support always fully qualifying stack names in CLI output
[#15857](#15857)
- [cli] Add --no-plugins and --no-dependencies to `pulumi install`
[#15910](#15910)
- [docs] Implement Java constructor syntax examples
[#15805](#15805)
- [sdk/nodejs] Make TypeScript and ts-node optional peer dependencies to
allow using user specified versions
[#15622](#15622)
- [sdk/{nodejs,python}] Allow apply to have unknown values during
updates
[#15898](#15898)
- [sdk/python] Add 'typeChecker' runtime option to the Python language
host
[#15922](#15922)
[#15725](#15725)
### Bug Fixes
- [auto] Tolerate missing stack and bookkeeping files in ProgramTest
[#15922](#15922)
[#15863](#15863)
- [cli] Fix a panic when user's home directory could not be looked up
[#15872](#15872)
- [cli] Fix some commands that didn't respect
`--disable-integrity-checking`
[#15911](#15911)
- [programgen/dotnet] Remove trailing whitespace from emitted DependsOn
resource option expressions
[#15922](#15922)
[#15892](#15892)
- [auto/go] Avoid flakyness when reading the event log from pulumi
commands
[#15856](#15856)
- [sdk/go] Fix Provider and Providers options in Go transform functions
[#15885](#15885)
- [sdk/nodejs] Handle serialization of aliases for well known native
functions
[#15873](#15873)
- [sdk/nodejs] Correctly serialise functions whose code would make use
of reserved identifiers
[#15879](#15879)
- [sdk/nodejs] Serialize function values obtained from Function.bind
[#15887](#15887)
- [sdk/python] Improve types of getters in Python SDK
[#15865](#15865)
- [sdkgen/{dotnet,go}] Fix SDK-generation when referencing shared types
in config variables
[#15772](#15772)
[#15922](#15922)
### Miscellaneous
- [sdk/nodejs] Update builtin module list for function serialization
[#15830](#15830)
- [sdk/nodejs] Set package.json engines to node >= 18
[#15845](#15845)
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 commit strengthens the type of the
@pulumi.getterdecorator so that tools like Pyright infer the type of the decorated function correctly. Prior to this, decorated properties could be inferred as having the typeAny. This is particularly troublesome when using methods such asapply:Here,
x.resulthaving the typeAnymeans thatvaluewill end up beingUnknown, providing no useful type information inside the lambda. With this commit,resultwill correctly be inferred as having the typeOutput[str], and thusvaluewill be typed asstr. Fixes #12557.