icalendar.prop.adr module#

ADR property of RFC 6350.

class icalendar.prop.adr.AdrFields(po_box: str, extended: str, street: str, locality: str, region: str, postal_code: str, country: str)[source]#

Bases: NamedTuple

Named fields for vCard ADR (Address) property per RFC 6350 Section 6.3.1.

Provides named access to the seven address components.

country: str#

Country name (full name).

extended: str#

Extended address (e.g., apartment or suite number).

locality: str#

Locality (e.g., city).

po_box: str#

Post office box.

postal_code: str#

Postal code.

region: str#

Region (e.g., state or province).

street: str#

Street address.

class icalendar.prop.adr.vAdr(fields, /, params=None)[source]#

Bases: object

vCard ADR (Address) structured property per RFC 6350 Section 6.3.1.

The ADR property represents a delivery address as a single text value. The structured type value consists of a sequence of seven address components. The component values must be specified in their corresponding position.

  • post office box

  • extended address (e.g., apartment or suite number)

  • street address

  • locality (e.g., city)

  • region (e.g., state or province)

  • postal code

  • country name (full name)

When a component value is missing, the associated component separator MUST still be specified.

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

Examples

>>> from icalendar.prop import vAdr
>>> adr = vAdr(("", "", "123 Main St", "Springfield", "IL", "62701", "USA"))
>>> adr.to_ical()
b';;123 Main St;Springfield;IL;62701;USA'
>>> vAdr.from_ical(";;123 Main St;Springfield;IL;62701;USA")
AdrFields(po_box='', extended='', street='123 Main St', locality='Springfield', region='IL', postal_code='62701', country='USA')
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)[source]#

Initialize ADR with seven fields or parse from vCard format string.

Parameters:

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

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

default_value: ClassVar[str] = 'TEXT'#
classmethod examples()[source]#

Examples of vAdr.

Return type:

list[None]

fields: AdrFields#
static from_ical(ical)[source]#

Parse vCard ADR format into an AdrFields named tuple.

Parameters:

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

Return type:

AdrFields

Returns:

AdrFields named tuple with seven field values.

classmethod from_jcal(jcal_property)[source]#

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: AdrFields#

The address fields as a named tuple.

params: Parameters#
to_ical()[source]#

Generate vCard format with semicolon-separated fields.

Return type:

bytes

to_jcal(name)[source]#

The jCal representation of this property according to RFC 7265.

Return type:

list