icalendar.prop.broken module

Parsing error value preservation.

class icalendar.prop.broken.vBroken(value, encoding='utf-8', /, params=None, expected_type=None, property_name=None, parse_error=None)

Bases: vText

Property that failed to parse, preserving raw value as text.

Represents property values that failed to parse with their expected type. The raw iCalendar string is preserved for round-trip serialization: ical -> xcal -> ical

default_value: ClassVar[str] = 'X-BROKEN'

The default value is x-broken.

With this, we can identify broken properties in xCal round-trip.

classmethod examples()

Examples of vBroken.

Return type:

list[Self]

expected_type

classmethod from_parse_error(raw_value, params, property_name, expected_type, error)

Create vBroken from parse failure.

Return type:

Self

parse_error

property_name

to_jcal(name)

Serialize the unparsed value as the RFC 7265 Section 7.1 unknown type.

Return type:

list