icalendar.prop.unknown module#

UNKNOWN values from RFC 7265.

class icalendar.prop.unknown.vUnknown(value: str | bytes, encoding: str = 'utf-8', /, params: dict[str, Any] | None = None)[source]#

Bases: vText

This is text but the VALUE parameter is unknown.

Since RFC 7265, it is important to record if values are unknown. For RFC 5545, we could just assume TEXT.

Create a new vText instance.

This method overrides str.__new__() because TEXT values inherit from str, which is immutable. The __new__ method decodes bytes if needed, creates the string instance, and attaches encoding metadata and iCalendar property parameters.

Parameters:

  • value – Raw text passed to to_unicode() before constructing the str value.

  • encoding – Encoding used when value is bytes.

  • params (Parameters) – Optional property parameters according to RFC 5545.

Returns:

A new vText instance with associated parameters.

Examples

>>> from icalendar import vText
>>> t = vText("Hello", params={"LANGUAGE": "en"})
>>> str(t)
'Hello'
>>> t.encoding
'utf-8'
>>> t.params
Parameters({'LANGUAGE': 'en'})
property VALUE: str#

The VALUE parameter or the default.

Purpose:

VALUE explicitly specify the value type format for a property value.

Description:

This parameter specifies the value type and format of the property value. The property values MUST be of a single value type. For example, a "RDATE" property cannot have a combination of DATE-TIME and TIME value types.

If the property's value is the default value type, then this parameter need not be specified. However, if the property's default value type is overridden by some other allowable value type, then this parameter MUST be specified.

Applications MUST preserve the value data for x-name and iana-token values that they don't recognize without attempting to interpret or parse the value data.

Returns:

The VALUE parameter or the default.

Examples

The VALUE defaults to the name of the property. Note that it is case-insensitive but always uppercase.

>>> from icalendar import vBoolean
>>> b = vBoolean(True)
>>> b.VALUE
'BOOLEAN'

Setting the VALUE parameter of a typed property usually does not make sense. For convenience, using this property, the value will be converted to an uppercase string. If you have some custom property, you might use it like this:

>>> from icalendar import vUnknown, Event
>>> v = vUnknown("Some property text.")
>>> v.VALUE = "x-type"  # lower case
>>> v.VALUE
'X-TYPE'
>>> event = Event()
>>> event.add("x-prop", v)
>>> print(event.to_ical())
BEGIN:VEVENT
X-PROP;VALUE=X-TYPE:Some property text.
END:VEVENT
default_value: ClassVar[str] = 'UNKNOWN'#
encoding#
classmethod examples()[source]#

Examples of vUnknown.

Return type:

list[None]

params: Parameters#