Skip to content

undefined

UNDEFINED module-attribute 

UNDEFINED = Undefined()

A value that does not exist.

UndefinedNoneOr module-attribute 

UndefinedNoneOr = UndefinedOr[t.Optional[T]]

A value that is undefined, none, or T

UndefinedOr module-attribute 

UndefinedOr = t.Union[T, Undefined]

A value that is undefined or T

Undefined

Represents an undefined value - without being None.

Source code in unkey/undefined.py 
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
class Undefined:
    """Represents an undefined value - without being None."""

    __slots__ = ()

    def __bool__(self) -> t.Literal[False]:
        return False

    def __copy__(self) -> Undefined:
        return self

    def __deepcopy__(self, memo: t.MutableMapping[int, t.Any]) -> Undefined:
        memo[id(self)] = self
        return self

    def __getstate__(self) -> t.Any:
        return False

    def __repr__(self) -> str:
        return "UNDEFINED"

    def __reduce__(self) -> str:
        return "UNDEFINED"

    def __str__(self) -> str:
        return "UNDEFINED"

all_undefined 

all_undefined(*values: t.Any) -> bool

Whether or not all values are undefined.

Parameters:

Name Type Description Default
*values t.Any

The values to check.

 ()

Returns:

Type Description
bool

True if all values were undefined.
Source code in unkey/undefined.py 
77
78
79
80
81
82
83
84
85
86
def all_undefined(*values: t.Any) -> bool:
    """Whether or not all values are undefined.

    Arguments:
        *values: The values to check.

    Returns:
        `True` if all values were undefined.
    """
    return all(v is UNDEFINED for v in values)

any_undefined 

any_undefined(*values: t.Any) -> bool

Whether or not any values are undefined.

Parameters:

Name Type Description Default
*values t.Any

The values to check.

 ()

Returns:

Type Description
bool

True if any values were undefined.
Source code in unkey/undefined.py 
89
90
91
92
93
94
95
96
97
98
def any_undefined(*values: t.Any) -> bool:
    """Whether or not any values are undefined.

    Arguments:
        *values: The values to check.

    Returns:
        `True` if any values were undefined.
    """
    return any(v is UNDEFINED for v in values)