startf

README

Qri Starlark Transformation Syntax

Qri ("query") is about datasets. Transformations are repeatable scripts for generating a dataset. Starlark is a scripting language from Google that feels a lot like python. This package implements starlark as a transformation syntax. Starlark tranformations are about as close as one can get to the full power of a programming language as a transformation syntax. Often you need this degree of control to generate a dataset.

Typical examples of a starlark transformation include:

• combining paginated calls to an API into a single dataset
• downloading unstructured structured data from the internet to extract
• pulling raw data off the web & turning it into a datset

We're excited about starlark for a few reasons:

• python syntax - many people working in data science these days write python, we like that, starlark likes that. dope.
• deterministic subset of python - unlike python, starlark removes properties that reduce introspection into code behaviour. things like while loops and recursive functions are omitted, making it possible for qri to infer how a given transformation will behave.
• parallel execution - thanks to this deterministic requirement (and lack of global interpreter lock) starlark functions can be executed in parallel. Combined with peer-2-peer networking, we're hoping to advance tranformations toward peer-driven distribed computing. More on that in the coming months.

Getting started

If you're mainly interested in learning how to write starlark transformations, our documentation is a better place to start. If you're interested in contributing to the way starlark transformations work, this is the place!

The easiest way to see starlark transformations in action is to use qri. This startf package powers all the starlark stuff in qri. Assuming you have the go programming language the following should work from a terminal:

# get this package
$ go get github.com/qri-io/startf

# navigate to package
$ cd $GOPATH/src/github.com/qri-io/startf

# run tests
$ go test ./...

Often the next steps are to install qri, mess with this startf package, then rebuild qri with your changes to see them in action within qri itself.

Starlark Special Functions

Special Functions are the core of a starlark transform script. Here's an example of a simple data function that sets the body of a dataset to a constant:

def transform(ds,ctx):
  ds.set_meta(["hello","world"])

Here's something slightly more complicated (but still very contrived) that modifies a dataset by adding up the length of all of the elements in a dataset body

def transform(ds, ctx):
  body = qri.get_body()
  if body != None:
    count = 0
    for entry in body:
      count += len(entry)
  ds.set_body([{"total": count}])

Starlark special functions have a few rules on top of starlark itself:

