regopy 1.5.2

Python interface for the OPA Rego Language and Runtime

regopy

Rego is the native query language of the Open Policy Agent project. If you want to learn more about Rego as a language, and its various use cases, we refer you to the language documentation above which OPA provides.

This module is a wrapper around rego-cpp, an open source cross-platform C++ implementation of the Rego language compiler and runtime developed and maintained by Microsoft. You can learn more about that project here. As much as possible in this wrapper we try to provide idiomatic Python interfaces to the Rego query engine. We hope the project is of use to those wishing to leverage the power of Rego within a Python context.

Example Usage

from regopy import Interpreter
rego = Interpreter()
print(rego.query("x=5;y=x + (2 - 4 * 0.25) * -3 + 7.4;2 * 5"))
# {"expressions":[true, true, 10], "bindings":{"x":5, "y":9.4}}
input0 = {
    "a": 10,
    "b": "20",
    "c": 30.0,
    "d": True
}
data0 = {
    "one": {
        "bar": "Foo",
        "baz": 5,
        "be": True,
        "bop": 23.4
    },
    "two": {
        "bar": "Bar",
        "baz": 12.3,
        "be": False,
        "bop": 42
    }
}
data1 = {
    "three": {
        "bar": "Baz",
        "baz": 15,
        "be": True,
        "bop": 4.23
    }
}
module = '''
    package objects

    rect := {`width`: 2, "height": 4}
    cube := {"width": 3, `height`: 4, "depth": 5}
    a := 42
    b := false
    c := null
    d := {"a": a, "x": [b, c]}
    index := 1
    shapes := [rect, cube]
    names := ["prod", `smoke1`, "dev"]
    sites := [{"name": "prod"}, {"name": names[index]}, {"name": "dev"}]
    e := {
        a: "foo",
        "three": c,
        names[2]: b,
        "four": d,
    }
    f := e["dev"]
'''
rego.set_input(input0)
rego.add_data(data0)
rego.add_data(data1)
rego.add_module("objects", module)
print(rego.query("x=[data.one, input.b, data.objects.sites[1]]"))
# {"expressions":[true], "bindings":{"x":[{"bar":"Foo", "baz":5, "be":true, "bop":23.4},"20",{"name":"smoke1"}]}}

bundle = rego.build("[data.one, input.b, data.objects.sites[1]] = x", ["objects/sites"])

rego = Interpreter()
rego.set_input({
    "a": 10,
    "b": "foo",
    "c": 30.0,
    "d": True
})

print(rego.query_bundle(bundle))
# {"expressions":[true], "bindings":{"x":[{"bar":"Foo", "baz":5, "be":true, "bop":23.4},"foo",{"name":"smoke1"}]}}

print(rego.query_bundle_entrypoint(bundle, "objects/sites"))
# {"expressions":[[{"name":"prod"},{"name":"smoke1"},{"name":"dev"}]]}

Language Support

We support v1.18.1 of Rego as defined by OPA. For the full supported grammar, see the Language Support section of the main README.

Builtins

We support the majority of the standard Rego built-ins, and provide a robust mechanism for including custom built-ins (via the CPP API). The following builtins are NOT supported at present:

• crypto.x509.parse_and_verify_certificates_with_options - Not yet implemented (no OPA conformance tests available)
• graphql.* - Not planned
• http.send - Not planned
• json.match_schema/json.verify_schema - Not planned
• net.* - Not planned
• providers.aws.sign_req - Not planned
• rego.metadata.chain/rego.metadata.rule/rego.parse_module - Not planned
• strings.render_template - Not planned
• time - This is entirely platform dependent at the moment, depending on whether there is a compiler on that platform which supports __cpp_lib_chrono >= 201907L.

Compatibility with the OPA Rego Go implementation

Our goal is to achieve and maintain full compatibility with the reference Go implementation. We have developed a test driver which runs the same tests and validates that we produce the same outputs. At this stage we pass all the non-builtin specific test suites, which we clone from the OPA repository. To build with the OPA tests available for testing, use one of the following presets:

• release-clang-opa
• release-opa