icalendar.prop.integer module

INT values from RFC 5545.

class icalendar.prop.integer.vInt(*args, params: dict[str, Any] | None = None, **kwargs)

Bases: int

Integer

Value Name:

INTEGER

Purpose:

This value type is used to identify properties that contain a signed integer value.

Format Definition:

This value type is defined by the following notation:

integer    = (["+"] / "-") 1*DIGIT

Description:

If the property permits, multiple "integer" values are specified by a COMMA-separated list of values. The valid range for "integer" is -2147483648 to 2147483647. If the sign is not specified, then the value is assumed to be positive.

The __new__ method creates a vInt instance:

Parameters:

• value – Integer value to encode. Can be positive or negative within the range -2147483648 to 2147483647.

• params – Optional parameter dictionary for the property.

Returns:

vInt instance

Examples

1234567890
-1234567890
+1234567890
432109876

>>> from icalendar.prop import vInt
>>> integer = vInt.from_ical('1234567890')
>>> integer
1234567890
>>> integer = vInt.from_ical('-1234567890')
>>> integer
-1234567890
>>> integer = vInt.from_ical('+1234567890')
>>> integer
1234567890
>>> integer = vInt.from_ical('432109876')
>>> integer
432109876

Create a PRIORITY property (1 = highest priority):

>>> priority = vInt(1)
>>> priority
1
>>> priority.to_ical()
b'1'

Create SEQUENCE property (for versioning):

>>> sequence = vInt(3)
>>> sequence.to_ical()
b'3'

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] = 'INTEGER'

classmethod examples()

Examples of vInt.

Return type:

list[None]

classmethod from_ical(ical)

classmethod from_jcal(jcal_property)

Parse jCal from RFC 7265.

Parameters:

jcal_property (list) – The jCal property to parse.

Raises:

JCalParsingError – If the provided jCal is invalid.

Return type:

None

params: Parameters

classmethod parse_jcal_value(value)

Parse a jCal value for vInt.

Raises:

JCalParsingError – If the value is not an int.

Return type:

int

to_ical()

Return type:

bytes

to_jcal(name)

The jCal representation of this property according to RFC 7265.

Return type:

list