1 2 3 4 5 6 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 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 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 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147
|
"""Tests for the iter library."""
from __future__ import annotations
import datetime
import random
from collections.abc import Generator
from typing import Any, Iterable, Iterator
import pytest
from dateutil import rrule
from ical.iter import (
MergedIterable,
MergedIterator,
RecurIterable,
RecurrenceError,
RulesetIterable,
)
EMPTY_LIST: list[bool] = []
EMPTY_ITERATOR_LIST: list[Iterator[bool]] = []
EMPTY_ITERABLE_LIST: list[Iterable[bool]] = []
def test_merged_empty() -> None:
"""Test iterating over an empty input."""
with pytest.raises(StopIteration):
next(iter(MergedIterable(EMPTY_ITERABLE_LIST)))
with pytest.raises(StopIteration):
next(iter(MergedIterator(EMPTY_ITERATOR_LIST)))
with pytest.raises(StopIteration):
next(MergedIterator(EMPTY_ITERATOR_LIST))
with pytest.raises(StopIteration):
next(MergedIterator([iter(EMPTY_LIST), iter(EMPTY_LIST)]))
def test_merge_is_sorted() -> None:
"""Test that the merge result of two sorted inputs is sorted."""
merged_it = MergedIterable([[1, 3, 5], [2, 4, 6]])
assert list(merged_it) == [1, 2, 3, 4, 5, 6]
def test_recur_empty() -> None:
"""Test recur with an empty input."""
def _is_even_year(value: datetime.date) -> bool:
return value.year % 2 == 0
input_dates = [
datetime.date(2022, 1, 1),
datetime.date(2023, 1, 1),
datetime.date(2024, 1, 1),
]
recur_it = RecurIterable(_is_even_year, input_dates)
assert list(recur_it) == [True, False, True]
# an iterator is an iterable
assert list(iter(iter(recur_it))) == [True, False, True]
def test_merge_false_values() -> None:
"""Test the merged iterator can handle values evaluating to False."""
merged_it: Iterable[float | int] = MergedIterable([[0, 1], [-2, 0, 0.5, 2]])
assert list(merged_it) == [-2, 0, 0, 0.5, 1, 2]
def test_merge_none_values() -> None:
"""Test the merged iterator can handle None values."""
merged_it = MergedIterable([[None, None], [None]])
assert list(merged_it) == [None, None, None]
@pytest.mark.parametrize(
"num_iters,num_objects",
[
(10, 10),
(10, 100),
(10, 1000),
(100, 10),
(100, 100),
],
)
def test_benchmark_merged_iter(
num_iters: int, num_objects: int, benchmark: Any
) -> None:
"""Add a benchmark for the merged iterator."""
def gen_items() -> Generator[float, None, None]:
nonlocal num_objects
for _ in range(num_objects):
yield random.random()
def exhaust() -> int:
nonlocal num_iters
merged_it = MergedIterable([gen_items() for _ in range(num_iters)])
return sum(1 for _ in merged_it)
result = benchmark(exhaust)
assert result == num_iters * num_objects
def test_debug_invalid_rules() -> None:
"""Exercise debug information by creating rules not supported by dateutil."""
recur_iter = RulesetIterable(
datetime.datetime(2022, 12, 19, 5, 0, 0),
[
rrule.rrule(
freq=rrule.DAILY,
dtstart=datetime.datetime(2022, 12, 19, 5, 0, 0),
count=3,
)
],
[datetime.date(2022, 12, 22)],
[datetime.date(2022, 12, 23)],
)
with pytest.raises(RecurrenceError) as exc_info:
list(recur_iter)
assert exc_info.value.args[0].startswith(
"Error evaluating recurrence rule (RulesetIterable(dtstart=2022-12-19 05:00:00, "
"rrule=['DTSTART:20221219T050000\\nRRULE:FREQ=DAILY;COUNT=3'], "
"rdate=[datetime.date(2022, 12, 22)], "
"exdate=[datetime.date(2022, 12, 23)]))"
)
def test_debug_invalid_rule_without_recur() -> None:
"""Test debugging information for another variation of unsupported ruleset."""
recur_iter = RulesetIterable(
datetime.datetime(2022, 12, 19, 5, 0, 0),
[],
[datetime.date(2022, 12, 22)],
[datetime.datetime(2022, 12, 23, 5, 0, 0)],
)
with pytest.raises(RecurrenceError) as exc_info:
list(recur_iter)
assert exc_info.value.args[0].startswith(
"Error evaluating recurrence rule (RulesetIterable(dtstart=2022-12-19 05:00:00, "
"rrule=[], "
"rdate=[datetime.date(2022, 12, 22)], "
"exdate=[datetime.datetime(2022, 12, 23, 5, 0)]))"
)
|