Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

Build complex rules, serialize them as JSON, and execute them in Python

Project Description

This parser accepts JsonLogic rules and executes them in Python.

This is a Python porting of the excellent GitHub project by jwadhams for JavaScript: json-logic-js.

All credit goes to him, this is simply an implementation of the same logic in Python (small differences below).

The JsonLogic format is designed to allow you to share rules (logic) between front-end and back-end code (regardless of language difference), even to store logic along with a record in a database. JsonLogic is documented extensively at JsonLogic.com, including examples of every supported operation and a place to try out rules in your browser.

The same format can also be executed in PHP by the library json-logic-php

Examples

Simple

from json_logic import jsonLogic
jsonLogic( { "==" : [1, 1] } )
# True

This is a simple test, equivalent to 1 == 1. A few things about the format:

  1. The operator is always in the “key” position. There is only one key per JsonLogic rule.
  2. The values are typically an array.
  3. Each value can be a string, number, boolean, array (non-associative), or null

Compound

Here we’re beginning to nest rules.

jsonLogic(
  {"and" : [
    { ">" : [3,1] },
    { "<" : [1,3] }
  ] }
)
# True

In an infix language (like Python) this could be written as:

( (3 > 1) and (1 < 3) )

Data-Driven

Obviously these rules aren’t very interesting if they can only take static literal data. Typically jsonLogic will be called with a rule object and a data object. You can use the var operator to get attributes of the data object:

jsonLogic(
  { "var" : ["a"] }, # Rule
  { a : 1, b : 2 }   # Data
)
# 1

If you like, we support syntactic sugar on unary operators to skip the array around values:

jsonLogic(
  { "var" : "a" },
  { a : 1, b : 2 }
)
# 1

You can also use the var operator to access an array by numeric index:

jsonLogic(
  {"var" : 1 },
  [ "apple", "banana", "carrot" ]
)
# "banana"

Here’s a complex rule that mixes literals and data. The pie isn’t ready to eat unless it’s cooler than 110 degrees, and filled with apples.

rules = { "and" : [
  {"<" : [ { "var" : "temp" }, 110 ]},
  {"==" : [ { "var" : "pie.filling" }, "apple" ] }
] }

data = { "temp" : 100, "pie" : { "filling" : "apple" } }

jsonLogic(rules, data)
# True

Always and Never

Sometimes the rule you want to process is “Always” or “Never.” If the first parameter passed to jsonLogic is a non-object, non-associative-array, it is returned immediately.

#Always
jsonLogic(True, data_will_be_ignored);
# True

#Never
jsonLogic(false, i_wasnt_even_supposed_to_be_here);
# False

Installation

The best way to install this library is via PIP:

pip install json-logic

If that doesn’t suit you, and you want to manage updates yourself, the entire library is self-contained in json_logic.py and you can download it straight into your project as you see fit.

curl -O https://raw.githubusercontent.com/nadirizr/json-logic-py/master/json_logic.py

Differences from the original JavaScript version

The only difference is in the straightforward ‘==’ and ‘===’ comparison operators, since they have different expected behavior in Python than in JavaScript.

In JS: * ‘==’ - Performs type coercion and compares. * ‘===’ - Does not perform type coercion.

In Python: * ‘==’ - Does not perform type coercion, compares using Pyton’s eq operator. * ‘===’ - Does not perform type coercion, compares using Python’s ‘is’ operator.

Release History

Release History

History Node

0.7.0a0

This version
History Node

0.6.3

History Node

0.6.2

Download Files

Download Files

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

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
json_logic-0.6.3-py2.py3-none-any.whl (8.3 kB) Copy SHA256 Checksum SHA256 py2.py3 Wheel Dec 4, 2015
json_logic-0.6.3.tar.gz (5.8 kB) Copy SHA256 Checksum SHA256 Source Dec 4, 2015

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting