graph LR
rules_predicates_Predicate["rules.predicates.Predicate"]
rules_predicates_predicate["rules.predicates.predicate"]
rules_predicates_test["rules.predicates.test"]
rules_predicates__apply["rules.predicates._apply"]
rules_predicates__combine["rules.predicates._combine"]
rules_predicates_AND["rules.predicates.AND"]
rules_predicates_OR["rules.predicates.OR"]
rules_predicates_XOR["rules.predicates.XOR"]
rules_predicates_INVERT["rules.predicates.INVERT"]
rules_predicates_predicate -- "defines" --> rules_predicates_Predicate
rules_predicates_test -- "evaluates" --> rules_predicates_Predicate
rules_predicates_test -- "calls" --> rules_predicates__apply
rules_predicates_AND -- "delegates to" --> rules_predicates__combine
rules_predicates_OR -- "delegates to" --> rules_predicates__combine
rules_predicates_XOR -- "delegates to" --> rules_predicates__combine
rules_predicates_INVERT -- "relies on" --> rules_predicates__apply
rules_predicates__combine -- "uses" --> rules_predicates__apply
The rules.predicates subsystem provides a flexible and extensible framework for defining and evaluating logical conditions. At its core is the Predicate abstract base class, which establishes the contract for all predicate objects. The predicate decorator simplifies the creation of Predicate instances from regular functions, promoting a functional approach to rule definition. The test function serves as the public entry point for evaluating predicates, abstracting the internal execution details. Complex logical operations are supported through combiners like AND, OR, XOR, and INVERT, which leverage the internal _combine and _apply methods for efficient and consistent evaluation. This design promotes reusability and modularity, allowing for the construction of sophisticated rule sets from simple, composable predicates.
The abstract base class for all predicate objects. It defines the fundamental interface and evaluation contract (__call__, _apply), serving as the primary extension point for custom predicates. It embodies the Template Method Pattern by deferring the actual evaluation logic to subclasses or wrapped functions, while providing a consistent evaluation mechanism.
Related Classes/Methods:
A decorator/factory function that transforms regular Python functions into Predicate instances. This embodies the Decorator Pattern, allowing for easy definition of simple predicates without explicit class creation, and wrapping callable logic within the Predicate interface.
Related Classes/Methods:
The public entry point for evaluating any given predicate against a context. It acts as the primary interface for users to interact with the predicate evaluation logic, abstracting away the internal _apply mechanism.
Related Classes/Methods:
An internal method of the Predicate class responsible for invoking the predicate's underlying callable with the correct arguments within the current invocation context. It handles argument binding and ensures consistent execution. This method is a crucial internal helper for predicate evaluation.
Related Classes/Methods:
An internal method of the Predicate class used by logical combiners (AND, OR, XOR) to evaluate and combine the results of multiple predicates. It implements short-circuiting logic for efficiency. This method is a crucial internal helper for complex predicate logic.
Related Classes/Methods:
A logical combiner that evaluates multiple predicates with an "AND" operation. It is an instance of Predicate that leverages _combine for its logic.
Related Classes/Methods:
A logical combiner that evaluates multiple predicates with an "OR" operation. It is an instance of Predicate that leverages _combine for its logic.
Related Classes/Methods:
A logical combiner for exclusive OR operations. It is an instance of Predicate that leverages _combine for its logic.
Related Classes/Methods:
A logical operator that negates the result of a single predicate. It is an instance of Predicate that relies on _apply for its evaluation and then inverts the result.
Related Classes/Methods: