History

Mikhail Shilkov 6cfa4afcaf Display full type names in Python references in the docs (#15784 ) <!--- 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 Currently, our resource API docs for Python only display a type name itself. If the type is defined in a different module, we do not indicate this explicitly, which causes confusion. For example, [K8s Pod Inputs](https://www.pulumi.com/registry/packages/kubernetes/api-docs/core/v1/pod/#inputs) is in `core.v1` module itself but refer to the `meta.v1.ObjectMeta` type. Node.js docs display the type as <img width="719" alt="image" src="https://github.com/pulumi/pulumi/assets/1454008/fb3e8fc5-7dc8-4661-ac6f-95e7d7918cfc"> but Python simply shows <img width="725" alt="image" src="https://github.com/pulumi/pulumi/assets/1454008/4cd4c09c-13cb-4070-b716-0b78ad98379b"> The same problem exists when we reference types from external packages, and even for composed types like `Sequence[some_external_type]`. This PR removes a special case for Python that reduces a full type name to its name. Instead, it executes on the same path as Node.js and C#. I had to apply some cleaning to Python types to remove underscore prefixes of modules. We use underscore-prefixed imports in SDK gen, but they should not be visible in user docs. I expect we need to apply the same fix to Go, but I suggest we do that as a follow-up. Testing: the existing test suite seems adequate for testing the change. All the discrepancies look like improvements to me. Fixes #15137 ## 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. --> - [ ] 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. -->		2024-04-01 14:59:50 +00:00
..
cgstrings	Use slice.Prealloc instead of make([]T, 0, ...)	2023-06-29 11:27:50 +01:00
convert	Fix flakyness in TestPluginMapper_MappedNamesDifferFromPulumiName (#15258 )	2024-01-25 15:17:38 +00:00
docs	Display full type names in Python references in the docs (#15784 )	2024-04-01 14:59:50 +00:00
dotnet	[sdk-gen, dotnet/go] Fixes SDK-generation when referencing shared types in config variables (#15772 )	2024-03-28 17:14:47 +00:00
gen_program_test	all: Reformat with gofumpt	2023-03-03 09:00:24 -08:00
go	[sdk-gen, dotnet/go] Fixes SDK-generation when referencing shared types in config variables (#15772 )	2024-03-28 17:14:47 +00:00
hcl2	[program-gen] Fix stack overflow when binding invoke that resolves to promise (#15463 )	2024-02-20 15:49:08 +00:00
nodejs	Test string outputs in conformance tests (#15823 )	2024-03-29 14:24:29 +00:00
pcl	[docs] Emit example constructor syntax for resources in typescript, python, go and csharp (#15624 )	2024-03-21 13:41:07 +00:00
python	Test string outputs in conformance tests (#15823 )	2024-03-29 14:24:29 +00:00
report	Prefer stable plugin release to pre-releases (#14700 )	2023-12-03 09:15:07 +00:00
schema	Add SupportPack to schemas to write out in the new style (#15713 )	2024-03-22 09:25:46 +00:00
testing	[sdk-gen, dotnet/go] Fixes SDK-generation when referencing shared types in config variables (#15772 )	2024-03-28 17:14:47 +00:00
README.md	fix some links	2023-05-19 19:39:26 -07:00
docs.go	Support "lifting" single-valued method returns to their return type (#8111 )	2021-10-01 11:33:02 -07:00
docs_test.go	ci: radical idea - what if slow tests & no stdout makes GH consider runner dead?	2022-03-06 14:52:13 -08:00
utilities.go	Use slice.Prealloc instead of make([]T, 0, ...)	2023-06-29 11:27:50 +01:00
utilities_test.go	ci: radical idea - what if slow tests & no stdout makes GH consider runner dead?	2022-03-06 14:52:13 -08:00
utilities_types.go	Initial implementation of simplified invokes for dotnet and nodejs	2023-01-11 14:17:14 -08:00

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: The pulumi convert command 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/.