Attention

You’re viewing an old version of the L’ART Research Assistant documentation. The project has moved to https://lart.readthedocs.io/projects/research-assistant.

research_client.lsbq.eel

Exposes the LSBQe to Python Eel.

Functions

`discard`(instid)	Discards a Response.
`getmissing`(instid)	Gets a list of missing fields.
`getversions`()	Retrieves the available versions of the LSBQe.
`init`(data)	Initialises a new LSBQe Response.
`iscomplete`(instid)	Checks whether a Response is complete.
`load_version`(instid, sections)	Load specified sections of an LSBQe version implementation.
`setclub`(instid, data)	Adds Community Language Use Behaviour Data to a Response.
`setldb`(instid, data)	Adds Language and Dialect Background Data to a Response.
`setlsb`(instid, data)	Adds Language and Social Background Data to a Response.
`setnotes`(instid, data)	Adds Participant and Experimenter Comments Data to a Response.
`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)

_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)

getmissing(instid)[source]

Gets a list of missing fields.

Return type:: list[str]
Parameters:: instid (str)

getversions()[source]

Retrieves the available versions of the LSBQe.

Return type:: dict[str, str]

init(data)[source]

Initialises a new LSBQe 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 LSBQe version implementation.

Return type:

dict[str, dict[str, Any]]

Parameters:

instid (str)
sections (list[str])

setclub(instid, data)[source]

Adds Community Language Use Behaviour Data to a Response.

Return type:

str

Parameters:

instid (str)
data (dict[str, Any])

setldb(instid, data)[source]

Adds Language and Dialect Background Data to a Response.

Return type:

str

Parameters:

instid (str)
data (dict[str, Any])

setlsb(instid, data)[source]

Adds Language and Social Background Data to a Response.

Return type:

str

Parameters:

instid (str)
data (dict[str, str])

setnotes(instid, data)[source]

Adds Participant and Experimenter Comments Data to a Response.

Return type:

str

Parameters:

instid (str)
data (dict[str, Any])

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].