client.exceptions#

This module provides the base class for all client and server HPS-related errors.

Exceptions#

HPSError

Provides the base class for all HPS-related errors.

APIError

Provides server-side related errors.

ClientError

Provides client-side related errors.

BinaryError

Provides client-side related errors.

NotReadyError

Provides client-side related errors.

TimeoutError

Provides client-side related errors.

Functions#

raise_for_status(response)

Automatically checks HTTP errors.

async_raise_for_status(response)

Module Contents#

exception client.exceptions.HPSError(*args, **kwargs)#

Bases: requests.exceptions.RequestException

Provides the base class for all HPS-related errors.

This class derives from the requests.exceptions.RequestException base class.

Example:
>>> from ansys.hps.client import HPSError
>>> from ansys.hps.client.jms import Client
>>> try:
>>>     client = Client(url="https://127.0.0.1:8443/hps/",
                        username="repuser",
                        password="wrong_psw")
>>> except HPSError as e:
>>>     print(e)
401 Client Error: invalid_grant for: POST https://127.0.0.1:8443/hps/auth...
Invalid user credentials
reason#
description#
give_up#
exception client.exceptions.APIError(*args, **kwargs)#

Bases: HPSError

Provides server-side related errors.

exception client.exceptions.ClientError(*args, **kwargs)#

Bases: HPSError

Provides client-side related errors.

exception client.exceptions.BinaryError(*args, **kwargs)#

Bases: HPSError

Provides client-side related errors.

exception client.exceptions.NotReadyError(*args, **kwargs)#

Bases: ClientError

Provides client-side related errors.

exception client.exceptions.TimeoutError(*args, **kwargs)#

Bases: ClientError

Provides client-side related errors.

client.exceptions.raise_for_status(response: httpx.Response)#

Automatically checks HTTP errors.

This method mimics the requests.Response.raise_for_status() method.

async client.exceptions.async_raise_for_status(response: httpx.Response)#