Skip to main content

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

Project description

json-logic-py

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:

var = ((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-modernized

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

json_logic_modernized-1.0.1.tar.gz (9.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

json_logic_modernized-1.0.1-py3-none-any.whl (6.7 kB view details)

Uploaded Python 3

File details

Details for the file json_logic_modernized-1.0.1.tar.gz.

File metadata

  • Download URL: json_logic_modernized-1.0.1.tar.gz
  • Upload date:
  • Size: 9.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.25

File hashes

Hashes for json_logic_modernized-1.0.1.tar.gz
Algorithm Hash digest
SHA256 d06d7612e0c2f26f7e725fc313bad54466222a5c88c7e213e65ecba51c13909c
MD5 f8cf99b4b9c65c9722299e19b6631512
BLAKE2b-256 47e61f6ddc40cf899602cbb33e640d82d4ed3dec773d8b31f056d88bd6917007

See more details on using hashes here.

File details

Details for the file json_logic_modernized-1.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for json_logic_modernized-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8f6b8f6fbdfc291f53fc89bd75e53bdc1c9b8bf5a98325640b22453cd42c3951
MD5 8142313072f76d45a22ce11b29eb504b
BLAKE2b-256 05ac98cbdd31e374ee6f8c6877b3016cc9879cab1a9d05507a83ba1ec85c5429

See more details on using hashes here.

Supported by

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