README
¶
go-python: Write Python in Go - The most intuitive Python wrapper for Golang
Goal
- Automatically DecRef for Python objects.
- Typed Python objects.
- Most intuitive and easy to use.
Features
- Call Python in Go.
- Basic types.
- Integers.
- Floats.
- Strings.
- Bytes.
- Booleans.
- Lists.
- Tuples.
- Dicts.
- Modules.
- Functions
- Keyword arguments.
- Mapping arguments and return values.
- Default arguments.
- Basic types.
- Call Go in Python.
- Export Go functions, struct types to Python.
- Auto export field types if it's a struct.
- Auto generate function signatures (used by gradio).
- Basic tests on common used libraries.
- matplotlib
- gradio
Plans
- Python virtual environment.
- Preprocess reference counting.
- True multi-threading.
- Support LLGo.
Examples
See the examples.
Hello World: Plot a line
package main
import . "github.com/cpunion/go-python"
func main() {
Initialize()
plt := ImportModule("matplotlib.pyplot")
plt.Call("plot", MakeTuple(5, 10), MakeTuple(10, 15), KwArgs{"color": "red"})
plt.Call("show")
}
Typed Python Objects
package main
import . "github.com/cpunion/go-python"
type plt struct {
Module
}
func Plt() plt {
return plt{ImportModule("matplotlib.pyplot")}
}
func (m plt) Plot(args ...any) Object {
return m.Call("plot", args...)
}
func (m plt) Show() {
m.Call("show")
}
func main() {
Initialize()
defer Finalize()
plt := Plt()
plt.Plot([]int{5, 10}, []int{10, 15}, KwArgs{"color": "red"})
plt.Show()
}
Define Python Objects with Go
package foo
import (
"fmt"
. "github.com/cpunion/go-python"
)
type Point struct {
X float64
Y float64
}
func (p *Point) init(x, y float64) {
p.X = x
p.Y = y
}
func (p *Point) Print() {
fmt.Printf("Point(%f, %f)\n", p.X, p.Y)
}
func (p *Point) Distance() float64 {
return p.X * p.Y
}
// Move method for Point
func (p *Point) Move(dx, dy float64) {
p.X += dx
p.Y += dy
}
func Add(a, b int) int {
return a + b
}
func InitFooModule() Module {
m := CreateModule("foo")
// Add the function to the module
m.AddMethod("add", Add, "(a, b) -> float\n--\n\nAdd two integers.")
// Add the type to the module
m.AddType(Point{}, (*Point).init, "Point", "Point objects")
return m
}
Call foo module from Python and Go.
package main
import (
"fmt"
. "github.com/cpunion/go-python"
"github.com/cpunion/go-python/demo/module/foo"
)
func main() {
Initialize()
defer Finalize()
fooMod := foo.InitFooModule()
GetModuleDict().SetString("foo", fooMod)
Main1(fooMod)
Main2()
}
func Main1(fooMod Module) {
sum := fooMod.Call("add", 1, 2).AsLong()
fmt.Printf("Sum of 1 + 2: %d\n", sum.Int64())
dict := fooMod.Dict()
Point := dict.Get(MakeStr("Point")).AsFunc()
point := Point.Call(3, 4)
fmt.Printf("dir(point): %v\n", point.Dir())
fmt.Printf("x: %v, y: %v\n", point.Attr("x"), point.Attr("y"))
distance := point.Call("distance").AsFloat()
fmt.Printf("Distance of 3 * 4: %f\n", distance.Float64())
point.Call("move", 1, 2)
fmt.Printf("x: %v, y: %v\n", point.Attr("x"), point.Attr("y"))
distance = point.Call("distance").AsFloat()
fmt.Printf("Distance of 4 * 6: %f\n", distance.Float64())
point.Call("print")
}
func Main2() {
fmt.Printf("=========== Main2 ==========\n")
_ = RunString(`
import foo
point = foo.Point(3, 4)
print("dir(point):", dir(point))
print("x:", point.x)
print("y:", point.y)
print("distance:", point.distance())
point.move(1, 2)
print("x:", point.x)
print("y:", point.y)
print("distance:", point.distance())
point.print()
`)
}
Call gradio
package main
import (
"os"
. "github.com/cpunion/go-python"
)
/*
import gradio as gr
def update_examples(country):
print("country:", country)
if country == "USA":
return gr.Dataset(samples=[["Chicago"], ["Little Rock"], ["San Francisco"]])
else:
return gr.Dataset(samples=[["Islamabad"], ["Karachi"], ["Lahore"]])
with gr.Blocks() as demo:
dropdown = gr.Dropdown(label="Country", choices=["USA", "Pakistan"], value="USA")
textbox = gr.Textbox()
examples = gr.Examples([["Chicago"], ["Little Rock"], ["San Francisco"]], textbox)
dropdown.change(update_examples, dropdown, examples.dataset)
demo.launch()
*/
var gr Module
func UpdateExamples(country string) Object {
println("country:", country)
if country == "USA" {
return gr.Call("Dataset", KwArgs{
"samples": [][]string{{"Chicago"}, {"Little Rock"}, {"San Francisco"}},
})
} else {
return gr.Call("Dataset", KwArgs{
"samples": [][]string{{"Islamabad"}, {"Karachi"}, {"Lahore"}},
})
}
}
func main() {
if len(os.Args) > 2 {
// avoid gradio start subprocesses
return
}
Initialize()
defer Finalize()
gr = ImportModule("gradio")
fn := CreateFunc("update_examples", UpdateExamples,
"(country, /)\n--\n\nUpdate examples based on country")
// Would be (in the future):
// fn := FuncOf(UpdateExamples)
demo := With(gr.Call("Blocks"), func(v Object) {
dropdown := gr.Call("Dropdown", KwArgs{
"label": "Country",
"choices": []string{"USA", "Pakistan"},
"value": "USA",
})
textbox := gr.Call("Textbox")
examples := gr.Call("Examples", [][]string{{"Chicago"}, {"Little Rock"}, {"San Francisco"}}, textbox)
dataset := examples.Attr("dataset")
dropdown.Call("change", fn, dropdown, dataset)
})
demo.Call("launch")
}
Documentation
¶
Index ¶
- func AllocCStr(s string) *C.char
- func AllocCStrDontFree(s string) *C.char
- func Cast[U, T Objecter](obj T) (u U)
- func FetchError() error
- func Finalize()
- func GoString(s *C.char) string
- func GoStringN(s *C.char, n int) string
- func Initialize()
- func RunString(code string) error
- func SetError(err error)
- func SetTypeError(err error)
- func ToValue(obj Object, v reflect.Value) bool
- func With[T Objecter](obj T, fn func(v T)) T
- type Bool
- type Bytes
- type Char
- type Complex
- type Dict
- func (d Dict) Del(key Objecter)
- func (obj Dict) Ensure()
- func (d Dict) Get(key Objecter) Object
- func (d Dict) GetString(key string) Object
- func (d Dict) HasKey(key any) bool
- func (d Dict) Items() func(fn func(key, value Object) bool)
- func (obj Dict) Nil() bool
- func (d Dict) Set(key, value Objecter)
- func (d Dict) SetString(key string, value Objecter)
- type Float
- type Func
- type InputType
- type Int
- type KwArgs
- type List
- type Long
- type Module
- type Object
- func (obj Object) AsBool() Bool
- func (obj Object) AsBytes() Bytes
- func (obj Object) AsComplex() Complex
- func (obj Object) AsDict() Dict
- func (obj Object) AsFloat() Float
- func (obj Object) AsFunc() Func
- func (obj Object) AsList() List
- func (obj Object) AsLong() Long
- func (obj Object) AsModule() Module
- func (obj Object) AsStr() Str
- func (obj Object) AsTuple() Tuple
- func (obj Object) Attr(name string) Object
- func (obj Object) AttrBool(name string) Bool
- func (obj Object) AttrBytes(name string) Bytes
- func (obj Object) AttrDict(name string) Dict
- func (obj Object) AttrFloat(name string) Float
- func (obj Object) AttrFunc(name string) Func
- func (obj Object) AttrList(name string) List
- func (obj Object) AttrLong(name string) Long
- func (obj Object) AttrString(name string) Str
- func (obj Object) AttrTuple(name string) Tuple
- func (obj Object) Call(name string, args ...any) Object
- func (obj Object) Dir() List
- func (obj Object) Ensure()
- func (obj Object) Equals(other Objecter) bool
- func (obj Object) IsBool() bool
- func (obj Object) IsBytes() bool
- func (obj Object) IsComplex() bool
- func (obj Object) IsDict() bool
- func (obj Object) IsFloat() bool
- func (obj Object) IsList() bool
- func (obj Object) IsLong() bool
- func (obj Object) IsStr() bool
- func (obj Object) IsTuple() bool
- func (obj Object) Nil() bool
- func (obj Object) Obj() *PyObject
- func (obj Object) Repr() string
- func (obj Object) SetAttr(name string, value any)
- func (obj Object) String() string
- func (obj Object) Type() Object
- type Objecter
- type Pointer
- type PyCFunction
- type PyObject
- type Str
- type Tuple
- type WChar
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AllocCStrDontFree ¶
func Initialize ¶
func Initialize()
func SetTypeError ¶
func SetTypeError(err error)
Types ¶
type Complex ¶
type Complex struct {
Object
}
func MakeComplex ¶
func MakeComplex(f complex128) Complex
func (Complex) Complex128 ¶
func (c Complex) Complex128() complex128
type Dict ¶
type Dict struct {
Object
}
func DictFromPairs ¶
func GetModuleDict ¶
func GetModuleDict() Dict
type Float ¶
type Float struct {
Object
}
Float represents a Python float object. It provides methods to convert between Go float types and Python float objects, as well as checking numeric properties.
type InputType ¶
const ( SingleInput InputType = C.Py_single_input FileInput InputType = C.Py_file_input EvalInput InputType = C.Py_eval_input )
type Long ¶
type Long struct {
Object
}
func LongFromFloat64 ¶
func LongFromString ¶
func LongFromUintptr ¶
func LongFromUnicode ¶
type Module ¶
type Module struct {
Object
}
func CreateModule ¶
func ImportModule ¶
func MainModule ¶
func MainModule() Module
type Object ¶
type Object struct {
// contains filtered or unexported fields
}
func (Object) AttrString ¶
type Objecter ¶
type Objecter interface {
Obj() *PyObject
Ensure()
// contains filtered or unexported methods
}
type PyCFunction ¶
type PyCFunction = C.PyCFunction
Source Files
¶
Directories
Click to show internal directories.
Click to hide internal directories.