Gafaelfawr Python client API#

rubin.gafaelfawr Package#

Client for Gafaelfawr.

Functions#

register_mock_gafaelfawr(respx_mock)

Mock out Gafaelfawr.

Classes#

GafaelfawrClient([http_client, ...])

Client for the Gafaelfawr service API.

GafaelfawrDiscoveryError(message[, user, ...])

Gafaelfawr was not found in service discovery.

GafaelfawrError(message[, user, failed_at])

Base class for Gafaelfawr client exceptions.

GafaelfawrGroup(**data)

Information about a single group.

GafaelfawrNotFoundError(message, *[, ...])

An HTTP request failed with a 404 response.

GafaelfawrNotebookQuota(**data)

Notebook Aspect quota information for a user.

GafaelfawrQuota(**data)

Quota information for a user.

GafaelfawrTapQuota(**data)

TAP quota information for a user.

GafaelfawrTokenData(**data)

Metadata about a token.

GafaelfawrUserInfo(**data)

Information about a user.

GafaelfawrValidationError(message[, user, ...])

Gafaelfawr response did not validate against the expected model.

GafaelfawrWebError(message, *[, failed_at, ...])

An HTTP request failed.

MockGafaelfawr()

Mock for the parts of the Gafaelfawr API used by the client.

MockGafaelfawrAction(*values)

Possible actions that could fail.

Class Inheritance Diagram#

Inheritance diagram of rubin.gafaelfawr._client.GafaelfawrClient, rubin.gafaelfawr._exceptions.GafaelfawrDiscoveryError, rubin.gafaelfawr._exceptions.GafaelfawrError, rubin.gafaelfawr._models.GafaelfawrGroup, rubin.gafaelfawr._exceptions.GafaelfawrNotFoundError, rubin.gafaelfawr._models.GafaelfawrNotebookQuota, rubin.gafaelfawr._models.GafaelfawrQuota, rubin.gafaelfawr._models.GafaelfawrTapQuota, rubin.gafaelfawr._models.GafaelfawrTokenData, rubin.gafaelfawr._models.GafaelfawrUserInfo, rubin.gafaelfawr._exceptions.GafaelfawrValidationError, rubin.gafaelfawr._exceptions.GafaelfawrWebError, rubin.gafaelfawr._mock.MockGafaelfawr, rubin.gafaelfawr._mock.MockGafaelfawrAction