mxcubecore.HardwareObjects.abstract.PyISPyBRestClient#

Classes

PyISPyBRestClient(rest_root[, timeout])

REST client for PyISPyB.

Exceptions

AuthenticationExpired

Raised when authentication refresh failed.

NoTokenException

Exception raised when no token is returned from authentication.

PyISPyBUnsuccessfulResponse

Exception raised when a response from the server is unsuccessful (not 200).
exception mxcubecore.HardwareObjects.abstract.PyISPyBRestClient.AuthenticationExpired[source]#

Bases: Exception

Raised when authentication refresh failed.

exception mxcubecore.HardwareObjects.abstract.PyISPyBRestClient.NoTokenException[source]#

Bases: Exception

Exception raised when no token is returned from authentication.

class mxcubecore.HardwareObjects.abstract.PyISPyBRestClient.PyISPyBRestClient(rest_root: str, timeout: int = 5)[source]#

Bases: object

REST client for PyISPyB.

It handles authentication and communication with PyISPyB REST API.

Parameters:

  • rest_root (str) –

  • timeout (int) –

exception mxcubecore.HardwareObjects.abstract.PyISPyBRestClient.PyISPyBUnsuccessfulResponse[source]#

Bases: Exception

Exception raised when a response from the server is unsuccessful (not 200).