Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions news/1851.feature.4
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Added a ``byminute`` property accessor to :class:`~icalendar.prop.recur.recur.vRecur` for getting, setting, and deleting the ``BYMINUTE`` part of a recurrence rule. @RishabhIIITD
81 changes: 81 additions & 0 deletions src/icalendar/prop/recur/recur.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

from __future__ import annotations

from collections.abc import Iterable
from typing import TYPE_CHECKING, Any, ClassVar
from xml.etree.ElementTree import Element, SubElement

Expand Down Expand Up @@ -478,6 +479,86 @@ def wkst(self) -> None:
"""Delete the WKST part of the recurrence rule."""
self.pop("WKST", None)

@property
def byminute(self) -> tuple[int, ...]:
"""The BYMINUTE part of the recurrence rule.

This specifies a list of minutes of the hour for the recurrence, per
:rfc:`5545#section-3.3.10`. Valid values are integers from 0 to 59.

Returns:
A tuple of integer minutes, or an empty tuple if ``BYMINUTE`` is not set.

Raises:
InvalidCalendar: if a stored value cannot be converted to int or is
outside the valid range of 0 to 59.

Example:
.. code-block:: pycon

>>> from icalendar.prop import vRecur
>>> vRecur.from_ical("FREQ=HOURLY;BYMINUTE=0,15,30,45").byminute
(0, 15, 30, 45)
>>> vRecur.from_ical("FREQ=HOURLY;BYMINUTE=0").byminute
(0,)
>>> vRecur.from_ical("FREQ=HOURLY").byminute
()
"""
values = self.get("BYMINUTE")
if values is None:
return ()
if not isinstance(values, SEQUENCE_TYPES):
values = [values]
result: list[int] = []
for val in values:
if isinstance(val, bool):
raise InvalidCalendar(f"BYMINUTE values must be integers, got {val!r}")
try:
minute = int(val)
except (TypeError, ValueError) as e:
raise InvalidCalendar(
f"BYMINUTE values must be integers, got {val!r}"
) from e
if not 0 <= minute <= 59:
raise InvalidCalendar(
f"BYMINUTE values must be between 0 and 59, got {minute}"
)
result.append(minute)
return tuple(result)

@byminute.setter
def byminute(self, value: int | Iterable[int] | None) -> None:
"""Set the BYMINUTE part of the recurrence rule, or delete it if None or empty."""
if value is None:
del self.byminute
return
if isinstance(value, int) and not isinstance(value, bool):
minutes = [value]
elif isinstance(value, Iterable) and not isinstance(value, (str, bytes)):
minutes = list(value)
else:
raise TypeError(
f"byminute must be an int or an iterable of ints, got {value!r}"
)
if not minutes:
del self.byminute
return
validated: list[vNonNegativeInt] = []
for m in minutes:
if not isinstance(m, int) or isinstance(m, bool):
raise TypeError(f"byminute items must be integers, got {m!r}")
if not 0 <= m <= 59:
raise InvalidCalendar(
f"BYMINUTE values must be between 0 and 59, got {m}"
)
validated.append(vNonNegativeInt(m))
self["BYMINUTE"] = validated

@byminute.deleter
def byminute(self) -> None:
"""Delete the BYMINUTE part of the recurrence rule."""
self.pop("BYMINUTE", None)

def __eq__(self, other: object) -> bool:
"""self == other"""
if not isinstance(other, vRecur):
Expand Down
133 changes: 133 additions & 0 deletions src/icalendar/tests/prop/recur/test_byminute.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,133 @@
"""Tests for the vRecur.byminute accessor (issue #1851)."""

import pytest

from icalendar.error import InvalidCalendar
from icalendar.prop import vRecur
from icalendar.prop.integer import vNonNegativeInt


def test_byminute_returns_empty_tuple_when_absent():
"""BYMINUTE is not set at all."""
assert vRecur.from_ical("FREQ=HOURLY").byminute == ()


def test_byminute_returns_empty_tuple_when_empty_list():
"""If an empty list is in there, an empty tuple is returned."""
recur = vRecur(FREQ=["HOURLY"], BYMINUTE=[])
assert recur.byminute == ()


