vobject.icalendar

Package vobject :: Module icalendar

[show private | hide private]

Module vobject.icalendar

Definitions and behavior for iCalendar, also known as vCalendar 2.0

Classes
`DateOrDateTimeBehavior`	Parent Behavior for ContentLines containing one DATE or DATE-TIME.
`DateTimeBehavior`	Parent Behavior for ContentLines containing one DATE-TIME.
`DaylightOrStandard`
`Duration`	Behavior for Duration ContentLines.
`FreeBusy`	Free or busy period of time.
`MultiDateBehavior`	Parent Behavior for ContentLines containing one or more DATE, DATE-TIME, or PERIOD.
`MultiTextBehavior`	Provide backslash escape encoding/decoding of each of several values.
`RecurringBehavior`	Parent Behavior for components which should be RecurringComponents.
`RecurringComponent`	A vCalendar component like VEVENT or VTODO which may recur.
`TextBehavior`	Provide backslash escape encoding/decoding for single valued properties.
`TimezoneComponent`	A VTIMEZONE object.
`Trigger`	DATE-TIME or DURATION
`UTCDateTimeBehavior`	A value which must be specified in UTC.
`VAlarm`	Alarm behavior.
`VCalendar2_0`	vCalendar 2.0 behavior.
`VEvent`	Event behavior.
`VFreeBusy`	Free/busy state behavior.
`VJournal`	Journal entry behavior.
`VTimezone`	Timezone behavior.
`VTodo`	To-do behavior.

Function Summary
	`dateTimeToString(dateTime, preserveTZ)` Convert to UTC if tzinfo is set, unless preserveTZ.
	`dateToString(date)`
	`deltaToOffset(delta)`
	`getTzid(tzid)` Return the tzid if it exists, or None.
	`isDuration(s)`
	`numToDigits(num, places)` Helper, for converting numbers to textual digits.
	`parseDtstart(contentline)`
	`registerTzid(tzid, tzinfo)` Register a tzid -> tzinfo mapping.
	`stringToDate(s, tzinfos)`
	`stringToDateTime(s, tzinfo)` Returns datetime.datetime object.
	`stringToDurations(s, strict)` Returns list of timedelta objects.
	`stringToPeriod(s, tzinfo)`
	`stringToTextValues(s, strict)` Returns list of strings.
	`timedeltaToString(delta)` Convert timedelta to an rfc2445 DURATION.

Variable Summary
`tuple`	`DATENAMES` = `('rdate', 'exdate')`
`tuple`	`DATESANDRULES` = `('exrule', 'rrule', 'rdate', 'exdate')`
`list`	`dateTimeOrDateList` = `['DTEND', 'DTSTART', 'DUE', 'RECURR...`
`str`	`escapableCharList` = `'\\;,Nn'`
`tuple`	`FREQUENCIES` = `('YEARLY', 'MONTHLY', 'WEEKLY', 'DAILY', '...`
`Logger`	`logger` = `<logging.Logger instance at 0x4023608c>`
`list`	`multiTextList` = `['CATEGORIES', 'RESOURCES']`
`unicode`	`PRODID` = `u'-//PYVOBJECT//NONSGML Version 1//EN'`
`tuple`	`RULENAMES` = `('exrule', 'rrule')`
`list`	`textList` = `['CALSCALE', 'METHOD', 'PRODID', 'CLASS', 'CO...`
`tzutc`	`utc` = `tzutc()`
`list`	`utcDateTimeList` = `['LAST-MODIFIED', 'CREATED', 'COMPLETE...`
`tuple`	`WEEKDAYS` = `('MO', 'TU', 'WE', 'TH', 'FR', 'SA', 'SU')`
`dict`	`__tzidMap` = `{'UTC': tzutc()}`

Function Details

dateTimeToString(dateTime, preserveTZ=True)

Convert to UTC if tzinfo is set, unless preserveTZ. Output string.

getTzid(tzid)

Return the tzid if it exists, or None.

numToDigits(num, places)

Helper, for converting numbers to textual digits.

registerTzid(tzid, tzinfo)

stringToDateTime(s, tzinfo=None)

Returns datetime.datetime object.

stringToDurations(s, strict=False)

Returns list of timedelta objects.

stringToTextValues(s, strict=False)

Returns list of strings.

timedeltaToString(delta)

Convert timedelta to an rfc2445 DURATION.

Variable Details

DATENAMES

Type:: tuple
Value:: ('rdate', 'exdate')

DATESANDRULES

Type:: tuple
Value:: ('exrule', 'rrule', 'rdate', 'exdate')

dateTimeOrDateList

Type:: list
Value:: ['DTEND', 'DTSTART', 'DUE', 'RECURRENCE-ID']

escapableCharList

Type:: str
Value:: '\\;,Nn'

FREQUENCIES

Type:: tuple
Value:: ('YEARLY', 'MONTHLY', 'WEEKLY', 'DAILY', 'HOURLY', 'MINUTELY', 'SECOND\ LY')

logger

Type:: Logger
Value:: <logging.Logger instance at 0x4023608c>

multiTextList

Type:: list
Value:: ['CATEGORIES', 'RESOURCES']

PRODID

Type:: unicode
Value:: u'-//PYVOBJECT//NONSGML Version 1//EN'

RULENAMES

Type:: tuple
Value:: ('exrule', 'rrule')

textList

Type:: list
Value:: ['CALSCALE', 'METHOD', 'PRODID', 'CLASS', 'COMMENT', 'DESCRIPTION', 'LOCATION', 'STATUS', ...

utc

Type:: tzutc
Value:: tzutc()

utcDateTimeList

Type:: list
Value:: ['LAST-MODIFIED', 'CREATED', 'COMPLETED', 'DTSTAMP']

WEEKDAYS

Type:: tuple
Value:: ('MO', 'TU', 'WE', 'TH', 'FR', 'SA', 'SU')

__tzidMap

Type:: dict
Value:: {'UTC': tzutc()}

Generated by Epydoc 2.1 on Fri Dec 14 17:25:15 2007

http://epydoc.sf.net