codegen

package
v3.184.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 18, 2025 License: Apache-2.0 Imports: 7 Imported by: 54

README

(codegen)= (crosscode)=

Code generation

Code generation is essential to Pulumi's ability to support both a variety of programming languages and a variety of cloud providers. This package defines the core components of Pulumi's code generation functionality (known as Pulumi CrossCode). At a high level, code generation is used to manage three categories of output: SDKs, programs, and documentation. At a lower level, these all make use of a number of shared concepts such as schema and Pulumi Configuration Language (PCL).

:::{toctree} :maxdepth: 1 :titlesonly:

/pkg/codegen/sdks.md /pkg/codegen/programs.md /pkg/codegen/docs/README /pkg/codegen/schema/README /pkg/codegen/pcl/README :::

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CleanDir 

func CleanDir(dirPath string, exclusions StringSet) error

CleanDir removes all existing files from a directory except those in the exclusions list. Note: The exclusions currently don't function recursively, so you cannot exclude a single file in a subdirectory, only entire subdirectories. This function will need improvements to be able to target that use-case.

func ExpandShortEnumName 

func ExpandShortEnumName(name string) string

func FilterExamples 

func FilterExamples(description string, lang string) string

FilterExamples filters the code snippets in a schema docstring to include only those that target the given language.

func IsNOptionalInput added in v3.17.0 

func IsNOptionalInput(t schema.Type) bool

func IsProvideDefaultsFuncRequired added in v3.19.0 

func IsProvideDefaultsFuncRequired(t schema.Type) bool

If a helper function needs to be invoked to provide default values for a plain type. The provided map cannot be reused.

func MapInnerType added in v3.31.0 

func MapInnerType(t schema.Type, f func(schema.Type) schema.Type) schema.Type

MapInnerType applies f to the first non-wrapper type in t. MapInnerType does not mutate it's input, and t should not either.

func MapOptionalType added in v3.31.1 

func MapOptionalType(t schema.Type, f func(schema.Type) schema.Type) schema.Type

Applies f to the first non-optional type in t. If t is Optional{v} then returns Optional{f(v)}, otherwise f(t) is returned

func OptionalType added in v3.6.0 

func OptionalType(p *schema.Property) schema.Type

OptionalType wraps the Property's type in an OptionalType if it is not already optional.

func PackageReferences added in v3.144.0 

func PackageReferences(pkg *schema.Package) []schema.PackageReference

PackageReferences returns a list of packages that are referenced by the given package.

func PkgEquals added in v3.49.0 

func PkgEquals(p1, p2 schema.PackageReference) bool

Check if two packages are the same.

func PlainType added in v3.6.0 

func PlainType(t schema.Type) schema.Type

PlainType deeply removes any InputTypes from t, with the exception of argument structs. Use ResolvedType to unwrap argument structs as well.

func RequiredType added in v3.6.0 

func RequiredType(p *schema.Property) schema.Type

RequiredType unwraps the OptionalType enclosing the Property's type, if any.

func ResolvedType added in v3.6.0 

func ResolvedType(t schema.Type) schema.Type

ResolvedType deeply removes any InputTypes from t.

func SimplifyInputUnion added in v3.6.0 

func SimplifyInputUnion(t schema.Type) schema.Type

func UnwrapType added in v3.6.0 

func UnwrapType(t schema.Type) schema.Type

UnwrapType removes any outer OptionalTypes and InputTypes from t.

func VisitType added in v3.50.0 

func VisitType(schemaType schema.Type, visitor func(t schema.Type))

func VisitTypeClosure added in v3.1.0 

func VisitTypeClosure(properties []*schema.Property, visitor func(t schema.Type))

Types

type DocLanguageHelper 

