obligate 1.0.0__tar.gz

obligate-1.0.0/LICENSE

@@ -0,0 +1,33 @@
+BSD 4-Clause License
+
+Copyright (c) 2026, Samuel Jones
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. All advertising materials mentioning features or use of this software must
+   display the following acknowledgement:
+     This product includes software developed by Obligate.
+
+4. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY COPYRIGHT HOLDER "AS IS" AND ANY EXPRESS OR
+IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
+EVENT SHALL COPYRIGHT HOLDER BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
+OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
+OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

obligate-1.0.0/PKG-INFO

@@ -0,0 +1,48 @@
+Metadata-Version: 2.4
+Name: obligate
+Version: 1.0.0
+Summary: Utilities for enforcing contracts
+License-Expression: BSD-4-Clause
+License-File: LICENSE
+Keywords: contracts,runtime-validation,precondition,postcondition,validation
+Author: Samuel Jones
+Author-email: sjones.nova@gmail.com
+Requires-Python: >=3.14
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Testing
+Project-URL: Repository, https://github.com/sjones5516/obligate
+Description-Content-Type: text/markdown
+
+# Obligate
+
+Obligate is a Python library for enforcing contracts.
+
+## Installation
+
+Use the package manager pip to install obligate.
+
+```bash
+pip install obligate
+```
+
+## Usage
+
+```python
+import obligate
+
+@obligate.BoolValidator.pre(
+    lambda x : x >= 0,
+    lambda x: ValueError(f"Expected value greater than 0. Got {x}."),
+)
+def sqrt(x: float) -> float:
+    return x ** 0.5
+```
+
+## Contributing
+
+Pull requests are welcome. For major changes, please open an issue first
+to discuss what you would like to change.
+
+Please make sure to update tests as appropriate.
+

obligate-1.0.0/README.md

@@ -0,0 +1,31 @@
+# Obligate
+
+Obligate is a Python library for enforcing contracts.
+
+## Installation
+
+Use the package manager pip to install obligate.
+
+```bash
+pip install obligate
+```
+
+## Usage
+
+```python
+import obligate
+
+@obligate.BoolValidator.pre(
+    lambda x : x >= 0,
+    lambda x: ValueError(f"Expected value greater than 0. Got {x}."),
+)
+def sqrt(x: float) -> float:
+    return x ** 0.5
+```
+
+## Contributing
+
+Pull requests are welcome. For major changes, please open an issue first
+to discuss what you would like to change.
+
+Please make sure to update tests as appropriate.

obligate-1.0.0/pyproject.toml

@@ -0,0 +1,33 @@
+[project]
+name = "obligate"
+version = "1.0.0"
+description = "Utilities for enforcing contracts"
+license = "BSD-4-Clause"
+authors = [
+    {name = "Samuel Jones",email = "sjones.nova@gmail.com"}
+]
+keywords = ["contracts", "runtime-validation", "precondition", "postcondition", "validation"]
+dynamic = [ "classifiers" ]
+readme = "README.md"
+requires-python = ">=3.14"
+dependencies = [
+]
+
+[project.urls]
+repository = "https://github.com/sjones5516/obligate"
+
+[tool.poetry]
+packages = [{include = "obligate", from = "src"}]
+
+classifiers = [
+    "Topic :: Software Development :: Testing"
+]
+
+[build-system]
+requires = ["poetry-core>=2.0.0,<3.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[dependency-groups]
+dev = [
+    "pytest (>=9.1.1,<10.0.0)"
+]

obligate-1.0.0/src/obligate/__init__.py

@@ -0,0 +1 @@
+from src.obligate.boolvalidator import BoolValidator

obligate-1.0.0/src/obligate/boolvalidator.py

@@ -0,0 +1,60 @@
+import functools
+from typing import Callable
+
+
+class BoolValidator:
+    @staticmethod
+    def pre[**P, R](
+        condition: Callable[P, bool],
+        error: Callable[P, Exception],
+    ) -> Callable[[Callable[P, R]], Callable[P, R]]:
+        """Guard a function with a precondition, raising a dynamically built exception.
+
+        ``error`` is called with the *same* arguments that were passed to the
+        wrapped function, letting the exception message embed the actual
+        values that failed validation.
+
+        Args:
+            condition: Returns ``True`` if the arguments are valid.
+            error: Called as ``error(*args, **kwargs)`` when ``condition``
+                fails; must return an ``Exception`` instance to raise.
+        """
+
+        def decorator(func: Callable[P, R]) -> Callable[P, R]:
+            @functools.wraps(func)
+            def wrapper(*args: P.args, **kwargs: P.kwargs) -> R:
+                if not condition(*args, **kwargs):
+                    raise error(*args, **kwargs)
+                return func(*args, **kwargs)
+
+            return wrapper
+
+        return decorator
+
+    @staticmethod
+    def post[**P, R](
+        condition: Callable[[R], bool],
+        error: Callable[[R], Exception],
+    ) -> Callable[[Callable[P, R]], Callable[P, R]]:
+        """Guard a function with a postcondition, raising a dynamically built exception.
+
+        ``error`` is called with the wrapped function's return value, letting
+        the exception message embed the actual result that failed validation.
+
+        Args:
+            condition: Returns ``True`` if the result is valid.
+            error: Called as ``error(result)`` when ``condition`` fails; must
+                return an ``Exception`` instance to raise.
+        """
+
+        def decorator(func: Callable[P, R]) -> Callable[P, R]:
+            @functools.wraps(func)
+            def wrapper(*args: P.args, **kwargs: P.kwargs) -> R:
+                result = func(*args, **kwargs)
+                if not condition(result):
+                    raise error(result)
+                return result
+
+            return wrapper
+
+        return decorator