Merge pull request #12 from cpunion/docs

cpunion · web-flow · commit d2a750bd528d · 2024-11-04T09:51:19.000+08:00
Docs
diff --git a/README.md b/README.md
@@ -35,12 +35,12 @@
 
 ## Examples
 
-See the [examples](_demo).
+See the [examples](demo).
 
 ### Hello World: Plot a line
 
 ```go
-// _demo/plot/plot.go
+// demo/plot/plot.go
 
 package main
 
@@ -58,7 +58,7 @@ func main() {
 ### Typed Python Objects
 
 ```go
-// _demo/plot2/plot2.go
+// demo/plot2/plot2.go
 
 package main
 
@@ -93,7 +93,7 @@ func main() {
 ### Define Python Objects with Go
 
 ```go
-// _demo/module/foo/foo.go
+// demo/module/foo/foo.go
 
 package foo
 
@@ -145,15 +145,15 @@ func InitFooModule() gp.Module {
 Call foo module from Python and Go.
 
 ```go
-// _demo/module/module.go
+// demo/module/module.go
 
 package main
 
 import (
 	"fmt"
 
 	gp "github.com/cpunion/go-python"
-	"github.com/cpunion/go-python/_demo/module/foo"
+	"github.com/cpunion/go-python/demo/module/foo"
 )
 
 func main() {
@@ -214,7 +214,7 @@ point.print()
 ### Call gradio
 
 ```go
-// _demo/gradio/gradio.go
+// demo/gradio/gradio.go
 
 package main
 
@@ -265,6 +265,7 @@ func main() {
 	}
 
 	gp.Initialize()
+	defer gp.Finalize()
 	gr = gp.ImportModule("gradio")
 	fn := gp.CreateFunc(UpdateExamples,
 		"(country, /)\n--\n\nUpdate examples based on country")
diff --git a/demo/autoderef/autoderef.go b/demo/autoderef/autoderef.go
@@ -29,7 +29,11 @@ for i in range(10):
 
 	mod := gp.ImportModule("__main__")
 	gbl := mod.Dict()
-	code := gp.CompileString(pythonCode, "<string>", gp.FileInput)
+	code, err := gp.CompileString(pythonCode, "<string>", gp.FileInput)
+	if err != nil {
+		fmt.Printf("Failed to compile Python code: %v\n", err)
+		return
+	}
 	_ = gp.EvalCode(code, gbl, gp.Nil().AsDict())
 	for i := 0; i < 10; i++ {
 		result := gp.EvalCode(code, gbl, gp.Nil().AsDict())
@@ -49,12 +53,9 @@ for i in range(10):
 		runtime.GC()
 	}
 
-	for i := 1; i <= 100000; i++ {
-		println(i)
+	for i := 1; i <= 1000000; i++ {
 		f := gp.MakeFloat(float64(i))
-		r := pymath.Sqrt(f)
-		b := r.IsInteger()
-		var _ bool = b.Bool()
+		_ = pymath.Sqrt(f)
 		if i%10000 == 0 {
 			fmt.Printf("Iteration %d in go\n", i)
 		}
diff --git a/demo/gradio/gradio.go b/demo/gradio/gradio.go
@@ -47,6 +47,7 @@ func main() {
 	}
 
 	gp.Initialize()
+	defer gp.Finalize()
 	gr = gp.ImportModule("gradio")
 	fn := gp.CreateFunc(UpdateExamples,
 		"(country, /)\n--\n\nUpdate examples based on country")
diff --git a/demo/module/foo/foo.go b/demo/module/foo/foo.go
diff --git a/demo/module/module.go b/demo/module/module.go
@@ -4,7 +4,7 @@ import (
 	"fmt"
 
 	gp "github.com/cpunion/go-python"
-	"github.com/cpunion/go-python/_demo/module/foo"
+	"github.com/cpunion/go-python/demo/module/foo"
 )
 
 func main() {
diff --git a/demo/plot/plot.go b/demo/plot/plot.go
diff --git a/demo/plot2/plot2.go b/demo/plot2/plot2.go
diff --git a/math/math_test.go b/math/math_test.go
@@ -1,14 +1,12 @@
 package math
 
 import (
-	"runtime"
 	"testing"
 
 	gp "github.com/cpunion/go-python"
 )
 
 func TestSqrt(t *testing.T) {
-	runtime.LockOSThread()
 	// Initialize Python
 	gp.Initialize()
 	defer gp.Finalize()
diff --git a/object.go b/object.go
@@ -52,6 +52,7 @@ func (obj Object) object() Object {
 
 func newObject(obj *PyObject) Object {
 	if obj == nil {
+		C.PyErr_Print()
 		return Object{}
 	}
 	o := &pyObject{obj: obj}
diff --git a/object_test.go b/object_test.go
@@ -82,7 +82,10 @@ class TestClass:
 	globals := MakeDict(nil)
 	globals.Set(MakeStr("__builtins__"), builtins.Object)
 
-	code := CompileString(pyCode, "<string>", FileInput)
+	code, err := CompileString(pyCode, "<string>", FileInput)
+	if err != nil {
+		t.Errorf("CompileString() error = %v", err)
+	}
 
 	EvalCode(code, globals, locals).AsModule()
 	testClass := locals.Get(MakeStr("TestClass")).AsFunc()
@@ -237,7 +240,10 @@ class TestClass:
 	builtins := ImportModule("builtins")
 	globals.Set(MakeStr("__builtins__"), builtins.Object)
 
-	code := CompileString(pyCode, "<string>", FileInput)
+	code, err := CompileString(pyCode, "<string>", FileInput)
+	if err != nil {
+		t.Errorf("CompileString() error = %v", err)
+	}
 	EvalCode(code, globals, locals)
 
 	testClass := locals.Get(MakeStr("TestClass")).AsFunc()
@@ -278,7 +284,10 @@ def make_tuple():
 		builtins := ImportModule("builtins")
 		globals.Set(MakeStr("__builtins__"), builtins.Object)
 
-		code := CompileString(pyCode, "<string>", FileInput)
+		code, err := CompileString(pyCode, "<string>", FileInput)
+		if err != nil {
+			t.Errorf("CompileString() error = %v", err)
+		}
 		EvalCode(code, globals, locals)
 
 		makeTuple := locals.Get(MakeStr("make_tuple")).AsFunc()
diff --git a/python.go b/python.go
@@ -8,13 +8,15 @@ import "C"
 import (
 	"fmt"
 	"reflect"
+	"runtime"
 	"unsafe"
 )
 
 type PyObject = C.PyObject
 type PyCFunction = C.PyCFunction
 
 func Initialize() {
+	runtime.LockOSThread()
 	C.Py_Initialize()
 }
 
@@ -34,14 +36,21 @@ const (
 	EvalInput   InputType = C.Py_eval_input
 )
 
-func CompileString(code, filename string, start InputType) Object {
+func CompileString(code, filename string, start InputType) (Object, error) {
 	ccode := AllocCStr(code)
 	cfilename := AllocCStr(filename)
 	o := C.Py_CompileString(ccode, cfilename, C.int(start))
 	// TODO: check why double free
 	C.free(unsafe.Pointer(ccode))
 	C.free(unsafe.Pointer(cfilename))
-	return newObject(o)
+	if o == nil {
+		err := FetchError()
+		if err != nil {
+			return Object{}, err
+		}
+		return Object{}, fmt.Errorf("failed to compile code")
+	}
+	return newObject(o), nil
 }
 
 func EvalCode(code Object, globals, locals Dict) Object {
@@ -68,7 +77,7 @@ func With[T Objecter](obj T, fn func(v T)) T {
 // ----------------------------------------------------------------------------
 
 func MainModule() Module {
-	return GetModule("__main__")
+	return ImportModule("__main__")
 }
 
 func None() Object {
@@ -89,9 +98,9 @@ func RunString(code string) error {
 	dict := main.Dict()
 
 	// Run the code string
-	codeObj := CompileString(code, "<string>", FileInput)
-	if codeObj.Nil() {
-		return fmt.Errorf("failed to compile code")
+	codeObj, err := CompileString(code, "<string>", FileInput)
+	if err != nil {
+		return err
 	}
 
 	ret := EvalCode(codeObj, dict, dict)
diff --git a/python_test.go b/python_test.go
@@ -6,7 +6,6 @@ import (
 )
 
 func setupTest(t *testing.T) {
-	runtime.LockOSThread()
 	Initialize()
 	t.Cleanup(func() {
 		runtime.GC()
@@ -72,7 +71,7 @@ func TestCompileString(t *testing.T) {
 	}
 
 	for _, tt := range tests {
-		obj := CompileString(tt.code, tt.filename, tt.start)
+		obj, _ := CompileString(tt.code, tt.filename, tt.start)
 		if obj.Nil() != tt.wantNil {
 			t.Errorf("CompileString() returned nil = %v, want %v", obj.Nil(), tt.wantNil)
 		}

Original file line number	Diff line number	Diff line change
`@@ -47,6 +47,7 @@ func main() {`
`47`	`47`	`}`
`48`	`48`
`49`	`49`	`gp.Initialize()`
	`50`	`+ defer gp.Finalize()`
`50`	`51`	`gr = gp.ImportModule("gradio")`
`51`	`52`	`fn := gp.CreateFunc(UpdateExamples,`
`52`	`53`	`"(country, /)\n--\n\nUpdate examples based on country")`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@ import (`
`4`	`4`	`"fmt"`
`5`	`5`
`6`	`6`	`gp "github.com/cpunion/go-python"`
`7`		`- "github.com/cpunion/go-python/_demo/module/foo"`
	`7`	`+ "github.com/cpunion/go-python/demo/module/foo"`
`8`	`8`	`)`
`9`	`9`
`10`	`10`	`func main() {`
Original file line number	Diff line number	Diff line change
`@@ -52,6 +52,7 @@ func (obj Object) object() Object {`
`52`	`52`
`53`	`53`	`func newObject(obj *PyObject) Object {`
`54`	`54`	`if obj == nil {`
	`55`	`+ C.PyErr_Print()`
`55`	`56`	`return Object{}`
`56`	`57`	`}`
`57`	`58`	`o := &pyObject{obj: obj}`