[codegen/python] Support `<Resource>Args` classes #6525

justinvp · 2021-03-13T00:51:11Z

Add support for creating instances of resources in Python using a <Resource>Args class. This capability aligns with how args are passed to resources in all the other language SDKs and the separate object bag allows the properties to be manipulated/validated/passed-around before creating the resource.

Part of #5146

github-actions · 2021-03-13T00:55:18Z

Diff for pulumi-random with merge commit 1c9cc8d

github-actions · 2021-03-13T00:55:47Z

Diff for pulumi-azuread with merge commit 1c9cc8d

github-actions · 2021-03-13T00:57:40Z

Diff for pulumi-kubernetes with merge commit 1c9cc8d

github-actions · 2021-03-13T01:02:43Z

Diff for pulumi-gcp with merge commit 1c9cc8d

github-actions · 2021-03-13T01:11:56Z

Diff for pulumi-azure with merge commit 1c9cc8d

github-actions · 2021-03-13T01:16:45Z

Diff for pulumi-aws with merge commit 1c9cc8d

github-actions · 2021-03-13T01:29:50Z

Diff for pulumi-azure-native with merge commit 1c9cc8d

github-actions · 2021-03-15T18:43:03Z

Diff for pulumi-random with merge commit 6896908

github-actions · 2021-03-15T18:43:11Z

Diff for pulumi-azuread with merge commit 6896908

github-actions · 2021-03-15T18:44:30Z

Diff for pulumi-kubernetes with merge commit 6896908

github-actions · 2021-03-15T18:50:17Z

Diff for pulumi-gcp with merge commit 6896908

github-actions · 2021-03-15T18:57:11Z

Diff for pulumi-azure with merge commit 6896908

github-actions · 2021-03-15T19:02:54Z

Diff for pulumi-aws with merge commit 6896908

github-actions · 2021-03-15T19:11:47Z

Diff for pulumi-azure-native with merge commit 6896908

justinvp · 2021-03-15T20:00:41Z

pkg/codegen/python/gen.go

-	mod.genInitDocstring(w, res)
+	// Now generate __init__ overloads along with an implementation...
+
+	// First, generate an __init__ overload that accepts the resource's inputs from the args class.


Do we have a preference regarding which overload is shown first in code completion lists? VS Code shows the overloads in the order they're declared (at least in this case), which is currently the new overload.

I'd propose having the keyword-based style first ahead of the args-based given that's what people are currently using. We could choose to flip this order for 3.0 to encourage the args-based as the 'default'

SGTM. I've pushed a commit that does that.

github-actions · 2021-03-16T13:26:10Z

Diff for pulumi-random with merge commit c764181

github-actions · 2021-03-16T13:26:19Z

Diff for pulumi-azuread with merge commit c764181

github-actions · 2021-03-16T13:27:17Z

Diff for pulumi-kubernetes with merge commit c764181

github-actions · 2021-03-16T13:32:50Z

Diff for pulumi-gcp with merge commit c764181

github-actions · 2021-03-16T13:41:54Z

Diff for pulumi-azure with merge commit c764181

github-actions · 2021-03-16T13:46:06Z

Diff for pulumi-aws with merge commit c764181

github-actions · 2021-03-16T13:58:39Z

Diff for pulumi-azure-native with merge commit c764181

komalali

LGTM. Do we know what impact this will have on docs and how we will handle presenting the overloads there?

github-actions · 2021-03-16T23:18:45Z

Diff for pulumi-azuread with merge commit c7fb9da

github-actions · 2021-03-16T23:19:08Z

Diff for pulumi-random with merge commit c7fb9da

github-actions · 2021-03-16T23:20:34Z

Diff for pulumi-kubernetes with merge commit c7fb9da

github-actions · 2021-03-16T23:24:24Z

Diff for pulumi-gcp with merge commit c7fb9da

github-actions · 2021-03-16T23:37:39Z

Diff for pulumi-azure with merge commit c7fb9da

github-actions · 2021-03-16T23:39:38Z

Diff for pulumi-aws with merge commit c7fb9da

github-actions · 2021-03-16T23:41:23Z

Diff for pulumi-azure-native with merge commit c7fb9da

komalali · 2021-03-19T20:14:11Z

Oh, I realized that all the tests here are of the codegen itself. Could we add some tests of this in use?

Add support for creating instances of resources in Python using a `<Resource>Args` class. This capability aligns with how args are passed to resources in all the other language SDKs and the separate object bag allows the properties to be manipulated/validated/passed-around before creating the resource.

Emit the overload that accepts the new args class last, so code completion shows the existing function-arg-based overload first.

Fix a regression that was causing function inputs to be incorrectly wrapped as `Input[T]`.

github-actions · 2021-04-02T06:55:49Z

Diff for pulumi-random with merge commit bc61f9e

github-actions · 2021-04-02T06:57:08Z

Diff for pulumi-kubernetes with merge commit bc61f9e

github-actions · 2021-04-02T06:57:20Z

Diff for pulumi-azuread with merge commit bc61f9e

github-actions · 2021-04-02T07:03:25Z

Diff for pulumi-gcp with merge commit bc61f9e

github-actions · 2021-04-02T07:11:12Z

Diff for pulumi-azure with merge commit bc61f9e

github-actions · 2021-04-02T07:16:16Z

Diff for pulumi-aws with merge commit bc61f9e

github-actions · 2021-04-02T07:34:28Z

