vobject.icalendar.TimezoneComponent

Package vobject :: Module icalendar :: Class TimezoneComponent

[show private | hide private]

Type TimezoneComponent

object --+        
         |        
     VBase --+    
             |    
     Component --+
                 |
                TimezoneComponent

A VTIMEZONE object.

VTIMEZONEs are parsed by dateutil.tz.tzical, the resulting datetime.tzinfo subclass is stored in self.tzinfo, self.tzid stores the TZID associated with this timezone.

Method Summary
	`__init__(self, tzinfo, args, *kwds)` Accept an existing Component or a tzinfo class.
	`__repr__(self)`
	`__setattr__(self, name, value)` For convenience, make self.contents directly accessible.
	`__str__(self)`
	`gettzinfo(self)`
	`pickTzid(tzinfo)` Given a tzinfo class, use known APIs to determine TZID, or use tzname. (Static method)
	`prettyPrint(self, level, tabwidth)`
	`registerTzinfo(obj, tzinfo)` (Class method)
	`settzinfo(self, tzinfo, start, end)` Create appropriate objects in self to represent tzinfo.
Inherited from Component
	`__getattr__(self, name)` For convenience, make self.contents directly accessible.
	`add(self, objOrName, group)` Add objOrName to contents, set behavior if it can be inferred.
	`components(self)` Return an iterable of all Component children.
	`getChildren(self)` Return an iterable of all children.
	`getSortedChildren(self)`
	`lines(self)` Return an iterable of all ContentLine children.
	`setBehaviorFromVersionLine(self, versionLine)` Set behavior if one matches name, versionLine.value.
	`setProfile(self, name)` Assign a PROFILE to this unnamed component.
	`sortChildKeys(self)`
	`transformChildrenFromNative(self, clearBehavior)` Recursively transform native children to vanilla representations.
	`transformChildrenToNative(self)` Recursively replace children with their native representation.
Inherited from VBase
	`autoBehavior(self, cascade)` Set behavior if name is in self.parentBehavior.knownChildren.
	`clearBehavior(self, cascade)` Set behavior to None.
	`serialize(self, buf, lineLength, validate)` Serialize to buf if it exists, otherwise return a string.
	`setBehavior(self, behavior, cascade)` Set behavior.
	`transformFromNative(self)` Return self transformed into a ContentLine or Component if needed.
	`transformToNative(self)` Transform this object into a custom VBase subclass.
	`validate(self, args, *kwds)` Call the behavior's validate method, or return True.
Inherited from object
	`__delattr__(...)` x.__delattr__('name') <==> del x.name
	`__getattribute__(...)` x.__getattribute__('name') <==> x.name
	`__hash__(x)` x.__hash__() <==> hash(x)
	`__new__(T, S, ...)` T.__new__(S, ...) -> a new object with type S, a subtype of T
	`__reduce__(...)` helper for pickle
	`__reduce_ex__(...)` helper for pickle

Property Summary
	`tzinfo`

Instance Variable Summary
	`name`: The uppercased name of the object, in this case always 'VTIMEZONE'.
	`tzid`: The string used to refer to this timezone.
	`tzinfo` = `vobject.icalendar.TimezoneComponent.tzinfo`
Inherited from Component
	`contents`: A dictionary of lists of Component or ContentLine instances.
	`useBegin`: A boolean flag determining whether BEGIN: and END: lines should be serialized.
Inherited from VBase
	`behavior`: The Behavior class associated with this object, which controls validation, transformations, and encoding.
	`group`: An optional group prefix, should be used only to indicate sort order in vCards, according to RFC2426
	`isNative`: Boolean describing whether this component is a Native instance.
	`parentBehavior`: The object's parent's behavior, or None if no behaviored parent exists.

Instance Method Details

init(self, tzinfo=None, *args, **kwds)
(Constructor)

Accept an existing Component or a tzinfo class.

Overrides:: vobject.vobject.Component.__init__

setattr(self, name, value)

For convenience, make self.contents directly accessible.

self.contents must contain lists, raise an error if value isn't a list.

Overrides:: vobject.vobject.Component.__setattr__ (inherited documentation)

settzinfo(self, tzinfo, start=2000, end=2030)

Create appropriate objects in self to represent tzinfo.

Assumptions:
- DST <-> Standard transitions occur on the hour
- never within a month of one another
- twice or fewer times a year
- never in the month of December
- DST always moves offset exactly one hour later
- tzinfo classes dst method always treats times that could be in either
  offset to be in the later regime

Static Method Details

pickTzid(tzinfo)

Given a tzinfo class, use known APIs to determine TZID, or use tzname.

Property Details

tzinfo

Get Method:: gettzinfo(self)

Instance Variable Details

name

The uppercased name of the object, in this case always 'VTIMEZONE'.

tzid

The string used to refer to this timezone.

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

http://epydoc.sf.net