icalendar.prop.org module

The ORG property from RFC 6350.

class icalendar.prop.org.vOrg(fields, /, params=None)

Bases: object

vCard ORG (Organization) structured property per RFC 6350 Section 6.6.4.

The ORG property specifies the organizational name and units associated with the vCard.

Its value is a structured type consisting of components separated by semicolons. The components are the organization name, followed by zero or more levels of organizational unit names:

organization-name; organizational-unit-1; organizational-unit-2; ...

Semicolons are field separators and are NOT escaped. Commas and backslashes within field values ARE escaped per RFC 6350.

Examples

A property value consisting of an organizational name, organizational unit #1 name, and organizational unit #2 name.

ORG:ABC\, Inc.;North American Division;Marketing

The same example in icalendar.

>>> from icalendar.prop import vOrg
>>> org = vOrg(("ABC, Inc.", "North American Division", "Marketing"))
>>> org.to_ical()
b'ABC\\, Inc.;North American Division;Marketing'
>>> vOrg.from_ical(r"ABC\, Inc.;North American Division;Marketing")
('ABC, Inc.', 'North American Division', 'Marketing')

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

__init__(fields, /, params=None)

Initialize ORG with variable fields or parse from vCard format string.

Parameters:

• fields (tuple[str, ...] | list[str] | str) -- Either a tuple or list of one or more strings, or a vCard format string with semicolon-separated fields

• params (dict[str, Any] | None) -- Optional property parameters

default_value: ClassVar[str] = 'TEXT'

classmethod examples()

Examples of vOrg.

Return type:

list[None]

fields: tuple[str, ...]

static from_ical(ical)

Parse vCard ORG format into a tuple of fields.

Parameters:

ical (str | bytes) -- vCard format string with semicolon-separated fields

Return type:

tuple[str, ...]

Returns:

Tuple of field values with one or more fields

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

property ical_value: tuple[str, ...]

The organization fields as a tuple.

property name: str

The organization name (first field).

params: Parameters

to_ical()

Generate vCard format with semicolon-separated fields.

Return type:

bytes

to_jcal(name)

The jCal representation of this property according to RFC 7265.

Return type:

list

property units: tuple[str, ...]

The organizational unit names (remaining fields after the name).