Diff for pulumi-azure-native with merge commit bc61f9e

- [sdk/go] Fix Go resource registrations (pulumi/pulumi#6641) - [sdk/python] Support `<Resource>Args` classes (pulumi/pulumi#6525)

justinvp added the impact/no-changelog-required This issue doesn't require a CHANGELOG update label Mar 15, 2021

justinvp marked this pull request as ready for review March 15, 2021 18:03

justinvp force-pushed the justin/pyargs branch from defacc6 to 277f704 Compare March 15, 2021 18:38

justinvp commented Mar 15, 2021

View reviewed changes

justinvp requested a review from komalali March 15, 2021 20:05

komalali approved these changes Mar 16, 2021

View reviewed changes

justinvp added 4 commits April 1, 2021 21:05

Swap order of emitted overloads

9c9f887

Emit the overload that accepts the new args class last, so code completion shows the existing function-arg-based overload first.

Fix regression in functionType handling

2c9d5bc

Fix a regression that was causing function inputs to be incorrectly wrapped as `Input[T]`.

Add integration test

f6f3d1d

justinvp force-pushed the justin/pyargs branch from c97a4f8 to f6f3d1d Compare April 2, 2021 06:51

justinvp merged commit dcf4359 into master Apr 2, 2021

pulumi-bot deleted the justin/pyargs branch April 2, 2021 17:09

lblackstone added a commit to pulumi/pulumi-kubernetes that referenced this pull request Apr 8, 2021

Update pulumi dependency

fcb664d

- [sdk/go] Fix Go resource registrations (pulumi/pulumi#6641) - [sdk/python] Support `<Resource>Args` classes (pulumi/pulumi#6525)

lblackstone mentioned this pull request Apr 8, 2021

Update pulumi dependency pulumi/pulumi-kubernetes#1521

Merged

lblackstone added a commit to pulumi/pulumi-kubernetes that referenced this pull request Apr 14, 2021

Update pulumi dependency

d89c0c7

- [sdk/go] Fix Go resource registrations (pulumi/pulumi#6641) - [sdk/python] Support `<Resource>Args` classes (pulumi/pulumi#6525)

lblackstone added a commit to pulumi/pulumi-kubernetes that referenced this pull request Apr 14, 2021

Update pulumi dependency

07e8584

- [sdk/go] Fix Go resource registrations (pulumi/pulumi#6641) - [sdk/python] Support `<Resource>Args` classes (pulumi/pulumi#6525)

lblackstone added a commit to pulumi/pulumi-kubernetes that referenced this pull request Apr 15, 2021

Update pulumi dependency (#1521)

729ff4e

- [sdk/go] Fix Go resource registrations (pulumi/pulumi#6641) - [sdk/python] Support `<Resource>Args` classes (pulumi/pulumi#6525)

justinvp mentioned this pull request May 29, 2021

[codegen/python] Rename conflicting ResourceArgs classes #7171

Merged

renovate bot mentioned this pull request Jun 6, 2021

chore(deps): update dependency @pulumi/kubernetes to v3 marcus-sa/pulumi-kubernetes-istio#61

Open

1 task

[codegen/python] Support <Resource>Args classes #6525

[codegen/python] Support <Resource>Args classes #6525

Conversation

justinvp commented Mar 13, 2021 • edited

github-actions bot commented Mar 13, 2021

github-actions bot commented Mar 13, 2021

github-actions bot commented Mar 13, 2021

github-actions bot commented Mar 13, 2021

github-actions bot commented Mar 13, 2021

github-actions bot commented Mar 13, 2021

github-actions bot commented Mar 13, 2021

github-actions bot commented Mar 15, 2021

github-actions bot commented Mar 15, 2021

github-actions bot commented Mar 15, 2021

github-actions bot commented Mar 15, 2021

github-actions bot commented Mar 15, 2021

github-actions bot commented Mar 15, 2021

github-actions bot commented Mar 15, 2021

justinvp Mar 15, 2021 • edited

Choose a reason for hiding this comment

leezen Mar 16, 2021

Choose a reason for hiding this comment

justinvp Mar 16, 2021

Choose a reason for hiding this comment

github-actions bot commented Mar 16, 2021

github-actions bot commented Mar 16, 2021

github-actions bot commented Mar 16, 2021

github-actions bot commented Mar 16, 2021

github-actions bot commented Mar 16, 2021

github-actions bot commented Mar 16, 2021

github-actions bot commented Mar 16, 2021

komalali left a comment

Choose a reason for hiding this comment

github-actions bot commented Mar 16, 2021

github-actions bot commented Mar 16, 2021

github-actions bot commented Mar 16, 2021

github-actions bot commented Mar 16, 2021

github-actions bot commented Mar 16, 2021

github-actions bot commented Mar 16, 2021

github-actions bot commented Mar 16, 2021

komalali commented Mar 19, 2021

github-actions bot commented Apr 2, 2021

github-actions bot commented Apr 2, 2021

github-actions bot commented Apr 2, 2021

github-actions bot commented Apr 2, 2021

github-actions bot commented Apr 2, 2021

github-actions bot commented Apr 2, 2021

github-actions bot commented Apr 2, 2021

[codegen/python] Support `<Resource>Args` classes #6525

[codegen/python] Support `<Resource>Args` classes #6525

justinvp commented Mar 13, 2021 •

edited

justinvp Mar 15, 2021 •

edited