icalendar.prop.boolean module#

BOOLEAN values from RFC 5545.

class icalendar.prop.boolean.vBoolean(*args: Any, params: dict[str, Any] | None = None, **kwargs: Any)[source]#

Bases: int

An iCalendar boolean value.

Converts between iCalendar BOOLEAN value types and Python boolean values. Conforming with RFC 5545 Section 3.3.2, iCalendar boolean values are represented as TRUE or FALSE. Values parsed from iCalendar text are case insensitive.

Parameters:: params (Parameters) – iCalendar property parameters associated with the value.
Returns:: A new vBoolean instance with the supplied property parameters.

Examples

Parse, create, and use iCalendar boolean values.

>>> from icalendar import vBoolean
>>> vBoolean.from_ical("TRUE")
True
>>> vBoolean.from_ical("fAlse")
False
>>> boolean = vBoolean(True)
>>> if boolean:
...     print("TRUE")
TRUE
>>> boolean.to_ical()
b'TRUE'

BOOL_MAP = {'FALSE': False, 'TRUE': True}#

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] = 'BOOLEAN'#

classmethod examples()[source]#

Examples of vBoolean.

Return type:: list[None]

classmethod from_ical(ical)[source]#

Return type:: bool

classmethod from_jcal(jcal_property)[source]#

Parse jCal from RFC 7265 to a vBoolean.

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

property ical_value: bool#: BOOLEAN property type according to RFC 5545 Section 3.3.2

params: Parameters#

to_ical()[source]#

Converts a vBoolean to a BOOLEAN property type.

This class method takes a vBoolean—a Python boolean value—and converts it to an iCalendar BOOLEAN property type, in compliance with RFC 5545 Section 3.3.2.

Return type:: bytes
Returns:: Either "TRUE" or "FALSE" as bytes, depending on the value of the vBoolean.

to_jcal(name)[source]#

The jCal representation of this property according to RFC 7265.

Return type:: list