icalendar.prop.binary module#

BINARY values from RFC 5545.

class icalendar.prop.binary.vBinary(obj, params=None)[source]#

Bases: object

Binary property values are Base64 encoded.

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

property base64data: str#

The Base64-encoded string view of this value.

This is the same string that to_ical() produces, exposed as a plain str instead of bytes so you don't need to call base64.b64encode() yourself. See #1550.

Returns:: The Base64-encoded representation of the stored value.

bytes: bytes#

The raw binary value of the BINARY property.

This is the authoritative storage and round-trips losslessly, including for non-UTF-8 data. Use this instead of the deprecated obj.

default_value: ClassVar[str] = 'BINARY'#

classmethod examples()[source]#

Examples of vBinary.

Return type:: list[None]

static from_ical(ical)[source]#

Return type:: bytes

classmethod from_jcal(jcal_property)[source]#

Parse jCal from RFC 7265 to a vBinary.

Parameters:: jcal_property (list) – The jCal property to parse.
Raises:: JCalParsingError – If the provided jCal is invalid.
Return type:: None

property ical_value: bytes#: The raw bytes value of the BINARY property.

Added in version 7.1.0.

Changed in version 7.1.3: Returns the raw stored bytes. Previously the stored value was Base64-decoded, which raised ValueError for non-Base64 input. See #1356.

property obj: str#: Deprecated string view of the value.

Deprecated since version 7.1.3: Use bytes for the raw binary value. obj decodes bytes as text and is lossy for non-UTF-8 data. It will be removed in icalendar 8.

params: Parameters#

to_ical()[source]#

Return type:: bytes

to_jcal(name)[source]#

The jCal representation of this property according to RFC 7265.

Return type:: list