mirror of https://github.com/pulumi/pulumi.git
e65c2aa368
Presently, the Python SDK incorrectly emits deprecation warnings for properties even if user code does not reference them. This is due to various pieces of code in the SDK that enumerate properties e.g. for the purpose of serialisation/RPC calls. In enumerating properties, their getters are invoked, triggering the deprecation warnings. There isn't currently a way for us to detect which properties may or may not be deprecated and handle them appropriately, so this commit introduces one. Deprecation messages are moved into a new decorator, `@pulumi.deprecated`. This decorator accepts a `Callable` and wraps it, making two changes: * Before the decorated `Callable`'s execution, deprecation messages are printed. * The returned `Callable` is tagged with a new reserved property, `_pulumi_deprecated_callable`, which references the wrapped `Callable` (that is, the original `Callable` whose invocation will _not_ produce deprecation warnings). With this in place, we subsequently make the following two changes: * We modify the SDK enumeration code (specifically that in `input_type_to_dict` to check for `_pulumi_deprecated_callable` properties and use them where appropriate to invoke getters without triggering deprecation warnings. * We modify Python code generation so that instead of emitting statements to print deprecation warnings, we simply emit applications of the `@pulumi.deprecated` decorator instead. This commit adds some Python unit tests to exercise the decorator and manual testing has been performed using the AWS Classic SDK. Fixes #15894 |
||
|---|---|---|
| .. | ||
| cgstrings | ||
| convert | ||
| docs | ||
| dotnet | ||
| gen_program_test | ||
| go | ||
| hcl2 | ||
| nodejs | ||
| pcl | ||
| python | ||
| report | ||
| schema | ||
| testing | ||
| README.md | ||
| docs.go | ||
| docs_test.go | ||
| utilities.go | ||
| utilities_test.go | ||
| utilities_types.go | ||
README.md
Pulumi CrossCode
The github.com/pulumi/pulumi/pkg/v3/codegen package defines the core components of Pulumi's CrossCode technology. CrossCode provides a set of foundational capabilities for working across a variety of programming languages supported by the Pulumi platform.
The core components of CrossCode in this package are:
- Schema: The definition of Pulumi Schema, a language-neutral specification of cloud resource models. Pulumi Schema is the interface definition language for all Pulumi Packages, and is used as input to SDK code generation for each supported Pulumi language.
- SDK Code Generation for Node.js, Python, Go and .NET: These libraries define how to create Pulumi SDKs from a Pulumi Schema definition of a package. The resulting SDKs expose the resource, components and functions from that package into the the Pulumi programming model defined for the given language.
- Docs Generation: In addition to generating per-language SDKs, CrossCode supports generating language-neutral documentation for a package from it's Pulumi Schema. This documentation is currently hosted in the Pulumi Registry, but can in principle be hosted in other contexts as well.
- Pulumi Configuration Language: An internal representation of Pulumi programs which supports all core concepts of the Pulumi programming model in a minimal form. Although not exposed directly to users today, this intermediate representation is used to support a variety of program conversion tasks, from and to various supported Pulumi languages.
- Program Generation for Node.js, Python, Go and .NET: Support for lowering Pulumi Configuration Language into each of the supported Pulumi languages, such that examples and programs can be generated for the language.
These foundations enable a vast array of features supported in the Pulumi Platform, including:
- Pulumi support for Node.js, Python, Go, .NET, Java and YAML: Each Pulumi language is supported by defining a representation of the Pulumi resource model in that language, and then implementing SDK Code Generation and Program Generation for the language.
- Pulumi Packages: Pulumi packages define a set of resources using Pulumi Schema, and use the CrossCode SDK Code Generators for every Pulumi language automatically.
pulumi import: Cloud infrastructure resources deployed outside of Pulumi can be imported into Pulumi, including generated Pulumi code in your language of choice which defines the infrastructure. This builds on the program generation support from CrossCode.- tf2pulumi, arm2pulumi, crd2pulumi, kube2pulumi and cf2pulumi: These tools convert the source IaC format into an intermediate Pulumi Configuration Language model, and then use the CrossCode program generation support to convert that ultimately into the language a Pulumi user wants to use for their infrastructure.
pulumi convert: Thepulumi convertcommand allows Pulumi YAML programs to be converted into programs in any other Pulumi language. Because Pulumi YAML is a proper subset of what can be expressed in Pulumi Configuration Language, this conversion from Pulumi YAML to Pulumi Configuration Language and then into each Pulumi language can be done faithfully.- Pulumi Registry: The Pulumi Registry provides discovery and documentation hosting for all Pulumi Packages. It is powered by the Pulumi Schema and CrossCode documentation generation features.
Learn more about Pulumi CrossCode at https://www.pulumi.com/crosscode/.