renamed Store to ModuleStore + docs

Drew O'Meara · Drew O'Meara · commit 61c783008031 · 2022-01-10T11:22:56.000-06:00
diff --git a/modules/runtime.go b/modules/runtime.go
@@ -29,7 +29,7 @@ func init() {
 
 // ctx implements py.Ctx
 type ctx struct {
-	store *py.Store
+	store *py.ModuleStore
 	opts  py.CtxOpts
 }
 
@@ -39,7 +39,7 @@ func NewCtx(opts py.CtxOpts) py.Ctx {
 		opts: opts,
 	}
 
-	ctx.store = py.NewStore()
+	ctx.store = py.NewModuleStore()
 
 	py.Import(ctx, "builtins", "sys")
 
@@ -224,6 +224,6 @@ func (ctx *ctx) GetModule(moduleName string) (*py.Module, error) {
 	return ctx.store.GetModule(moduleName)
 }
 
-func (ctx *ctx) Store() *py.Store {
+func (ctx *ctx) Store() *py.ModuleStore {
 	return ctx.store
 }
diff --git a/py/module.go b/py/module.go
@@ -42,7 +42,8 @@ type ModuleImpl struct {
 	Code    *Code  // Module code body
 }
 
-type Store struct {
+// ModuleStore is a container of Module imported into an owning py.Ctx.
+type ModuleStore struct {
 	// Registry of installed modules
 	modules map[string]*Module
 	// Builtin module
@@ -78,13 +79,13 @@ func (rt *Runtime) RegisterModule(impl *ModuleImpl) {
 	rt.ModuleImpls[impl.Info.Name] = impl
 }
 
-func NewStore() *Store {
-	return &Store{
+func NewModuleStore() *ModuleStore {
+	return &ModuleStore{
 		modules: make(map[string]*Module),
 	}
 }
 
-// Module is a runtime instance of a ModuleImpl bound the py.Ctx that imported it.
+// Module is a runtime instance of a ModuleImpl bound to the py.Ctx that imported it.
 type Module struct {
 	ModuleInfo
 
@@ -108,8 +109,10 @@ func (m *Module) GetDict() StringDict {
 	return m.Globals
 }
 
-// Define a new module
-func (store *Store) NewModule(ctx Ctx, info ModuleInfo, methods []*Method, globals StringDict) (*Module, error) {
+// NewModule adds a new Module instance to this ModuleStore.
+// Each given Method prototype is used to create a new "live" Method bound this the newly created Module.
+// This func also sets appropriate module global attribs based on the given ModuleInfo (e.g. __name__).
+func (store *ModuleStore) NewModule(ctx Ctx, info ModuleInfo, methods []*Method, globals StringDict) (*Module, error) {
 	if info.Name == "" {
 		info.Name = MainModuleName
 	}
@@ -147,7 +150,7 @@ func (store *Store) NewModule(ctx Ctx, info ModuleInfo, methods []*Method, globa
 }
 
 // Gets a module
-func (store *Store) GetModule(name string) (*Module, error) {
+func (store *ModuleStore) GetModule(name string) (*Module, error) {
 	m, ok := store.modules[name]
 	if !ok {
 		return nil, ExceptionNewf(ImportError, "Module '%s' not found", name)
@@ -156,7 +159,7 @@ func (store *Store) GetModule(name string) (*Module, error) {
 }
 
 // Gets a module or panics
-func (store *Store) MustGetModule(name string) *Module {
+func (store *ModuleStore) MustGetModule(name string) *Module {
 	m, err := store.GetModule(name)
 	if err != nil {
 		panic(err)
diff --git a/py/run.go b/py/run.go
@@ -41,7 +41,7 @@ type Ctx interface {
 	GetModule(moduleName string) (*Module, error)
 
 	// Gereric access to this context's modules / state.
-	Store() *Store
+	Store() *ModuleStore
 }
 
 // CompileOpts specifies options for high-level compilation.

Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ func init() {`
`29`	`29`
`30`	`30`	`// ctx implements py.Ctx`
`31`	`31`	`type ctx struct {`
`32`		`- store *py.Store`
	`32`	`+ store *py.ModuleStore`
`33`	`33`	`opts py.CtxOpts`
`34`	`34`	`}`
`35`	`35`
`@@ -39,7 +39,7 @@ func NewCtx(opts py.CtxOpts) py.Ctx {`
`39`	`39`	`opts: opts,`
`40`	`40`	`}`
`41`	`41`
`42`		`- ctx.store = py.NewStore()`
	`42`	`+ ctx.store = py.NewModuleStore()`
`43`	`43`
`44`	`44`	`py.Import(ctx, "builtins", "sys")`
`45`	`45`
`@@ -224,6 +224,6 @@ func (ctx ctx) GetModule(moduleName string) (py.Module, error) {`
`224`	`224`	`return ctx.store.GetModule(moduleName)`
`225`	`225`	`}`
`226`	`226`
`227`		`-func (ctx ctx) Store() py.Store {`
	`227`	`+func (ctx ctx) Store() py.ModuleStore {`
`228`	`228`	`return ctx.store`
`229`	`229`	`}`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ type Ctx interface {`
`41`	`41`	`GetModule(moduleName string) (*Module, error)`
`42`	`42`
`43`	`43`	`// Gereric access to this context's modules / state.`
`44`		`- Store() *Store`
	`44`	`+ Store() *ModuleStore`
`45`	`45`	`}`
`46`	`46`
`47`	`47`	`// CompileOpts specifies options for high-level compilation.`