Skip to main content

A easy to use validator for json content

Project description

Believe

A python package for json validation. Useful for unit test or data validation for restful json body.

Installation

pip install believe

Sample usage

import believe as B
import time

# String Match
assert B.AnyStr() == "any_str"
assert B.AnyIntStr() == "123"
assert B.AnyUUID() == "732c0743-2638-47d5-902d-0daa3080348b"
assert B.AnySHA1() == "b130c4b97d0640eaf3f45f7360a5b4dbbf561f58"
assert B.AnyIPV4() == "1.2.3.4"

# Number Match
assert B.AnyInt(min_value=1) == 1 # X >= 1
assert B.AnyInt(max_value=10) == 10 # X <= 10
assert B.AnyInt(min_value=1, max_value=10) == 5 # 1 <= X <= 10
assert B.AnyFloat(min_value=1.0, max_value=10.0) == 5.0 # 1.0 <= X <= 10.0
assert B.Almost(time.time()) == time.time() # Allow some time gap

# List Match
assert B.OneOf("one", "two") == "one"
assert B.AnyOrder([1, 2, 3]) == [2, 1, 3]
assert B.ListOf({"type": B.OneOf("A", "B")}) == [{"type": "A"}, {"type": "B"}, {"type": "A"}]

# Dict Match
assert B.Dict({"name": B.AnyStr()}) == {"name": "ken"}
assert B.Dict({"name": B.AnyStr(), "value": B.Optional(B.AnyStr())}) == {"name": "ken"}
assert B.Dict({"name": B.AnyStr(), "value": B.Optional(B.AnyStr())}) == {"name": "ken", "value": "nek"}
assert B.DictOf(B.AnyUUID(), B.OneOf("ok", "fail")) == {"732c0743-2638-47d5-902d-0daa3080348b": "ok",
                                                        "5cfd50ba-c3d3-4fb7-b2fe-e9a6e039ad29": "fail"}

# Other Match
assert B.Nullable(B.AnyStr()) == None # Allow None
assert B.Any(bytes) == b'123' # only check type
assert B.Not(B.OneOf("A")) == "B"

# validate with error exception
validator = B.Dict({"name": B.AnyInt()})
B.validate(validator, {"name": "ken"})  # believe.error.ValidateError: [e_path=$.name] 'ken' != AnyInt()

Common Usage (Unit test comparison)

Use BelieveMixin on your test case to enable flexible comparison.

import unittest
from believe import BelieveMixin

class BelieveTestCase(unittest.TestCase, BelieveMixin):
    def test_believe(self):
        self.assertEquals(self.AnyStr(), "abc")
        self.assertEquals(self.AnyIntStr(), "1")

Advance Usage (flask)

Save following code as flask_example.py

import believe as B

from flask import Flask, request, current_app, jsonify

app = Flask(__name__)

@app.route('/', methods=['POST'])
def hello_believe():
    content = request.get_json()
    json_validator = B.Dict({
        "user_name": B.AnyStr(min_len=1, max_len=32),
    })
    try:
        json_validator.validate(content)
    except B.ValidateError as e:
        current_app.logger.error(str(e))
        # xss_safe_message won't echo request content to prevent xss via error message
        return jsonify(message=e.xss_safe_message()), 400
    return jsonify(f'{content["user_name"]} welcome back!')

app.run(debug=1, host='0.0.0.0', port=80)

Install and run sample

$> pip install flask
$> python flask_example.py

Test with invalid value

$> curl localhost -X POST -d '{"user_name": ""}' -H 'content-type: application/json'

Test with valid value

$> curl localhost -X POST -d '{"user_name": "123"}' -H 'content-type: application/json'

Project details


Download files

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

Files for believe, version 1.0.9
Filename, size File type Python version Upload date Hashes
Filename, size believe-1.0.9-py3-none-any.whl (8.0 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size believe-1.0.9.tar.gz (7.1 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page