starlarkhelper

Dec 9, 2021

Changes in this version

+ func NewListFromStrings(elems []string) *starlark.List

Oct 22, 2021

Changes in this version

+ func TraverseList(value starlark.Value, f func(starlark.Value) error) error

+ func TraverseLists(values []starlark.Value, f func(starlark.Value) error) error

Sep 27, 2021

Changes in this version

type Function

+ func (f Function) Copy() *Function

type Module

+ func (m Module) Copy() *Module

Sep 10, 2021

Changes in this version

+ type AssertableBool struct

+ Reason string

+ func NewFalseWithReason(reason string) AssertableBool

+ func (a AssertableBool) Assert() (pass bool, failReason string)

Sep 9, 2021

Changes in this version

type Module

+ SubModules []*Module

Sep 9, 2021

Changes in this version

+ func ToStringDict(globalMiddleware Middleware, elements ...map[string]interface{}) starlark.StringDict

type Function

+ Ctx context.Context

+ Middleware Middleware

+ type Middleware func(ctx context.Context, h *Helper, do BuiltinFunc) (starlark.Value, error)

+ func ChainMiddleware(middlewares ...Middleware) Middleware

type Module

+ FuncMiddleware Middleware

Sep 8, 2021

Changes in this version

type Arg

+ func BoolArg(name string) Arg

+ func BytesArg(name string) Arg

+ func FloatArg(name string) Arg

Sep 7, 2021

Changes in this version

type Arg

+ func StructArg(name string, desc *StructDescription) Arg

Aug 31, 2021

Changes in this version

+ func ToStringList(value starlark.Value) ([]string, error)

type Helper

+ func (h *Helper) GetKeywordArgsStringList(key string) ([]string, error)

+ func (h *Helper) GetKeywordArgsStringListWithDefault(key string, defaultValue []string) ([]string, error)

Aug 31, 2021

Changes in this version

+ func IsArgExist(err error) bool

+ type ErrArgExist struct

+ ArgName string

+ func (e ErrArgExist) Error() string

type Helper

+ KeywordArgs starlark.StringDict

+ PositionalArgs []starlark.Value

+ func (h *Helper) CheckContainKeywordArg(keys ...string) error

+ func (h *Helper) CheckOnlyContainKeywordArg(keys ...string) error

Aug 31, 2021

Changes in this version

+ func IsArgNotExist(err error) bool

+ func IsArgTypeMismatch(err error) bool

+ type ErrArgNotExist struct

+ ArgName string

+ func (e ErrArgNotExist) Error() string

+ type ErrArgTypeMismatch struct

+ ArgName string

+ ExpectType string

+ func (e ErrArgTypeMismatch) Error() string

type Helper

+ func (h *Helper) ContainKeywordArg(key ...string) bool

+ func (h *Helper) GetAllPositionalArgs() []starlark.Value

+ func (h *Helper) GetKeywordArgsBoolWithDefault(key string, defaultValue bool) (bool, error)

+ func (h *Helper) GetKeywordArgsInt64(key string) (int64, error)

+ func (h *Helper) GetKeywordArgsInt64WithDefault(key string, defaultValue int64) (int64, error)

+ func (h *Helper) GetKeywordArgsString(key string) (string, error)

+ func (h *Helper) GetKeywordArgsStringWithDefault(key string, defaultValue string) (string, error)

+ func (h *Helper) GetKeywordArgsUint64(key string) (uint64, error)

+ func (h *Helper) GetKeywordArgsUint64WithDefault(key string, defaultValue uint64) (uint64, error)

Aug 26, 2021

Changes in this version

+ func Hash(v string, fact uint32) uint32

Aug 24, 2021

Changes in this version

+ func AsEvalError(err error) *starlark.EvalError

+ func CallStack(err error) starlark.CallStack

Aug 17, 2021

Changes in this version

+ var ELLIPSIS = symbolArg("...")

+ var SLASH = symbolArg("/")

+ var STAR = symbolArg("*")

+ func ArgGetInDef(a Arg, mode HelpMode) string

+ func ArgGetOutDef(a Arg) string

+ func AssertFunc()

+ func CheckArgsContain(kwargs []starlark.Tuple, key ...string) bool

+ func Equal(one, another starlark.Value) bool

+ func EqualInt(one starlark.Value, another int64) bool

+ func GetExamplesDoc(examples []Example, mode HelpMode) string

+ func GetFromArgs(kwargs []starlark.Tuple, key string) starlark.Value

