bind: slice elem method auto-wraps the handle, also maps

* fixes issue #191 (slice elem method auto-wraps the handle, including extra tests in slices), and fixes py wrapper imports to include everything referenced.

* also wrap handles for map __getitem__

* also rm gopy exe

* update after previewing PR: remove gopy.gide, don't print extra py imports, undo one usage change.

* one more cmd-exe fix

Author: sbinet

_examples/slices/slices.go

@@ -4,6 +4,8 @@
 
 package slices
 
+import "fmt"
+
 func IntSum(s []int) int {
 	sum := 0
 	for _, value := range s {
@@ -25,3 +27,23 @@ type SliceInt8 []int8
 type SliceInt16 []int16
 type SliceInt32 []int32
 type SliceInt64 []int64
+
+type SliceIface []interface{}
+
+type S struct {
+	Name string
+}
+
+func CreateSSlice() []*S {
+	return []*S{&S{"S0"}, &S{"S1"}, &S{"S2"}}
+}
+
+func PrintSSlice(ss []*S) {
+	for i, s := range ss {
+		fmt.Printf("%d: %v\n", i, s.Name)
+	}
+}
+
+func PrintS(s *S) {
+	fmt.Printf("%v\n", s.Name)
+}

_examples/slices/test.py

@@ -24,4 +24,15 @@
 si64 = slices.SliceInt64([-4,-5])
 print ("signed slice elements:", si8[0], si16[0], si32[0], si64[0])
 
+ss = slices.CreateSSlice()
+print ("struct slice: ", ss)
+print ("struct slice[0]: ", ss[0])
+print ("struct slice[1]: ", ss[1])
+print ("struct slice[2].Name: ", ss[2].Name)
+
+slices.PrintSSlice(ss)
+
+slices.PrintS(ss[0])
+slices.PrintS(ss[1])
+
 print("OK")

bind/gen.go

@@ -192,6 +192,9 @@ mod.add_include('"%[1]s_go.h"')
 mod.add_function('GoPyInit', None, [])
 `
 
+	// appended to imports in py wrap preamble as key for adding at end
+	importHereKeyString = "%%%%%%<<<<<<ADDIMPORTSHERE>>>>>>>%%%%%%%"
+
 	// 3 = specific package name, 4 = spec pkg path, 5 = doc, 6 = imports
 	PyWrapPreamble = `%[5]s
 # python wrapper for package %[4]s within overall package %[1]s
@@ -451,6 +454,18 @@ func (g *pyGen) genOut() {
 
 func (g *pyGen) genPkgWrapOut() {
 	g.pywrap.Printf("\n\n")
+	// note: must generate import string at end as imports can be added during processing
+	impstr := ""
+	for _, im := range g.pkg.pyimports {
+		if g.mode == ModeGen || g.mode == ModeBuild {
+			impstr += fmt.Sprintf("import %s\n", im)
+		} else {
+			impstr += fmt.Sprintf("from %s import %s\n", g.outname, im)
+		}
+	}
+	b := g.pywrap.buf.Bytes()
+	nb := bytes.Replace(b, []byte(importHereKeyString), []byte(impstr), 1)
+	g.pywrap.buf = bytes.NewBuffer(nb)
 	g.genPrintOut(g.pkg.pkg.Name()+".py", g.pywrap)
 }
 
@@ -529,13 +544,10 @@ func (g *pyGen) genPyWrapPreamble() {
 	for _, im := range imps {
 		ipath := im.Path()
 		if _, has := g.pkgmap[ipath]; has {
-			if g.mode == ModeGen || g.mode == ModeBuild {
-				impstr += fmt.Sprintf("import %s\n", im.Name())
-			} else {
-				impstr += fmt.Sprintf("from %s import %s\n", g.outname, im.Name())
-			}
+			g.pkg.AddPyImport(ipath, false)
 		}
 	}
+	impstr += importHereKeyString
 
 	if g.mode == ModeExe {
 		g.pywrap.Printf(PyWrapExePreamble, g.outname, g.cmdstr, n, pkgimport, pkgDoc, impstr)

bind/gen_map.go

@@ -164,9 +164,17 @@ otherwise parameter is a python list that we copy from
 		g.pywrap.Printf("def __getitem__(self, key):\n")
 		g.pywrap.Indent()
 		if ksym.hasHandle() {
-			g.pywrap.Printf("return _%s_elem(self.handle, key.handle)\n", qNm)
+			if esym.hasHandle() {
+				g.pywrap.Printf("return %s(handle=_%s_elem(self.handle, key.handle))\n", esym.pyPkgId(slc.gopkg), qNm)
+			} else {
+				g.pywrap.Printf("return _%s_elem(self.handle, key.handle)\n", qNm)
+			}
 		} else {
-			g.pywrap.Printf("return _%s_elem(self.handle, key)\n", qNm)
+			if esym.hasHandle() {
+				g.pywrap.Printf("return %s(handle=_%s_elem(self.handle, key))\n", esym.pyPkgId(slc.gopkg), qNm)
+			} else {
+				g.pywrap.Printf("return _%s_elem(self.handle, key)\n", qNm)
+			}
 		}
 		g.pywrap.Outdent()
 

bind/gen_slice.go

@@ -158,7 +158,11 @@ otherwise parameter is a python list that we copy from
 		g.pywrap.Indent()
 		g.pywrap.Printf("raise IndexError('slice index out of range')\n")
 		g.pywrap.Outdent()
-		g.pywrap.Printf("return _%s_elem(self.handle, key)\n", qNm)
+		if esym.hasHandle() {
+			g.pywrap.Printf("return %s(handle=_%s_elem(self.handle, key))\n", esym.pyPkgId(slc.gopkg), qNm)
+		} else {
+			g.pywrap.Printf("return _%s_elem(self.handle, key)\n", qNm)
+		}
 		g.pywrap.Outdent()
 		g.pywrap.Printf("else:\n")
 		g.pywrap.Indent()

bind/package.go

@@ -8,6 +8,7 @@ import (
 	"fmt"
 	"go/doc"
 	"go/types"
+	"path/filepath"
 	"reflect"
 	"strings"
 )
@@ -20,15 +21,16 @@ type Package struct {
 	sz  types.Sizes
 	doc *doc.Package
 
-	syms    *symtab // note: this is now *always* = symbols.current
-	objs    map[string]Object
-	consts  []*Const
-	vars    []*Var
-	structs []*Struct
-	ifaces  []*Interface
-	slices  []*Slice
-	maps    []*Map
-	funcs   []*Func
+	syms      *symtab // note: this is now *always* = symbols.current
+	objs      map[string]Object
+	consts    []*Const
+	vars      []*Var
+	structs   []*Struct
+	ifaces    []*Interface
+	slices    []*Slice
+	maps      []*Map
+	funcs     []*Func
+	pyimports map[string]string // extra python imports from incidental python wrapper includes
 	// calls   []*Signature // TODO: could optimize calls back into python to gen once
 }
 
@@ -52,17 +54,19 @@ func NewPackage(pkg *types.Package, doc *doc.Package) (*Package, error) {
 	fmt.Printf("\n--- Processing package: %v ---\n", pkg.Path())
 	sz := int64(reflect.TypeOf(int(0)).Size())
 	p := &Package{
-		pkg:  pkg,
-		n:    0,
-		sz:   &types.StdSizes{WordSize: sz, MaxAlign: sz},
-		doc:  doc,
-		syms: current,
-		objs: map[string]Object{},
+		pkg:       pkg,
+		n:         0,
+		sz:        &types.StdSizes{WordSize: sz, MaxAlign: sz},
+		doc:       doc,
+		syms:      current,
+		objs:      map[string]Object{},
+		pyimports: map[string]string{},
 	}
 	err := p.process()
 	if err != nil {
 		return nil, err
 	}
+
 	Packages = append(Packages, p)
 	return p, err
 }
@@ -77,6 +81,28 @@ func (p *Package) ImportPath() string {
 	return p.doc.ImportPath
 }
 
+// add given path to python imports -- these packages were referenced
+func (p *Package) AddPyImport(ipath string, extra bool) {
+	mypath := p.pkg.Path()
+	if mypath == "go" {
+		return
+	}
+	if ipath == mypath {
+		return
+	}
+	if p.pyimports == nil {
+		p.pyimports = make(map[string]string)
+	}
+	if _, has := p.pyimports[ipath]; has {
+		return
+	}
+	nm := filepath.Base(ipath)
+	p.pyimports[ipath] = nm
+	// if extra {
+	// 	fmt.Printf("%v added py import: %v = %v\n", mypath, ipath, nm)
+	// }
+}
+
 // getDoc returns the doc string associated with types.Object
 // parent is the name of the containing scope ("" for global scope)
 func (p *Package) getDoc(parent string, o types.Object) string {

bind/symbols.go

@@ -298,6 +298,9 @@ func (s *symbol) isPtrOrIface() bool {
 }
 
 func (s *symbol) hasHandle() bool {
+	if s.goname == "interface{}" {
+		return false
+	}
 	return !s.isBasic() && !s.isSignature()
 }
 
@@ -356,7 +359,8 @@ func (s *symbol) idname() string {
 // pyPkgId returns the python package-qualified version of Id
 func (s *symbol) pyPkgId(curPkg *types.Package) string {
 	pnm := s.gopkg.Name()
-	if _, has := thePyGen.pkgmap[s.gopkg.Path()]; !has { // external symbols are all in go package
+	ppath := s.gopkg.Path()
+	if _, has := thePyGen.pkgmap[ppath]; !has { // external symbols are all in go package
 		if pnm == "go" {
 			return s.id
 		} else {
@@ -368,7 +372,8 @@ func (s *symbol) pyPkgId(curPkg *types.Package) string {
 	}
 	if !s.isNamed() && (s.isMap() || s.isSlice() || s.isArray()) {
 		//		idnm := strings.TrimPrefix(s.id[uidx+1:], pnm+"_") // in case it has that redundantly
-		if s.gopkg.Path() != curPkg.Path() {
+		if ppath != curPkg.Path() {
+			thePyGen.pkg.AddPyImport(ppath, true) // ensure that this is included in current package
 			return pnm + "." + s.id
 		} else {
 			return s.id
@@ -379,7 +384,8 @@ func (s *symbol) pyPkgId(curPkg *types.Package) string {
 		return s.id // shouldn't happen
 	}
 	idnm := strings.TrimPrefix(s.id[uidx+1:], pnm+"_") // in case it has that redundantly
-	if s.gopkg.Path() != curPkg.Path() {
+	if ppath != curPkg.Path() {
+		thePyGen.pkg.AddPyImport(ppath, true) // ensure that this is included in current package
 		return pnm + "." + idnm
 	} else {
 		return idnm

cmd_exe.go

@@ -31,6 +31,8 @@ exe generates and compiles (C)Python language bindings for a Go package, includi
 
 The primary need for an exe instead of a pkg dynamic library is when the main thread must be used for something other than running the python interpreter, such as for a GUI library where the main thread must be used for running the GUI event loop (e.g., GoGi).
 
+When including multiple packages, list in order of increasing dependency, and use -name arg to give appropriate name.
+
 ex:
  $ gopy exe [options] <go-package-name> [other-go-package...]
  $ gopy exe github.com/go-python/gopy/_examples/hi

cmd_pkg.go

@@ -29,6 +29,8 @@ func gopyMakeCmdPkg() *commander.Command {
 		Long: `
 pkg generates and compiles (C)Python language bindings for a Go package, including subdirectories, and generates python module packaging suitable for distribution.  if setup.py file does not yet exist in the target directory, then it along with other default packaging files are created, using arguments.  Typically you create initial default versions of these files and then edit them, and after that, only regenerate the go binding files.
 
+When including multiple packages, list in order of increasing dependency, and use -name arg to give appropriate name.
+
 ex:
  $ gopy pkg [options] <go-package-name> [other-go-package...]
  $ gopy pkg github.com/go-python/gopy/_examples/hi