Skip to content

FrozenSeries

freezeframe.series.FrozenSeries 

FrozenSeries(array)

Typed, immutable series backed by a pyarrow.Array.

The type parameter T reflects the Python type of each element and is used by static analysis tools. At runtime the Arrow type is available via the type property.

Parameters:

Name Type Description Default
array Array

The underlying pa.Array. Must not be mutated externally after construction.

 required
Source code in src\freezeframe\series.py 
56
57
def __init__(self, array: pa.Array) -> None:
    object.__setattr__(self, "_array", array)

null_count property 

null_count

Number of null values.

type property 

type

The Arrow DataType of this series.

__eq__ 

__eq__(other)

Element-wise equality — returns a boolean pa.Array.

Source code in src\freezeframe\series.py 
128
129
130
def __eq__(self, other: Any) -> pa.Array:
    """Element-wise equality — returns a boolean ``pa.Array``."""
    return pc.equal(self._array, self._rhs(other))  # type: ignore[attr-defined]

__ge__ 

__ge__(other)

Element-wise greater-than-or-equal — returns a boolean pa.Array.

Source code in src\freezeframe\series.py 
148
149
150
def __ge__(self, other: Any) -> pa.Array:
    """Element-wise greater-than-or-equal — returns a boolean ``pa.Array``."""
    return pc.greater_equal(self._array, self._rhs(other))  # type: ignore[attr-defined]

__getitem__ 

__getitem__(index: int) -> T

__getitem__(index: slice) -> FrozenSeries[T]

__getitem__(index)

Return a single element or a sliced sub-series.

Parameters:

Name Type Description Default
index int | slice

An integer index returns the element as a Python value (nullable columns may return None). A slice returns a new FrozenSeries over the selected range.

 required
Source code in src\freezeframe\series.py 
106
107
108
109
110
111
112
113
114
115
116
117
118
def __getitem__(self, index: int | slice) -> T | FrozenSeries[T]:
    """Return a single element or a sliced sub-series.

    Parameters
    ----------
    index:
        An integer index returns the element as a Python value (nullable
        columns may return ``None``).  A slice returns a new
        ``FrozenSeries`` over the selected range.
    """
    if isinstance(index, slice):
        return FrozenSeries(self._array[index])
    return self._array[index].as_py()

__gt__ 

__gt__(other)

Element-wise greater-than — returns a boolean pa.Array.

Source code in src\freezeframe\series.py 
144
145
146
def __gt__(self, other: Any) -> pa.Array:
    """Element-wise greater-than — returns a boolean ``pa.Array``."""
    return pc.greater(self._array, self._rhs(other))  # type: ignore[attr-defined]

__iter__ 

__iter__()

Iterate over elements as Python values (nulls become None).

Source code in src\freezeframe\series.py 
95
96
97
98
def __iter__(self) -> Iterator[T]:
    """Iterate over elements as Python values (nulls become ``None``)."""
    for scalar in self._array:
        yield scalar.as_py()

__le__ 

__le__(other)

Element-wise less-than-or-equal — returns a boolean pa.Array.

Source code in src\freezeframe\series.py 
140
141
142
def __le__(self, other: Any) -> pa.Array:
    """Element-wise less-than-or-equal — returns a boolean ``pa.Array``."""
    return pc.less_equal(self._array, self._rhs(other))  # type: ignore[attr-defined]

__len__ 

__len__()

Number of elements.

Source code in src\freezeframe\series.py 
91
92
93
def __len__(self) -> int:
    """Number of elements."""
    return len(self._array)

__lt__ 

__lt__(other)

Element-wise less-than — returns a boolean pa.Array.

Source code in src\freezeframe\series.py 
136
137
138
def __lt__(self, other: Any) -> pa.Array:
    """Element-wise less-than — returns a boolean ``pa.Array``."""
    return pc.less(self._array, self._rhs(other))  # type: ignore[attr-defined]

__ne__ 

__ne__(other)

Element-wise inequality — returns a boolean pa.Array.

Source code in src\freezeframe\series.py 
132
133
134
def __ne__(self, other: Any) -> pa.Array:
    """Element-wise inequality — returns a boolean ``pa.Array``."""
    return pc.not_equal(self._array, self._rhs(other))  # type: ignore[attr-defined]

equals 

equals(other)

Return True if both series have identical type and values.

Unlike ==, this returns a single bool and correctly handles null values (two nulls at the same position are considered equal).

Parameters:

Name Type Description Default
other FrozenSeries[Any]

The series to compare against.

 required
Source code in src\freezeframe\series.py 
156
157
158
159
160
161
162
163
164
165
166
167
168
169
def equals(self, other: FrozenSeries[Any]) -> bool:
    """Return ``True`` if both series have identical type and values.

    Unlike ``==``, this returns a single ``bool`` and correctly handles
    null values (two nulls at the same position are considered equal).

    Parameters
    ----------
    other:
        The series to compare against.
    """
    if not isinstance(other, FrozenSeries):
        return NotImplemented
    return self._array.equals(other._array)

to_arrow 

to_arrow()

Return the underlying pa.Array directly.

Source code in src\freezeframe\series.py 
179
180
181
def to_arrow(self) -> pa.Array:
    """Return the underlying ``pa.Array`` directly."""
    return self._array

to_pylist 

to_pylist()

Return elements as a plain Python list (nulls become None).

Source code in src\freezeframe\series.py 
175
176
177
def to_pylist(self) -> list[T | None]:
    """Return elements as a plain Python list (nulls become ``None``)."""
    return self._array.to_pylist()