[sdkgen/python] Fix error calling _configure when the value is None (#14014)
We recently fixed an issue where defaults weren't set for nested objects
when the nested objects are passed as dicts (#13825). Unfortunately,
this introduced a regression when the nested object is optional, but it
itself has required fields, and the nested object is not specified. In
that case, an unintended error is raised.
Consider a `Provider` resource with an optional `certmanager:
ProviderCertmanagerArgs` argument, which itself has two required
properties: `mtls_cert_pem` and `mtls_key_pem`.
When creating a new `Provider` without specifying a `certmanager`, we
get an error:
```
TypeError: ProviderCertmanagerArgs._configure() missing 2 required positional arguments: 'mtls_cert_pem' and 'mtls_key_pem'
```
The source of the problem is this check in the generated `Provider`'s
constructor:
```python
if not isinstance(certmanager, ProviderCertmanagerArgs):
certmanager = certmanager or {}
def _setter(key, value):
certmanager[key] = value
ProviderCertmanagerArgs._configure(_setter, **certmanager)
```
When `certmanager` is not specified, its value is `None`, which is also
not an instance of `ProviderCertmanagerArgs`. So the code inside the
`if` executes. `ProviderCertmanagerArgs._configure` is called on an
empty dict, and the error is raised because there are two required
positional arguments to `ProviderCertmanagerArgs._configure`.
The fix is to add an additional check to ensure the value is not `None`.
Fixes #14012
2023-09-22 18:28:25 +00:00
|
|
|
# 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
|
[sdkgen/python] Fix error calling _configure when the value is None (#14014)
We recently fixed an issue where defaults weren't set for nested objects
when the nested objects are passed as dicts (#13825). Unfortunately,
this introduced a regression when the nested object is optional, but it
itself has required fields, and the nested object is not specified. In
that case, an unintended error is raised.
Consider a `Provider` resource with an optional `certmanager:
ProviderCertmanagerArgs` argument, which itself has two required
properties: `mtls_cert_pem` and `mtls_key_pem`.
When creating a new `Provider` without specifying a `certmanager`, we
get an error:
```
TypeError: ProviderCertmanagerArgs._configure() missing 2 required positional arguments: 'mtls_cert_pem' and 'mtls_key_pem'
```
The source of the problem is this check in the generated `Provider`'s
constructor:
```python
if not isinstance(certmanager, ProviderCertmanagerArgs):
certmanager = certmanager or {}
def _setter(key, value):
certmanager[key] = value
ProviderCertmanagerArgs._configure(_setter, **certmanager)
```
When `certmanager` is not specified, its value is `None`, which is also
not an instance of `ProviderCertmanagerArgs`. So the code inside the
`if` executes. `ProviderCertmanagerArgs._configure` is called on an
empty dict, and the error is raised because there are two required
positional arguments to `ProviderCertmanagerArgs._configure`.
The fix is to add an additional check to ensure the value is not `None`.
Fixes #14012
2023-09-22 18:28:25 +00:00
|
|
|
from . import _utilities
|
|
|
|
from ._inputs import *
|
|
|
|
|
|
|
|
__all__ = ['ProviderArgs', 'Provider']
|
|
|
|
|
|
|
|
@pulumi.input_type
|
|
|
|
class ProviderArgs:
|
|
|
|
def __init__(__self__, *,
|
|
|
|
certmanager: Optional[pulumi.Input['ProviderCertmanagerArgs']] = None):
|
|
|
|
"""
|
|
|
|
The set of arguments for constructing a Provider resource.
|
|
|
|
"""
|
|
|
|
if certmanager is not None:
|
[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
|
|
|
pulumi.set(__self__, "certmanager", certmanager)
|
[sdkgen/python] Fix error calling _configure when the value is None (#14014)
We recently fixed an issue where defaults weren't set for nested objects
when the nested objects are passed as dicts (#13825). Unfortunately,
this introduced a regression when the nested object is optional, but it
itself has required fields, and the nested object is not specified. In
that case, an unintended error is raised.
Consider a `Provider` resource with an optional `certmanager:
ProviderCertmanagerArgs` argument, which itself has two required
properties: `mtls_cert_pem` and `mtls_key_pem`.
When creating a new `Provider` without specifying a `certmanager`, we
get an error:
```
TypeError: ProviderCertmanagerArgs._configure() missing 2 required positional arguments: 'mtls_cert_pem' and 'mtls_key_pem'
```
The source of the problem is this check in the generated `Provider`'s
constructor:
```python
if not isinstance(certmanager, ProviderCertmanagerArgs):
certmanager = certmanager or {}
def _setter(key, value):
certmanager[key] = value
ProviderCertmanagerArgs._configure(_setter, **certmanager)
```
When `certmanager` is not specified, its value is `None`, which is also
not an instance of `ProviderCertmanagerArgs`. So the code inside the
`if` executes. `ProviderCertmanagerArgs._configure` is called on an
empty dict, and the error is raised because there are two required
positional arguments to `ProviderCertmanagerArgs._configure`.
The fix is to add an additional check to ensure the value is not `None`.
Fixes #14012
2023-09-22 18:28:25 +00:00
|
|
|
|
|
|
|
@property
|
|
|
|
@pulumi.getter
|
|
|
|
def certmanager(self) -> Optional[pulumi.Input['ProviderCertmanagerArgs']]:
|
|
|
|
return pulumi.get(self, "certmanager")
|
|
|
|
|
|
|
|
@certmanager.setter
|
|
|
|
def certmanager(self, value: Optional[pulumi.Input['ProviderCertmanagerArgs']]):
|
|
|
|
pulumi.set(self, "certmanager", value)
|
|
|
|
|
|
|
|
|
|
|
|
class Provider(pulumi.ProviderResource):
|
|
|
|
@overload
|
|
|
|
def __init__(__self__,
|
|
|
|
resource_name: str,
|
|
|
|
opts: Optional[pulumi.ResourceOptions] = None,
|
|
|
|
certmanager: Optional[pulumi.Input[pulumi.InputType['ProviderCertmanagerArgs']]] = None,
|
|
|
|
__props__=None):
|
|
|
|
"""
|
|
|
|
Create a Foo 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[ProviderArgs] = None,
|
|
|
|
opts: Optional[pulumi.ResourceOptions] = None):
|
|
|
|
"""
|
|
|
|
Create a Foo resource with the given unique name, props, and options.
|
|
|
|
:param str resource_name: The name of the resource.
|
|
|
|
:param ProviderArgs 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(ProviderArgs, 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,
|
|
|
|
certmanager: Optional[pulumi.Input[pulumi.InputType['ProviderCertmanagerArgs']]] = 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__ = ProviderArgs.__new__(ProviderArgs)
|
|
|
|
|
|
|
|
__props__.__dict__["certmanager"] = pulumi.Output.from_input(certmanager).apply(pulumi.runtime.to_json) if certmanager is not None else None
|
|
|
|
super(Provider, __self__).__init__(
|
|
|
|
'foo',
|
|
|
|
resource_name,
|
|
|
|
__props__,
|
|
|
|
opts)
|
|
|
|
|