Skip to content

castlecraft_engineer.abstractions.specification

castlecraft_engineer.abstractions.specification

AndSpecification

Bases: Specification[T]

A composite specification that is satisfied if both of its component specifications are satisfied.

Source code in src/castlecraft_engineer/abstractions/specification.py 
43
44
45
46
47
48
49
50
51
52
53
54
55
56
class AndSpecification(Specification[T]):
    """
    A composite specification that is satisfied if both of its
    component specifications are satisfied.
    """

    def __init__(self, spec1: Specification[T], spec2: Specification[T]):
        self._spec1 = spec1
        self._spec2 = spec2

    def is_satisfied_by(self, candidate: T) -> bool:
        return self._spec1.is_satisfied_by(candidate) and self._spec2.is_satisfied_by(
            candidate
        )

NotSpecification

Bases: Specification[T]

A specification that is satisfied if its component specification is not satisfied (logical negation).

Source code in src/castlecraft_engineer/abstractions/specification.py 
75
76
77
78
79
80
81
82
83
84
85
class NotSpecification(Specification[T]):
    """
    A specification that is satisfied if its component specification
    is not satisfied (logical negation).
    """

    def __init__(self, spec: Specification[T]):
        self._spec = spec

    def is_satisfied_by(self, candidate: T) -> bool:
        return not self._spec.is_satisfied_by(candidate)

OrSpecification

Bases: Specification[T]

A composite specification that is satisfied if at least one of its component specifications is satisfied.

Source code in src/castlecraft_engineer/abstractions/specification.py 
59
60
61
62
63
64
65
66
67
68
69
70
71
72
class OrSpecification(Specification[T]):
    """
    A composite specification that is satisfied if at least one of its
    component specifications is satisfied.
    """

    def __init__(self, spec1: Specification[T], spec2: Specification[T]):
        self._spec1 = spec1
        self._spec2 = spec2

    def is_satisfied_by(self, candidate: T) -> bool:
        return self._spec1.is_satisfied_by(candidate) or self._spec2.is_satisfied_by(
            candidate
        )

Specification

Bases: ABC, Generic[T]

Abstract base class for the Specification pattern. A specification determines if a candidate object matches some criteria.

Source code in src/castlecraft_engineer/abstractions/specification.py 
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
class Specification(abc.ABC, Generic[T]):
    """
    Abstract base class for the Specification pattern.
    A specification determines if a candidate object matches some criteria.
    """

    @abc.abstractmethod
    def is_satisfied_by(self, candidate: T) -> bool:
        """
        Checks if the given candidate object satisfies the specification.

        Args:
            candidate: The object to check.

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

    def __and__(self, other: Any) -> "Specification[T]":
        """Combines this specification with another using a logical AND."""
        if not isinstance(other, Specification):
            return NotImplemented  # Allows Python to try reflected __rand__ or raise TypeError
        return AndSpecification(self, other)

    def __or__(self, other: Any) -> "Specification[T]":
        """Combines this specification with another using a logical OR."""
        if not isinstance(other, Specification):
            return NotImplemented  # Allows Python to try reflected __ror__ or raise TypeError
        return OrSpecification(self, other)

    def __invert__(self) -> "NotSpecification[T]":
        """Negates this specification using a logical NOT."""
        return NotSpecification(self)

__and__(other)

Combines this specification with another using a logical AND.

Source code in src/castlecraft_engineer/abstractions/specification.py 
26
27
28
29
30
def __and__(self, other: Any) -> "Specification[T]":
    """Combines this specification with another using a logical AND."""
    if not isinstance(other, Specification):
        return NotImplemented  # Allows Python to try reflected __rand__ or raise TypeError
    return AndSpecification(self, other)

__invert__()

Negates this specification using a logical NOT.

Source code in src/castlecraft_engineer/abstractions/specification.py 
38
39
40
def __invert__(self) -> "NotSpecification[T]":
    """Negates this specification using a logical NOT."""
    return NotSpecification(self)

__or__(other)

Combines this specification with another using a logical OR.

Source code in src/castlecraft_engineer/abstractions/specification.py 
32
33
34
35
36
def __or__(self, other: Any) -> "Specification[T]":
    """Combines this specification with another using a logical OR."""
    if not isinstance(other, Specification):
        return NotImplemented  # Allows Python to try reflected __ror__ or raise TypeError
    return OrSpecification(self, other)

is_satisfied_by(candidate) abstractmethod

Checks if the given candidate object satisfies the specification.

Parameters:

Name Type Description Default
candidate T

The object to check.

 required

Returns:

Type Description
bool

True if the candidate satisfies the specification, False otherwise.
Source code in src/castlecraft_engineer/abstractions/specification.py 
13
14
15
16
17
18
19
20
21
22
23
24
@abc.abstractmethod
def is_satisfied_by(self, candidate: T) -> bool:
    """
    Checks if the given candidate object satisfies the specification.

    Args:
        candidate: The object to check.

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