plasmapy.utils.decorators.checks

Decorator for checking input/output arguments of functions.

Classes

CheckBase([checks_on_return])

Base class for 'Check' decorator classes.

CheckUnits([checks_on_return])

A decorator class to 'check' — limit/control — the units of input and return arguments to a function or method.

CheckValues([checks_on_return])

A decorator class to 'check' — limit/control — the values of input and return arguments to a function or method.
Inheritance diagram of plasmapy.utils.decorators.checks.CheckBase, plasmapy.utils.decorators.checks.CheckUnits, plasmapy.utils.decorators.checks.CheckValues

Functions

check_relativistic([func, betafrac])

Warns or raises an exception when the output of the decorated function is greater than betafrac times the speed of light.

check_units([func, checks_on_return])

A decorator to 'check' — limit/control — the units of input and return arguments to a function or method.

check_values([func, checks_on_return])

A decorator to 'check' — limit/control — the values of input and return arguments to a function or method.