yaegi

Yaegi 是另一个优雅的 Go 解释器。 它为可执行的 Go 脚本和插件提供支持，可用于嵌入式解释器或交互式 shell，基于 Go 运行时。

特性

• 完全支持 Go 语言规范
• 使用纯 Go 编写，仅使用标准库
• 简单的解释器 API：New()、Eval()、Use()
• 可在 Go 支持的任何地方运行
• 所有 Go 和运行时资源都可从脚本访问（可控制）
• 安全性：默认情况下不使用也不导出 unsafe 和 syscall 包
• 支持最新的两个主要 Go 版本（Go 1.21 和 Go 1.22）

安装

Go 包

import "github.com/traefik/yaegi/interp"

命令行可执行文件

go install github.com/traefik/yaegi/cmd/yaegi@latest

注意，您可以使用 rlwrap（使用您喜欢的包管理器安装）， 并在 ~/.bashrc 中将 yaegi 命令别名为 alias yaegi='rlwrap yaegi'，以获得历史记录和命令行编辑功能。

CI 集成

curl -sfL https://raw.githubusercontent.com/traefik/yaegi/master/install.sh | bash -s -- -b $GOPATH/bin v0.9.0

使用方法

作为嵌入式解释器

使用 New() 创建解释器，使用 Eval() 运行 Go 代码：

package main

import (
	"github.com/traefik/yaegi/interp"
	"github.com/traefik/yaegi/stdlib"
)

func main() {
	i := interp.New(interp.Options{})

	i.Use(stdlib.Symbols)

	_, err := i.Eval(`import "fmt"`)
	if err != nil {
		panic(err)
	}

	_, err = i.Eval(`fmt.Println("Hello Yaegi")`)
	if err != nil {
		panic(err)
	}
}

Go Playground

作为动态扩展框架

以下程序是预先编译的，除了 bar() 是解释执行的，具体步骤如下：

1. 使用 i.Eval(src) 在解释器上下文中评估脚本
2. 使用 v, err := i.Eval("foo.Bar") 从解释器上下文获取符号，作为 reflect.Value
3. 应用 Interface() 方法和类型断言将 v 转换为 bar，就像它是编译好的一样

package main

import "github.com/traefik/yaegi/interp"

const src = `package foo
func Bar(s string) string { return s + "-Foo" }`

func main() {
	i := interp.New(interp.Options{})

	_, err := i.Eval(src)
	if err != nil {
		panic(err)
	}

	v, err := i.Eval("foo.Bar")
	if err != nil {
		panic(err)
	}

	bar := v.Interface().(func(string) string)

	r := bar("Kung")
	println(r)
}

Go Playground

作为命令行解释器

Yaegi 命令可以运行交互式的读取-求值-打印循环（REPL）：

$ yaegi
> 1 + 2
3
> import "fmt"
> fmt.Println("Hello World")
Hello World
>

请注意，在交互模式下，所有标准库包都是预先导入的， 您可以直接使用它们：

$ yaegi
> reflect.TypeOf(time.Date)
: func(int, time.Month, int, int, int, int, int, *time.Location) time.Time
>

或者解释 Go 包、目录或文件，包括它自身：

$ yaegi -syscall -unsafe -unrestricted github.com/traefik/yaegi/cmd/yaegi
>

或者在 shebang 行中用于 Go 脚本：

$ cat /tmp/test
#!/usr/bin/env yaegi
package main

import "fmt"

func main() {
	fmt.Println("test")
}
$ ls -la /tmp/test
-rwxr-xr-x 1 dow184 dow184 93 Jan  6 13:38 /tmp/test
$ /tmp/test
test

文档

有关 Yaegi 命令和库的文档可以在常用的 godoc.org 上找到。

内部设计的关键文档：https://marc.vertes.org/yaegi-internals/ 另请参阅 interp/trace.go 以获取有用的打印命令，以查看编译过程中发生的情况。

限制

除了预计在短期内修复的已知错误外，还有一些暂时不计划解决的限制：

• 不支持汇编文件（.s）。
• 不支持调用 C 代码（没有虚拟的 "C" 包）。
• 不支持有关编译器、链接器或嵌入文件的指令。
• 无法动态添加要从预编译代码中使用的接口，因为需要预编译接口包装器。
• 使用 reflect 表示类型和使用 %T 打印值在编译模式和解释模式下可能会产生不同的结果。
• 解释计算密集型代码可能会比编译模式慢得多。

目前还不支持 Go 模块。在支持之前，需要将源代码安装到 $GOPATH/src/github.com/traefik/yaegi 以通过所有测试。

贡献

贡献指南。

许可证

Apache 2.0。