461 lines
17 KiB
Python
461 lines
17 KiB
Python
|
# -*- coding: utf-8 -*-
|
||
|
|
from __future__ import unicode_literals
|
||
|
|
|
||
|
|
from datetime import datetime
|
||
|
|
from datetime import timedelta
|
||
|
|
import unittest
|
||
|
|
|
||
|
|
import icalendar
|
||
|
|
import pytz
|
||
|
|
import re
|
||
|
|
|
||
|
|
|
||
|
|
class TestCalComponent(unittest.TestCase):
|
||
|
|
|
||
|
|
def test_cal_Component(self):
|
||
|
|
from icalendar.cal import Component, Calendar, Event
|
||
|
|
from icalendar import prop
|
||
|
|
|
||
|
|
# A component is like a dictionary with extra methods and attributes.
|
||
|
|
c = Component()
|
||
|
|
c.name = 'VCALENDAR'
|
||
|
|
|
||
|
|
self.assertTrue(c)
|
||
|
|
self.assertTrue(c.is_empty())
|
||
|
|
|
||
|
|
# Every key defines a property.A property can consist of either a
|
||
|
|
# single item. This can be set with a single value...
|
||
|
|
c['prodid'] = '-//max m//icalendar.mxm.dk/'
|
||
|
|
self.assertFalse(c.is_empty())
|
||
|
|
|
||
|
|
self.assertEqual(
|
||
|
|
c,
|
||
|
|
Calendar({'PRODID': '-//max m//icalendar.mxm.dk/'})
|
||
|
|
)
|
||
|
|
|
||
|
|
# or with a list
|
||
|
|
c['ATTENDEE'] = ['Max M', 'Rasmussen']
|
||
|
|
self.assertEqual(
|
||
|
|
c,
|
||
|
|
Calendar({'ATTENDEE': ['Max M', 'Rasmussen'],
|
||
|
|
'PRODID': '-//max m//icalendar.mxm.dk/'})
|
||
|
|
)
|
||
|
|
|
||
|
|
# ## ADD MULTIPLE VALUES TO A PROPERTY
|
||
|
|
|
||
|
|
# if you use the add method you don't have to considder if a value is
|
||
|
|
# a list or not.
|
||
|
|
c = Component()
|
||
|
|
c.name = 'VEVENT'
|
||
|
|
|
||
|
|
# add multiple values at once
|
||
|
|
c.add('attendee',
|
||
|
|
['test@test.com', 'test2@test.com'])
|
||
|
|
|
||
|
|
# or add one per line
|
||
|
|
c.add('attendee', 'maxm@mxm.dk')
|
||
|
|
c.add('attendee', 'test@example.dk')
|
||
|
|
|
||
|
|
# add again multiple values at once to very concatenaton of lists
|
||
|
|
c.add('attendee',
|
||
|
|
['test3@test.com', 'test4@test.com'])
|
||
|
|
|
||
|
|
self.assertEqual(
|
||
|
|
c,
|
||
|
|
Event({'ATTENDEE': [
|
||
|
|
prop.vCalAddress('test@test.com'),
|
||
|
|
prop.vCalAddress('test2@test.com'),
|
||
|
|
prop.vCalAddress('maxm@mxm.dk'),
|
||
|
|
prop.vCalAddress('test@example.dk'),
|
||
|
|
prop.vCalAddress('test3@test.com'),
|
||
|
|
prop.vCalAddress('test4@test.com')
|
||
|
|
]})
|
||
|
|
)
|
||
|
|
|
||
|
|
###
|
||
|
|
|
||
|
|
# You can get the values back directly ...
|
||
|
|
c.add('prodid', '-//my product//')
|
||
|
|
self.assertEqual(c['prodid'], prop.vText('-//my product//'))
|
||
|
|
|
||
|
|
# ... or decoded to a python type
|
||
|
|
self.assertEqual(c.decoded('prodid'), b'-//my product//')
|
||
|
|
|
||
|
|
# With default values for non existing properties
|
||
|
|
self.assertEqual(c.decoded('version', 'No Version'), 'No Version')
|
||
|
|
|
||
|
|
c.add('rdate', [datetime(2013, 3, 28), datetime(2013, 3, 27)])
|
||
|
|
self.assertTrue(isinstance(c.decoded('rdate'), prop.vDDDLists))
|
||
|
|
|
||
|
|
# The component can render itself in the RFC 2445 format.
|
||
|
|
c = Component()
|
||
|
|
c.name = 'VCALENDAR'
|
||
|
|
c.add('attendee', 'Max M')
|
||
|
|
self.assertEqual(
|
||
|
|
c.to_ical(),
|
||
|
|
b'BEGIN:VCALENDAR\r\nATTENDEE:Max M\r\nEND:VCALENDAR\r\n'
|
||
|
|
)
|
||
|
|
|
||
|
|
# Components can be nested, so You can add a subcompont. Eg a calendar
|
||
|
|
# holds events.
|
||
|
|
e = Component(summary='A brief history of time')
|
||
|
|
e.name = 'VEVENT'
|
||
|
|
e.add('dtend', '20000102T000000', encode=0)
|
||
|
|
e.add('dtstart', '20000101T000000', encode=0)
|
||
|
|
self.assertEqual(
|
||
|
|
e.to_ical(),
|
||
|
|
b'BEGIN:VEVENT\r\nDTEND:20000102T000000\r\n'
|
||
|
|
+ b'DTSTART:20000101T000000\r\nSUMMARY:A brief history of time\r'
|
||
|
|
+ b'\nEND:VEVENT\r\n'
|
||
|
|
)
|
||
|
|
|
||
|
|
c.add_component(e)
|
||
|
|
self.assertEqual(
|
||
|
|
c.subcomponents,
|
||
|
|
[Event({'DTEND': '20000102T000000', 'DTSTART': '20000101T000000',
|
||
|
|
'SUMMARY': 'A brief history of time'})]
|
||
|
|
)
|
||
|
|
|
||
|
|
# We can walk over nested componentes with the walk method.
|
||
|
|
self.assertEqual([i.name for i in c.walk()], ['VCALENDAR', 'VEVENT'])
|
||
|
|
|
||
|
|
# We can also just walk over specific component types, by filtering
|
||
|
|
# them on their name.
|
||
|
|
self.assertEqual([i.name for i in c.walk('VEVENT')], ['VEVENT'])
|
||
|
|
|
||
|
|
self.assertEqual(
|
||
|
|
[i['dtstart'] for i in c.walk('VEVENT')],
|
||
|
|
['20000101T000000']
|
||
|
|
)
|
||
|
|
|
||
|
|
# We can enumerate property items recursively with the property_items
|
||
|
|
# method.
|
||
|
|
self.assertEqual(
|
||
|
|
c.property_items(),
|
||
|
|
[('BEGIN', b'VCALENDAR'), ('ATTENDEE', prop.vCalAddress('Max M')),
|
||
|
|
('BEGIN', b'VEVENT'), ('DTEND', '20000102T000000'),
|
||
|
|
('DTSTART', '20000101T000000'),
|
||
|
|
('SUMMARY', 'A brief history of time'), ('END', b'VEVENT'),
|
||
|
|
('END', b'VCALENDAR')]
|
||
|
|
)
|
||
|
|
|
||
|
|
# We can also enumerate property items just under the component.
|
||
|
|
self.assertEqual(
|
||
|
|
c.property_items(recursive=False),
|
||
|
|
[('BEGIN', b'VCALENDAR'),
|
||
|
|
('ATTENDEE', prop.vCalAddress('Max M')),
|
||
|
|
('END', b'VCALENDAR')]
|
||
|
|
)
|
||
|
|
|
||
|
|
sc = c.subcomponents[0]
|
||
|
|
self.assertEqual(
|
||
|
|
sc.property_items(recursive=False),
|
||
|
|
[('BEGIN', b'VEVENT'), ('DTEND', '20000102T000000'),
|
||
|
|
('DTSTART', '20000101T000000'),
|
||
|
|
('SUMMARY', 'A brief history of time'), ('END', b'VEVENT')]
|
||
|
|
)
|
||
|
|
|
||
|
|
# Text fields which span multiple mulitple lines require proper
|
||
|
|
# indenting
|
||
|
|
c = Calendar()
|
||
|
|
c['description'] = 'Paragraph one\n\nParagraph two'
|
||
|
|
self.assertEqual(
|
||
|
|
c.to_ical(),
|
||
|
|
b'BEGIN:VCALENDAR\r\nDESCRIPTION:Paragraph one\\n\\nParagraph two'
|
||
|
|
+ b'\r\nEND:VCALENDAR\r\n'
|
||
|
|
)
|
||
|
|
|
||
|
|
# INLINE properties have their values on one property line. Note the
|
||
|
|
# double quoting of the value with a colon in it.
|
||
|
|
c = Calendar()
|
||
|
|
c['resources'] = 'Chair, Table, "Room: 42"'
|
||
|
|
self.assertEqual(
|
||
|
|
c,
|
||
|
|
Calendar({'RESOURCES': 'Chair, Table, "Room: 42"'})
|
||
|
|
)
|
||
|
|
|
||
|
|
self.assertEqual(
|
||
|
|
c.to_ical(),
|
||
|
|
b'BEGIN:VCALENDAR\r\nRESOURCES:Chair\\, Table\\, "Room: 42"\r\n'
|
||
|
|
+ b'END:VCALENDAR\r\n'
|
||
|
|
)
|
||
|
|
|
||
|
|
# The inline values must be handled by the get_inline() and
|
||
|
|
# set_inline() methods.
|
||
|
|
self.assertEqual(
|
||
|
|
c.get_inline('resources', decode=0),
|
||
|
|
['Chair', 'Table', 'Room: 42']
|
||
|
|
)
|
||
|
|
|
||
|
|
# These can also be decoded
|
||
|
|
self.assertEqual(
|
||
|
|
c.get_inline('resources', decode=1),
|
||
|
|
[b'Chair', b'Table', b'Room: 42']
|
||
|
|
)
|
||
|
|
|
||
|
|
# You can set them directly ...
|
||
|
|
c.set_inline('resources', ['A', 'List', 'of', 'some, recources'],
|
||
|
|
encode=1)
|
||
|
|
self.assertEqual(c['resources'], 'A,List,of,"some, recources"')
|
||
|
|
|
||
|
|
# ... and back again
|
||
|
|
self.assertEqual(
|
||
|
|
c.get_inline('resources', decode=0),
|
||
|
|
['A', 'List', 'of', 'some, recources']
|
||
|
|
)
|
||
|
|
|
||
|
|
c['freebusy'] = '19970308T160000Z/PT3H,19970308T200000Z/PT1H,'\
|
||
|
|
+ '19970308T230000Z/19970309T000000Z'
|
||
|
|
self.assertEqual(
|
||
|
|
c.get_inline('freebusy', decode=0),
|
||
|
|
['19970308T160000Z/PT3H', '19970308T200000Z/PT1H',
|
||
|
|
'19970308T230000Z/19970309T000000Z']
|
||
|
|
)
|
||
|
|
|
||
|
|
freebusy = c.get_inline('freebusy', decode=1)
|
||
|
|
self.assertTrue(isinstance(freebusy[0][0], datetime))
|
||
|
|
self.assertTrue(isinstance(freebusy[0][1], timedelta))
|
||
|
|
|
||
|
|
def test_cal_Component_add(self):
|
||
|
|
# Test the for timezone correctness: dtstart should preserve it's
|
||
|
|
# timezone, created, dtstamp and last-modified must be in UTC.
|
||
|
|
Component = icalendar.cal.Component
|
||
|
|
comp = Component()
|
||
|
|
vienna = pytz.timezone("Europe/Vienna")
|
||
|
|
comp.add('dtstart', vienna.localize(datetime(2010, 10, 10, 10, 0, 0)))
|
||
|
|
comp.add('created', datetime(2010, 10, 10, 12, 0, 0))
|
||
|
|
comp.add('dtstamp', vienna.localize(datetime(2010, 10, 10, 14, 0, 0)))
|
||
|
|
comp.add('last-modified', pytz.utc.localize(
|
||
|
|
datetime(2010, 10, 10, 16, 0, 0)))
|
||
|
|
|
||
|
|
lines = comp.to_ical().splitlines()
|
||
|
|
self.assertTrue(
|
||
|
|
b"DTSTART;TZID=Europe/Vienna;VALUE=DATE-TIME:20101010T100000"
|
||
|
|
in lines)
|
||
|
|
self.assertTrue(b"CREATED;VALUE=DATE-TIME:20101010T120000Z" in lines)
|
||
|
|
self.assertTrue(b"DTSTAMP;VALUE=DATE-TIME:20101010T120000Z" in lines)
|
||
|
|
self.assertTrue(
|
||
|
|
b"LAST-MODIFIED;VALUE=DATE-TIME:20101010T160000Z" in lines
|
||
|
|
)
|
||
|
|
|
||
|
|
def test_cal_Component_add_no_reencode(self):
|
||
|
|
"""Already encoded values should not be re-encoded.
|
||
|
|
"""
|
||
|
|
from icalendar import cal, prop
|
||
|
|
comp = cal.Component()
|
||
|
|
comp.add('ATTACH', 'me')
|
||
|
|
|
||
|
|
comp.add('ATTACH', 'you', encode=False)
|
||
|
|
binary = prop.vBinary('us')
|
||
|
|
comp.add('ATTACH', binary)
|
||
|
|
|
||
|
|
self.assertEqual(comp['ATTACH'], ['me', 'you', binary])
|
||
|
|
|
||
|
|
def test_cal_Component_add_property_parameter(self):
|
||
|
|
# Test the for timezone correctness: dtstart should preserve it's
|
||
|
|
# timezone, crated, dtstamp and last-modified must be in UTC.
|
||
|
|
Component = icalendar.cal.Component
|
||
|
|
comp = Component()
|
||
|
|
comp.add('X-TEST-PROP', 'tryout.',
|
||
|
|
parameters={'prop1': 'val1', 'prop2': 'val2'})
|
||
|
|
lines = comp.to_ical().splitlines()
|
||
|
|
self.assertTrue(b"X-TEST-PROP;PROP1=val1;PROP2=val2:tryout." in lines)
|
||
|
|
|
||
|
|
def test_cal_Component_from_ical(self):
|
||
|
|
# Check for proper handling of TZID parameter of datetime properties
|
||
|
|
Component = icalendar.cal.Component
|
||
|
|
for component_name, property_name in (
|
||
|
|
('VEVENT', 'DTSTART'),
|
||
|
|
('VEVENT', 'DTEND'),
|
||
|
|
('VEVENT', 'RECURRENCE-ID'),
|
||
|
|
('VTODO', 'DUE')
|
||
|
|
):
|
||
|
|
component_str = 'BEGIN:' + component_name + '\n'
|
||
|
|
component_str += property_name + ';TZID=America/Denver:'
|
||
|
|
component_str += '20120404T073000\nEND:' + component_name
|
||
|
|
component = Component.from_ical(component_str)
|
||
|
|
self.assertEqual(str(component[property_name].dt.tzinfo.zone),
|
||
|
|
"America/Denver")
|
||
|
|
|
||
|
|
component_str = 'BEGIN:' + component_name + '\n'
|
||
|
|
component_str += property_name + ':'
|
||
|
|
component_str += '20120404T073000\nEND:' + component_name
|
||
|
|
component = Component.from_ical(component_str)
|
||
|
|
self.assertEqual(component[property_name].dt.tzinfo,
|
||
|
|
None)
|
||
|
|
|
||
|
|
def test_cal_Component_to_ical_property_order(self):
|
||
|
|
Component = icalendar.cal.Component
|
||
|
|
component_str = [b'BEGIN:VEVENT',
|
||
|
|
b'DTSTART:19970714T170000Z',
|
||
|
|
b'DTEND:19970715T035959Z',
|
||
|
|
b'SUMMARY:Bastille Day Party',
|
||
|
|
b'END:VEVENT']
|
||
|
|
component = Component.from_ical(b'\r\n'.join(component_str))
|
||
|
|
|
||
|
|
sorted_str = component.to_ical().splitlines()
|
||
|
|
assert sorted_str != component_str
|
||
|
|
assert set(sorted_str) == set(component_str)
|
||
|
|
|
||
|
|
preserved_str = component.to_ical(sorted=False).splitlines()
|
||
|
|
assert preserved_str == component_str
|
||
|
|
|
||
|
|
def test_cal_Component_to_ical_parameter_order(self):
|
||
|
|
Component = icalendar.cal.Component
|
||
|
|
component_str = [b'BEGIN:VEVENT',
|
||
|
|
b'X-FOOBAR;C=one;A=two;B=three:helloworld.',
|
||
|
|
b'END:VEVENT']
|
||
|
|
component = Component.from_ical(b'\r\n'.join(component_str))
|
||
|
|
|
||
|
|
sorted_str = component.to_ical().splitlines()
|
||
|
|
assert sorted_str[0] == component_str[0]
|
||
|
|
assert sorted_str[1] == b'X-FOOBAR;A=two;B=three;C=one:helloworld.'
|
||
|
|
assert sorted_str[2] == component_str[2]
|
||
|
|
|
||
|
|
preserved_str = component.to_ical(sorted=False).splitlines()
|
||
|
|
assert preserved_str == component_str
|
||
|
|
|
||
|
|
def test_repr(self):
|
||
|
|
"""Test correct class representation.
|
||
|
|
"""
|
||
|
|
from icalendar.cal import Component, Calendar, Event
|
||
|
|
|
||
|
|
component = Component()
|
||
|
|
component['key1'] = 'value1'
|
||
|
|
|
||
|
|
self.assertTrue(
|
||
|
|
re.match(r"Component\({u?'KEY1': u?'value1'}\)", str(component))
|
||
|
|
)
|
||
|
|
|
||
|
|
calendar = Calendar()
|
||
|
|
calendar['key1'] = 'value1'
|
||
|
|
|
||
|
|
self.assertTrue(
|
||
|
|
re.match(r"VCALENDAR\({u?'KEY1': u?'value1'}\)", str(calendar))
|
||
|
|
)
|
||
|
|
|
||
|
|
event = Event()
|
||
|
|
event['key1'] = 'value1'
|
||
|
|
|
||
|
|
self.assertTrue(
|
||
|
|
re.match(r"VEVENT\({u?'KEY1': u?'value1'}\)", str(event))
|
||
|
|
)
|
||
|
|
|
||
|
|
# Representation of nested Components
|
||
|
|
nested = Component(key1='VALUE1')
|
||
|
|
nested.add_component(component)
|
||
|
|
calendar.add_component(event)
|
||
|
|
nested.add_component(calendar)
|
||
|
|
|
||
|
|
self.assertTrue(
|
||
|
|
re.match(
|
||
|
|
r"Component\({u?'KEY1': u?'VALUE1'}, "
|
||
|
|
r"Component\({u?'KEY1': u?'value1'}\), "
|
||
|
|
r"VCALENDAR\({u?'KEY1': u?'value1'}, "
|
||
|
|
r"VEVENT\({u?'KEY1': u?'value1'}\)\)\)",
|
||
|
|
str(nested)
|
||
|
|
)
|
||
|
|
)
|
||
|
|
|
||
|
|
|
||
|
|
class TestCal(unittest.TestCase):
|
||
|
|
|
||
|
|
def test_cal_ComponentFactory(self):
|
||
|
|
ComponentFactory = icalendar.cal.ComponentFactory
|
||
|
|
factory = ComponentFactory()
|
||
|
|
component = factory['VEVENT']
|
||
|
|
event = component(dtstart='19700101')
|
||
|
|
self.assertEqual(
|
||
|
|
event.to_ical(),
|
||
|
|
b'BEGIN:VEVENT\r\nDTSTART:19700101\r\nEND:VEVENT\r\n'
|
||
|
|
)
|
||
|
|
|
||
|
|
self.assertEqual(
|
||
|
|
factory.get('VCALENDAR', icalendar.cal.Component),
|
||
|
|
icalendar.cal.Calendar)
|
||
|
|
|
||
|
|
def test_cal_Calendar(self):
|
||
|
|
# Setting up a minimal calendar component looks like this
|
||
|
|
cal = icalendar.cal.Calendar()
|
||
|
|
|
||
|
|
# Some properties are required to be compliant
|
||
|
|
cal['prodid'] = '-//My calendar product//mxm.dk//'
|
||
|
|
cal['version'] = '2.0'
|
||
|
|
|
||
|
|
# We also need at least one subcomponent for a calendar to be compliant
|
||
|
|
event = icalendar.cal.Event()
|
||
|
|
event['summary'] = 'Python meeting about calendaring'
|
||
|
|
event['uid'] = '42'
|
||
|
|
event.add('dtstart', datetime(2005, 4, 4, 8, 0, 0))
|
||
|
|
cal.add_component(event)
|
||
|
|
self.assertEqual(
|
||
|
|
cal.subcomponents[0].to_ical(),
|
||
|
|
b'BEGIN:VEVENT\r\nSUMMARY:Python meeting about calendaring\r\n'
|
||
|
|
+ b'DTSTART;VALUE=DATE-TIME:20050404T080000\r\nUID:42\r\n'
|
||
|
|
+ b'END:VEVENT\r\n')
|
||
|
|
|
||
|
|
# Write to disc
|
||
|
|
import tempfile
|
||
|
|
import os
|
||
|
|
directory = tempfile.mkdtemp()
|
||
|
|
with open(os.path.join(directory, 'test.ics'), 'wb') as fp:
|
||
|
|
fp.write(cal.to_ical())
|
||
|
|
|
||
|
|
# Parsing a complete calendar from a string will silently ignore wrong
|
||
|
|
# events but adding the error information to the component's 'errors'
|
||
|
|
# attribute. The error in the following is the third EXDATE: it has an
|
||
|
|
# empty DATE.
|
||
|
|
s = '\r\n'.join(('BEGIN:VCALENDAR',
|
||
|
|
'PRODID:-//Google Inc//Google Calendar 70.9054//EN',
|
||
|
|
'VERSION:2.0',
|
||
|
|
'CALSCALE:GREGORIAN',
|
||
|
|
'METHOD:PUBLISH',
|
||
|
|
'BEGIN:VEVENT',
|
||
|
|
'DESCRIPTION:Perfectly OK event',
|
||
|
|
'DTSTART;VALUE=DATE:20080303',
|
||
|
|
'DTEND;VALUE=DATE:20080304',
|
||
|
|
'RRULE:FREQ=DAILY;UNTIL=20080323T235959Z',
|
||
|
|
'EXDATE;VALUE=DATE:20080311',
|
||
|
|
'END:VEVENT',
|
||
|
|
'BEGIN:VEVENT',
|
||
|
|
'DESCRIPTION:Wrong event',
|
||
|
|
'DTSTART;VALUE=DATE:20080303',
|
||
|
|
'DTEND;VALUE=DATE:20080304',
|
||
|
|
'RRULE:FREQ=DAILY;UNTIL=20080323T235959Z',
|
||
|
|
'EXDATE;VALUE=DATE:20080311',
|
||
|
|
'EXDATE;VALUE=DATE:',
|
||
|
|
'END:VEVENT',
|
||
|
|
'END:VCALENDAR'))
|
||
|
|
self.assertEqual(
|
||
|
|
[e['DESCRIPTION'].to_ical()
|
||
|
|
for e in icalendar.cal.Calendar.from_ical(s).walk('VEVENT')],
|
||
|
|
[b'Perfectly OK event', b'Wrong event'])
|
||
|
|
self.assertEqual(
|
||
|
|
[e.errors
|
||
|
|
for e in icalendar.cal.Calendar.from_ical(s).walk('VEVENT')],
|
||
|
|
[[], [('EXDATE', "Expected datetime, date, or time, got: ''")]]
|
||
|
|
)
|
||
|
|
|
||
|
|
def test_cal_strict_parsing(self):
|
||
|
|
cal_str = b'\r\n'.join(
|
||
|
|
[
|
||
|
|
b'BEGIN:VCALENDAR',
|
||
|
|
b'BEGIN:VTIMEZONE',
|
||
|
|
b'TZID:Europe/Prague',
|
||
|
|
b'BEGIN:STANDARD',
|
||
|
|
b'DTSTART:18500101T000000',
|
||
|
|
b'TZNAME:PMT',
|
||
|
|
b'TZOFFSETFROM:+5744',
|
||
|
|
b'TZOFFSETTO:+5744',
|
||
|
|
b'END:STANDARD',
|
||
|
|
b'END:VTIMEZONE',
|
||
|
|
b'END:VCALENDAR',
|
||
|
|
b'',
|
||
|
|
]
|
||
|
|
)
|
||
|
|
|
||
|
|
self.assertRaises(ValueError, icalendar.Calendar.from_ical, cal_str)
|
||
|
|
icalendar.vUTCOffset.ignore_exceptions = True
|
||
|
|
self.assertEqual(icalendar.Calendar.from_ical(cal_str).to_ical(), cal_str)
|
||
|
|
icalendar.vUTCOffset.ignore_exceptions = False
|