starlark: add debug API for Locals and FreeVars #539
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This change adds the following new API to allow debugging tools
and built-in functions access to the internals of Function values
and call frames:
package starlark
type Binding struct {
Name string
Pos syntax.Position
}
func (fr *frame) NumLocals() int
func (fr *frame) Local(i int) (Binding, Value)
type DebugFrame interface {
...
NumLocals() int
Local(i int) (Binding, Value)
}
func (fn *Function) NumFreeVars() int
func (fn *Function) FreeVar(i int) (Binding, Value)
This is strictly a breaking change, but the changed functions
(the Local methods) were previously documented as experimental.
The fix is straightforward.
Also, a test of DebugFrame to write an 'env' function in
a similar vein to Python's 'dir' function.
Fixes #538
jayconrod
approved these changes
Apr 11, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This change adds the following new API to allow debugging tools and built-in functions access to the internals of Function values and call frames:
package starlark
type Binding struct {
Name string
Pos syntax.Position
}
func (fr *frame) NumLocals() int
func (fr *frame) Local(i int) (Binding, Value)
type DebugFrame interface {
...
NumLocals() int
Local(i int) (Binding, Value)
}
func (fn *Function) NumFreeVars() int
func (fn *Function) FreeVar(i int) (Binding, Value)
This is strictly a breaking change, but the changed functions (the Local methods) were previously documented as experimental. The fix is straightforward.
Also, a test of DebugFrame to write an 'env' function in a similar vein to Python's 'dir' function.
Fixes #538