Skip to main content

A simple JSON schema checker

Project description

Jsonism - The Simple Python JSON Checker

A super-simple library for validating JSON against a schema.

Install from pip

pip install jsonism

Why use Jsonism?

Jsonism is a great alternative to jsonschema when you just want to do some simple validation of JSON without your code getting horrendously complicated.

It's quick to set up a basic schema checker.

Example usage

Import the checker

from jsonism.checker import validate

The validate function returns True if the input you give it matches the schema that you provide.

Basic flat objects

schema = {
    "Bob": str,
    "Lucy": int,
    "Bert": bool
}
input = {
    "Bob": "Is Bob",
    "Lucy": 13,
    "Bert": True
}
validate(input, schema)

Lists

input = ["Bob", "Alice", "John"]
schema = [str]
validate(input, schema)

Other stuff

input = {"Usernames": [{"username": "Bob", "age": 23}, {"username": "Bill", "age": 98}]}
schema = {"Usernames": [{"username": str, "age": int}]}
validate(input, schema)

Obviously for more complex json, you can json.loads the input.

Permissive validation

Jsonism is permissive when it comes to extra elements. As long as the elements listed in the schema are provided, validate will return True. If additional elements are added to the input, validate will still return True.

schema = {
    "Bob": str,
    "Lucy": int,
    "Bert": bool
}
input = {
    "Bob": "Is Bob",
    "Lucy": 13,
    "Bert": True,
    "Colin": 21
}
validate(input, schema)  # Will return True

Value validation

This is absolutely optional, in order to keep things as simple as possible and enable the use of the in-built types int, str, bool, and float wherever possible. But we do also support the use of value validation as follows:

from jsonism.checker import validate
from jsonism.types import String, Integer, Boolean, Float

schema = {
    "Bob": String(len=6),
    "Lucy": Integer(max=96),
    "Bert": Boolean(allowed=True),
    "Chris": Float(min=12.34)
}
input = {
    "Bob": "Is Bob",
    "Lucy": 30,
    "Bert": True,
    "Chris": 34.2
}
validate(input, schema)  # Will return True

Lists of valid values

from jsonism.checker import validate
from jsonism.types import String, Integer, Boolean, Float

schema = {
    "Bob": String(options=["Is Bob", "Not Bob"]),
    "Lucy": Integer(max=22),
    "Bert": Boolean(allowed=True)
}
input = {
    "Bob": "Was Bob",
    "Lucy": 22,
    "Bert": True
}
validate(input, schema)  # Will return False

But it doesn't have feature x!

Well, I did say it was simple. It will always support the very simple initialisation shown above. We also now support value validation. If you have a burning desire to add a feature, please either post an issue or make a pull request at https://github.com/bmcollier/jsonism.

Project details


Download files

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

Source Distribution

jsonism-1.1.2.tar.gz (6.1 kB view details)

Uploaded Source

Built Distribution

jsonism-1.1.2-py3-none-any.whl (9.2 kB view details)

Uploaded Python 3

File details

Details for the file jsonism-1.1.2.tar.gz.

File metadata

  • Download URL: jsonism-1.1.2.tar.gz
  • Upload date:
  • Size: 6.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/33.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.63.0 importlib-metadata/4.11.2 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.8.2

File hashes

Hashes for jsonism-1.1.2.tar.gz
Algorithm Hash digest
SHA256 a386360cbbcc448af365f174a02e290df9e4dae3e19046f22c559f5952d1d164
MD5 2e58fcf80c458161076ebcd77ce342b8
BLAKE2b-256 c0331b55a7c8abdfddfdb67a3fa44ed4642840034038e73d525dbda3a0cbd407

See more details on using hashes here.

File details

Details for the file jsonism-1.1.2-py3-none-any.whl.

File metadata

  • Download URL: jsonism-1.1.2-py3-none-any.whl
  • Upload date:
  • Size: 9.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/33.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.63.0 importlib-metadata/4.11.2 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.8.2

File hashes

Hashes for jsonism-1.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 2e4debf7678442a62012a8a0a44f3545d6baddfaeac5e84126e22cbcb5ae08ce
MD5 e0f680a276113f9fa8597eb668856fb0
BLAKE2b-256 ed0bd71a95cd0f9a1714ef32ed3788170c9bb1b0279807e295a81e30716eac13

See more details on using hashes here.

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