Skip to main content

A python function parameter and return type-checking decorator

Project description

# Complaince
A python function parameter and return type-checking decorator

Both the parameters types and return type(optional to check for return type)
can be done using a single decorator.

Each parameter can have multiple possible types , mentioned in a tuple

Examples
========
When plainly checking parameter types

```python
@param_check((int,float),(int,float))
def myfunc(a, b):
```
This indicates the parameters a,b can be either int or float

```python
@param_check((int,),(int,))
def myfunc(a, b):
```
In this case both a and b have to be int only (tuple definition is a must )

There is are two optional parameters:

1. level - Key-Value pair indicates warning message(continue execution after type error) or throw an exception(essentially
terminating the execution flow) (0 - warning , 1 - exception error) Default
is warning i.e 0

2. ret - Key-Value pair indicating possible return types, in this case too
value is a tuple

```python
@param_check((int,float),(int,float), level = 1, ret = (int,float))
def myfunc(a, b)
```
In the above example we will throw an exception if the parameters, return value do not match
required types. Return value can be either an in or float

Compatability
=============
Requires python 2.6 or higher
Works with python 3.0 and higher

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

complaince-1.0.1.0b1.dev1-py2.py3-none-any.whl (5.0 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page