go/types: add Info.PkgName method #62037

adonovan · 2023-08-15T07:26:16Z

Any time a client of go/types needs to find the types.PkgName (or just the name) defined by an import, they must write logic equivalent to this:

// PkgName returns the local package name defined by the specified import.
func (info *types.Info) PkgName(imp *ast.ImportSpec) (*types.PkgName, bool) {
	var obj types.Object
	if imp.Name != nil {
		obj = info.Defs[imp.Name]
	} else {
		obj = info.Implicits[imp]
	}
	pkgname, ok := obj.(*types.PkgName)
	return pkgname, ok
}

I propose that we add this method to types.Info.

The text was updated successfully, but these errors were encountered:

findleyr · 2023-08-15T12:48:49Z

Makes sense to me, in general, though I think we should discuss the name/signature.

The proposed API is fine, but perhaps inconsistent with the existing methods. Currently, types.Info has two methods: ObjectOf and TypeOf, both of which accept an argument from the go/ast domain and return a possibly nil go/types result. Therefore, would a more consistent API be something like this?

// ImportOf returns the local package name defined by the specified import, or nil if not found.
func (info *types.Info) ImportOf(imp *ast.ImportSpec) *types.PkgName

adonovan · 2023-08-15T13:02:21Z

Fair point about nil (vs bool). How about a name of PkgNameOf?

findleyr · 2023-08-15T13:04:39Z

PkgNameOf SGTM. Indeed, it is the most natural name since ObjectOf returns an Object, and TypeOf returns a Type.

adonovan · 2023-10-14T17:50:38Z

I found at least 5 copies of this function in x/tools:

