Skip to main content

A Python library for checking parameters.

Project description

validate_parameters
-------------------
校验函数参数的工具

- 校验类型

.. code :: python

@validParam(a=int)
def func(a, b=1, *args, **kwargs):
return Result().data = a, b, args, kwargs


| 正确时,返回值:func定义的Result()对象(由用户自己定义)
| 错误时,返回值:Result()对象,

.. code :: python

Result().flag = False,
Result().msg = 'func() parameter validation fails, param: a, value: a(str), msg(None)'
Result().code/status = -3000

* 自定义函数

.. code :: python

def max_11(x):
if x> 11:
return True, 'msg', 'code'
else:
return False, 'msg', 'code'

@validParam(a=int, b=max_11)
def func(a, b=1, *args, **kwargs)
return Result().data = a, b, args, kwargs

| 其中,msg和code为用户自定义,且为可选参数
| 正确时,返回值:func定义的Result()对象(由用户自己定义)
| 错误时,返回值:Result()对象,

.. code :: python

Result().flag = False,
Result().msg = 'func() parameter validation fails, param: a, value: a(str), msg(*{{ msg }}*)'
Result().code/status = *{{ code }}*

* 校验类型和函数

.. code :: python

@validParam(a=int, b=(int, max_11))
def func(a, b=1, *args, **kwargs)
return Result().data = a, b, args, kwargs

| 其中,msg和code为用户自定义,且为可选参数
| 正确时,返回值:func定义的Result()对象(由用户自己定义)
| 错误时,返回值:Result()对象,

.. code :: python

Result().flag = False,
Result().msg = 'func() parameter validation fails, param: a, value: a(str), msg(*{{ msg }}*)'
Result().code/status = *{{ code }}*

Result
------

- 返回值对象Result()
- 支持Result().code和Result()["code]取值
- 支持Result().code=1和Result()["code]=1赋值
- 支持转json格式,json.dumps(Result(), defaults=Result().to_json)
- 支持转dict对象,Result().dict()

- 默认参数包括:

.. code :: python

flag=True, data=None, code=None, msg=None, status=None, return_values=None

上传至pypi
------

::

python setup.py bdist_wheel --universal
twine upload dist/*

| *username: chenyang21 passwd: devops58ganji*
| *需要更新LICENSE里的version,否则上传会失败*


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

validate_parameters-0.1.4-py2.py3-none-any.whl (7.2 kB view details)

Uploaded Python 2Python 3

File details

Details for the file validate_parameters-0.1.4-py2.py3-none-any.whl.

File metadata

  • Download URL: validate_parameters-0.1.4-py2.py3-none-any.whl
  • Upload date:
  • Size: 7.2 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.18.4 setuptools/40.5.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/2.7.11

File hashes

Hashes for validate_parameters-0.1.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 441710ff99e1b34a8d65d5ed83298e82ccc0c6c1366e8c38634cf071f625f896
MD5 eadf95147dc9bea41640c7205c30b629
BLAKE2b-256 8851ed712f225566711f570b6a0bd4e41ad6b52912ea061ef94342b91a715da4

See more details on using hashes here.

Supported by

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