uibcdf_systems._private_tools.exceptions.BadCallError

exception uibcdf_systems._private_tools.exceptions.BadCallError(argument=None)

Exception raised when a method, or a class, was not properly called or instantiated.

This exception is raised when a method or a class was not properly called or instantiated.

Parameters

argument (str, optional) – The name of the possible wrong input argument.

Raises

BadCallError – A message is printed out with the name of the class or the method raising the exception, the possible wrong argument, the link to the API documentation, and the link to the issues board of OpenMolecularSystems’ GitHub repository.

Examples

>>> from openmolecularsystems._private_tools.exceptions import BadCallError
>>> def method_name(item, a=True):
...    if type(a) not in [int, float]:
...       raise BadCallError('a')
...    pass

See Also

Developer Guide > Exceptions > BadCallError