+ func GetFromArgsBool(kwargs []starlark.Tuple, key string, defaultValue bool) (bool, error)

+ func GetFromArgsInt64(kwargs []starlark.Tuple, key string, defaultValue int64) (int64, error)

+ func GetHelpFor(v starlark.Value, mode HelpMode) string

+ func GetHelperHelpFor(v CanHelp, mode HelpMode) string

+ func String(any fmt.Stringer) starlark.String

+ type Arg interface

+ Default func(value interface{}) Arg

+ DocLong func() string

+ DocShort func() string

+ InDefaultValue func() string

+ InName func() string

+ InType func() string

+ Long func(s string) Arg

+ Optional func() Arg

+ OutType func() string

+ Short func(s string) Arg

+ func AnyArg(name string) Arg

+ func DictArg(name string, keyType, valueType Arg) Arg

+ func FuncArg(name string, in Args, out Arg) Arg

+ func IntArg(name string) Arg

+ func ListArg(name string, innerType Arg) Arg

+ func NoneArg(name string) Arg

+ func StringArg(name string) Arg

+ func TupleArg(name string, a ...Arg) Arg

+ func UnionArg(name string, a ...Arg) Arg

+ type Args interface

+ func M(a ...Arg) Args

+ type Assertable interface

+ Assert func() (pass bool, failReason string)

+ type BasicType string

+ const TypeAny

+ const TypeBool

+ const TypeBytes

+ const TypeFloat

+ const TypeInt

+ const TypeNone

+ const TypeString

+ type BuiltinFunc func(h Helper) (starlark.Value, error)

+ func UnHelp(f StandardFunc) BuiltinFunc

+ type CanHelp interface

+ GetDefDoc func(mode HelpMode) string

+ GetFullDesc func(mode HelpMode) string

+ GetSimpleDesc func(mode HelpMode) string

+ type CustomTypeArg struct

+ Name string

+ Type starlark.Value

+ func (c CustomTypeArg) Default(value interface{}) Arg

+ func (c CustomTypeArg) DocLong() string

+ func (c CustomTypeArg) DocShort() string

+ func (c CustomTypeArg) InDefaultValue() string

+ func (c CustomTypeArg) InName() string

+ func (c CustomTypeArg) InType() string

+ func (c CustomTypeArg) Long(s string) Arg

+ func (c CustomTypeArg) Optional() Arg

+ func (c CustomTypeArg) OutType() string

+ func (c CustomTypeArg) Short(s string) Arg

+ type DataTypeMember struct

+ Examples []Example

+ Long string

+ Name string

+ Short string

+ type DocObject struct

+ func NewDocObject(h CanHelp) DocObject

+ func (d DocObject) Freeze()

+ func (d DocObject) Hash() (uint32, error)

+ func (d DocObject) String() string

+ func (d DocObject) Truth() starlark.Bool

+ func (d DocObject) Type() string

+ type DocProvider interface

+ type Example struct

+ Code string

+ Comment string

+ func (e *Example) GetDoc(mode HelpMode) string

+ type Function struct

+ ArgOut Arg

+ ArgsIn Args

+ Examples []Example

+ Fn BuiltinFunc

+ FuncName string

+ Long string

+ Short string

+ func HelpFunc() *Function

+ func NewBuiltinFunction(name string, f BuiltinFunc) *Function

+ func (f *Function) ArgsInSplit() []Arg

+ func (f *Function) CallInternal(thread *starlark.Thread, args starlark.Tuple, kwargs []starlark.Tuple) (starlark.Value, error)

+ func (f *Function) Freeze()

+ func (f *Function) GetArgOutDef() string

+ func (f *Function) GetArgsInDef() string

+ func (f *Function) GetDefDoc(mode HelpMode) string

+ func (f *Function) GetFullDesc(mode HelpMode) string

+ func (f *Function) GetSimpleDesc(mode HelpMode) string

+ func (f *Function) Hash() (uint32, error)

+ func (f *Function) Name() string

+ func (f *Function) Receiver() starlark.Value

+ func (f *Function) String() string

+ func (f *Function) Truth() starlark.Bool

+ func (f *Function) Type() string

+ type HelpMode uint8

+ const HelpModeHTML

+ const HelpModePure

+ const HelpModeTerminal

+ type Helper struct

+ Args starlark.Tuple

+ Err error

+ Fn *Function

+ Kwargs []starlark.Tuple

+ Name string

+ Thread *starlark.Thread