cmd/guru/describe.go
623-		if n.Name != nil {
624-			obj = qpos.info.Defs[n.Name]
625-		} else {
626:			obj = qpos.info.Implicits[n]
627-		}
628-		pkgname, _ := obj.(*types.PkgName)
629-		if pkgname == nil {

go/analysis/passes/pkgfact/pkgfact.go
120-}
121-
122-func imported(info *types.Info, spec *ast.ImportSpec) *types.Package {
123:	obj, ok := info.Implicits[spec]
124-	if !ok {
125-		obj = info.Defs[spec.Name] // renaming import
126-	}

go/analysis/passes/cgocall/cgocall.go
371-
372-// TODO(adonovan): make this a library function or method of Info.
373-func imported(info *types.Info, spec *ast.ImportSpec) *types.Package {
374:	obj, ok := info.Implicits[spec]
375-	if !ok {
376-		obj = info.Defs[spec.Name] // renaming import
377-	}

gopls/internal/lsp/source/highlight.go
473-	if imp.Name != nil {
474-		obj = info.Defs[imp.Name]
475-	} else {
476:		obj = info.Implicits[imp]
477-	}
478-	pkgname, ok := obj.(*types.PkgName)
479-	return pkgname, ok

internal/refactor/inline/inline.go
2088-	if imp.Name != nil {
2089-		obj = info.Defs[imp.Name]
2090-	} else {
2091:		obj = info.Implicits[imp]
2092-	}
2093-	pkgname, ok := obj.(*types.PkgName)
2094-	return pkgname, ok

rsc · 2023-10-27T03:29:45Z

This proposal has been added to the active column of the proposals project
and will now be reviewed at the weekly proposal review meetings.
— rsc for the proposal review group

rsc · 2023-11-02T17:16:43Z

Have all remaining concerns about this proposal been addressed?

In go/types, add a new method:

// PkgName returns the local package name defined by the import.
func (info *types.Info) PkgName(imp *ast.ImportSpec)

griesemer · 2023-11-02T17:32:58Z

For consistency in naming with the existing functions, and per the comment above, this should probably be:

// PkgNameOf returns the local package name defined by the import,
// or nil if it is not found.
//
// Precondition: the Defs and Implicts maps are populated.
func (info *types.Info) PkgNameOf(imp *ast.ImportSpec) *PkgName

rsc · 2023-11-10T17:28:33Z

Based on the discussion above, this proposal seems like a likely accept.
— rsc for the proposal review group

In go/types, add a new method:

// PkgNameOf returns the local package name defined by the import.
func (info *types.Info) PkgNameOf(imp *ast.ImportSpec)

gopherbot · 2023-11-10T19:11:17Z

Change https://go.dev/cl/541575 mentions this issue: go/types, types2: implement Info.PkgNameOf

For #62037. Change-Id: I354f6417232708278d3f2b2d5ea41ff48e08d6b6 Reviewed-on: https://go-review.googlesource.com/c/go/+/541575 Reviewed-by: Alan Donovan <adonovan@google.com> Reviewed-by: Robert Findley <rfindley@google.com> TryBot-Result: Gopher Robot <gobot@golang.org> Reviewed-by: Robert Griesemer <gri@google.com> Auto-Submit: Robert Griesemer <gri@google.com> Run-TryBot: Robert Griesemer <gri@google.com>

The decl.go file in cmd/compile/internal/noder has been removed as its only contained function, pkgNameOf, is now redundant. This change updates the references of this function to use the method PkgNameOf directly from the *types2.Info struct. For golang#62037

gopherbot · 2023-11-12T02:58:30Z

Change https://go.dev/cl/541738 mentions this issue: cmd/compile: remove redundant function pkgNameOf

Replace calls to pkgNameOf with calls to types2.Info.PkgNameOf. Delete function pkgNameOf and file decl.go which are not needed anymore. For #62037 Change-Id: Ib8a0411cc9eb9fdd42ee6e73c23deed2daaf73d5 GitHub-Last-Rev: 3c8928f GitHub-Pull-Request: #64075 Reviewed-on: https://go-review.googlesource.com/c/go/+/541738 TryBot-Result: Gopher Robot <gobot@golang.org> Reviewed-by: Keith Randall <khr@golang.org> Run-TryBot: Robert Griesemer <gri@google.com> Run-TryBot: qiulaidongfeng <2645477756@qq.com> Auto-Submit: Robert Griesemer <gri@google.com> Reviewed-by: Keith Randall <khr@google.com> Reviewed-by: Robert Griesemer <gri@google.com>

rsc · 2023-11-16T10:11:22Z

No change in consensus, so accepted. 🎉
This issue now tracks the work of implementing the proposal.
— rsc for the proposal review group

In go/types, add a new method:

// PkgNameOf returns the local package name defined by the import.
func (info *types.Info) PkgNameOf(imp *ast.ImportSpec)

griesemer · 2023-11-16T16:46:02Z

This has already been implemented and was submitted. Closing.

gopherbot · 2023-12-04T20:39:36Z

Change https://go.dev/cl/546975 mentions this issue: doc: add release note for go/types/PkgNameOf

For #62037. Change-Id: Id1d02f88205e5ea62662e78c8313731ec9e55b1e Reviewed-on: https://go-review.googlesource.com/c/go/+/546975 Reviewed-by: Alan Donovan <adonovan@google.com> TryBot-Bypass: Robert Griesemer <gri@google.com> Reviewed-by: Robert Griesemer <gri@google.com> Auto-Submit: Robert Griesemer <gri@google.com>

For golang#62037. Change-Id: Id1d02f88205e5ea62662e78c8313731ec9e55b1e Reviewed-on: https://go-review.googlesource.com/c/go/+/546975 Reviewed-by: Alan Donovan <adonovan@google.com> TryBot-Bypass: Robert Griesemer <gri@google.com> Reviewed-by: Robert Griesemer <gri@google.com> Auto-Submit: Robert Griesemer <gri@google.com>

adonovan added the Proposal label Aug 15, 2023

gopherbot added this to the Proposal milestone Aug 15, 2023

adonovan assigned griesemer and findleyr Aug 15, 2023

adonovan changed the title ~~proposal: go/types: add Info.ImportedPkgName method~~ proposal: go/types: add Info.PkgName method Nov 1, 2023

rsc added the Proposal-FinalCommentPeriod label Nov 10, 2023

aimuz mentioned this issue Nov 12, 2023

cmd/compile: remove redundant function pkgNameOf #64075

Closed

rsc changed the title ~~proposal: go/types: add Info.PkgName method~~ go/types: add Info.PkgName method Nov 16, 2023

rsc modified the milestones: Proposal, Backlog Nov 16, 2023

rsc added Proposal-Accepted and removed Proposal-FinalCommentPeriod labels Nov 16, 2023

griesemer closed this as completed Nov 16, 2023

mknyszek mentioned this issue Nov 22, 2023

api: audit for Go 1.22 #64343

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

go/types: add Info.PkgName method #62037

go/types: add Info.PkgName method #62037

adonovan commented Aug 15, 2023 •

edited by rsc

findleyr commented Aug 15, 2023 •

edited

adonovan commented Aug 15, 2023

findleyr commented Aug 15, 2023 •

edited

adonovan commented Oct 14, 2023

rsc commented Oct 27, 2023

rsc commented Nov 2, 2023

griesemer commented Nov 2, 2023

rsc commented Nov 10, 2023

gopherbot commented Nov 10, 2023

gopherbot commented Nov 12, 2023

rsc commented Nov 16, 2023

griesemer commented Nov 16, 2023

gopherbot commented Dec 4, 2023

go/types: add Info.PkgName method #62037

go/types: add Info.PkgName method #62037

Comments

adonovan commented Aug 15, 2023 • edited by rsc

findleyr commented Aug 15, 2023 • edited

adonovan commented Aug 15, 2023

findleyr commented Aug 15, 2023 • edited

adonovan commented Oct 14, 2023

rsc commented Oct 27, 2023

rsc commented Nov 2, 2023

griesemer commented Nov 2, 2023

rsc commented Nov 10, 2023

gopherbot commented Nov 10, 2023

gopherbot commented Nov 12, 2023

rsc commented Nov 16, 2023

griesemer commented Nov 16, 2023

gopherbot commented Dec 4, 2023

adonovan commented Aug 15, 2023 •

edited by rsc

findleyr commented Aug 15, 2023 •

edited

findleyr commented Aug 15, 2023 •

edited