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 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218
|
"""Tests for component encoding and decoding."""
from pydantic import field_serializer
import pytest
import datetime
import zoneinfo
from typing import Optional, Union
from ical.component import ComponentModel
from ical.exceptions import CalendarParseError, ParameterValueError
from ical.parsing.component import ParsedComponent
from ical.parsing.property import ParsedProperty, ParsedPropertyParameter
from ical.types.data_types import serialize_field
def test_encode_component() -> None:
"""Test for a text property value."""
class OtherComponent(ComponentModel):
"""Model used as a sub-component."""
other_value: str
second_value: Optional[str] = None
class TestModel(ComponentModel):
"""Model with a Text value."""
text_value: str
repeated_text_value: list[str]
some_component: list[OtherComponent]
single_component: OtherComponent
dt: datetime.datetime
serialize_fields = field_serializer("*")(serialize_field) # type: ignore[pydantic-field]
model = TestModel.model_validate(
{
"text_value": "Example text",
"repeated_text_value": ["a", "b", "c"],
"some_component": [
{"other_value": "value1", "second_value": "valuez"},
{"other_value": "value2"},
],
"single_component": {
"other_value": "value3",
},
"dt": [ParsedProperty(name="dt", value="20220724T120000")],
}
)
component = model.__encode_component_root__()
assert component.name == "TestModel"
assert component.properties == [
ParsedProperty(name="text_value", value="Example text"),
ParsedProperty(name="repeated_text_value", value="a"),
ParsedProperty(name="repeated_text_value", value="b"),
ParsedProperty(name="repeated_text_value", value="c"),
ParsedProperty(name="dt", value="20220724T120000"),
]
assert component.components == [
ParsedComponent(
name="some_component",
properties=[
ParsedProperty(name="other_value", value="value1"),
ParsedProperty(name="second_value", value="valuez"),
],
),
ParsedComponent(
name="some_component",
properties=[
ParsedProperty(name="other_value", value="value2"),
],
),
ParsedComponent(
name="single_component",
properties=[
ParsedProperty(name="other_value", value="value3"),
],
),
]
def test_list_parser() -> None:
"""Test for a repeated property value."""
class TestModel(ComponentModel):
"""Model under test."""
dt: list[datetime.datetime]
model = TestModel.model_validate(
{
"dt": [
ParsedProperty(name="dt", value="20220724T120000"),
ParsedProperty(name="dt", value="20220725T130000"),
],
}
)
assert model.dt == [
datetime.datetime(2022, 7, 24, 12, 0, 0),
datetime.datetime(2022, 7, 25, 13, 0, 0),
]
def test_list_union_parser() -> None:
"""Test for a repeated union value."""
class TestModel(ComponentModel):
"""Model under test."""
dt: list[Union[datetime.datetime, datetime.date]]
model = TestModel.model_validate(
{
"dt": [
ParsedProperty(name="dt", value="20220724T120000"),
ParsedProperty(name="dt", value="20220725"),
],
}
)
assert model.dt == [
datetime.datetime(2022, 7, 24, 12, 0, 0),
datetime.date(2022, 7, 25),
]
def test_optional_field_parser() -> None:
"""Test for an optional field parser."""
class TestModel(ComponentModel):
"""Model under test."""
dt: Optional[datetime.datetime] = None
model = TestModel.model_validate(
{"dt": [ParsedProperty(name="dt", value="20220724T120000")]}
)
assert model.dt == datetime.datetime(2022, 7, 24, 12, 0, 0)
def test_union_parser() -> None:
"""Test for a union value."""
class TestModel(ComponentModel):
"""Model under test."""
dt: Union[datetime.datetime, datetime.date]
with pytest.raises(CalendarParseError, match=".*Expected one value for field: dt"):
model = TestModel.model_validate(
{
"dt": [
ParsedProperty(name="dt", value="20220724T120000"),
ParsedProperty(name="dt", value="20220725"),
],
},
)
model = TestModel.model_validate(
{
"dt": [
ParsedProperty(name="dt", value="20220724T120000"),
],
}
)
assert model.dt == datetime.datetime(2022, 7, 24, 12, 0, 0)
model = TestModel.model_validate(
{
"dt": [
ParsedProperty(name="dt", value="20220725"),
],
}
)
assert model.dt == datetime.date(2022, 7, 25)
model = TestModel.model_validate(
{
"dt": [
ParsedProperty(
name="dt",
value="20220724T120000",
params=[ParsedPropertyParameter("TZID", ["America/New_York"])],
),
],
}
)
assert model.dt == datetime.datetime(
2022, 7, 24, 12, 0, 0, tzinfo=zoneinfo.ZoneInfo(key="America/New_York")
)
assert model.dt != datetime.datetime(2022, 7, 24, 12, 0, 0)
with pytest.raises(
CalendarParseError,
match="Expected DATE-TIME TZID value 'America/New_Mork' to be valid timezone.*",
):
model = TestModel.model_validate(
{
"dt": [
ParsedProperty(
name="dt",
value="20220724T120000",
params=[ParsedPropertyParameter("TZID", ["America/New_Mork"])],
),
],
}
)
with pytest.raises(
CalendarParseError,
match=".*Failed to validate: .* as datetime or date, due to: .*Expected value to match DATE-TIME pattern: .*Expected value to match DATE pattern: .*",
):
model = TestModel.model_validate(
{
"dt": [
ParsedProperty(name="dt", value="2025NotADateOrADateTime"),
],
}
)
|