+ func (h *Helper) ArgsCount() int

+ func (h *Helper) CheckExactArgs(count int) error

+ func (h *Helper) CheckMinArgs(count int) error

+ func (h *Helper) ConvertString(convert starlark.String, to *string) *Helper

+ func (h *Helper) GetFirstArg() (starlark.Value, error)

+ func (h *Helper) GetKeywordArgs(key string) starlark.Value

+ func (h *Helper) GetKeywordArgsBool(key string, defaultValue bool) (bool, error)

+ func (h *Helper) Print(msg string)

+ func (h *Helper) UnpackArgs(pairs ...interface{}) *Helper

+ func (h *Helper) UnpackArgsIgnoreKeyword(pairs ...interface{}) *Helper

+ func (h *Helper) UnpackBasicArgs(pairs ...interface{}) *Helper

+ func (h *Helper) UnpackPositionalArgs(min int, vars ...interface{}) *Helper

+ type Module struct

+ Functions []*Function

+ Name string

+ PreDeclares []*PreDeclaredValue

+ Short string

+ Structs []*StructDescription

+ func (m *Module) Get() *StarlarkModule

+ type PreDeclaredValue struct

+ Examples []Example

+ Long string

+ Name string

+ Short string

+ Value starlark.Value

+ func (m *PreDeclaredValue) GetDefDoc(mode HelpMode) string

+ func (m *PreDeclaredValue) GetFullDesc(mode HelpMode) string

+ func (m *PreDeclaredValue) GetSimpleDesc(mode HelpMode) string

+ type RawDefaultString string

+ type StandardFunc func(thread *starlark.Thread, fn *Function, args starlark.Tuple, ...) (v starlark.Value, err error)

+ type StarlarkModule struct

+ func (m *StarlarkModule) GetDefDoc(mode HelpMode) string

+ func (m *StarlarkModule) GetFullDesc(mode HelpMode) string

+ func (m *StarlarkModule) GetSimpleDesc(mode HelpMode) string

+ type Struct struct

+ Descriptor *StructDescription

+ Values starlark.StringDict

+ func (s *Struct) Assert() (bool, string)

+ func (s *Struct) Attr(name string) (starlark.Value, error)

+ func (s *Struct) AttrNames() []string

+ func (s *Struct) Description() string

+ func (s *Struct) FieldEqual(name string, value starlark.Value) bool

+ func (s *Struct) Freeze()

+ func (s *Struct) Get(key starlark.Value) (v starlark.Value, found bool, err error)

+ func (s *Struct) GetDefDoc(mode HelpMode) string

+ func (s *Struct) GetFullDesc(mode HelpMode) string

+ func (s *Struct) GetSimpleDesc(mode HelpMode) string

+ func (s *Struct) Hash() (uint32, error)

+ func (s *Struct) Items() []starlark.Tuple

+ func (s *Struct) Iterate() starlark.Iterator

+ func (s *Struct) String() string

+ func (s *Struct) ToDict() *starlark.Dict

+ func (s *Struct) Truth() starlark.Bool

+ func (s *Struct) Type() string

+ type StructDescription struct

+ AssertNote string

+ AssertProvider func(s *Struct) (pass bool, failReason string)

+ Editable bool

+ Examples []Example

+ Fields map[string]Arg

+ GetProvider func(s *Struct, key starlark.Value) (v starlark.Value, found bool, err error)

+ HashProvider func(s *Struct) (uint32, error)

+ Long string

+ Name string

+ ReturnNoneForUnExistField bool

+ Short string

+ StringProvider func(s *Struct) string

+ TruthProvider func(s *Struct) starlark.Bool

+ func NewStruct(name string, args ...Arg) *StructDescription

+ func (d *StructDescription) ConstructAll(dict starlark.StringDict) (*Struct, error)

+ func (d *StructDescription) GetDefDoc(mode HelpMode) string

+ func (d *StructDescription) GetFullDesc(mode HelpMode) string

+ func (d *StructDescription) GetSimpleDesc(mode HelpMode) string

+ func (d *StructDescription) MustConstructAll(dict starlark.StringDict) *Struct

+ func (d *StructDescription) ProvideDoc() DocProvider

+ func (d *StructDescription) UnsafeConstruct(dict starlark.StringDict) *Struct

+ func (d *StructDescription) WithAssertProvider(f func(s *Struct) (pass bool, failReason string)) *StructDescription

+ type UnpackArgsFunc func(pairs ...interface{}) error