Summary#

Exceptions

`PyRockyError`	Provides the generic exception for the PyRocky API.
`RockyLaunchError`	Provides the error raised when problems occurs during launch of the Rocky app.
`RockyApiError`	Provides the `Exception` class for an error generated in the API layer.

Description#

Module where the exceptions of the project are contained.

Module detail#

exception exceptions.PyRockyError#

Bases: Exception

Provides the generic exception for the PyRocky API.

Overview#

Methods

with_traceback

Exception.with_traceback(tb) –

Special methods

`__delattr__`	Implement delattr(self, name).
`__dir__`	Default dir() implementation.
`__eq__`	Return self==value.
`__format__`	Default object formatter.
`__ge__`	Return self>=value.
`__getattribute__`	Return getattr(self, name).
`__gt__`	Return self>value.
`__hash__`	Return hash(self).
`__le__`	Return self<=value.
`__lt__`	Return self
`__ne__`	Return self!=value.
`__reduce__`	Helper for pickle.
`__reduce_ex__`	Helper for pickle.
`__repr__`	Return repr(self).
`__setattr__`	Implement setattr(self, name, value).
`__setstate__`
`__sizeof__`	Size of object in memory, in bytes.
`__str__`	Return str(self).
`__subclasshook__`	Abstract classes can override this to customize issubclass().

Import detail#

from ansys.rocky.core.exceptions import PyRockyError

Method detail#

PyRockyError.__delattr__()#: Implement delattr(self, name).

PyRockyError.__dir__()#: Default dir() implementation.

PyRockyError.__eq__()#: Return self==value.

PyRockyError.__format__()#: Default object formatter.

PyRockyError.__ge__()#: Return self>=value.

PyRockyError.__getattribute__()#: Return getattr(self, name).

PyRockyError.__gt__()#: Return self>value.

PyRockyError.__hash__()#: Return hash(self).

PyRockyError.__le__()#: Return self<=value.

PyRockyError.__lt__()#: Return self

PyRockyError.__ne__()#: Return self!=value.

PyRockyError.__reduce__()#: Helper for pickle.

PyRockyError.__reduce_ex__()#: Helper for pickle.

PyRockyError.__repr__()#: Return repr(self).

PyRockyError.__setattr__()#: Implement setattr(self, name, value).

PyRockyError.__setstate__()#

PyRockyError.__sizeof__()#: Size of object in memory, in bytes.

PyRockyError.__str__()#: Return str(self).

PyRockyError.__subclasshook__()#

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

PyRockyError.with_traceback()#: Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception PyRockyError.RockyLaunchError#

Bases: PyRockyError

Provides the error raised when problems occurs during launch of the Rocky app.

Overview#

Methods

with_traceback

Exception.with_traceback(tb) –

Special methods

`__delattr__`	Implement delattr(self, name).
`__dir__`	Default dir() implementation.
`__eq__`	Return self==value.
`__format__`	Default object formatter.
`__ge__`	Return self>=value.
`__getattribute__`	Return getattr(self, name).
`__gt__`	Return self>value.
`__hash__`	Return hash(self).
`__le__`	Return self<=value.
`__lt__`	Return self
`__ne__`	Return self!=value.
`__reduce__`	Helper for pickle.
`__reduce_ex__`	Helper for pickle.
`__repr__`	Return repr(self).
`__setattr__`	Implement setattr(self, name, value).
`__setstate__`
`__sizeof__`	Size of object in memory, in bytes.
`__str__`	Return str(self).
`__subclasshook__`	Abstract classes can override this to customize issubclass().

Import detail#

from ansys.rocky.core.exceptions import RockyLaunchError

Method detail#

RockyLaunchError.__delattr__()#: Implement delattr(self, name).

RockyLaunchError.__dir__()#: Default dir() implementation.

RockyLaunchError.__eq__()#: Return self==value.

RockyLaunchError.__format__()#: Default object formatter.

RockyLaunchError.__ge__()#: Return self>=value.

RockyLaunchError.__getattribute__()#: Return getattr(self, name).

RockyLaunchError.__gt__()#: Return self>value.

RockyLaunchError.__hash__()#: Return hash(self).

RockyLaunchError.__le__()#: Return self<=value.

RockyLaunchError.__lt__()#: Return self

RockyLaunchError.__ne__()#: Return self!=value.

RockyLaunchError.__reduce__()#: Helper for pickle.

RockyLaunchError.__reduce_ex__()#: Helper for pickle.

RockyLaunchError.__repr__()#: Return repr(self).

RockyLaunchError.__setattr__()#: Implement setattr(self, name, value).

RockyLaunchError.__setstate__()#

RockyLaunchError.__sizeof__()#: Size of object in memory, in bytes.

RockyLaunchError.__str__()#: Return str(self).

RockyLaunchError.__subclasshook__()#

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

RockyLaunchError.with_traceback()#: Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception RockyLaunchError.RockyApiError#

Bases: Exception

Provides the Exception class for an error generated in the API layer.

Overview#

Methods

with_traceback

Exception.with_traceback(tb) –

Special methods

`__delattr__`	Implement delattr(self, name).
`__dir__`	Default dir() implementation.
`__eq__`	Return self==value.
`__format__`	Default object formatter.
`__ge__`	Return self>=value.
`__getattribute__`	Return getattr(self, name).
`__gt__`	Return self>value.
`__hash__`	Return hash(self).
`__le__`	Return self<=value.
`__lt__`	Return self
`__ne__`	Return self!=value.
`__reduce__`	Helper for pickle.
`__reduce_ex__`	Helper for pickle.
`__repr__`	Return repr(self).
`__setattr__`	Implement setattr(self, name, value).
`__setstate__`
`__sizeof__`	Size of object in memory, in bytes.
`__str__`	Return str(self).
`__subclasshook__`	Abstract classes can override this to customize issubclass().

Import detail#

from ansys.rocky.core.exceptions import RockyApiError

Method detail#

RockyApiError.__delattr__()#: Implement delattr(self, name).

RockyApiError.__dir__()#: Default dir() implementation.

RockyApiError.__eq__()#: Return self==value.

RockyApiError.__format__()#: Default object formatter.

RockyApiError.__ge__()#: Return self>=value.

RockyApiError.__getattribute__()#: Return getattr(self, name).

RockyApiError.__gt__()#: Return self>value.

RockyApiError.__hash__()#: Return hash(self).

RockyApiError.__le__()#: Return self<=value.

RockyApiError.__lt__()#: Return self

RockyApiError.__ne__()#: Return self!=value.

RockyApiError.__reduce__()#: Helper for pickle.

RockyApiError.__reduce_ex__()#: Helper for pickle.

RockyApiError.__repr__()#: Return repr(self).

RockyApiError.__setattr__()#: Implement setattr(self, name, value).

RockyApiError.__setstate__()#

RockyApiError.__sizeof__()#: Size of object in memory, in bytes.

RockyApiError.__str__()#: Return str(self).

RockyApiError.__subclasshook__()#

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

RockyApiError.with_traceback()#: Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.