Skip to content

Base

base

Core specification abstraction.

Provides the foundational specification contract without any composition
implementation details or dependencies.

Specification

Bases: ABC

Abstract predicate over a candidate object.

Specifications encapsulate business rules that can be evaluated
against an object of type T.

This is the minimal contract: only is_satisfied_by().
Composition (and_, or_, not_) is added by ComposableSpecification.

Source code in src/forging_blocks/foundation/specification/base.py 
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
class Specification[T](ABC):
    """Abstract predicate over a candidate object.

    Specifications encapsulate business rules that can be evaluated
    against an object of type T.

    This is the minimal contract: only is_satisfied_by().
    Composition (and_, or_, not_) is added by ComposableSpecification.
    """

    @abstractmethod
    def is_satisfied_by(self, candidate: T) -> bool:
        """Determine whether the candidate satisfies this specification.

        Args:
            candidate: The object to evaluate.

        Returns:
            True if the candidate satisfies this specification, False otherwise.
        """
        ...

is_satisfied_by(candidate: T) -> bool abstractmethod

Determine whether the candidate satisfies this specification.

Parameters:

Name Type Description Default
candidate T

The object to evaluate.

 required

Returns:

Type Description
bool

True if the candidate satisfies this specification, False otherwise.
Source code in src/forging_blocks/foundation/specification/base.py 
20
21
22
23
24
25
26
27
28
29
30
@abstractmethod
def is_satisfied_by(self, candidate: T) -> bool:
    """Determine whether the candidate satisfies this specification.

    Args:
        candidate: The object to evaluate.

    Returns:
        True if the candidate satisfies this specification, False otherwise.
    """
    ...