opa-golib-python-bindings 0.1.0__py3-none-macosx_11_0_arm64.whl

opa_bindings/__init__.py

@@ -0,0 +1,3 @@
+from .engine import OpaEngine, OpaError, OpaUndefinedError
+
+__all__ = ["OpaEngine", "OpaError", "OpaUndefinedError"]

opa_bindings/_native.py

@@ -0,0 +1,51 @@
+"""ctypes bindings for the Go c-shared bridge library."""
+
+import ctypes
+from pathlib import Path
+
+_LIB_PATH = Path(__file__).parent / "libopabridge.so"
+
+# char* (*opa_callback)(unsigned long long h, char* name, char* argsJson)
+# Return type is c_void_p so ctypes does not copy/free: the Python side keeps
+# the returned buffer alive until the callback is invoked again, and Go copies
+# it synchronously.
+CALLBACK = ctypes.CFUNCTYPE(
+    ctypes.c_void_p, ctypes.c_uint64, ctypes.c_char_p, ctypes.c_char_p
+)
+
+
+def load():
+    lib = ctypes.CDLL(str(_LIB_PATH))
+
+    lib.OpaNew.restype = ctypes.c_uint64
+    lib.OpaNew.argtypes = []
+
+    lib.OpaDestroy.restype = None
+    lib.OpaDestroy.argtypes = [ctypes.c_uint64]
+
+    lib.OpaFreeString.restype = None
+    lib.OpaFreeString.argtypes = [ctypes.c_void_p]
+
+    # Fallible calls return a malloc'd char* envelope; declare as c_void_p so
+    # we can free it after copying.
+    lib.OpaAddPolicy.restype = ctypes.c_void_p
+    lib.OpaAddPolicy.argtypes = [ctypes.c_uint64, ctypes.c_char_p, ctypes.c_char_p]
+
+    lib.OpaAddData.restype = ctypes.c_void_p
+    lib.OpaAddData.argtypes = [ctypes.c_uint64, ctypes.c_char_p, ctypes.c_char_p]
+
+    lib.OpaRegisterBuiltin.restype = ctypes.c_void_p
+    lib.OpaRegisterBuiltin.argtypes = [
+        ctypes.c_uint64,
+        ctypes.c_char_p,
+        ctypes.c_int,
+        CALLBACK,
+    ]
+
+    lib.OpaEvalQuery.restype = ctypes.c_void_p
+    lib.OpaEvalQuery.argtypes = [ctypes.c_uint64, ctypes.c_char_p, ctypes.c_char_p]
+
+    lib.OpaEvalDocument.restype = ctypes.c_void_p
+    lib.OpaEvalDocument.argtypes = [ctypes.c_uint64, ctypes.c_char_p, ctypes.c_char_p]
+
+    return lib

opa_bindings/engine.py

