policy-pattern 0.1.0__tar.gz

policy_pattern-0.1.0/LICENSE.md

@@ -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 2026 Guillem Pozo Sebastián
+
+   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.

policy_pattern-0.1.0/PKG-INFO

@@ -0,0 +1,148 @@
+Metadata-Version: 2.4
+Name: policy-pattern
+Version: 0.1.0
+Summary: A minimal, embeddable ReBAC authorization engine for Python, inspired by Google Zanzibar.
+Keywords: python,authorization,access-control,rebac,zanzibar,security
+Author: Guillem Pozo Sebastián
+Author-email: Guillem Pozo Sebastián <58363308+guillem-ps@users.noreply.github.com>
+License-Expression: Apache-2.0
+License-File: LICENSE.md
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Typing :: Typed
+Classifier: Topic :: Security
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.12
+Project-URL: Homepage, https://github.com/guillem-ps/policy-pattern
+Project-URL: Repository, https://github.com/guillem-ps/policy-pattern
+Project-URL: Issues, https://github.com/guillem-ps/policy-pattern/issues
+Description-Content-Type: text/markdown
+
+# policy-pattern
+
+> A small, embeddable ReBAC authorization engine for Python, inspired by Google Zanzibar.
+
+<p align="center">
+    <a href="https://github.com/guillem-ps/policy-pattern/actions/workflows/test.yaml" target="_blank">
+        <img src="https://github.com/guillem-ps/policy-pattern/actions/workflows/test.yaml/badge.svg" alt="Test Pipeline">
+    </a>
+    <a href="https://github.com/guillem-ps/policy-pattern/actions/workflows/lint.yaml" target="_blank">
+        <img src="https://github.com/guillem-ps/policy-pattern/actions/workflows/lint.yaml/badge.svg" alt="Lint Pipeline">
+    </a>
+    <a href="https://codecov.io/gh/guillem-ps/policy-pattern" target="_blank">
+        <img src="https://codecov.io/gh/guillem-ps/policy-pattern/graph/badge.svg" alt="Coverage Pipeline">
+    </a>
+    <a href="pyproject.toml" target="_blank">
+        <img src="https://img.shields.io/badge/version-0.1.0-blue" alt="Package Version">
+    </a>
+    <a href="pyproject.toml" target="_blank">
+        <img src="https://img.shields.io/badge/python-3.12%20%7C%203.13%20%7C%203.14-blue" alt="Supported Python Versions">
+    </a>
+</p>
+
+`policy-pattern` is a standalone Python library for relationship-based access control (ReBAC). It models
+authorization as relationships between subjects and objects and evaluates those relationships through composable
+authorization rules.
+
+- **No authorization server**
+- **No required framework**
+- **No required database**
+- **No network hop**
+
+The library is designed to be embedded directly into Python applications that need richer authorization semantics
+than traditional role-based access control.
+
+> **Status:** v1 is code-complete — model, `compile()`, the storage port, `MemoryTupleStore`, and the `Evaluator`
+> all exist and are tested.
+
+See [Architecture § Scope](docs/architecture.md#scope) for what's planned (v1.x/v2) and unscheduled ideas.
+
+---
+
+## Table of Contents
+
+* [Example](#example)
+* [Documentation](#documentation)
+* [Contributing](#contributing)
+* [License](#license)
+* [References](#references)
+
+---
+
+## Example
+
+```python
+model = Model()
+model.types["document"] = Type(
+    name="document",
+    relations={
+        "owner": Relation(allowed_subject_types=("user",)),
+        "parent": Relation(allowed_subject_types=("folder",)),
+    },
+    permissions={
+        "viewer": Union(left=Reference(name="owner"), right=TupleToUserset(tupleset="parent", computed="viewer")),
+    },
+)
+compiled = model.compile()
+
+evaluator = Evaluator(model=compiled, store=store)
+evaluator.check(alice, "viewer", document_42)
+```
+
+`viewer` here means "the document's own owner, or the owner of whatever folder it lives in" — a document under
+`folder:engineering` inherits access from that folder without copying a permission onto every document.
+
+See the [Usage Guide](docs/usage/README.md) for the full, runnable walkthrough — every rewrite operator, nested
+groups, `EvaluationBudget`, and error handling.
+
+---
+
+## Documentation
+
+The repository uses specifications and architecture documents as part of the implementation contract — they
+describe **what must be true**, independent of any one adapter's implementation.
+
+```text
+docs/
+├── README.md        — documentation index, start here
+├── usage/README.md  — worked examples for every rewrite operator, budgets, error handling
+├── architecture.md  — the model shape, compile(), the storage port, the evaluator, and scope/roadmap
+├── semantics.md     — the storage contract every TupleStore adapter must satisfy
+└── errors.md        — the PPxxx error code ranges and what each one means
+```
+
+Start with the [Usage Guide](docs/usage/README.md) to see the library working end to end, then
+[Architecture](docs/architecture.md) to understand why the model is shaped the way it is.
+
+---
+
+## Contributing
+
+We love community help! Before you open an issue or pull request, please read:
+
+* [How to Contribute](.github/CONTRIBUTING.md)
+* [Code of Conduct](.github/CODE_OF_CONDUCT.md)
+* [Security Policy](SECURITY.md)
+
+---
+
+## License
+
+Licensed under the [Apache License 2.0](LICENSE.md).
+
+---
+
+## References
+
+The design is influenced by authorization systems and literature including:
+
+* [Google Zanzibar](https://research.google/pubs/zanzibar-googles-consistent-global-authorization-system/)
+* [OpenFGA](https://openfga.dev)
+* [SpiceDB](https://github.com/authzed/spicedb) / [AuthZed](https://authzed.com)
+
+`policy-pattern` is an independent project and is not an implementation of, or affiliated with, those projects.

policy_pattern-0.1.0/README.md

@@ -0,0 +1,123 @@
+# policy-pattern
+
+> A small, embeddable ReBAC authorization engine for Python, inspired by Google Zanzibar.
+
+<p align="center">
+    <a href="https://github.com/guillem-ps/policy-pattern/actions/workflows/test.yaml" target="_blank">
+        <img src="https://github.com/guillem-ps/policy-pattern/actions/workflows/test.yaml/badge.svg" alt="Test Pipeline">
+    </a>
+    <a href="https://github.com/guillem-ps/policy-pattern/actions/workflows/lint.yaml" target="_blank">
+        <img src="https://github.com/guillem-ps/policy-pattern/actions/workflows/lint.yaml/badge.svg" alt="Lint Pipeline">
+    </a>
+    <a href="https://codecov.io/gh/guillem-ps/policy-pattern" target="_blank">
+        <img src="https://codecov.io/gh/guillem-ps/policy-pattern/graph/badge.svg" alt="Coverage Pipeline">
+    </a>
+    <a href="pyproject.toml" target="_blank">
+        <img src="https://img.shields.io/badge/version-0.1.0-blue" alt="Package Version">
+    </a>
+    <a href="pyproject.toml" target="_blank">
+        <img src="https://img.shields.io/badge/python-3.12%20%7C%203.13%20%7C%203.14-blue" alt="Supported Python Versions">
+    </a>
+</p>
+
+`policy-pattern` is a standalone Python library for relationship-based access control (ReBAC). It models
+authorization as relationships between subjects and objects and evaluates those relationships through composable
+authorization rules.
+
+- **No authorization server**
+- **No required framework**
+- **No required database**
+- **No network hop**
+
+The library is designed to be embedded directly into Python applications that need richer authorization semantics
+than traditional role-based access control.
+
+> **Status:** v1 is code-complete — model, `compile()`, the storage port, `MemoryTupleStore`, and the `Evaluator`
+> all exist and are tested.
+
+See [Architecture § Scope](docs/architecture.md#scope) for what's planned (v1.x/v2) and unscheduled ideas.
+
+---
+
+## Table of Contents
+
+* [Example](#example)
+* [Documentation](#documentation)
+* [Contributing](#contributing)
+* [License](#license)
+* [References](#references)
+
+---
+
+## Example
+
+```python
+model = Model()
+model.types["document"] = Type(
+    name="document",
+    relations={
+        "owner": Relation(allowed_subject_types=("user",)),
+        "parent": Relation(allowed_subject_types=("folder",)),
+    },
+    permissions={
+        "viewer": Union(left=Reference(name="owner"), right=TupleToUserset(tupleset="parent", computed="viewer")),
+    },
+)
+compiled = model.compile()
+
+evaluator = Evaluator(model=compiled, store=store)
+evaluator.check(alice, "viewer", document_42)
+```
+
+`viewer` here means "the document's own owner, or the owner of whatever folder it lives in" — a document under
+`folder:engineering` inherits access from that folder without copying a permission onto every document.
+
+See the [Usage Guide](docs/usage/README.md) for the full, runnable walkthrough — every rewrite operator, nested
+groups, `EvaluationBudget`, and error handling.
+
+---
+
+## Documentation
+
+The repository uses specifications and architecture documents as part of the implementation contract — they
+describe **what must be true**, independent of any one adapter's implementation.
+
+```text
+docs/
+├── README.md        — documentation index, start here
+├── usage/README.md  — worked examples for every rewrite operator, budgets, error handling
+├── architecture.md  — the model shape, compile(), the storage port, the evaluator, and scope/roadmap
+├── semantics.md     — the storage contract every TupleStore adapter must satisfy
+└── errors.md        — the PPxxx error code ranges and what each one means
+```
+
+Start with the [Usage Guide](docs/usage/README.md) to see the library working end to end, then
+[Architecture](docs/architecture.md) to understand why the model is shaped the way it is.
+
+---
+
+## Contributing
+
+We love community help! Before you open an issue or pull request, please read:
+
+* [How to Contribute](.github/CONTRIBUTING.md)
+* [Code of Conduct](.github/CODE_OF_CONDUCT.md)
+* [Security Policy](SECURITY.md)
+
+---
+
+## License
+
+Licensed under the [Apache License 2.0](LICENSE.md).
+
+---
+
+## References
+
+The design is influenced by authorization systems and literature including:
+
+* [Google Zanzibar](https://research.google/pubs/zanzibar-googles-consistent-global-authorization-system/)
+* [OpenFGA](https://openfga.dev)
+* [SpiceDB](https://github.com/authzed/spicedb) / [AuthZed](https://authzed.com)
+
+`policy-pattern` is an independent project and is not an implementation of, or affiliated with, those projects.

policy_pattern-0.1.0/policy_pattern/adapters/__init__.py

@@ -0,0 +1,3 @@
+from .memory import MemoryTupleStore
+
+__all__ = ["MemoryTupleStore"]

policy_pattern-0.1.0/policy_pattern/adapters/memory.py

@@ -0,0 +1,135 @@
+"""
+In-memory TupleStore adapter — demo/test adapter, no throughput requirement.
+"""
+
+from collections.abc import Generator
+from contextlib import contextmanager
+from heapq import nsmallest
+from threading import Lock
+from typing import override
+
+from policy_pattern.models import Mutation, ObjectReference, Subject, Tuple
+from policy_pattern.ports import ReadResult, TupleStore, View
+
+
+class MemoryTupleStore(TupleStore):
+    """
+    In-memory `TupleStore` — a plain `set[Tuple]` behind a lock, no index.
+
+    `read_relation()` does a linear scan over a snapshot; no
+    `dict[(object, relation), set[Tuple]]` index is maintained. An index
+    would need to stay in lockstep with `write_tuples()` on every call —
+    real complexity bought for a performance property this adapter is
+    explicitly not required to have (`docs/semantics.md` § Threading calls
+    it a "demo/test adapter with no throughput requirement"). Real
+    throughput is `PostgresTupleStore`'s job, not this one's.
+
+    Example:
+        store = MemoryTupleStore()
+        store.write_tuples(Mutation(additions=frozenset({t}), deletions=frozenset()))
+        with store.snapshot() as view:
+            view.read_tuple(subject, "owner", object)
+    """
+
+    def __init__(self) -> None:
+        """
+        Starts empty.
+        """
+        self._tuples: set[Tuple] = set()
+        self._lock = Lock()
+
+    @override
+    def write_tuples(self, mutation: Mutation) -> None:
+        """
+        Atomically applies additions/deletions under the lock.
+
+        `Mutation.__post_init__` already guarantees `additions`/`deletions`
+        are disjoint — this method does not re-validate that.
+        """
+        with self._lock:
+            self._tuples = (self._tuples - mutation.deletions) | mutation.additions
+
+    @override
+    @contextmanager
+    def snapshot(self) -> Generator[View, None, None]:
+        """
+        Copies the current tuple set under the lock, then yields a view over the copy.
+
+        The copy — not a re-held lock — is what makes the view stable: once
+        the copy exists, nothing that happens to the live set afterward can
+        be observed through the already-open view, because the view never
+        looks at the live set again.
+        """
+        with self._lock:
+            frozen = frozenset(self._tuples)
+        yield _MemoryView(frozen)
+
+
+class _MemoryView(View):
+    """
+    Read-only view over one immutable snapshot of a `MemoryTupleStore`.
+
+    Private: nothing outside `MemoryTupleStore.snapshot()` ever constructs
+    one directly.
+    """
+
+    def __init__(self, tuples: frozenset[Tuple]) -> None:
+        """
+        Wraps an already-copied, immutable tuple set.
+        """
+        self._tuples = tuples
+
+    @property
+    def tuples(self) -> frozenset[Tuple]:
+        """
+        Returns the snapshot's tuples.
+
+        Private: nothing outside `MemoryTupleStore.snapshot()` ever needs
+        to see this.
+        """
+        return self._tuples
+
+    @override
+    def read_tuple(self, subject: Subject, relation: str, object: ObjectReference) -> bool:
+        """
+        Checks exact membership by constructing the equivalent Tuple.
+
+        Reuses `Tuple.__post_init__`'s own validation (delegating `relation`
+        to `Identifier`) instead of duplicating it here.
+        """
+        return Tuple(subject=subject, relation=relation, object=object) in self.tuples
+
+    @override
+    def read_relation(self, object: ObjectReference, relation: str, limit: int) -> ReadResult:
+        """
+        Linearly scans the snapshot for matches, bounded by `limit + 1`.
+
+        Args:
+            object: The `ObjectReference` to match.
+            relation: The relation name to match.
+            limit: The maximum number of matches to return. If more than
+                `limit` matches exist, the result is truncated to exactly
+                `limit` and `complete=False`.
+
+        Matches are ranked by `repr()` before truncating — `frozenset`
+        iteration order is not stable (hash randomization), and an
+        unordered scan would make which tuples survive truncation vary
+        between runs with identical data, breaking
+        docs/architecture.md's determinism guarantee. `heapq.nsmallest`
+        keeps only `limit + 1` candidates in memory at a time, rather than
+        `sorted()`'s full match set — with a huge match set and a small
+        limit, that is the difference between O(limit) and O(match count)
+        memory. `limit=0` needs no special-casing: it is already
+        well-defined (immediately incomplete if any match exists,
+        complete-and-empty otherwise).
+        """
+        candidates: list[Tuple] = nsmallest(
+            limit + 1,
+            (t for t in self.tuples if t.object == object and t.relation == relation),
+            key=repr,
+        )
+
+        if len(candidates) > limit:
+            return ReadResult(tuples=frozenset(candidates[:limit]), complete=False)
+
+        return ReadResult(tuples=frozenset(candidates), complete=True)

policy_pattern-0.1.0/policy_pattern/errors/__init__.py

@@ -0,0 +1,19 @@
+from .base_error import BaseError
+from .evaluation_error import EvaluationError
+from .identifier_error import InvalidIdentifierError
+from .model_validation_error import ModelValidationError
+from .mutation_error import InvalidMutationError
+from .relation_error import InvalidRelationError
+from .unknown_name_error import UnknownNameError
+from .unknown_type_error import UnknownTypeError
+
+__all__ = [
+    "BaseError",
+    "EvaluationError",
+    "InvalidIdentifierError",
+    "InvalidMutationError",
+    "InvalidRelationError",
+    "ModelValidationError",
+    "UnknownNameError",
+    "UnknownTypeError",
+]

policy_pattern-0.1.0/policy_pattern/errors/base_error.py

@@ -0,0 +1,28 @@
+"""
+Base class for all policy pattern errors.
+To create a standardized error response, inherit from this class and set the `code` attribute to a unique error code.
+"""
+
+from typing import ClassVar
+
+
+class BaseError(Exception):
+    """
+    Custom exception class for policy pattern errors.
+    It provides a standardized error response format with a unique error code, message,
+    and optional related information.
+    """
+
+    code: ClassVar[str]
+
+    def __init__(self, *, message: str, related: str | None = None) -> None:
+        """
+        Initialize the BaseError following the standard error response format in the policy pattern docs errors.md.
+
+        Args:
+            message (str): A description of the error.
+            related (str | None): Additional information about the error, such as the field or type that caused it.
+        """
+        self.message = message
+        self.related = related
+        super().__init__(f"[{self.code}] {message}")

policy_pattern-0.1.0/policy_pattern/errors/evaluation_error.py

@@ -0,0 +1,16 @@
+"""
+Set of errors related to Evaluator runtime failures (budget exceeded, cycle detected).
+"""
+
+from .base_error import BaseError
+
+
+class EvaluationError(BaseError):
+    """
+    Error raised when check() cannot complete: a cycle was detected, or a configured
+    EvaluationBudget limit (max_depth, max_nodes, max_store_reads) was exceeded.
+    Attributes:
+        code (ClassVar[str]): A unique error code for the specific error type.
+    """
+
+    code = "PP201"