research_client.agt.eel

Exposes the AGT to Python Eel.

Functions

discard(instid)

Discards a Response.

end(instid[, data])

Redirect participant in right sequence after AGT end screen.

get_traits()

Return the list of AGT stimuli.

getmissing(instid)

Gets a list of missing fields.

getversions()

Retrieves the available versions of the AGT.

init(data)

Initialises a new AGT Response.

iscomplete(instid)

Checks whether a Response is complete.

load_version(instid, sections)

Load specified sections of an AGT version implementation.

setratings(instid, data)

Adds the ratings for a given trial and redirects to the next trial.

store(instid)

Submits a (complete) Response for long-term storage.

_expose(func)[source]

Wraps, renames and exposes a function to eel.

Return type:

TypeVar(F, bound= Callable[..., Any])

Parameters:

func (F)

_getinstance(instid)[source]
Return type:

Response

Parameters:

instid (str)

_getnexttrial(instid, current_trial)[source]

Return the trial following current_trial on an AGT Response.

Return type:

Optional[str]

Parameters:
  • instid (str)

  • current_trial (str)

_handleexception(exc)[source]

Passes exception to exceptionhandler if defined, otherwise continues raising.

Return type:

None

Parameters:

exc (Exception)

discard(instid)[source]

Discards a Response.

Return type:

bool

Parameters:

instid (str)

end(instid, data=None)[source]

Redirect participant in right sequence after AGT end screen.

Return type:

str

Parameters:
  • instid (str)

  • data (Optional[dict[str, str]])

get_traits()[source]

Return the list of AGT stimuli.

getmissing(instid)[source]

Gets a list of missing fields.

Return type:

list[str]

Parameters:

instid (str)

getversions()[source]

Retrieves the available versions of the AGT.

Return type:

dict[str, str]

init(data)[source]

Initialises a new AGT Response.

Return type:

str

Parameters:

data (dict[str, Any])

iscomplete(instid)[source]

Checks whether a Response is complete.

Return type:

bool

Parameters:

instid (str)

load_version(instid, sections)[source]

Load specified sections of an AGT version implementation.

Return type:

dict[str, dict[str, Any]]

Parameters:
  • instid (str)

  • sections (list[str])

setratings(instid, data)[source]

Adds the ratings for a given trial and redirects to the next trial.

Return type:

None

Parameters:
  • instid (str)

  • data (dict[str, str])

store(instid)[source]

Submits a (complete) Response for long-term storage.

Return type:

bool

Parameters:

instid (str)

F = TypeVar(F, bound=Callable)

Type:    TypeVar

Invariant TypeVar bound to typing.Callable[…, typing.Any].