/
doc.go
156 lines (135 loc) 路 5.17 KB
/
doc.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
// Copyright 2016-2018, Pulumi Corporation.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// Pulling out some of the repeated strings tokens into constants would harm readability,
// so we just ignore the goconst linter's warning.
//
// nolint: lll, goconst
package python
import (
"errors"
"fmt"
"strings"
"github.com/pulumi/pulumi/pkg/codegen"
"github.com/pulumi/pulumi/pkg/codegen/schema"
)
// DocLanguageHelper is the Python-specific implementation of the DocLanguageHelper.
type DocLanguageHelper struct{}
var _ codegen.DocLanguageHelper = DocLanguageHelper{}
// GetDocLinkForResourceType is not implemented at this time for Python.
func (d DocLanguageHelper) GetDocLinkForResourceType(packageName, modName, typeName string) string {
return ""
}
// GetDocLinkForResourceInputOrOutputType is not implemented at this time for Python.
func (d DocLanguageHelper) GetDocLinkForResourceInputOrOutputType(packageName, modName, typeName string, input bool) string {
return ""
}
// GetDocLinkForFunctionInputOrOutputType is not implemented at this time for Python.
func (d DocLanguageHelper) GetDocLinkForFunctionInputOrOutputType(packageName, modName, typeName string, input bool) string {
return ""
}
// GetLanguageTypeString returns the Python-specific type given a Pulumi schema type.
func (d DocLanguageHelper) GetLanguageTypeString(pkg *schema.Package, moduleName string, t schema.Type, input, optional bool) string {
name := pyType(t)
// The Python SDK generator will simply return "list" or "dict" for enumerables.
// So we examine the underlying types to provide some more information on
// the elements inside the enumerable.
switch name {
case "list":
arrTy := t.(*schema.ArrayType)
elType := arrTy.ElementType.String()
return getListWithTypeName(elementTypeToName(elType))
case "dict":
switch dTy := t.(type) {
case *schema.UnionType:
types := make([]string, 0, len(dTy.ElementTypes))
for _, e := range dTy.ElementTypes {
if schema.IsPrimitiveType(e) {
types = append(types, e.String())
continue
}
t := d.GetLanguageTypeString(pkg, moduleName, e, input, optional)
types = append(types, t)
}
return strings.Join(types, " | ")
case *schema.MapType:
if uTy, ok := dTy.ElementType.(*schema.UnionType); ok {
return d.GetLanguageTypeString(pkg, moduleName, uTy, input, optional)
}
elType := dTy.ElementType.String()
return getMapWithTypeName(elementTypeToName(elType))
case *schema.ObjectType:
return getDictWithTypeName(tokenToName(dTy.Token))
default:
return "Dict[str, Any]"
}
}
return name
}
// GetResourceFunctionResultName is not implemented for Python and returns an empty string.
func (d DocLanguageHelper) GetResourceFunctionResultName(resourceName string) string {
return ""
}
// GenPropertyCaseMap generates the case maps for a property.
func (d DocLanguageHelper) GenPropertyCaseMap(pkg *schema.Package, modName, tool string, prop *schema.Property, snakeCaseToCamelCase, camelCaseToSnakeCase map[string]string) {
mod := &modContext{
pkg: pkg,
mod: modName,
tool: tool,
snakeCaseToCamelCase: snakeCaseToCamelCase,
camelCaseToSnakeCase: camelCaseToSnakeCase,
}
if err := mod.recordProperty(prop); err != nil {
fmt.Printf("error building case map for %q in module %q", prop.Name, modName)
}
}
// GetPropertyName is not implemented for Python because property names in Python must use
// property case maps, which need to be generated at each provider's package-level.
func (d DocLanguageHelper) GetPropertyName(p *schema.Property) (string, error) {
return "", errors.New("this method is not supported for the python language")
}
// elementTypeToName returns the type name from an element type of the form
// package:module:_type, with its leading "_" stripped.
func elementTypeToName(el string) string {
parts := strings.Split(el, ":")
if len(parts) == 3 {
el = parts[2]
}
el = strings.TrimPrefix(el, "_")
return el
}
// getListWithTypeName returns a Python representation of a list containing
// items of `t`.
func getListWithTypeName(t string) string {
if t == "string" {
return "List[str]"
}
return fmt.Sprintf("List[%s]", strings.Title(t))
}
// getDictWithTypeName returns the Python representation of a dictionary
// where each item is of type `t`.
func getDictWithTypeName(t string) string {
return fmt.Sprintf("Dict[%s]", strings.Title(t))
}
// getMapWithTypeName returns the Python representation of a dictionary
// with a string keu and a value of type `t`.
func getMapWithTypeName(t string) string {
switch t {
case "string":
return "Dict[str, str]"
case "any":
return "Dict[str, Any]"
default:
return fmt.Sprintf("Dict[str, %s]", strings.Title(t))
}
}