py-predicate 1.0__tar.gz → 1.2__tar.gz

{py_predicate-1.0 → py_predicate-1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: py_predicate
-Version: 1.0
+Version: 1.2
 Summary: Module to create composable predicates
 Author-email: Maurits Rijk <maurits.rijk@gmail.com>
 Requires-Python: >=3.10
@@ -50,6 +50,9 @@ Provides-Extra: test
 
 py-predicate is a typed Python library to create composable predicates.
 
+These predicates can be used for generating test-cases (property based testing) and
+run-time instrumenting of functions against a specification based on predicates.
+
 # Getting started
 
 To get started, install the library with [pip](https://pip.pypa.io/en/stable/)
@@ -87,9 +90,14 @@ series of integers for which the predicate ``between_2_and_3`` is False. The ``g
 infinite (well, with lots of duplicates obviously) series of integers for which the predicate is True.
 
 ```python
-from predicate import generate_false, generate_true
+from predicate import generate_false, generate_true, ge_p, le_p
 from more_itertools import take
 
+ge_2 = ge_p(2)
+le_3 = le_p(3)
+
+between_2_and_3 = ge_2 & le_3
+
 take(5, generate_true(between_2_and_3))
 
 take(5, generate_false(between_2_and_3))

{py_predicate-1.0 → py_predicate-1.2}/README.md

@@ -6,6 +6,9 @@
 
 py-predicate is a typed Python library to create composable predicates.
 
+These predicates can be used for generating test-cases (property based testing) and
+run-time instrumenting of functions against a specification based on predicates.
+
 # Getting started
 
 To get started, install the library with [pip](https://pip.pypa.io/en/stable/)
@@ -43,9 +46,14 @@ series of integers for which the predicate ``between_2_and_3`` is False. The ``g
 infinite (well, with lots of duplicates obviously) series of integers for which the predicate is True.
 
 ```python
-from predicate import generate_false, generate_true
+from predicate import generate_false, generate_true, ge_p, le_p
 from more_itertools import take
 
+ge_2 = ge_p(2)
+le_3 = le_p(3)
+
+between_2_and_3 = ge_2 & le_3
+
 take(5, generate_true(between_2_and_3))
 
 take(5, generate_false(between_2_and_3))

{py_predicate-1.0 → py_predicate-1.2}/predicate/__init__.py

@@ -2,86 +2,79 @@
 
 __version__ = "0.0.1"
 
+from predicate.all_predicate import all_p
 from predicate.always_false_predicate import always_false_p, never_p
 from predicate.always_true_predicate import always_p, always_true_p
+from predicate.any_predicate import any_p
+from predicate.comp_predicate import comp_p
+from predicate.dict_of_predicate import is_dict_of_p
+from predicate.eq_predicate import eq_false_p, eq_p, eq_true_p, zero_p
 from predicate.explain import explain
+from predicate.fn_predicate import fn_p, is_even_p, is_finite_p, is_inf_p, is_nan_p, is_odd_p
 from predicate.formatter import to_dot, to_json, to_latex
+from predicate.ge_predicate import ge_p
 from predicate.generator.generate_false import generate_false
 from predicate.generator.generate_true import generate_true
+from predicate.gt_predicate import gt_p, pos_p
+from predicate.has_key_predicate import has_key_p
+from predicate.has_length_predicate import has_length_p, is_empty_p, is_not_empty_p
+from predicate.has_path_predicate import has_path_p
+from predicate.implies_predicate import implies_p
+from predicate.in_predicate import in_p
+from predicate.is_falsy_predicate import is_falsy_p
+from predicate.is_instance_predicate import (
+    is_bool_p,
+    is_callable_p,
+    is_complex_p,
+    is_container_p,
+    is_datetime_p,
+    is_hashable_p,
+    is_instance_p,
+    is_iterable_p,
+    is_predicate_p,
+    is_range_p,
+    is_set_p,
+    is_tuple_p,
+    is_uuid_p,
+)
 from predicate.is_lambda_predicate import is_lambda_p, is_lambda_with_signature_p
+from predicate.is_none_predicate import is_none_p
+from predicate.is_not_none_predicate import is_not_none_p
+from predicate.is_predicate_of_p import is_predicate_of_p
+from predicate.is_subclass_predicate import is_enum_p
+from predicate.is_truthy_predicate import is_truthy_p
+from predicate.lazy_predicate import lazy_p
+from predicate.le_predicate import le_p
+from predicate.list_of_predicate import is_list_of_p
+from predicate.lt_predicate import lt_p, neg_p
 from predicate.match_predicate import exactly_n, match_p, optional, plus, repeat, star
+from predicate.ne_predicate import ne_p
+from predicate.not_in_predicate import not_in_p
 from predicate.optimizer.predicate_optimizer import can_optimize, optimize
+from predicate.range_predicate import ge_le_p, ge_lt_p, gt_le_p, gt_lt_p
+from predicate.regex_predicate import regex_p
+from predicate.set_of_predicate import is_set_of_p
 from predicate.set_predicates import (
-    in_p,
     is_real_subset_p,
     is_real_superset_p,
     is_subset_p,
     is_superset_p,
-    not_in_p,
 )
+from predicate.spec.exercise import exercise
+from predicate.spec.instrument import instrument_function
+from predicate.spec.spec import Spec
 from predicate.standard_predicates import (
-    all_p,
-    any_p,
-    comp_p,
-    eq_false_p,
-    eq_p,
-    eq_true_p,
-    fn_p,
-    ge_le_p,
-    ge_lt_p,
-    ge_p,
-    gt_le_p,
-    gt_lt_p,
-    gt_p,
-    has_key_p,
-    has_length_p,
-    is_bool_p,
-    is_callable_p,
-    is_complex_p,
-    is_container_p,
-    is_datetime_p,
-    is_dict_of_p,
     is_dict_p,
-    is_empty_p,
-    is_even_p,
-    is_falsy_p,
-    is_finite_p,
     is_float_p,
-    is_hashable_p,
-    is_inf_p,
-    is_instance_p,
     is_int_p,
     is_iterable_of_p,
-    is_iterable_p,
-    is_list_of_p,
     is_list_p,
-    is_nan_p,
-    is_none_p,
-    is_not_empty_p,
-    is_not_none_p,
-    is_odd_p,
-    is_predicate_of_p,
-    is_predicate_p,
-    is_range_p,
-    is_set_of_p,
-    is_set_p,
     is_str_p,
-    is_truthy_p,
-    is_tuple_of_p,
-    is_tuple_p,
-    is_uuid_p,
-    lazy_p,
-    le_p,
-    lt_p,
-    ne_p,
-    neg_p,
-    pos_p,
-    regex_p,
     root_p,
-    tee_p,
     this_p,
-    zero_p,
 )
+from predicate.tee_predicate import tee_p
+from predicate.tuple_of_predicate import is_tuple_of_p
 
 __all__ = [
     "all_p",
@@ -95,6 +88,7 @@ __all__ = [
     "eq_p",
     "eq_true_p",
     "exactly_n",
+    "exercise",
     "explain",
     "fn_p",
     "ge_le_p",
@@ -107,7 +101,10 @@ __all__ = [
     "gt_p",
     "has_key_p",
     "has_length_p",
+    "has_path_p",
+    "implies_p",
     "in_p",
+    "instrument_function",
     "is_alnum_p",
     "is_alpha_p",
     "is_ascii_p",
@@ -120,6 +117,7 @@ __all__ = [
     "is_dict_of_p",
     "is_dict_p",
     "is_empty_p",
+    "is_enum_p",
     "is_even_p",
     "is_falsy_p",
     "is_finite_p",
@@ -179,6 +177,7 @@ __all__ = [
     "to_json",
     "to_latex",
     "zero_p",
+    "Spec",
 ]
 
 from predicate.str_predicates import (

{py_predicate-1.0 → py_predicate-1.2}/predicate/all_predicate.py

@@ -2,7 +2,7 @@ from dataclasses import dataclass
 from typing import Iterable, override
 
 from predicate.helpers import first_false
-from predicate.predicate import Predicate
+from predicate.predicate import Predicate, resolve_predicate
 
 
 @dataclass
@@ -34,3 +34,8 @@ class AllPredicate[T](Predicate[T]):
         fail = first_false(iterable, self.predicate)
 
         return {"reason": f"Item '{fail}' didn't match predicate {self.predicate!r}"}
+
+
+def all_p[T](predicate: Predicate[T]) -> AllPredicate[T]:
+    """Return True if the predicate holds for each item in the iterable, otherwise False."""
+    return AllPredicate(predicate=resolve_predicate(predicate))

{py_predicate-1.0 → py_predicate-1.2}/predicate/always_false_predicate.py

@@ -8,7 +8,7 @@ from predicate.predicate import Predicate
 class AlwaysFalsePredicate(Predicate):
     """A predicate class that models the 'False' predicate."""
 
-    def __call__(self, *args, **kwargs):
+    def __call__(self, *args, **kwargs) -> bool:
         return False
 
     def __repr__(self) -> str:

{py_predicate-1.0 → py_predicate-1.2}/predicate/always_true_predicate.py

@@ -8,7 +8,7 @@ from predicate.predicate import Predicate
 class AlwaysTruePredicate(Predicate):
     """A predicate class that models the 'True' predicate."""
 
-    def __call__(self, *args, **kwargs):
+    def __call__(self, *args, **kwargs) -> bool:
         return True
 
     def __repr__(self) -> str:

{py_predicate-1.0 → py_predicate-1.2}/predicate/any_predicate.py

@@ -1,7 +1,7 @@
 from dataclasses import dataclass
 from typing import Iterable, override
 
-from predicate.predicate import Predicate
+from predicate.predicate import Predicate, resolve_predicate
 
 
 @dataclass
@@ -31,3 +31,8 @@ class AnyPredicate[T](Predicate[T]):
     @override
     def explain_failure(self, iterable: Iterable[T]) -> dict:
         return {"reason": f"No item matches predicate {self.predicate!r}"}
+
+
+def any_p[T](predicate: Predicate[T]) -> AnyPredicate[T]:
+    """Return True if the predicate holds for any item in the iterable, otherwise False."""
+    return AnyPredicate(predicate=resolve_predicate(predicate))

{py_predicate-1.0 → py_predicate-1.2}/predicate/comp_predicate.py

@@ -1,5 +1,5 @@
 from dataclasses import dataclass
-from typing import Callable, override
+from typing import Any, Callable, override
 
 from predicate.predicate import Predicate
 
@@ -24,3 +24,8 @@ class CompPredicate[S, T](Predicate[T]):
     @override
     def explain_failure(self, x: S) -> dict:
         return {"reason": self.predicate.explain(x)}
+
+
+def comp_p[T](fn: Callable[[Any], T], predicate: Predicate[T]) -> CompPredicate:
+    """Return a predicate, composed of a function and another predicate."""
+    return CompPredicate(fn=fn, predicate=predicate)

{py_predicate-1.0 → py_predicate-1.2}/predicate/constructor/construct.py

@@ -5,30 +5,26 @@ from more_itertools import first, gray_product, take
 from predicate import (
     always_false_p,
     always_true_p,
+    ge_p,
+    gt_p,
     is_datetime_p,
     is_falsy_p,
     is_float_p,
     is_int_p,
+    is_none_p,
     is_not_none_p,
     is_set_p,
     is_str_p,
     is_truthy_p,
-)
-from predicate.constructor.helpers import perfect_match, sort_by_match
-from predicate.constructor.mutate import mutations
-from predicate.predicate import Predicate
-from predicate.standard_predicates import (
-    ge_p,
-    gt_p,
-    is_bool_p,
-    is_dict_p,
-    is_list_p,
-    is_none_p,
     le_p,
     lt_p,
     ne_p,
-    zero_p,
 )
+from predicate.constructor.helpers import perfect_match, sort_by_match
+from predicate.constructor.mutate import mutations
+from predicate.eq_predicate import zero_p
+from predicate.is_instance_predicate import is_bool_p, is_dict_p, is_list_p
+from predicate.predicate import Predicate
 
 
 def construct(false_set: list, true_set: list, attempts: int = 30) -> Predicate | None:

{py_predicate-1.0 → py_predicate-1.2}/predicate/dict_of_predicate.py

@@ -53,7 +53,7 @@ class DictOfPredicate[T](Predicate[T]):
 
 
 def to_key_p(key_p: Predicate | str) -> Predicate:
-    from predicate.standard_predicates import eq_p
+    from predicate import eq_p
 
     match key_p:
         case str(s):
@@ -68,3 +68,9 @@ def from_key_p(key_p: Predicate) -> Predicate | str:
             return v
         case _:
             return key_p
+
+
+def is_dict_of_p(*predicates: tuple[Predicate | str, Predicate]) -> Predicate:
+    """Return True if value is a set, and for all elements in the set the predicate is True, otherwise False."""
+    # return is_set_p & all_p(predicate)
+    return DictOfPredicate(list(predicates))

{py_predicate-1.0 → py_predicate-1.2}/predicate/eq_predicate.py

@@ -1,5 +1,5 @@
 from dataclasses import dataclass
-from typing import override
+from typing import Final, override
 
 from predicate.predicate import Predicate
 
@@ -23,3 +23,18 @@ class EqPredicate[T](Predicate[T]):
     @override
     def explain_failure(self, x: T) -> dict:
         return {"reason": f"{x} is not equal to {self.v!r}"}
+
+
+def eq_p[T](v: T) -> EqPredicate[T]:
+    """Return True if the value is equal to the constant, otherwise False."""
+    return EqPredicate(v=v)
+
+
+zero_p: Final[EqPredicate] = eq_p(0)
+"""Returns True of the value is zero, otherwise False."""
+
+eq_true_p: Final[EqPredicate] = eq_p(True)
+"""Returns True if the value is True, otherwise False."""
+
+eq_false_p: Final[EqPredicate] = eq_p(False)
+"""Returns True if the value is False, otherwise False."""

py_predicate-1.2/predicate/fn_predicate.py

@@ -0,0 +1,67 @@
+import math
+from dataclasses import dataclass
+from itertools import repeat
+from typing import Callable, Final, Iterator, override
+
+from predicate.generator.helpers import generate_even_numbers, generate_odd_numbers, random_floats
+from predicate.predicate import Predicate
+
+
+def undefined() -> Iterator:
+    raise ValueError("Please register generator type")
+
+
+@dataclass
+class FnPredicate[T](Predicate[T]):
+    """A predicate class that can hold a function."""
+
+    predicate_fn: Callable[[T], bool]
+    generate_false_fn: Callable[[], Iterator] = undefined
+    generate_true_fn: Callable[[], Iterator] = undefined
+
+    def __call__(self, x: T) -> bool:
+        return self.predicate_fn(x)
+
+    def __repr__(self) -> str:
+        return f"fn_p(predicate_fn={self.predicate_fn.__name__})"
+
+    @override
+    def explain_failure(self, x: T) -> dict:
+        return {"reason": f"Function returned False for value {x}"}
+
+
+def fn_p[T](
+    fn: Callable[[T], bool],
+    generate_false_fn: Callable[[], Iterator[T]] = undefined,
+    generate_true_fn: Callable[[], Iterator[T]] = undefined,
+) -> Predicate[T]:
+    """Return the boolean value of the function call."""
+    return FnPredicate(predicate_fn=fn, generate_false_fn=generate_false_fn, generate_true_fn=generate_true_fn)
+
+
+is_even_p: Final[Predicate[int]] = fn_p(
+    fn=lambda x: x % 2 == 0, generate_true_fn=generate_even_numbers, generate_false_fn=generate_odd_numbers
+)
+is_odd_p: Final[Predicate[int]] = fn_p(
+    fn=lambda x: x % 2 != 0, generate_true_fn=generate_odd_numbers, generate_false_fn=generate_even_numbers
+)
+
+
+def generate_nan() -> Iterator:
+    yield from repeat(math.nan)
+
+
+def generate_inf() -> Iterator:
+    while True:
+        yield -math.inf
+        yield math.inf
+
+
+is_finite_p: Final[Predicate] = fn_p(fn=math.isfinite, generate_true_fn=random_floats, generate_false_fn=generate_inf)
+"""Return True if value is finite, otherwise False."""
+
+is_inf_p: Final[Predicate] = fn_p(fn=math.isinf, generate_true_fn=generate_inf, generate_false_fn=random_floats)
+"""Return True if value is infinite, otherwise False."""
+
+is_nan_p: Final[Predicate] = fn_p(fn=math.isnan, generate_true_fn=generate_nan, generate_false_fn=random_floats)
+"""Return True if value is not a number, otherwise False."""

{py_predicate-1.0 → py_predicate-1.2}/predicate/formatter/format_dot.py

@@ -17,6 +17,7 @@ from predicate.formatter.helpers import set_to_str
 from predicate.ge_predicate import GePredicate
 from predicate.gt_predicate import GtPredicate
 from predicate.implies import Implies
+from predicate.in_predicate import InPredicate
 from predicate.is_falsy_predicate import IsFalsyPredicate
 from predicate.is_instance_predicate import IsInstancePredicate
 from predicate.is_none_predicate import IsNonePredicate
@@ -26,6 +27,7 @@ from predicate.le_predicate import LePredicate
 from predicate.lt_predicate import LtPredicate
 from predicate.named_predicate import NamedPredicate
 from predicate.ne_predicate import NePredicate
+from predicate.not_in_predicate import NotInPredicate
 from predicate.optimizer.predicate_optimizer import optimize
 from predicate.predicate import (
     AndPredicate,
@@ -37,12 +39,10 @@ from predicate.predicate import (
 from predicate.range_predicate import GeLePredicate, GeLtPredicate, GtLePredicate, GtLtPredicate
 from predicate.root_predicate import RootPredicate, find_root_predicate
 from predicate.set_predicates import (
-    InPredicate,
     IsRealSubsetPredicate,
     IsRealSupersetPredicate,
     IsSubsetPredicate,
     IsSupersetPredicate,
-    NotInPredicate,
 )
 from predicate.tee_predicate import TeePredicate
 from predicate.this_predicate import ThisPredicate, find_this_predicate

{py_predicate-1.0 → py_predicate-1.2}/predicate/formatter/format_latex.py

@@ -6,6 +6,7 @@ from predicate.eq_predicate import EqPredicate
 from predicate.ge_predicate import GePredicate
 from predicate.gt_predicate import GtPredicate
 from predicate.implies_predicate import ImpliesPredicate
+from predicate.in_predicate import InPredicate
 from predicate.le_predicate import LePredicate
 from predicate.lt_predicate import LtPredicate
 from predicate.ne_predicate import NePredicate
@@ -18,7 +19,6 @@ from predicate.predicate import (
 )
 from predicate.range_predicate import GeLePredicate, GeLtPredicate, GtLePredicate, GtLtPredicate
 from predicate.set_predicates import (
-    InPredicate,
     IsRealSubsetPredicate,
     IsRealSupersetPredicate,
     IsSubsetPredicate,

{py_predicate-1.0 → py_predicate-1.2}/predicate/ge_predicate.py

@@ -23,3 +23,8 @@ class GePredicate[T](Predicate[T]):
     @override
     def explain_failure(self, x: T) -> dict:
         return {"reason": f"{x} is not greater or equal to {self.v!r}"}
+
+
+def ge_p(v: ConstrainedT) -> GePredicate[ConstrainedT]:
+    """Return True if the value is greater or equal than the constant, otherwise False."""
+    return GePredicate(v=v)