type DocLanguageHelper interface {
	// GetModuleName returns the in-language name of the module.
	//
	// For example, lets get the hypothetical name of the module for the "pkg:module/nestedMod:Type" token in python:
	//
	//	var python python_codegen.DocLanguageHelper
	//	python.GetModuleName(pkgRef, pkgRef.TokenToModule("pkg:module/nestedMod:Type")) // "module.nestedmod"
	GetModuleName(pkg schema.PackageReference, modName string) string

	GetPropertyName(p *schema.Property) (string, error)
	GetEnumName(e *schema.Enum, typeName string) (string, error)
	// GetTypeName gets the name of a type in the language of the DocLanguageHelper.
	//
	// relativeToModule describes the module that is consuming the type
	// name. Typically, GetTypeName will output an unqualified name if typ is native
	// to relativeToModule. Otherwise GetTypeName may return a qualified name.
	// relativeToModule should always be a module returned from pkg.TokenToModule. It
	// should not be language specialized.
	//
	// For example, lets get the name of a hypothetical python property type:
	//
	//	var pkg *schema.Package = getOurPackage(/* Schema{
	//		Name: "pkg",
	//		Resource: []{
	//			{
	//				Token: "pkg:myModule:Resource",
	//				Properties: []{
	//					{
	//						Type: Object{Name: "pkg:myModule:TheType"},
	//						Name: "theType",
	//					},
	//				},
	//			},
	//		},
	//	} */)
	//	var res *schema.Resource = pkg.Resources[i]
	//	var prop *schema.Property := res.Properties[j]
	//
	//	var python python_codegen.DocLanguageHelper
	//
	//	unqualifiedName := python.GetTypeName(pkg, prop.Type, false, pkg.TokenToModule(res.Token))
	//	fmt.Println(unqualifiedName) // Prints "TheType".
	//
	//	qualifiedName := python.GetTypeName(pkg, prop.Type, false, "")
	//	fmt.Println(qualifiedName) // Prints "my_module.TheType"
	GetTypeName(pkg schema.PackageReference, t schema.Type, input bool, relativeToModule string) string
	// GetResourceName returns the name of the resource.
	//
	// Implements should prefer a short name if possible: "MyResource" over "Pulumi.MyPackage.MyModule.MyResource".
	GetResourceName(r *schema.Resource) string
	GetFunctionName(f *schema.Function) string

	// GetResourceFunctionResultName returns the name of the result type when a static resource function is used to lookup
	// an existing resource.
	GetResourceFunctionResultName(modName string, f *schema.Function) string

	// Methods
	GetMethodName(m *schema.Method) string
	GetMethodResultName(pkg schema.PackageReference, modName string, r *schema.Resource, m *schema.Method) string

	// Doc links
	GetDocLinkForResourceType(pkg *schema.Package, moduleName, typeName string) string
	GetDocLinkForPulumiType(pkg *schema.Package, typeName string) string
	GetDocLinkForResourceInputOrOutputType(pkg *schema.Package, moduleName, typeName string, input bool) string
	GetDocLinkForFunctionInputOrOutputType(pkg *schema.Package, moduleName, typeName string, input bool) string
}

DocLanguageHelper is an interface for extracting language-specific information from a Pulumi schema. See the implementation for this interface under each of the language code generators.

type Fs added in v3.47.0 

type Fs map[string][]byte

A simple in memory file system.

func (Fs) Add added in v3.47.0 

func (fs Fs) Add(path string, contents []byte)

Add a new file to the Fs.

Panic if the file is a duplicate.

type Set 

type Set map[interface{}]struct{}

func (Set) Add 

func (s Set) Add(v interface{})

func (Set) Delete added in v3.14.0 

func (s Set) Delete(v interface{})

func (Set) Has 

func (s Set) Has(v interface{}) bool

type StringSet 

type StringSet map[string]struct{}

func NewStringSet 

func NewStringSet(values ...string) StringSet

func (StringSet) Add 

func (ss StringSet) Add(s string)

func (StringSet) Any 

func (ss StringSet) Any() bool

func (StringSet) Contains added in v3.5.0 

func (ss StringSet) Contains(subset StringSet) bool

Contains returns true if all elements of the subset are also present in the current set. It also returns true if subset is empty.

func (StringSet) Delete 

func (ss StringSet) Delete(s string)

func (StringSet) Except added in v3.23.0 

func (ss StringSet) Except(s string) StringSet

StringSet.Except returns the string set setminus s.

func (StringSet) Has 

func (ss StringSet) Has(s string) bool

func (StringSet) SortedValues 

func (ss StringSet) SortedValues() []string

func (StringSet) Subtract added in v3.5.0 

func (ss StringSet) Subtract(other StringSet) StringSet

Subtract returns a new string set with all elements of the current set that are not present in the other set.

func (StringSet) Union added in v3.42.0 

func (ss StringSet) Union(other StringSet) StringSet

Source Files

View all Source files

Directories

Path Synopsis
package cgstrings has various string processing functions that are useful during code generation.
 package cgstrings has various string processing functions that are useful during code generation.
Pulling out some of the repeated strings tokens into constants would harm readability, so we just ignore the goconst linter's warning.
 Pulling out some of the repeated strings tokens into constants would harm readability, so we just ignore the goconst linter's warning.
Pulling out some of the repeated strings tokens into constants would harm readability, so we just ignore the goconst linter's warning.
 Pulling out some of the repeated strings tokens into constants would harm readability, so we just ignore the goconst linter's warning.
hcl2
model
model/format
model/pretty
pretty is an extensible utility library to pretty-print nested structures.
 pretty is an extensible utility library to pretty-print nested structures.
syntax
Pulling out some of the repeated strings tokens into constants would harm readability, so we just ignore the goconst linter's warning.
 Pulling out some of the repeated strings tokens into constants would harm readability, so we just ignore the goconst linter's warning.
tstypes
Helper code to assist emitting correctly minimally parenthesized TypeScript type literals.
 Helper code to assist emitting correctly minimally parenthesized TypeScript type literals.
Pulling out some of the repeated strings tokens into constants would harm readability, so we just ignore the goconst linter's warning.
 Pulling out some of the repeated strings tokens into constants would harm readability, so we just ignore the goconst linter's warning.
testing
test
utils

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.