icalendar.prop.geo module

GEO property values from RFC 5545.

class icalendar.prop.geo.vGeo(geo, /, params=None)

Bases: object

Geographic Position

Property Name:

GEO

Purpose:

This property specifies information related to the global position for the activity specified by a calendar component.

Value Type:

FLOAT. The value MUST be two SEMICOLON-separated FLOAT values.

Property Parameters:

IANA and non-standard property parameters can be specified on this property.

Conformance:

This property can be specified in "VEVENT" or "VTODO" calendar components.

Description:

This property value specifies latitude and longitude, in that order (i.e., "LAT LON" ordering). The longitude represents the location east or west of the prime meridian as a positive or negative real number, respectively. The longitude and latitude values MAY be specified up to six decimal places, which will allow for accuracy to within one meter of geographical position. Receiving applications MUST accept values of this precision and MAY truncate values of greater precision.

Example:

GEO:37.386013;-122.082932

Parse vGeo:

>>> from icalendar.prop import vGeo
>>> geo = vGeo.from_ical('37.386013;-122.082932')
>>> geo
(37.386013, -122.082932)

Add a geo location to an event:

>>> from icalendar import Event
>>> event = Event()
>>> latitude = 37.386013
>>> longitude = -122.082932
>>> event.add('GEO', (latitude, longitude))
>>> event['GEO']
vGeo((37.386013, -122.082932))

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__(geo, /, params=None)

Create a new vGeo from a tuple of (latitude, longitude).

Raises:

ValueError -- if geo is not a tuple of (latitude, longitude)

default_value: ClassVar[str] = 'FLOAT'

classmethod examples()

Examples of vGeo.

Return type:

list[None]

static 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

Create a new vGeo from a tuple of (latitude, longitude).

Raises:

ValueError -- if geo is not a tuple of (latitude, longitude)

to_ical()

to_jcal(name)

Convert to jCal object.

Return type:

list