def test_byminute_returns_single_value():
assert vRecur.from_ical("FREQ=HOURLY;BYMINUTE=30").byminute == (30,)


def test_byminute_returns_multiple_values():
assert vRecur.from_ical("FREQ=HOURLY;BYMINUTE=0,15,30,45").byminute == (
0,
15,
30,
45,
)


def test_byminute_boundary_values_are_valid():
assert vRecur.from_ical("FREQ=HOURLY;BYMINUTE=0").byminute == (0,)
assert vRecur.from_ical("FREQ=HOURLY;BYMINUTE=59").byminute == (59,)


def test_setting_byminute_with_single_int():
recur = vRecur.from_ical("FREQ=HOURLY")
recur.byminute = 15
assert recur.byminute == (15,)
assert isinstance(recur["BYMINUTE"][0], vNonNegativeInt)
assert recur.to_ical() == b"FREQ=HOURLY;BYMINUTE=15"


def test_setting_byminute_with_list():
recur = vRecur.from_ical("FREQ=HOURLY")
recur.byminute = [0, 30]
assert recur.byminute == (0, 30)
assert recur.to_ical() == b"FREQ=HOURLY;BYMINUTE=0,30"


def test_setting_byminute_with_tuple():
recur = vRecur.from_ical("FREQ=HOURLY")
recur.byminute = (10, 20, 59)
assert recur.byminute == (10, 20, 59)
assert recur.to_ical() == b"FREQ=HOURLY;BYMINUTE=10,20,59"


def test_setting_byminute_to_none_deletes_value():
recur = vRecur.from_ical("FREQ=HOURLY;BYMINUTE=30")
recur.byminute = None
assert recur.byminute == ()
assert "BYMINUTE" not in recur


def test_setting_byminute_to_empty_sequence_deletes_value():
recur = vRecur.from_ical("FREQ=HOURLY;BYMINUTE=30")
recur.byminute = []
assert recur.byminute == ()
assert "BYMINUTE" not in recur

recur.byminute = [30]
recur.byminute = ()
assert recur.byminute == ()
assert "BYMINUTE" not in recur


def test_deleting_byminute_removes_value():
recur = vRecur.from_ical("FREQ=HOURLY;BYMINUTE=30")
del recur.byminute
assert recur.byminute == ()
assert "BYMINUTE" not in recur


def test_deleting_byminute_when_absent_does_not_raise():
recur = vRecur.from_ical("FREQ=HOURLY")
del recur.byminute
assert recur.byminute == ()


def test_setting_byminute_to_non_int_type_raises_type_error():
recur = vRecur.from_ical("FREQ=HOURLY")
with pytest.raises(TypeError):
recur.byminute = "30"
with pytest.raises(TypeError):
recur.byminute = [0, "30"]


def test_setting_byminute_to_bool_raises_type_error():
recur = vRecur.from_ical("FREQ=HOURLY")
with pytest.raises(TypeError):
recur.byminute = True
with pytest.raises(TypeError):
recur.byminute = [0, True]


@pytest.mark.parametrize("invalid_minute", [-1, 60, 100])
def test_setting_byminute_out_of_range_raises_invalid_calendar(invalid_minute):
recur = vRecur.from_ical("FREQ=HOURLY")
with pytest.raises(
InvalidCalendar, match="BYMINUTE values must be between 0 and 59"
):
recur.byminute = invalid_minute
with pytest.raises(
InvalidCalendar, match="BYMINUTE values must be between 0 and 59"
):
recur.byminute = [0, invalid_minute]


@pytest.mark.parametrize("stored", [-1, 60, "abc", True])
def test_directly_assigned_invalid_byminute_raises_invalid_calendar(stored):
recur = vRecur.from_ical("FREQ=HOURLY")
recur["BYMINUTE"] = [stored]
with pytest.raises(InvalidCalendar):
_ = recur.byminute


def test_byminute_roundtrips_through_ical():
recur = vRecur.from_ical("FREQ=HOURLY;BYMINUTE=0,15,30,45")
roundtripped = vRecur.from_ical(recur.to_ical().decode())
assert roundtripped.byminute == (0, 15, 30, 45)