@@ -0,0 +1,196 @@
+"""High-level Python API around the Go/OPA bridge library."""
+
+import ctypes
+import inspect
+import json
+import sys
+
+from . import _native
+
+
+class OpaError(Exception):
+    def __init__(self, code: str, message: str):
+        super().__init__(f"{code}: {message}")
+        self.code = code
+        self.message = message
+
+
+class OpaUndefinedError(OpaError):
+    def __init__(self, what: str):
+        super().__init__("undefined", f"{what} is undefined")
+
+
+_lib = None
+
+
+def _get_lib():
+    global _lib
+    if _lib is None:
+        _lib = _native.load()
+    return _lib
+
+
+class OpaEngine:
+    """An embedded OPA policy engine instance.
+
+    Policies are Rego modules added under a path, data is deep-merged JSON,
+    and Python callables can be registered as custom Rego builtins.
+    """
+
+    def __init__(self):
+        self._lib = _get_lib()
+        self._handle = self._lib.OpaNew()
+        self._functions = {}
+        # Buffers returned to Go must outlive the call; Go copies them
+        # synchronously, so keeping the latest buffer per builtin suffices.
+        self._callback_buffers = {}
+        self._trampoline = _native.CALLBACK(self._dispatch)
+        #: Called as ``print_handler(message, location)`` for each Rego
+        #: ``print(...)`` during evaluation; None writes them to stderr.
+        self.print_handler = None
+        #: Prints captured by the most recent eval, as (message, location).
+        self.last_prints = []
+
+    # -- lifecycle -----------------------------------------------------
+
+    def close(self):
+        if self._handle is not None:
+            self._lib.OpaDestroy(self._handle)
+            self._handle = None
+
+    def __enter__(self):
+        return self
+
+    def __exit__(self, *exc):
+        self.close()
+
+    def __del__(self):
+        try:
+            self.close()
+        except Exception:
+            pass
+
+    # -- internals -----------------------------------------------------
+
+    def _check_open(self):
+        if self._handle is None:
+            raise OpaError("closed", "engine has been closed")
+
+    def _call(self, fn, *args):
+        ptr = fn(self._handle, *args)
+        if not ptr:
+            raise OpaError("internal", "native call returned NULL")
+        try:
+            raw = ctypes.string_at(ptr)
+        finally:
+            self._lib.OpaFreeString(ptr)
+        envelope = json.loads(raw)
+        if "error" in envelope and envelope["error"] is not None:
+            err = envelope["error"]
+            raise OpaError(err.get("code", "unknown"), err.get("message", ""))
+        return envelope
+
+    def _eval_result(self, envelope):
+        self.last_prints = [
+            (p["message"], p["location"]) for p in envelope.get("prints") or []
+        ]
+        for message, location in self.last_prints:
+            if self.print_handler is not None:
+                self.print_handler(message, location)
+            else:
+                print(f"{location}: {message}", file=sys.stderr)
+        return envelope.get("result")
+
+    def _dispatch(self, handle, name, args_json):
+        name = name.decode()
+        try:
+            fn, arity = self._functions[name]
+            args = json.loads(args_json)
+            if arity == -1:
+                # Variadic builtins take a single array argument in Rego.
+                args = args[0]
+            response = {"result": fn(*args)}
+        except Exception as e:  # never let an exception cross into Go
+            response = {"error": repr(e)}
+        try:
+            buf = ctypes.create_string_buffer(json.dumps(response).encode())
+        except Exception as e:
+            buf = ctypes.create_string_buffer(
+                json.dumps({"error": f"unserializable result: {e!r}"}).encode()
+            )
+        self._callback_buffers[name] = buf
+        return ctypes.addressof(buf)
+
+    # -- public API ----------------------------------------------------
+
+    def add_policy(self, path: str, source: str):
+        """Add a Rego module under the given path (module name)."""
+        self._check_open()
+        self._call(self._lib.OpaAddPolicy, path.encode(), source.encode())
+
+    def add_data(self, value, path: str = ""):
+        """Deep-merge a JSON-compatible value into the data document.
+
+        ``path`` is a dotted path (e.g. ``"roles.admin"``); empty means root.
+        Conflicting existing values raise OpaError(code="merge_conflict").
+        """
+        self._check_open()
+        self._call(self._lib.OpaAddData, path.encode(), json.dumps(value).encode())
+
+    def register_function(self, name: str, fn, *, arity: int | None = None):
+        """Expose a Python callable as a Rego builtin.
+
+        Arity is inferred from the signature unless given; ``*args`` means
+        variadic, in which case the builtin takes a single array argument in
+        Rego (e.g. ``many(["a", "b"])``) that is unpacked into ``*args``.
+        Arguments and the return value are JSON-compatible objects.
+        """
+        self._check_open()
+        if arity is None:
+            arity = 0
+            for p in inspect.signature(fn).parameters.values():
+                if p.kind is inspect.Parameter.VAR_POSITIONAL:
+                    arity = -1
+                    break
+                if p.kind in (
+                    inspect.Parameter.POSITIONAL_ONLY,
+                    inspect.Parameter.POSITIONAL_OR_KEYWORD,
+                ):
+                    arity += 1
+        self._functions[name] = (fn, arity)
+        try:
+            self._call(
+                self._lib.OpaRegisterBuiltin, name.encode(), arity, self._trampoline
+            )
+        except Exception:
+            del self._functions[name]
+            raise
+
+    def eval_query(self, query: str, input=None):
+        """Evaluate a Rego query; returns a list of binding dicts."""
+        self._check_open()
+        rs = self._eval_result(
+            self._call(self._lib.OpaEvalQuery, query.encode(), _encode_input(input))
+        )
+        if not rs:
+            return []
+        return [r.get("bindings", {}) for r in rs]
+
+    def eval_document(self, path: str, input=None):
+        """Evaluate the document at ``data.<path>`` and return its value.
+
+        Raises OpaUndefinedError if the document is undefined.
+        """
+        self._check_open()
+        rs = self._eval_result(
+            self._call(self._lib.OpaEvalDocument, path.encode(), _encode_input(input))
+        )
+        if not rs or not rs[0].get("expressions"):
+            raise OpaUndefinedError(f"data.{path}" if path else "data")
+        return rs[0]["expressions"][0]["value"]
+
+
+def _encode_input(input):
+    if input is None:
+        return b""
+    return json.dumps(input).encode()

opa_golib_python_bindings-0.1.0.dist-info/METADATA

@@ -0,0 +1,8 @@
+Metadata-Version: 2.5
+Name: opa-golib-python-bindings
+Version: 0.1.0
+Summary: Python bindings for the OPA (Open Policy Agent) Rego engine via a Go c-shared library
+License-File: LICENSE
+Requires-Python: >=3.14
+Provides-Extra: dev
+Requires-Dist: pytest; extra == 'dev'

opa_golib_python_bindings-0.1.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+opa_bindings/__init__.py,sha256=cJ_hOegzboEzy51IhT-bA3RGkiu7Bv4-8QIdNYhw5wo,117
+opa_bindings/_native.py,sha256=ezZr5RHIzWxHWtxsk859nyrHXZs3GArVNtSuLhbYj98,1652
+opa_bindings/engine.py,sha256=g2a5pLQY3lzmm59MVC8ZQBBmmVBG1GTRC6xdDZDFhL0,6661
+opa_bindings/libopabridge.so,sha256=9Bh4EULZdYLcD-RuS58rnXA_ysfQW68BjcE6XE1gdpo,26152114
+opa_golib_python_bindings-0.1.0.dist-info/METADATA,sha256=1LIgLJ8eCwYJvPOyKWCWjNDzro5lrTMh_MYmQSRwLg4,268
+opa_golib_python_bindings-0.1.0.dist-info/WHEEL,sha256=X_XT35qwFyuTF8LewfTGgVi6_4WoC3HnGv5CQcZCRtY,102
+opa_golib_python_bindings-0.1.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+opa_golib_python_bindings-0.1.0.dist-info/RECORD,,

opa_golib_python_bindings-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.32.0
+Root-Is-Purelib: false
+Tag: py3-none-macosx_11_0_arm64

opa_golib_python_bindings-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.