pulumi/tests/testdata/codegen/resource-property-overlap/python/pulumi_example/rec.py

97 lines
3.5 KiB
Python
Raw Normal View History

# coding=utf-8
# *** WARNING: this file was generated by test. ***
# *** Do not edit by hand unless you're certain you know what you are doing! ***
import copy
import warnings
import pulumi
import pulumi.runtime
[sdkgen/python] revert changes introducing `_configure` (#14427) <!--- Thanks so much for your contribution! If this is your first time contributing, please ensure that you have read the [CONTRIBUTING](https://github.com/pulumi/pulumi/blob/master/CONTRIBUTING.md) documentation. --> # Description <!--- Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. --> Fixes https://github.com/pulumi/pulumi/issues/14418 Reopens https://github.com/pulumi/pulumi/issues/12546 This removes the `_configure()` ResourceArgs helper method as it has caused a number of issues (linked below). `_configure()` was added in order to support initializing default values sdk side for python. This has led to the following PRs being merged to address unexpected bugs. ## Overview of fixes: It will be quite hard to demonstrate without examples, so I will give an example of the code and describe its short comings: --- - https://github.com/pulumi/pulumi/issues/14418 ```python args = MyArgs() # fails as required argument foo not provided args.foo = "Hello, World!" ``` --- - https://github.com/pulumi/pulumi/pull/14235 Supporting `imageName` and `image_name` ```python def _configure(... image_name, # required ...): ... # This should not error, but errors. _configure(imageName="debian") ``` --- - https://github.com/pulumi/pulumi/pull/14281 ```python def _configure(... image_name, # required ... **kwargs): ... # This should not fail, but fails as `image_name` is not provided _configure(imageName="debian") ``` --- - https://github.com/pulumi/pulumi/pull/14014 ```python class Thing: def __init__(self, ... # Optional certmanager=None, ...): ... Thing._configure( ... certmanager=None, ...) ... def _configure(...): ... # This block runs when certmanager = None, but should not. if not isinstance(certmanager, ProviderCertmanagerArgs): certmanager = certmanager or {} def _setter(key, value): certmanager[key] = value ProviderCertmanagerArgs._configure(_setter, **certmanager) ... Provider() ``` --- - https://github.com/pulumi/pulumi/pull/14321 ```python registry_info=accessToken.apply(get_registry_info) # Build and publish the image. image = Image( 'my-image', build=DockerBuildArgs( context='app', ), image_name=image_name, # Note that this is an Output. registry=registry_info, ) # registry is not None and it is not an instance of RegistryArgs, so we fall into the if, thinking it is a dict, but it is an Output. if registry is not None and not isinstance(registry, RegistryArgs): registry = registry or {} def _setter(key, value): registry[key] = value RegistryArgs._configure(_setter, **registry) __props__.__dict__["registry"] = registry ``` --- - https://github.com/pulumi/pulumi/pull/14318 ```python # foo.core.v1.PodArgs may be an external type and may not be upgraded to have _configure() and will fail, but should not. if pod is not None and not isinstance(pod, foo.core.v1.PodArgs): pod = pod or {} def _setter(key, value): pod[key] = value pulumi_kubernetes.core.v1.PodArgs._configure(_setter, **pod) ``` ## Checklist - [x] I have run `make tidy` to update any new dependencies - [x] I have run `make lint` to verify my code passes the lint check - [x] I have formatted my code using `gofumpt` <!--- Please provide details if the checkbox below is to be left unchecked. --> - [ ] I have added tests that prove my fix is effective or that my feature works <!--- User-facing changes require a CHANGELOG entry. --> - [x] I have run `make changelog` and committed the `changelog/pending/<file>` documenting my change <!-- If the change(s) in this PR is a modification of an existing call to the Pulumi Cloud, then the service should honor older versions of the CLI where this change would not exist. You must then bump the API version in /pkg/backend/httpstate/client/api.go, as well as add it to the service. --> - [ ] Yes, there are changes in this PR that warrants bumping the Pulumi Cloud API version <!-- @Pulumi employees: If yes, you must submit corresponding changes in the service repo. -->
2023-10-27 22:28:41 +00:00
from typing import Any, Mapping, Optional, Sequence, Union, overload
from . import _utilities
__all__ = ['RecArgs', 'Rec']
@pulumi.input_type
class RecArgs:
def __init__(__self__):
"""
The set of arguments for constructing a Rec resource.
"""
pass
[sdkgen/python] `_configure` now handles original prop names (#14235) <!--- Thanks so much for your contribution! If this is your first time contributing, please ensure that you have read the [CONTRIBUTING](https://github.com/pulumi/pulumi/blob/master/CONTRIBUTING.md) documentation. --> # Description <!--- Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. --> Python SDK generation's `_configure` method now supports setters of the property name based on its original name. Now supports: ```python Foo("my-foo", propName=10) ``` Instead of just: ```python Foo("my-foo", prop_name=10) ``` Fixes #14151 Fixes #14239 ## Checklist - [x] I have run `make tidy` to update any new dependencies - [x] I have run `make lint` to verify my code passes the lint check - [x] I have formatted my code using `gofumpt` <!--- Please provide details if the checkbox below is to be left unchecked. --> - [x] I have added tests that prove my fix is effective or that my feature works <!--- User-facing changes require a CHANGELOG entry. --> - [x] I have run `make changelog` and committed the `changelog/pending/<file>` documenting my change <!-- If the change(s) in this PR is a modification of an existing call to the Pulumi Cloud, then the service should honor older versions of the CLI where this change would not exist. You must then bump the API version in /pkg/backend/httpstate/client/api.go, as well as add it to the service. --> - [ ] Yes, there are changes in this PR that warrants bumping the Pulumi Cloud API version <!-- @Pulumi employees: If yes, you must submit corresponding changes in the service repo. -->
2023-10-13 22:38:18 +00:00
class Rec(pulumi.CustomResource):
@overload
def __init__(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
__props__=None):
"""
Create a Rec resource with the given unique name, props, and options.
:param str resource_name: The name of the resource.
:param pulumi.ResourceOptions opts: Options for the resource.
"""
...
@overload
def __init__(__self__,
resource_name: str,
args: Optional[RecArgs] = None,
opts: Optional[pulumi.ResourceOptions] = None):
"""
Create a Rec resource with the given unique name, props, and options.
:param str resource_name: The name of the resource.
:param RecArgs args: The arguments to use to populate this resource's properties.
:param pulumi.ResourceOptions opts: Options for the resource.
"""
...
def __init__(__self__, resource_name: str, *args, **kwargs):
resource_args, opts = _utilities.get_resource_args_opts(RecArgs, pulumi.ResourceOptions, *args, **kwargs)
if resource_args is not None:
__self__._internal_init(resource_name, opts, **resource_args.__dict__)
else:
__self__._internal_init(resource_name, *args, **kwargs)
def _internal_init(__self__,
resource_name: str,
opts: Optional[pulumi.ResourceOptions] = None,
__props__=None):
opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
if not isinstance(opts, pulumi.ResourceOptions):
raise TypeError('Expected resource options to be a ResourceOptions instance')
if opts.id is None:
if __props__ is not None:
raise TypeError('__props__ is only valid when passed in combination with a valid opts.id to get an existing resource')
__props__ = RecArgs.__new__(RecArgs)
__props__.__dict__["rec"] = None
super(Rec, __self__).__init__(
'example::Rec',
resource_name,
__props__,
opts)
@staticmethod
def get(resource_name: str,
id: pulumi.Input[str],
opts: Optional[pulumi.ResourceOptions] = None) -> 'Rec':
"""
Get an existing Rec resource's state with the given name, id, and optional extra
properties used to qualify the lookup.
:param str resource_name: The unique name of the resulting resource.
:param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
:param pulumi.ResourceOptions opts: Options for the resource.
"""
opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
__props__ = RecArgs.__new__(RecArgs)
__props__.__dict__["rec"] = None
return Rec(resource_name, opts=opts, __props__=__props__)
@property
@pulumi.getter
[codegen/go] Remove ResourcePtr input/output types (#8449) These changes remove the `Ptr` variants of input/ouptut types for resources. A `TPtr` input or output is normally generated for `T` if `T` is present in an `optional(input(T))` or `optional(output(T))` and if the Go representation for `T` is not nilable. The generation of `Ptr` variants for resource types breaks the latter rule: the canonical representation of a resource type named `Foo` is a pointer to a struct type named `Foo` (i.e. `*Foo`). `Foo` itself is not a resource, as it does not implement the Go `Resource` interface. Because this representation already accommodates `nil` to indicate the lack of a value, we need not generate `FooPtr{Input,Output}` types. Besides being unnecessary, the implementation of `Ptr` types for resources was incorrect. Rather than using `**Foo` as their element type, these types use `*Foo`--identical to the element type used for the normal input/output types. Furthermore, the generated code for at least `FooOutput.ToFooPtrOutputWithContext` and `FooPtrOutput.Elem` was incorrect, making these types virtually unusable in practice. Finally, these `Ptr` types should never appear on input/output properties in practice, as the logic we use to generate input and output type references never generates them for `optional({input,output}(T)). Instead, it generates references to the standard input/output types. Though this is _technically_ a breaking change--it changes the set of exported types for any package that defines resources--I believe that in practice it will be invisible to users for the reasons stated above. These types are not usable, and were never referenced. This is preparatory work for #7943.
2021-11-23 18:24:56 +00:00
def rec(self) -> pulumi.Output[Optional['Rec']]:
return pulumi.get(self, "rec")