2020-03-09 17:35:20 +00:00
|
|
|
// Copyright 2016-2020, 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.
|
|
|
|
//
|
2023-01-06 00:07:45 +00:00
|
|
|
//nolint:lll, goconst
|
2020-03-09 17:35:20 +00:00
|
|
|
package docs
|
|
|
|
|
|
|
|
import (
|
|
|
|
"strings"
|
|
|
|
"unicode"
|
|
|
|
|
2024-03-14 22:10:14 +00:00
|
|
|
"github.com/pulumi/pulumi/pkg/v3/codegen"
|
2021-03-17 13:20:05 +00:00
|
|
|
"github.com/pulumi/pulumi/pkg/v3/codegen/dotnet"
|
|
|
|
go_gen "github.com/pulumi/pulumi/pkg/v3/codegen/go"
|
2024-03-14 22:10:14 +00:00
|
|
|
"github.com/pulumi/pulumi/pkg/v3/codegen/schema"
|
2023-06-28 16:02:04 +00:00
|
|
|
"github.com/pulumi/pulumi/sdk/v3/go/common/slice"
|
2021-03-17 13:20:05 +00:00
|
|
|
"github.com/pulumi/pulumi/sdk/v3/go/common/util/contract"
|
2020-03-09 17:35:20 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
func isDotNetTypeNameBoundary(prev rune, next rune) bool {
|
|
|
|
// For C# type names, which are PascalCase are qualified using "." as the separator.
|
|
|
|
return prev == rune('.') && unicode.IsUpper(next)
|
|
|
|
}
|
|
|
|
|
|
|
|
func isPythonTypeNameBoundary(prev rune, next rune) bool {
|
|
|
|
// For Python, names are snake_cased (Duh?).
|
|
|
|
return (prev == rune('_') && unicode.IsLower(next))
|
|
|
|
}
|
|
|
|
|
|
|
|
// wbr inserts HTML <wbr> in between case changes, e.g. "fooBar" becomes "foo<wbr>Bar".
|
|
|
|
func wbr(s string) string {
|
2023-06-28 16:02:04 +00:00
|
|
|
runes := slice.Prealloc[rune](len(s))
|
2020-03-09 17:35:20 +00:00
|
|
|
var prev rune
|
|
|
|
for i, r := range s {
|
|
|
|
if i != 0 &&
|
|
|
|
// For TS, JS and Go, property names are camelCase and types are PascalCase.
|
|
|
|
((unicode.IsLower(prev) && unicode.IsUpper(r)) ||
|
|
|
|
isDotNetTypeNameBoundary(prev, r) ||
|
|
|
|
isPythonTypeNameBoundary(prev, r)) {
|
|
|
|
runes = append(runes, []rune("<wbr>")...)
|
|
|
|
}
|
|
|
|
runes = append(runes, r)
|
|
|
|
prev = r
|
|
|
|
}
|
|
|
|
return string(runes)
|
|
|
|
}
|
|
|
|
|
|
|
|
// tokenToName returns the resource name from a Pulumi token.
|
|
|
|
func tokenToName(tok string) string {
|
|
|
|
components := strings.Split(tok, ":")
|
|
|
|
contract.Assertf(len(components) == 3, "malformed token %v", tok)
|
2020-04-28 00:47:01 +00:00
|
|
|
return components[2]
|
2020-03-09 17:35:20 +00:00
|
|
|
}
|
2020-04-07 00:01:33 +00:00
|
|
|
|
2024-03-14 22:10:14 +00:00
|
|
|
func tokenToPackageName(tok string) string {
|
|
|
|
components := strings.Split(tok, ":")
|
|
|
|
contract.Assertf(len(components) == 3, "malformed token %v", tok)
|
|
|
|
return components[0]
|
|
|
|
}
|
|
|
|
|
2020-04-07 00:01:33 +00:00
|
|
|
func title(s, lang string) string {
|
|
|
|
switch lang {
|
|
|
|
case "go":
|
|
|
|
return go_gen.Title(s)
|
|
|
|
case "csharp":
|
|
|
|
return dotnet.Title(s)
|
|
|
|
default:
|
|
|
|
return strings.Title(s)
|
|
|
|
}
|
|
|
|
}
|
2021-10-01 00:35:44 +00:00
|
|
|
|
|
|
|
func modFilenameToDisplayName(name string) string {
|
|
|
|
parts := strings.Split(name, "/")
|
|
|
|
return parts[len(parts)-1]
|
|
|
|
}
|
|
|
|
|
|
|
|
func getModuleLink(name string) string {
|
|
|
|
return strings.ToLower(name) + "/"
|
|
|
|
}
|
|
|
|
|
|
|
|
func getResourceLink(name string) string {
|
2023-01-18 20:23:08 +00:00
|
|
|
link := strings.ToLower(name)
|
|
|
|
// Handle URL generation for resources named `index`. We prepend a double underscore
|
|
|
|
// here, since a link of .../<module>/index has trouble resolving and returns a 404 in
|
|
|
|
// the browser, likely due to `index` being some sort of reserved keyword.
|
|
|
|
if link == "index" {
|
2023-01-20 20:53:34 +00:00
|
|
|
return "--" + link
|
2023-01-18 20:23:08 +00:00
|
|
|
}
|
|
|
|
return link
|
2021-10-01 00:35:44 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
func getFunctionLink(name string) string {
|
|
|
|
return strings.ToLower(name)
|
|
|
|
}
|
2024-03-14 22:10:14 +00:00
|
|
|
|
|
|
|
// isExternalType checks if the type is external to the given package.
|
|
|
|
func isExternalType(t schema.Type, pkg schema.PackageReference) (isExternal bool) {
|
|
|
|
switch typ := t.(type) {
|
|
|
|
case *schema.ObjectType:
|
|
|
|
return typ.PackageReference != nil && !codegen.PkgEquals(typ.PackageReference, pkg)
|
|
|
|
case *schema.ResourceType:
|
|
|
|
return typ.Resource != nil && pkg != nil && !codegen.PkgEquals(typ.Resource.PackageReference, pkg)
|
|
|
|
case *schema.EnumType:
|
|
|
|
return pkg != nil && !codegen.PkgEquals(typ.PackageReference, pkg)
|
|
|
|
}
|
|
|
|
return
|
|
|
|
}
|
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
|
|
|
|
|
|
|
// Iterate character by character and remove underscores if that underscore
|
|
|
|
// is at the very front of an identifier, follows a special character, and is not a delimeter
|
|
|
|
// within an identifier.
|
|
|
|
func removeLeadingUnderscores(s string) string {
|
|
|
|
var sb strings.Builder
|
|
|
|
lastChar := ' '
|
|
|
|
for _, ch := range s {
|
|
|
|
if ch != '_' || (unicode.IsLetter(lastChar)) {
|
|
|
|
sb.WriteRune(ch)
|
|
|
|
}
|
|
|
|
lastChar = ch
|
|
|
|
}
|
|
|
|
return sb.String()
|
|
|
|
}
|