1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
|
argvalidate - Python argument validator library documentation
===========================================================================
Contents:
.. toctree::
:maxdepth: 2
argvalidate
envvars
Primer
======
argvalidate is a small Python module which gives developers the opportunity
to do both argument- and return-value type checking.
This basically enables you to be sure that an argument passed to a function and
the return value of a function is of a specific type, or even one of a list
specified types.
argvalidate provides you with two different decorators, which define the
rules for argument types and return value types:
:func:`~argvalidate.accepts` and
:func:`~argvalidate.returns`.
argvalidate either raises an :ref:`exception <argvalidate-exceptions>` or
creates a Python warning if it detects an error. This behaviour can be
configured via :ref:`environment variables <argvalidate-envvars>`.
Reporting bugs
==============
If you find any bugs in argvalidate, have comments, suggestions or feature
requests, please use the `project homepage <http://code.sp-its.at/projects/argvalidate>`_.
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
|