1
.. _argvalidate-module:
6
.. automodule:: argvalidate
8
Below you can find the documentation of the public API of argvalidate.
10
Even though more constants, decorators, exceptions and functions may be
11
specified in the argvalidate module, only those described here form the API
12
and are intended for public use.
16
Do *not* rely on any internals of argvalidate, as these may change at any
17
time, without further notice.
19
The API described here forms the public interface to argvalidate and as such
20
will have functionality pending for removal deprecated first.
25
.. autofunction:: accepts
26
.. autofunction:: returns
30
Stacking of decorator of the same type (ie. :func:`accepts`
31
and :func:`accepts`, :func:`returns` and :func:`returns`) is not possible
32
and will cause a :exc:`DecoratorStackingException` to be raised.
34
Stacking of different types of decorators (ie. :func:`returns` and
36
is possible though and will neither raise an exception nor break anything.
38
.. autofunction:: func_args
39
.. autofunction:: method_args
40
.. autofunction:: return_value
46
.. autofunction:: one_of
47
.. autofunction:: raises_exceptions
48
.. autofunction:: warns_kwarg_as_arg
51
.. _argvalidate-exceptions:
55
.. autoexception:: ArgvalidateException
57
.. autoexception:: ArgumentTypeException
58
.. autoexception:: ReturnValueTypeException
59
.. autoexception:: DecoratorNonKeyLengthException
60
.. autoexception:: DecoratorKeyUnspecifiedException
61
.. autoexception:: DecoratorStackingException
added
removed
doc/argvalidate.rst
