sweetbean.variable

CodeVariable

Bases: Variable

A variable to access JavaScript code.

Source code in sweetbean/variable/__init__.py

class CodeVariable(Variable):
    """
    A variable to access JavaScript code.
    """

    def __init__(self, name, value):
        """
        Arguments:
            name: the name of the variable
            value: the initial value of the variable
        """
        super().__init__(name)
        self.value = value

    def set(self):
        return f"let {self.name}={self.value};"

    def to_js(self):
        return self.name

__init__(name, value)

Parameters:

Name	Type	Description	Default
name		the name of the variable	required
value		the initial value of the variable	required

Source code in sweetbean/variable/__init__.py

def __init__(self, name, value):
    """
    Arguments:
        name: the name of the variable
        value: the initial value of the variable
    """
    super().__init__(name)
    self.value = value

DataVariable

Bases: Variable

A data variable for jsPsych to access data of previous trials.

Source code in sweetbean/variable/__init__.py

class DataVariable(Variable):
    """
    A data variable for jsPsych to access data of previous trials.
    """

    def __init__(self, name, window):
        """
        Arguments:
            name: the name of the variable
            window: the window of the data
        """
        super().__init__(name)
        self.name = f'data["bean_{name}"]'
        self.raw_name = name
        self.window = window

    def to_js(self):
        if self.window == 0:
            return self.name
        return f"jsPsych.data.get().last({self.window})['trials'][0]['bean_{self.raw_name}']"

__init__(name, window)

Parameters:

Name	Type	Description	Default
name		the name of the variable	required
window		the window of the data	required

Source code in sweetbean/variable/__init__.py

def __init__(self, name, window):
    """
    Arguments:
        name: the name of the variable
        window: the window of the data
    """
    super().__init__(name)
    self.name = f'data["bean_{name}"]'
    self.raw_name = name
    self.window = window

FunctionVariable

Bases: Variable

A variable that is the result of a function. Examples: >>> def add(a, b): ... return a + b >>> FunctionVariable('a', add, [1, 2]).to_js() ((a,b) => {return a+b})(1, 2)

Source code in sweetbean/variable/__init__.py

class FunctionVariable(Variable):
    """
    A variable that is the result of a function.
    Examples:
        >>> def add(a, b):
        ...     return a + b
        >>> FunctionVariable('a', add, [1, 2]).to_js()
        ((a,b) => {return a+b})(1, 2)

    """

    def __init__(self, name, fct, args):
        """
        Arguments:
            name: the name of the variable
            fct: the function
            args: the arguments of the function
        """
        super().__init__(name)
        self.fct = fct
        self.args = args

    def to_js(self):
        fct_declaration = _fct_to_js(self.fct)
        fct_input = _fct_args_to_js(self.args)
        return f"({fct_declaration}){fct_input}"

__init__(name, fct, args)

Parameters:

Name	Type	Description	Default
name		the name of the variable	required
fct		the function	required
args		the arguments of the function	required

Source code in sweetbean/variable/__init__.py

def __init__(self, name, fct, args):
    """
    Arguments:
        name: the name of the variable
        fct: the function
        args: the arguments of the function
    """
    super().__init__(name)
    self.fct = fct
    self.args = args

SharedVariable

A variable that can be shared between different stimuli.

Source code in sweetbean/variable/__init__.py

class SharedVariable:
    """
    A variable that can be shared between different stimuli.
    """

    def __init__(self, name, value):
        """
        Arguments:
            name: the name of the variable
            value: the initial value of the variable
        """
        self.name = str(name)
        self.value = value

    def set(self):
        return f"let {self.name}={self.value};"

    def to_js(self):
        return self.name

__init__(name, value)

Parameters:

Name	Type	Description	Default
name		the name of the variable	required
value		the initial value of the variable	required

Source code in sweetbean/variable/__init__.py

def __init__(self, name, value):
    """
    Arguments:
        name: the name of the variable
        value: the initial value of the variable
    """
    self.name = str(name)
    self.value = value

SideEffect

Source code in sweetbean/variable/__init__.py

class SideEffect:
    def __init__(self, set_variable, get_variable):
        """
        A side effect that can set variables.

        Arguments:
            set_variable: the variable to set (often a SharedVariable)
            get_variable: the variable to get (e.g, the variable the set variable should be set to)
        """
        self.set_variable = set_variable
        self.get_variable = get_variable

    def to_js(self):
        return f"{self.set_variable.name}={_var_to_js(self.get_variable)};"

__init__(set_variable, get_variable)

A side effect that can set variables.

Parameters:

Name	Type	Description	Default
set_variable		the variable to set (often a SharedVariable)	required
get_variable		the variable to get (e.g, the variable the set variable should be set to)	required

Source code in sweetbean/variable/__init__.py

def __init__(self, set_variable, get_variable):
    """
    A side effect that can set variables.

    Arguments:
        set_variable: the variable to set (often a SharedVariable)
        get_variable: the variable to get (e.g, the variable the set variable should be set to)
    """
    self.set_variable = set_variable
    self.get_variable = get_variable

TimelineVariable

Bases: Variable

A timeline variable for jsPsych.

Source code in sweetbean/variable/__init__.py

class TimelineVariable(Variable):
    """
    A timeline variable for jsPsych.
    """

    def to_js(self):
        return f"jsPsych.timelineVariable('{self.name}')"

Variable

Bases: ABC

A base class for variables.

Source code in sweetbean/variable/__init__.py

class Variable(ABC):
    """
    A base class for variables.
    """

    def __init__(self, name):
        self.name = name

    @abstractmethod
    def to_js(self):
        pass