iblqt.core.QAlyx

class iblqt.core.QAlyx[source]

Bases: QObject

A Qt wrapper for one.webclient.AlyxClient.

__init__(base_url, parent=None)[source]

Parameters:

base_url (str)
parent (QObject | None)

login(username, password=None, cache_token=False)[source]

Try to log into Alyx.

Parameters:

username (str) – Alyx username.
password (str, optional) – Alyx password.
cache_token (bool) – If true, the token is cached for subsequent auto-logins. Default: False.

Return type:

None

logout()[source]: Log out of Alyx.

rest(*args, **kwargs)[source]

Query Alyx rest API.

A wrapper for one.webclient.AlyxClient.rest().

Parameters:

*args (Any) – Positional arguments passed to AlyxClient.rest().
**args (Any) – Keyword arguments passed to AlyxClient.rest().

Returns:

The response received from Alyx.

Return type:

Any

authenticationFailed(str): Emitted when a login attempt failed due to incorrect credentials.

property client: AlyxClient

Get the wrapped client.

Returns:

AlyxClient
The wrapped client.

connectionFailed(Exception): Emitted when a login attempt failed due to connection issues.

loggedIn(str): Emitted when successfully logged in.

loggedOut: Emitted when logged out.

statusChanged(bool): Emitted when the login status has changed.

tokenMissing(str): Emitted when a login attempt failed due to a missing cache token.