Skip to content

Pure

Bases: PurityResult

Class for pure results.

A function is pure if it has no (External-, Internal-)Read nor (External-, Internal-)Write side effects. A pure function must also have no unknown reasons.

Attributes:

Name Type Description
is_class bool

Whether the result is for a class or not.
Source code in src/library_analyzer/processing/api/purity_analysis/model/_purity.py 
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
@dataclass
class Pure(PurityResult):
    """Class for pure results.

    A function is pure if it has no (External-, Internal-)Read nor (External-, Internal-)Write side effects.
    A pure function must also have no unknown reasons.

    Attributes
    ----------
    is_class :
        Whether the result is for a class or not.
    """

    is_class: bool = False

    def update(self, other: PurityResult | None) -> PurityResult:
        """Update the current result with another result.

        Parameters
        ----------
        other :
            The result to update with.

        Returns
        -------
        PurityResult
            The updated result.

        Raises
        ------
        TypeError
            If the result cannot be updated with the given result.
        """
        if other is None:
            return self.clone()
        elif isinstance(self, Pure):
            if isinstance(other, Pure):
                return self.clone()
            elif isinstance(other, Impure):
                return other.clone()
        elif isinstance(self, Impure):
            if isinstance(other, Pure):
                return self.clone()
            elif isinstance(other, Impure):
                return Impure(reasons=self.reasons | other.reasons).clone()

        raise TypeError(f"Cannot update {self} with {other}")

    @staticmethod
    def clone() -> Pure:
        return Pure()

    def to_dict(self, shorten: bool = False) -> dict[str, Any]:  # noqa: ARG002
        return {"purity": self.__class__.__name__}

    def __hash__(self) -> int:
        return hash(str(self))

    def __str__(self) -> str:
        return f"{self.__class__.__name__}"

is_class: bool = False class-attribute instance-attribute

__hash__()

Source code in src/library_analyzer/processing/api/purity_analysis/model/_purity.py 
111
112
def __hash__(self) -> int:
    return hash(str(self))

__init__(is_class=False)

__str__()

Source code in src/library_analyzer/processing/api/purity_analysis/model/_purity.py 
114
115
def __str__(self) -> str:
    return f"{self.__class__.__name__}"

clone() staticmethod

Source code in src/library_analyzer/processing/api/purity_analysis/model/_purity.py 
104
105
106
@staticmethod
def clone() -> Pure:
    return Pure()

to_dict(shorten=False)

Source code in src/library_analyzer/processing/api/purity_analysis/model/_purity.py 
108
109
def to_dict(self, shorten: bool = False) -> dict[str, Any]:  # noqa: ARG002
    return {"purity": self.__class__.__name__}

update(other)

Update the current result with another result.

Parameters:

Name Type Description Default
other PurityResult | None

The result to update with.

 required

Returns:

Type Description
PurityResult

The updated result.

Raises:

Type Description
TypeError

If the result cannot be updated with the given result.
Source code in src/library_analyzer/processing/api/purity_analysis/model/_purity.py 
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
def update(self, other: PurityResult | None) -> PurityResult:
    """Update the current result with another result.

    Parameters
    ----------
    other :
        The result to update with.

    Returns
    -------
    PurityResult
        The updated result.

    Raises
    ------
    TypeError
        If the result cannot be updated with the given result.
    """
    if other is None:
        return self.clone()
    elif isinstance(self, Pure):
        if isinstance(other, Pure):
            return self.clone()
        elif isinstance(other, Impure):
            return other.clone()
    elif isinstance(self, Impure):
        if isinstance(other, Pure):
            return self.clone()
        elif isinstance(other, Impure):
            return Impure(reasons=self.reasons | other.reasons).clone()

    raise TypeError(f"Cannot update {self} with {other}")