• special functions always accept a transformation context (the ctx arg)
• When you define a data function, qri calls it for you
• All special functions are optional (you don't need to define them), except transform. transform is required.
• Special functions are always called in the same order

More docs on the provide API is coming soon.

Running a transform

Let's say the above function is saved as transform.star. First, create a dataset file (saved as dataset.yaml, for example) with at least the minimal structure:

name: dataset_name
transform:
  scriptpath: transform.star
  config:
    org: qri-io
    repo: frontend

Then invoke qri:

qri save --file=config.yaml

Fun! More info over on our docs site

---

Documentation

Overview

Package startf implements dataset transformations using the starlark programming dialect For more info on starlark check github.com/google/starlark

Index

• Constants
• Variables
• func AddMutateFieldCheck(check func(path ...string) error) func(o *ExecOpts)
• func AddQriNodeOpt(node *p2p.QriNode) func(o *ExecOpts)
• func DefaultExecOpts(o *ExecOpts)
• func Error(thread *starlark.Thread, _ *starlark.Builtin, args starlark.Tuple, ...) (starlark.Value, error)
• func ExecScript(ds *dataset.Dataset, opts ...func(o *ExecOpts)) error
• func SetOutWriter(w io.Writer) func(o *ExecOpts)
• type EntryReader
  • func NewEntryReader(st *dataset.Structure, iter starlark.Iterable) *EntryReader
  • func (r *EntryReader) Close() error
  • func (r *EntryReader) ReadEntry() (e dsio.Entry, err error)
  • func (r *EntryReader) Structure() *dataset.Structure
• type ExecOpts
• type HTTPGuard
  • func (h *HTTPGuard) Allowed(req *http.Request) error
  • func (h *HTTPGuard) DisableNtwk()
  • func (h *HTTPGuard) EnableNtwk()
• type ModuleLoader

Constants

const Version = "0.3.2"

Version is the current version of this startf, this version number will be written with each transformation exectution

Variables

var DefaultModuleLoader = func(thread *starlark.Thread, module string) (dict starlark.StringDict, err error) {
	return starlib.Loader(thread, module)
}

DefaultModuleLoader is the loader ExecScript will use unless configured otherwise

var ErrNotDefined = fmt.Errorf("not defined")

ErrNotDefined is for when a starlark value is not defined or does not exist

var (

	// ErrNtwkDisabled is returned whenever a network call is attempted but h.NetworkEnabled is false
	ErrNtwkDisabled = fmt.Errorf("network use is disabled. http can only be used during download step")
)

Functions

func AddMutateFieldCheck

func AddMutateFieldCheck(check func(path ...string) error) func(o *ExecOpts)

AddMutateFieldCheck provides a checkFunc to ExecScript

func AddQriNodeOpt

func AddQriNodeOpt(node *p2p.QriNode) func(o *ExecOpts)

AddQriNodeOpt adds a qri node to execution options

func DefaultExecOpts

func DefaultExecOpts(o *ExecOpts)

DefaultExecOpts applies default options to an ExecOpts pointer

func Error

func Error(thread *starlark.Thread, _ *starlark.Builtin, args starlark.Tuple, kwargs []starlark.Tuple) (starlark.Value, error)

Error halts program execution with an error

func ExecScript

func ExecScript(ds *dataset.Dataset, opts ...func(o *ExecOpts)) error

ExecScript executes a transformation against a starlark script file, giving back an EntryReader of resulting data ExecScript modifies the given dataset pointer. At bare minimum it will set transformation details, but starlark scripts can modify many parts of the dataset pointer, including meta, structure, and transform the returned io.Reader contains printed output from script execution

func SetOutWriter

func SetOutWriter(w io.Writer) func(o *ExecOpts)

SetOutWriter provides a writer to record the "stderr" diagnostic output of the transform script

Types

type EntryReader

type EntryReader struct {
	// contains filtered or unexported fields
}

EntryReader implements the dsio.EntryReader interface for starlark.Iterable's

func NewEntryReader

func NewEntryReader(st *dataset.Structure, iter starlark.Iterable) *EntryReader

NewEntryReader creates a new Entry Reader

func (*EntryReader) Close

func (r *EntryReader) Close() error

Close finalizes the reader

func (*EntryReader) ReadEntry

func (r *EntryReader) ReadEntry() (e dsio.Entry, err error)

ReadEntry reads one entry from the reader

func (*EntryReader) Structure

func (r *EntryReader) Structure() *dataset.Structure

Structure gives this reader's structure

type ExecOpts

type ExecOpts struct {
	Node             *p2p.QriNode               // supply a QriNode to make the 'qri' module available in starlark
	AllowFloat       bool                       // allow floating-point numbers
	AllowSet         bool                       // allow set data type
	AllowLambda      bool                       // allow lambda expressions
	AllowNestedDef   bool                       // allow nested def statements
	Secrets          map[string]interface{}     // passed-in secrets (eg: API keys)
	Globals          starlark.StringDict        // global values to pass for script execution
	MutateFieldCheck func(path ...string) error // func that errors if field specified by path is mutated
	OutWriter        io.Writer                  // provide a writer to record script "stdout" to
	ModuleLoader     ModuleLoader               // starlark module loader function
}

ExecOpts defines options for execution

type HTTPGuard

type HTTPGuard struct {
	NetworkEnabled bool
}

HTTPGuard protects network requests, only allowing when network is enabled

func (*HTTPGuard) Allowed

func (h *HTTPGuard) Allowed(req *http.Request) error

Allowed implements starlib/http RequestGuard

func (*HTTPGuard) DisableNtwk

func (h *HTTPGuard) DisableNtwk()

DisableNtwk prevents network calls from succeeding

func (*HTTPGuard) EnableNtwk

func (h *HTTPGuard) EnableNtwk()

EnableNtwk allows network calls

type ModuleLoader

type ModuleLoader func(thread *starlark.Thread, module string) (starlark.StringDict, error)

ModuleLoader is a function that can load starlark modules