The exceptions.py module

Summary

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 binary-related errors.
NotReadyError	Provides not ready-related errors.
TimeoutError	Provides timeout-related errors.

Functions

raise_for_status	Automatically check for HTTP errors.
async_raise_for_status	Method for httpx.Response objects that checks HTTP errors.

Description

Provides the base class for all client and server HPS-related errors.

Module detail

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

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

Overview

Attributes

reason
description
give_up

Import detail

from ansys.hps.data_transfer.client.exceptions import HPSError

Attribute detail

HPSError.reason

HPSError.description

HPSError.give_up

exception HPSError.APIError(*args, **kwargs)

Provides server-side related errors.

Import detail

from ansys.hps.data_transfer.client.exceptions import APIError

exception HPSError.ClientError(*args, **kwargs)

Provides client-side related errors.

Import detail

from ansys.hps.data_transfer.client.exceptions import ClientError

exception HPSError.BinaryError(*args, **kwargs)

Provides binary-related errors.

Import detail

from ansys.hps.data_transfer.client.exceptions import BinaryError

exception HPSError.NotReadyError(*args, **kwargs)

Provides not ready-related errors.

Import detail

from ansys.hps.data_transfer.client.exceptions import NotReadyError

exception HPSError.TimeoutError(*args, **kwargs)

Provides timeout-related errors.

Import detail

from ansys.hps.data_transfer.client.exceptions import TimeoutError

HPSError.raise_for_status(response: httpx.Response)

Automatically check for HTTP errors.

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

async HPSError.async_raise_for_status(response: httpx.Response)

Method for httpx.Response objects that checks HTTP errors.