diff options
42 files changed, 2558 insertions, 2449 deletions
diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..40fef5b --- /dev/null +++ b/.gitignore @@ -0,0 +1,9 @@ +*~ +*.log +*.pyc +.DS_Store +build/**/* +dist/**/* +vobject.egg-info/**/* +venv/**/* +.idea/* diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..41e1c5c --- /dev/null +++ b/.travis.yml @@ -0,0 +1,10 @@ +language: python +python: + - "2.7" + - "3.3" + - "3.4" + - "3.5" +# command to install dependencies +install: pip install -e . +# command to run tests +script: python tests.py diff --git a/ACKNOWLEDGEMENTS.txt b/ACKNOWLEDGEMENTS.txt index 100138a..044911b 100644 --- a/ACKNOWLEDGEMENTS.txt +++ b/ACKNOWLEDGEMENTS.txt @@ -1,4 +1,8 @@ Enormous thanks to:
+Jeffrey Harris, for his incredible work on the original package
+Tim Baxter, for all his work maintaining vobject over the past few years
+Adieu, for keeping things alive on github
+Kristian Glass, for his enormous help with testing and Python3 matters
Gustavo Niemeyer, for all his work on dateutil
Dave Cridland, for helping talk about vobject and working on vcard
TJ Gabbour, for putting his heart into parsing
diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..d20a6fe --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,2 @@ +include README.md ACKNOWLEDGEMENTS.txt LICENSE-2.0.txt +recursive-include test_files *.ics diff --git a/PKG-INFO b/PKG-INFO deleted file mode 100644 index a8007d7..0000000 --- a/PKG-INFO +++ /dev/null @@ -1,55 +0,0 @@ -Metadata-Version: 1.0 -Name: vobject -Version: 0.8.1c -Summary: VObject: module for reading vCard and vCalendar files -Home-page: http://vobject.skyhouseconsulting.com -Author: Jeffrey Harris -Author-email: jeffrey@osafoundation.org -License: Apache -Description: Description - ----------- - - Parses iCalendar and vCard files into Python data structures, decoding the relevant encodings. Also serializes vobject data structures to iCalendar, vCard, or (experimentally) hCalendar unicode strings. - - Requirements - ------------ - - Requires python 2.4 or later, dateutil (http://labix.org/python-dateutil) 1.1 or later. - - Recent changes - -------------- - - Make change_tz.py compatible with python 2.4, so the entire package stays compatible - - Fall back to default (the most recent standard) behavior if a VCARD - or VCALENDAR doesn't have a recognized VERSION - - Fixed a bad performance bug when parsing large text bodies, thanks to Morgen Sagen at Apple - - Changed license to Apache 2.0 from Apache 1.1 - - Worked around an issue with Apple Address Book's vcard PHOTO parser - - Added change_tz module and script for quickly changing event timezones for an - ics file. Requires PyICU. - - Add support for BYMONTHDAY=-1 (days before the end of the month) when setting rrules - from a dateutil rrule - - Tolerate a Ruby iCalendar library escaping semi-colons in RRULEs - - Make vobjects pickle-able - - Add introspection help for IPython so tab completion works with - vobject's custom __getattr__ - - Allow Outlook's technically illegal use of commas in TZIDs - - Allow unicode names for TZIDs - - Worked around Lotus Notes use of underscores in names by just silently replacing - with dashes - - When allowing quoted-printable data, honor CHARSET for each line, defaulting to - iso-8859-1 - - Simplified directory layout, unit tests are now available via setup.py test - - For older changes, see - - http://vobject.skyhouseconsulting.com/history.html or - - http://websvn.osafoundation.org/listing.php?repname=vobject&path=/trunk/ - -Platform: any -Classifier: Development Status :: 5 - Production/Stable -Classifier: Environment :: Console -Classifier: License :: OSI Approved :: BSD License -Classifier: Intended Audience :: Developers -Classifier: Natural Language :: English -Classifier: Programming Language :: Python -Classifier: Operating System :: OS Independent -Classifier: Topic :: Text Processing @@ -1,59 +1,78 @@ -======= -VObject -======= +# VObject [](https://pypi.python.org/pypi/vobject) [](https://pypi.python.org/pypi/vobject) [](https://travis-ci.org/eventable/vobject) [](http://www.apache.org/licenses/LICENSE-2.0.html) [](https://www.quantifiedcode.com/app/project/bb995082e4d24119956445829b1e960c) -VObject simplifies the process of parsing and creating iCalendar and -vCard objects. +VObject is intended to be a full-featured Python package for parsing and generating vCard and vCalendar files. It was originally developed in concert with the Open Source Application Foundation's Chandler project by Jeffrey Harris. Many thanks to [all the contributors](https://github.com/eventable/vobject/blob/master/ACKNOWLEDGEMENTS.txt) for their dedication and support. The project is currently being maintained by [Eventable](https://github.com/eventable) and [Sameen Karim](https://github.com/skarim). --------------- - Installation --------------- +Currently, iCalendar files are supported and well tested. vCard 3.0 files are supported, and all data should be imported, but only a few components are understood in a sophisticated way. The [Calendar Server](http://calendarserver.org/) team has added VAVAILABILITY support to VObject's iCalendar parsing. Please report bugs and issues directly on [GitHub](https://github.com/eventable/vobject/issues). -To install vobject, run:: +VObject is licensed under the [Apache 2.0 license](http://www.apache.org/licenses/LICENSE-2.0). - python setup.py install +Useful scripts included with VObject: -vobject requires the dateutil package, which can be installed via -easy_install or downloaded from http://labix.org/python-dateutil +* [ics_diff](https://github.com/eventable/vobject/blob/master/vobject/ics_diff.py): order is irrelevant in iCalendar files, return a diff of meaningful changes between icalendar files +* [change_tz](https://github.com/eventable/vobject/blob/master/vobject/change_tz.py): Take an iCalendar file with events in the wrong timezone, change all events or just UTC events into one of the timezones PyICU supports. Requires [PyICU](https://pypi.python.org/pypi/PyICU/). ---------------- - Running tests ---------------- -Unit tests live in doctests throughout the source code, to run all tests, use:: +# Installation - python tests/tests.py +To install with [pip](https://pypi.python.org/pypi/pip), run: -------- - Usage -------- +``` +pip install vobject +``` -Creating iCalendar objects -.......................... -vobject has a basic datastructure for working with iCalendar-like +Or download the package and run: + +``` +python setup.py install +``` + +VObject requires Python 2.7 or higher, along with the [dateutil](https://pypi.python.org/pypi/python-dateutil/) and [six](https://pypi.python.org/pypi/six) packages. + + +# Running tests + +To run all tests, use: + +``` +python tests.py +``` + + +# Usage + +## iCalendar + +#### Creating iCalendar objects + +VObject has a basic datastructure for working with iCalendar-like syntaxes. Additionally, it defines specialized behaviors for many of the commonly used iCalendar objects. To create an object that already has a behavior defined, run: +``` >>> import vobject ->>> cal = vobject.newFromBehavior('vcalendar') +>>> > cal = vobject.newFromBehavior('vcalendar') >>> cal.behavior <class 'vobject.icalendar.VCalendar2_0'> +``` Convenience functions exist to create iCalendar and vCard objects: +``` >>> cal = vobject.iCalendar() >>> cal.behavior <class 'vobject.icalendar.VCalendar2_0'> >>> card = vobject.vCard() >>> card.behavior <class 'vobject.vcard.VCard3_0'> +``` Once you have an object, you can use the add method to create children: +``` >>> cal.add('vevent') <VEVENT| []> >>> cal.vevent.add('summary').value = "This is a note" @@ -61,6 +80,7 @@ children: VCALENDAR VEVENT SUMMARY: This is a note +``` Note that summary is a little different from vevent, it's a ContentLine, not a Component. It can't have children, and it has a @@ -69,6 +89,7 @@ special value attribute. ContentLines can also have parameters. They can be accessed with regular attribute names with _param appended: +``` >>> cal.vevent.summary.x_random_param = 'Random parameter' >>> cal.prettyPrint() VCALENDAR @@ -76,6 +97,7 @@ regular attribute names with _param appended: SUMMARY: This is a note params for SUMMARY: X-RANDOM ['Random parameter'] +``` There are a few things to note about this example @@ -84,36 +106,41 @@ There are a few things to note about this example * X-RANDOM's value is a list. If you want to access the full list of parameters, not just the first, -use <paramname>_paramlist: +use <paramname>_paramlist: +``` >>> cal.vevent.summary.x_random_paramlist ['Random parameter'] >>> cal.vevent.summary.x_random_paramlist.append('Other param') >>> cal.vevent.summary <SUMMARY{'X-RANDOM': ['Random parameter', 'Other param']}This is a note> +``` -Similar to parameters, If you want to access more than just the first -child of a Component, you can access the full list of children of a -given name by appending _list to the attribute name: +Similar to parameters, If you want to access more than just the first child of a Component, you can access the full list of children of a given name by appending _list to the attribute name: +``` >>> cal.add('vevent').add('summary').value = "Second VEVENT" >>> for ev in cal.vevent_list: ... print ev.summary.value This is a note Second VEVENT +``` The interaction between the del operator and the hiding of the underlying list is a little tricky, del cal.vevent and del cal.vevent_list both delete all vevent children: +``` >>> first_ev = cal.vevent >>> del cal.vevent >>> cal <VCALENDAR| []> >>> cal.vevent = first_ev +``` -vobject understands Python's datetime module and tzinfo classes. +VObject understands Python's datetime module and tzinfo classes. +``` >>> import datetime >>> utc = vobject.icalendar.utc >>> start = cal.vevent.add('dtstart') @@ -124,9 +151,11 @@ vobject understands Python's datetime module and tzinfo classes. SUMMARY: This is a note params for SUMMARY: X-RANDOM ['Random parameter', 'Other param'] +``` Components and ContentLines have serialize methods: +``` >>> cal.vevent.add('uid').value = 'Sample UID' >>> icalstream = cal.serialize() >>> print icalstream @@ -139,6 +168,7 @@ DTSTART:20060216T000000Z SUMMARY;X-RANDOM=Random parameter,Other param:This is a note END:VEVENT END:VCALENDAR +``` Observe that serializing adds missing required lines like version and prodid. A random UID would be generated, too, if one didn't exist. @@ -147,30 +177,35 @@ If dtstart's tzinfo had been something other than UTC, an appropriate vtimezone would be created for it. -Parsing iCalendar objects -......................... +#### Parsing iCalendar objects To parse one top level component from an existing iCalendar stream or string, use the readOne function: +``` >>> parsedCal = vobject.readOne(icalstream) >>> parsedCal.vevent.dtstart.value datetime.datetime(2006, 2, 16, 0, 0, tzinfo=tzutc()) +``` -Similarly, readComponents is a generator yielding one top level -component at a time from a stream or string. +Similarly, readComponents is a generator yielding one top level component at a time from a stream or string. +``` >>> vobject.readComponents(icalstream).next().vevent.dtstart.value datetime.datetime(2006, 2, 16, 0, 0, tzinfo=tzutc()) +``` More examples can be found in source code doctests. -vCards -...... + +## vCards + +#### Creating vCard objects Making vCards proceeds in much the same way. Note that the 'N' and 'FN' attributes are required. +``` >>> j = vobject.vCard() >>> j.add('n') <N{} > @@ -189,9 +224,11 @@ attributes are required. TYPE ['INTERNET'] FN: Jeffrey Harris N: Jeffrey Harris +``` serializing will add any required computable attributes (like 'VERSION') +``` >>> j.serialize() 'BEGIN:VCARD\r\nVERSION:3.0\r\nEMAIL;TYPE=INTERNET:jeffrey@osafoundation.org\r\nFN:Jeffrey Harris\r\nN:Harris;Jeffrey;;;\r\nEND:VCARD\r\n' >>> j.prettyPrint() @@ -202,10 +239,11 @@ serializing will add any required computable attributes (like 'VERSION') TYPE ['INTERNET'] FN: Jeffrey Harris N: Jeffrey Harris +``` -Parsing vCards -.............. +#### Parsing vCard objects +``` >>> s = """ ... BEGIN:VCARD ... VERSION:3.0 @@ -224,4 +262,5 @@ Parsing vCards FN: Jeffrey Harris N: Jeffrey Harris >>> v.n.value.family -u'Harris'
\ No newline at end of file +u'Harris' +``` diff --git a/ez_setup/README.txt b/ez_setup/README.txt deleted file mode 100755 index 9287f5a..0000000 --- a/ez_setup/README.txt +++ /dev/null @@ -1,15 +0,0 @@ -This directory exists so that Subversion-based projects can share a single -copy of the ``ez_setup`` bootstrap module for ``setuptools``, and have it -automatically updated in their projects when ``setuptools`` is updated. - -For your convenience, you may use the following svn:externals definition:: - - ez_setup svn://svn.eby-sarna.com/svnroot/ez_setup - -You can set this by executing this command in your project directory:: - - svn propedit svn:externals . - -And then adding the line shown above to the file that comes up for editing. -Then, whenever you update your project, ``ez_setup`` will be updated as well. - diff --git a/ez_setup/__init__.py b/ez_setup/__init__.py deleted file mode 100755 index d24e845..0000000 --- a/ez_setup/__init__.py +++ /dev/null @@ -1,276 +0,0 @@ -#!python -"""Bootstrap setuptools installation - -If you want to use setuptools in your package's setup.py, just include this -file in the same directory with it, and add this to the top of your setup.py:: - - from ez_setup import use_setuptools - use_setuptools() - -If you want to require a specific version of setuptools, set a download -mirror, or use an alternate download directory, you can do so by supplying -the appropriate options to ``use_setuptools()``. - -This file can also be run as a script to install or upgrade setuptools. -""" -import sys -DEFAULT_VERSION = "0.6c9" -DEFAULT_URL = "http://pypi.python.org/packages/%s/s/setuptools/" % sys.version[:3] - -md5_data = { - 'setuptools-0.6b1-py2.3.egg': '8822caf901250d848b996b7f25c6e6ca', - 'setuptools-0.6b1-py2.4.egg': 'b79a8a403e4502fbb85ee3f1941735cb', - 'setuptools-0.6b2-py2.3.egg': '5657759d8a6d8fc44070a9d07272d99b', - 'setuptools-0.6b2-py2.4.egg': '4996a8d169d2be661fa32a6e52e4f82a', - 'setuptools-0.6b3-py2.3.egg': 'bb31c0fc7399a63579975cad9f5a0618', - 'setuptools-0.6b3-py2.4.egg': '38a8c6b3d6ecd22247f179f7da669fac', - 'setuptools-0.6b4-py2.3.egg': '62045a24ed4e1ebc77fe039aa4e6f7e5', - 'setuptools-0.6b4-py2.4.egg': '4cb2a185d228dacffb2d17f103b3b1c4', - 'setuptools-0.6c1-py2.3.egg': 'b3f2b5539d65cb7f74ad79127f1a908c', - 'setuptools-0.6c1-py2.4.egg': 'b45adeda0667d2d2ffe14009364f2a4b', - 'setuptools-0.6c2-py2.3.egg': 'f0064bf6aa2b7d0f3ba0b43f20817c27', - 'setuptools-0.6c2-py2.4.egg': '616192eec35f47e8ea16cd6a122b7277', - 'setuptools-0.6c3-py2.3.egg': 'f181fa125dfe85a259c9cd6f1d7b78fa', - 'setuptools-0.6c3-py2.4.egg': 'e0ed74682c998bfb73bf803a50e7b71e', - 'setuptools-0.6c3-py2.5.egg': 'abef16fdd61955514841c7c6bd98965e', - 'setuptools-0.6c4-py2.3.egg': 'b0b9131acab32022bfac7f44c5d7971f', - 'setuptools-0.6c4-py2.4.egg': '2a1f9656d4fbf3c97bf946c0a124e6e2', - 'setuptools-0.6c4-py2.5.egg': '8f5a052e32cdb9c72bcf4b5526f28afc', - 'setuptools-0.6c5-py2.3.egg': 'ee9fd80965da04f2f3e6b3576e9d8167', - 'setuptools-0.6c5-py2.4.egg': 'afe2adf1c01701ee841761f5bcd8aa64', - 'setuptools-0.6c5-py2.5.egg': 'a8d3f61494ccaa8714dfed37bccd3d5d', - 'setuptools-0.6c6-py2.3.egg': '35686b78116a668847237b69d549ec20', - 'setuptools-0.6c6-py2.4.egg': '3c56af57be3225019260a644430065ab', - 'setuptools-0.6c6-py2.5.egg': 'b2f8a7520709a5b34f80946de5f02f53', - 'setuptools-0.6c7-py2.3.egg': '209fdf9adc3a615e5115b725658e13e2', - 'setuptools-0.6c7-py2.4.egg': '5a8f954807d46a0fb67cf1f26c55a82e', - 'setuptools-0.6c7-py2.5.egg': '45d2ad28f9750e7434111fde831e8372', - 'setuptools-0.6c8-py2.3.egg': '50759d29b349db8cfd807ba8303f1902', - 'setuptools-0.6c8-py2.4.egg': 'cba38d74f7d483c06e9daa6070cce6de', - 'setuptools-0.6c8-py2.5.egg': '1721747ee329dc150590a58b3e1ac95b', - 'setuptools-0.6c9-py2.3.egg': 'a83c4020414807b496e4cfbe08507c03', - 'setuptools-0.6c9-py2.4.egg': '260a2be2e5388d66bdaee06abec6342a', - 'setuptools-0.6c9-py2.5.egg': 'fe67c3e5a17b12c0e7c541b7ea43a8e6', - 'setuptools-0.6c9-py2.6.egg': 'ca37b1ff16fa2ede6e19383e7b59245a', -} - -import sys, os -try: from hashlib import md5 -except ImportError: from md5 import md5 - -def _validate_md5(egg_name, data): - if egg_name in md5_data: - digest = md5(data).hexdigest() - if digest != md5_data[egg_name]: - print >>sys.stderr, ( - "md5 validation of %s failed! (Possible download problem?)" - % egg_name - ) - sys.exit(2) - return data - -def use_setuptools( - version=DEFAULT_VERSION, download_base=DEFAULT_URL, to_dir=os.curdir, - download_delay=15 -): - """Automatically find/download setuptools and make it available on sys.path - - `version` should be a valid setuptools version number that is available - as an egg for download under the `download_base` URL (which should end with - a '/'). `to_dir` is the directory where setuptools will be downloaded, if - it is not already available. If `download_delay` is specified, it should - be the number of seconds that will be paused before initiating a download, - should one be required. If an older version of setuptools is installed, - this routine will print a message to ``sys.stderr`` and raise SystemExit in - an attempt to abort the calling script. - """ - was_imported = 'pkg_resources' in sys.modules or 'setuptools' in sys.modules - def do_download(): - egg = download_setuptools(version, download_base, to_dir, download_delay) - sys.path.insert(0, egg) - import setuptools; setuptools.bootstrap_install_from = egg - try: - import pkg_resources - except ImportError: - return do_download() - try: - pkg_resources.require("setuptools>="+version); return - except pkg_resources.VersionConflict, e: - if was_imported: - print >>sys.stderr, ( - "The required version of setuptools (>=%s) is not available, and\n" - "can't be installed while this script is running. Please install\n" - " a more recent version first, using 'easy_install -U setuptools'." - "\n\n(Currently using %r)" - ) % (version, e.args[0]) - sys.exit(2) - else: - del pkg_resources, sys.modules['pkg_resources'] # reload ok - return do_download() - except pkg_resources.DistributionNotFound: - return do_download() - -def download_setuptools( - version=DEFAULT_VERSION, download_base=DEFAULT_URL, to_dir=os.curdir, - delay = 15 -): - """Download setuptools from a specified location and return its filename - - `version` should be a valid setuptools version number that is available - as an egg for download under the `download_base` URL (which should end - with a '/'). `to_dir` is the directory where the egg will be downloaded. - `delay` is the number of seconds to pause before an actual download attempt. - """ - import urllib2, shutil - egg_name = "setuptools-%s-py%s.egg" % (version,sys.version[:3]) - url = download_base + egg_name - saveto = os.path.join(to_dir, egg_name) - src = dst = None - if not os.path.exists(saveto): # Avoid repeated downloads - try: - from distutils import log - if delay: - log.warn(""" ---------------------------------------------------------------------------- -This script requires setuptools version %s to run (even to display -help). I will attempt to download it for you (from -%s), but -you may need to enable firewall access for this script first. -I will start the download in %d seconds. - -(Note: if this machine does not have network access, please obtain the file - - %s - -and place it in this directory before rerunning this script.) ----------------------------------------------------------------------------""", - version, download_base, delay, url - ); from time import sleep; sleep(delay) - log.warn("Downloading %s", url) - src = urllib2.urlopen(url) - # Read/write all in one block, so we don't create a corrupt file - # if the download is interrupted. - data = _validate_md5(egg_name, src.read()) - dst = open(saveto,"wb"); dst.write(data) - finally: - if src: src.close() - if dst: dst.close() - return os.path.realpath(saveto) - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -def main(argv, version=DEFAULT_VERSION): - """Install or upgrade setuptools and EasyInstall""" - try: - import setuptools - except ImportError: - egg = None - try: - egg = download_setuptools(version, delay=0) - sys.path.insert(0,egg) - from setuptools.command.easy_install import main - return main(list(argv)+[egg]) # we're done here - finally: - if egg and os.path.exists(egg): - os.unlink(egg) - else: - if setuptools.__version__ == '0.0.1': - print >>sys.stderr, ( - "You have an obsolete version of setuptools installed. Please\n" - "remove it from your system entirely before rerunning this script." - ) - sys.exit(2) - - req = "setuptools>="+version - import pkg_resources - try: - pkg_resources.require(req) - except pkg_resources.VersionConflict: - try: - from setuptools.command.easy_install import main - except ImportError: - from easy_install import main - main(list(argv)+[download_setuptools(delay=0)]) - sys.exit(0) # try to force an exit - else: - if argv: - from setuptools.command.easy_install import main - main(argv) - else: - print "Setuptools version",version,"or greater has been installed." - print '(Run "ez_setup.py -U setuptools" to reinstall or upgrade.)' - -def update_md5(filenames): - """Update our built-in md5 registry""" - - import re - - for name in filenames: - base = os.path.basename(name) - f = open(name,'rb') - md5_data[base] = md5(f.read()).hexdigest() - f.close() - - data = [" %r: %r,\n" % it for it in md5_data.items()] - data.sort() - repl = "".join(data) - - import inspect - srcfile = inspect.getsourcefile(sys.modules[__name__]) - f = open(srcfile, 'rb'); src = f.read(); f.close() - - match = re.search("\nmd5_data = {\n([^}]+)}", src) - if not match: - print >>sys.stderr, "Internal error!" - sys.exit(2) - - src = src[:match.start(1)] + repl + src[match.end(1):] - f = open(srcfile,'w') - f.write(src) - f.close() - - -if __name__=='__main__': - if len(sys.argv)>2 and sys.argv[1]=='--md5update': - update_md5(sys.argv[2:]) - else: - main(sys.argv[1:]) - - - - - - diff --git a/setup.cfg b/setup.cfg deleted file mode 100644 index 861a9f5..0000000 --- a/setup.cfg +++ /dev/null @@ -1,5 +0,0 @@ -[egg_info] -tag_build = -tag_date = 0 -tag_svn_revision = 0 - @@ -1,77 +1,69 @@ -"""VObject: module for reading vCard and vCalendar files
+"""
+VObject: module for reading vCard and vCalendar files
Description
-----------
-Parses iCalendar and vCard files into Python data structures, decoding the relevant encodings. Also serializes vobject data structures to iCalendar, vCard, or (experimentally) hCalendar unicode strings.
+Parses iCalendar and vCard files into Python data structures, decoding the
+relevant encodings. Also serializes vobject data structures to iCalendar, vCard,
+or (experimentally) hCalendar unicode strings.
Requirements
------------
-Requires python 2.4 or later, dateutil (http://labix.org/python-dateutil) 1.1 or later.
+Requires python 2.7 or later, dateutil 2.4.0 or later.
Recent changes
--------------
- - Make change_tz.py compatible with python 2.4, so the entire package stays compatible
- - Fall back to default (the most recent standard) behavior if a VCARD
- or VCALENDAR doesn't have a recognized VERSION
- - Fixed a bad performance bug when parsing large text bodies, thanks to Morgen Sagen at Apple
- - Changed license to Apache 2.0 from Apache 1.1
- - Worked around an issue with Apple Address Book's vcard PHOTO parser
- - Added change_tz module and script for quickly changing event timezones for an
- ics file. Requires PyICU.
- - Add support for BYMONTHDAY=-1 (days before the end of the month) when setting rrules
- from a dateutil rrule
- - Tolerate a Ruby iCalendar library escaping semi-colons in RRULEs
- - Make vobjects pickle-able
- - Add introspection help for IPython so tab completion works with
- vobject's custom __getattr__
- - Allow Outlook's technically illegal use of commas in TZIDs
- - Allow unicode names for TZIDs
- - Worked around Lotus Notes use of underscores in names by just silently replacing
- with dashes
- - When allowing quoted-printable data, honor CHARSET for each line, defaulting to
- iso-8859-1
- - Simplified directory layout, unit tests are now available via setup.py test
+ - Python 3 compatible
+ - Updated version of dateutil (2.4.0 and above)
+ - More comprehensive unit tests available in tests.py
+ - Performance improvements in iteration
+ - Test files are included in PyPI download package
For older changes, see
- - http://vobject.skyhouseconsulting.com/history.html or
- - http://websvn.osafoundation.org/listing.php?repname=vobject&path=/trunk/
-
+ - http://eventable.github.io/vobject/#release-history or
+ - http://vobject.skyhouseconsulting.com/history.html
"""
-from ez_setup import use_setuptools
-use_setuptools()
-
from setuptools import setup, find_packages
doclines = __doc__.splitlines()
setup(name = "vobject",
- version = "0.8.1c",
+ version = "0.9.2",
author = "Jeffrey Harris",
author_email = "jeffrey@osafoundation.org",
+ maintainer = "Sameen Karim",
+ maintainer_email="sameen@eventable.com",
license = "Apache",
zip_safe = True,
- url = "http://vobject.skyhouseconsulting.com",
- entry_points = { 'console_scripts': ['ics_diff = vobject.ics_diff:main',
- 'change_tz = vobject.change_tz:main']},
+ url = "http://eventable.github.io/vobject/",
+ download_url = 'https://github.com/eventable/vobject/tarball/0.9.1',
+ bugtrack_url = "https://github.com/eventable/vobject/issues",
+ entry_points = {
+ 'console_scripts': [
+ 'ics_diff = vobject.ics_diff:main',
+ 'change_tz = vobject.change_tz:main'
+ ]
+ },
include_package_data = True,
- test_suite = "test_vobject",
-
- install_requires = ['python-dateutil >= 1.1'],
-
+ install_requires = ['python-dateutil >= 2.4.0'],
platforms = ["any"],
packages = find_packages(),
- description = doclines[0],
+ description = "A full-featured Python package for parsing and creating "
+ "iCalendar and vCard files",
long_description = "\n".join(doclines[2:]),
+ keywords = ['vobject', 'icalendar', 'vcard', 'ics', 'vcs', 'hcalendar'],
classifiers = """
Development Status :: 5 - Production/Stable
Environment :: Console
- License :: OSI Approved :: BSD License
Intended Audience :: Developers
+ License :: OSI Approved :: Apache Software License
Natural Language :: English
- Programming Language :: Python
Operating System :: OS Independent
+ Programming Language :: Python
+ Programming Language :: Python :: 2.7
+ Programming Language :: Python :: 3
Topic :: Text Processing""".strip().splitlines()
)
diff --git a/test_files/availablity.ics b/test_files/availablity.ics new file mode 100644 index 0000000..446db07 --- /dev/null +++ b/test_files/availablity.ics @@ -0,0 +1,14 @@ +BEGIN:VAVAILABILITY
+UID:test
+DTSTART:20060216T000000Z
+DTEND:20060217T000000Z
+BEGIN:AVAILABLE
+UID:test1
+DTSTART:20060216T090000Z
+DTEND:20060216T120000Z
+DTSTAMP:20060215T000000Z
+SUMMARY:Available in the morning
+END:AVAILABLE
+BUSYTYPE:BUSY
+DTSTAMP:20060215T000000Z
+END:VAVAILABILITY
diff --git a/test_files/badline.ics b/test_files/badline.ics new file mode 100644 index 0000000..ed81a6b --- /dev/null +++ b/test_files/badline.ics @@ -0,0 +1,10 @@ +BEGIN:VCALENDAR +METHOD:PUBLISH +VERSION:2.0 +BEGIN:VEVENT +DTSTART:19870405T020000 +X-BAD/SLASH:TRUE +X-BAD_UNDERSCORE:TRUE +UID:EC9439B1-FF65-11D6-9973-003065F99D04 +END:VEVENT +END:VCALENDAR diff --git a/test_files/badstream.ics b/test_files/badstream.ics new file mode 100644 index 0000000..42a3220 --- /dev/null +++ b/test_files/badstream.ics @@ -0,0 +1,16 @@ +BEGIN:VCALENDAR +CALSCALE:GREGORIAN +X-WR-TIMEZONE;VALUE=TEXT:US/Pacific +METHOD:PUBLISH +PRODID:-//Apple Computer\, Inc//iCal 1.0//EN +X-WR-CALNAME;VALUE=TEXT:Example +VERSION:2.0 +BEGIN:VEVENT +DTSTART:20021028T140000Z +BEGIN:VALARM +TRIGGER:a20021028120000 +ACTION:DISPLAY +DESCRIPTION:This trigger has a nonsensical value +END:VALARM +END:VEVENT +END:VCALENDAR diff --git a/test_files/freebusy.ics b/test_files/freebusy.ics new file mode 100644 index 0000000..fb38f68 --- /dev/null +++ b/test_files/freebusy.ics @@ -0,0 +1,7 @@ +BEGIN:VFREEBUSY
+UID:test
+DTSTART:20060216T010000Z
+DTEND:20060216T030000Z
+FREEBUSY:20060216T010000Z/PT1H
+FREEBUSY:20060216T010000Z/20060216T030000Z
+END:VFREEBUSY
diff --git a/test_files/journal.ics b/test_files/journal.ics new file mode 100644 index 0000000..5c4d7d6 --- /dev/null +++ b/test_files/journal.ics @@ -0,0 +1,15 @@ +BEGIN:VJOURNAL +UID:19970901T130000Z-123405@example.com +DTSTAMP:19970901T130000Z +DTSTART;VALUE=DATE:19970317 +SUMMARY:Staff meeting minutes +DESCRIPTION:1. Staff meeting: Participants include Joe\, + Lisa\, and Bob. Aurora project plans were reviewed. + There is currently no budget reserves for this project. + Lisa will escalate to management. Next meeting on Tuesday.\n + 2. Telephone Conference: ABC Corp. sales representative + called to discuss new printer. Promised to get us a demo by + Friday.\n3. Henry Miller (Handsoff Insurance): Car was + totaled by tree. Is looking into a loaner car. 555-2323 + (tel). +END:VJOURNAL diff --git a/test_files/more_tests.txt b/test_files/more_tests.txt index 4102fcc..779e79b 100644 --- a/test_files/more_tests.txt +++ b/test_files/more_tests.txt @@ -9,9 +9,9 @@ Unicode in vCards >>> card.add('adr').value = vobject.vcard.Address(u'5\u1234 Nowhere, Apt 1', 'Berkeley', 'CA', '94704', 'USA') >>> card <VCARD| [<ADR{}5? Nowhere, Apt 1\nBerkeley, CA 94704\nUSA>, <FN{}Hello? World!>, <N{} Hello? World >]> ->>> card.serialize().decode("utf-8") +>>> card.serialize() u'BEGIN:VCARD\r\nVERSION:3.0\r\nADR:;;5\u1234 Nowhere\\, Apt 1;Berkeley;CA;94704;USA\r\nFN:Hello\u1234 World!\r\nN:World;Hello\u1234;;;\r\nEND:VCARD\r\n' ->>> print card.serialize() +>>> print(card.serialize()) BEGIN:VCARD VERSION:3.0 ADR:;;5ሴ Nowhere\, Apt 1;Berkeley;CA;94704;USA @@ -32,16 +32,16 @@ Unicode in TZID ............... >>> f = get_stream("tzid_8bit.ics") >>> cal = vobject.readOne(f) ->>> print cal.vevent.dtstart.value +>>> print(cal.vevent.dtstart.value) 2008-05-30 15:00:00+06:00 ->>> print cal.vevent.dtstart.serialize() +>>> print(cal.vevent.dtstart.serialize()) DTSTART;TZID=Екатеринбург:20080530T150000 Commas in TZID .............. >>> f = get_stream("ms_tzid.ics") >>> cal = vobject.readOne(f) ->>> print cal.vevent.dtstart.value +>>> print(cal.vevent.dtstart.value) 2008-05-30 15:00:00+10:00 Equality in vCards @@ -56,7 +56,7 @@ Organization (org) .................. >>> card.add('org').value = ["Company, Inc.", "main unit", "sub-unit"] ->>> print card.org.serialize() +>>> print(card.org.serialize()) ORG:Company\, Inc.;main unit;sub-unit Ruby escapes semi-colons in rrules @@ -67,7 +67,6 @@ Ruby escapes semi-colons in rrules >>> iter(cal.vevent.rruleset).next() datetime.datetime(2003, 1, 1, 7, 0) - quoted-printable ................ diff --git a/test_files/silly_test.ics b/test_files/silly_test.ics new file mode 100644 index 0000000..2ee72db --- /dev/null +++ b/test_files/silly_test.ics @@ -0,0 +1,5 @@ +sillyname:name +profile:sillyprofile +stuff:folded + line +morestuff;asinine:this line is not folded, but in practice probably ought to be, as it is exceptionally long, and moreover demonstratively stupid diff --git a/test_files/simple_2_0_test.ics b/test_files/simple_2_0_test.ics new file mode 100644 index 0000000..9ffa758 --- /dev/null +++ b/test_files/simple_2_0_test.ics @@ -0,0 +1,10 @@ +BEGIN:VCALENDAR
+VERSION:2.0
+PRODID:-//PYVOBJECT//NONSGML Version 1//EN
+BEGIN:VEVENT
+UID:Not very random UID
+DTSTART:20060509T000000
+CREATED:20060101T180000Z
+DESCRIPTION:Test event
+END:VEVENT
+END:VCALENDAR
diff --git a/test_files/simple_3_0_test.ics b/test_files/simple_3_0_test.ics new file mode 100644 index 0000000..d5e4642 --- /dev/null +++ b/test_files/simple_3_0_test.ics @@ -0,0 +1,13 @@ +BEGIN:VCARD +VERSION:3.0 +FN:Daffy Duck Knudson (with Bugs Bunny and Mr. Pluto) +N:Knudson;Daffy Duck (with Bugs Bunny and Mr. Pluto) +NICKNAME:gnat and gnu and pluto +BDAY;value=date:02-10 +TEL;type=HOME:+01-(0)2-765.43.21 +TEL;type=CELL:+01-(0)5-555.55.55 +ACCOUNT;type=HOME:010-1234567-05 +ADR;type=HOME:;;Haight Street 512\;\nEscape\, Test;Novosibirsk;;80214;Gnuland +TEL;type=HOME:+01-(0)2-876.54.32 +ORG:University of Novosibirsk, Department of Octopus Parthenogenesis +END:VCARD diff --git a/test_files/simple_test.ics b/test_files/simple_test.ics new file mode 100644 index 0000000..aefb51e --- /dev/null +++ b/test_files/simple_test.ics @@ -0,0 +1,5 @@ +BEGIN:VCALENDAR +BEGIN:VEVENT +SUMMARY;blah=hi!:Bastille Day Party +END:VEVENT +END:VCALENDAR diff --git a/test_files/standard_test.ics b/test_files/standard_test.ics new file mode 100644 index 0000000..4593fe1 --- /dev/null +++ b/test_files/standard_test.ics @@ -0,0 +1,41 @@ +BEGIN:VCALENDAR +CALSCALE:GREGORIAN +X-WR-TIMEZONE;VALUE=TEXT:US/Pacific +METHOD:PUBLISH +PRODID:-//Apple Computer\, Inc//iCal 1.0//EN +X-WR-CALNAME;VALUE=TEXT:Example +VERSION:2.0 +BEGIN:VEVENT +SEQUENCE:5 +DTSTART;TZID=US/Pacific:20021028T140000 +RRULE:FREQ=Weekly;COUNT=10 +DTSTAMP:20021028T011706Z +SUMMARY:Coffee with Jason +UID:EC9439B1-FF65-11D6-9973-003065F99D04 +DTEND;TZID=US/Pacific:20021028T150000 +BEGIN:VALARM +TRIGGER;VALUE=DURATION:-P1D +ACTION:DISPLAY +DESCRIPTION:Event reminder\, with comma\nand line feed +END:VALARM +END:VEVENT +BEGIN:VTIMEZONE +X-LIC-LOCATION:Random location +TZID:US/Pacific +LAST-MODIFIED:19870101T000000Z +BEGIN:STANDARD +DTSTART:19671029T020000 +RRULE:FREQ=YEARLY;BYDAY=-1SU;BYMONTH=10 +TZOFFSETFROM:-0700 +TZOFFSETTO:-0800 +TZNAME:PST +END:STANDARD +BEGIN:DAYLIGHT +DTSTART:19870405T020000 +RRULE:FREQ=YEARLY;BYDAY=1SU;BYMONTH=4 +TZOFFSETFROM:-0800 +TZOFFSETTO:-0700 +TZNAME:PDT +END:DAYLIGHT +END:VTIMEZONE +END:VCALENDAR diff --git a/test_files/timezones.ics b/test_files/timezones.ics new file mode 100644 index 0000000..e839223 --- /dev/null +++ b/test_files/timezones.ics @@ -0,0 +1,107 @@ +BEGIN:VTIMEZONE +TZID:US/Pacific +BEGIN:STANDARD +DTSTART:19671029T020000 +RRULE:FREQ=YEARLY;BYDAY=-1SU;BYMONTH=10 +TZOFFSETFROM:-0700 +TZOFFSETTO:-0800 +TZNAME:PST +END:STANDARD +BEGIN:DAYLIGHT +DTSTART:19870405T020000 +RRULE:FREQ=YEARLY;BYDAY=1SU;BYMONTH=4 +TZOFFSETFROM:-0800 +TZOFFSETTO:-0700 +TZNAME:PDT +END:DAYLIGHT +END:VTIMEZONE + +BEGIN:VTIMEZONE +TZID:US/Eastern +BEGIN:STANDARD +DTSTART:19671029T020000 +RRULE:FREQ=YEARLY;BYDAY=-1SU;BYMONTH=10 +TZOFFSETFROM:-0400 +TZOFFSETTO:-0500 +TZNAME:EST +END:STANDARD +BEGIN:DAYLIGHT +DTSTART:19870405T020000 +RRULE:FREQ=YEARLY;BYDAY=1SU;BYMONTH=4 +TZOFFSETFROM:-0500 +TZOFFSETTO:-0400 +TZNAME:EDT +END:DAYLIGHT +END:VTIMEZONE + +BEGIN:VTIMEZONE +TZID:Santiago +BEGIN:STANDARD +DTSTART:19700314T000000 +TZOFFSETFROM:-0300 +TZOFFSETTO:-0400 +RRULE:FREQ=YEARLY;BYMONTH=3;BYDAY=2SA +TZNAME:Pacific SA Standard Time +END:STANDARD +BEGIN:DAYLIGHT +DTSTART:19701010T000000 +TZOFFSETFROM:-0400 +TZOFFSETTO:-0300 +RRULE:FREQ=YEARLY;BYMONTH=10;BYDAY=2SA +TZNAME:Pacific SA Daylight Time +END:DAYLIGHT +END:VTIMEZONE + +BEGIN:VTIMEZONE +TZID:W. Europe +BEGIN:STANDARD +DTSTART:19701025T030000 +TZOFFSETFROM:+0200 +TZOFFSETTO:+0100 +RRULE:FREQ=YEARLY;BYMONTH=10;BYDAY=-1SU +TZNAME:W. Europe Standard Time +END:STANDARD +BEGIN:DAYLIGHT +DTSTART:19700329T020000 +TZOFFSETFROM:+0100 +TZOFFSETTO:+0200 +RRULE:FREQ=YEARLY;BYMONTH=3;BYDAY=-1SU +TZNAME:W. Europe Daylight Time +END:DAYLIGHT +END:VTIMEZONE + +BEGIN:VTIMEZONE +TZID:US/Fictitious-Eastern +LAST-MODIFIED:19870101T000000Z +BEGIN:STANDARD +DTSTART:19671029T020000 +RRULE:FREQ=YEARLY;BYDAY=-1SU;BYMONTH=10 +TZOFFSETFROM:-0400 +TZOFFSETTO:-0500 +TZNAME:EST +END:STANDARD +BEGIN:DAYLIGHT +DTSTART:19870405T020000 +RRULE:FREQ=YEARLY;BYDAY=1SU;BYMONTH=4;UNTIL=20050403T070000Z +TZOFFSETFROM:-0500 +TZOFFSETTO:-0400 +TZNAME:EDT +END:DAYLIGHT +END:VTIMEZONE + +BEGIN:VTIMEZONE +TZID:America/Montreal +LAST-MODIFIED:20051013T233643Z +BEGIN:DAYLIGHT +DTSTART:20050403T070000 +TZOFFSETTO:-0400 +TZOFFSETFROM:+0000 +TZNAME:EDT +END:DAYLIGHT +BEGIN:STANDARD +DTSTART:20051030T020000 +TZOFFSETTO:-0500 +TZOFFSETFROM:-0400 +TZNAME:EST +END:STANDARD +END:VTIMEZONE diff --git a/test_files/vcard_with_groups.ics b/test_files/vcard_with_groups.ics new file mode 100644 index 0000000..d64ff90 --- /dev/null +++ b/test_files/vcard_with_groups.ics @@ -0,0 +1,18 @@ +home.begin:vcard +version:3.0 +source:ldap://cn=Meister%20Berger,o=Universitaet%20Goerlitz,c=DE +name:Meister Berger +fn:Meister Berger +n:Berger;Meister +bday;value=date:1963-09-21 +o:Universit=E6t G=F6rlitz +title:Mayor +title;language=de;value=text:Burgermeister +note:The Mayor of the great city of + Goerlitz in the great country of Germany.\nNext line. +email;internet:mb@goerlitz.de +home.tel;type=fax,voice;type=msg:+49 3581 123456 +home.label:Hufenshlagel 1234\n + 02828 Goerlitz\n + Deutschland +END:VCARD diff --git a/test_files/vtodo.ics b/test_files/vtodo.ics new file mode 100644 index 0000000..26b577c --- /dev/null +++ b/test_files/vtodo.ics @@ -0,0 +1,13 @@ +BEGIN:VCALENDAR +VERSION:2.0 +PRODID:-//Example Corp.//CalDAV Client//EN +BEGIN:VTODO +UID:20070313T123432Z-456553@example.com +DTSTAMP:20070313T123432Z +DUE;VALUE=DATE:20070501 +SUMMARY:Submit Quebec Income Tax Return for 2006 +CLASS:CONFIDENTIAL +CATEGORIES:FAMILY,FINANCE +STATUS:NEEDS-ACTION +END:VTODO +END:VCALENDAR diff --git a/test_vobject.py b/test_vobject.py deleted file mode 100644 index 9ee214a..0000000 --- a/test_vobject.py +++ /dev/null @@ -1,783 +0,0 @@ -"""Long or boring tests for vobjects."""
-
-import vobject
-from vobject import base, icalendar, behavior, vcard, hcalendar
-import StringIO, re, dateutil.tz, datetime
-
-import doctest, test_vobject, unittest
-
-from pkg_resources import resource_stream
-
-base.logger.setLevel(base.logging.FATAL)
-#------------------- Testing and running functions -----------------------------
-# named additional_tests for setuptools
-def additional_tests():
-
- flags = doctest.NORMALIZE_WHITESPACE | doctest.REPORT_ONLY_FIRST_FAILURE | doctest.ELLIPSIS
- suite = unittest.TestSuite()
- for module in base, test_vobject, icalendar, vobject, vcard:
- suite.addTest(doctest.DocTestSuite(module, optionflags=flags))
-
- suite.addTest(doctest.DocFileSuite(
- 'README.txt', 'test_files/more_tests.txt',
- package='__main__', optionflags=flags
- ))
- return suite
-
-if __name__ == '__main__':
- runner = unittest.TextTestRunner()
- runner.run(additional_tests())
-
-
-testSilly="""
-sillyname:name
-profile:sillyprofile
-stuff:folded
- line
-""" + "morestuff;asinine:this line is not folded, \
-but in practice probably ought to be, as it is exceptionally long, \
-and moreover demonstratively stupid"
-
-icaltest=r"""BEGIN:VCALENDAR
-CALSCALE:GREGORIAN
-X-WR-TIMEZONE;VALUE=TEXT:US/Pacific
-METHOD:PUBLISH
-PRODID:-//Apple Computer\, Inc//iCal 1.0//EN
-X-WR-CALNAME;VALUE=TEXT:Example
-VERSION:2.0
-BEGIN:VEVENT
-SEQUENCE:5
-DTSTART;TZID=US/Pacific:20021028T140000
-RRULE:FREQ=Weekly;COUNT=10
-DTSTAMP:20021028T011706Z
-SUMMARY:Coffee with Jason
-UID:EC9439B1-FF65-11D6-9973-003065F99D04
-DTEND;TZID=US/Pacific:20021028T150000
-BEGIN:VALARM
-TRIGGER;VALUE=DURATION:-P1D
-ACTION:DISPLAY
-DESCRIPTION:Event reminder\, with comma\nand line feed
-END:VALARM
-END:VEVENT
-BEGIN:VTIMEZONE
-X-LIC-LOCATION:Random location
-TZID:US/Pacific
-LAST-MODIFIED:19870101T000000Z
-BEGIN:STANDARD
-DTSTART:19671029T020000
-RRULE:FREQ=YEARLY;BYDAY=-1SU;BYMONTH=10
-TZOFFSETFROM:-0700
-TZOFFSETTO:-0800
-TZNAME:PST
-END:STANDARD
-BEGIN:DAYLIGHT
-DTSTART:19870405T020000
-RRULE:FREQ=YEARLY;BYDAY=1SU;BYMONTH=4
-TZOFFSETFROM:-0800
-TZOFFSETTO:-0700
-TZNAME:PDT
-END:DAYLIGHT
-END:VTIMEZONE
-END:VCALENDAR"""
-
-badDtStartTest="""BEGIN:VCALENDAR
-METHOD:PUBLISH
-VERSION:2.0
-BEGIN:VEVENT
-DTSTART:20021028
-DTSTAMP:20021028T011706Z
-SUMMARY:Coffee with Jason
-UID:EC9439B1-FF65-11D6-9973-003065F99D04
-END:VEVENT
-END:VCALENDAR"""
-
-badLineTest="""BEGIN:VCALENDAR
-METHOD:PUBLISH
-VERSION:2.0
-BEGIN:VEVENT
-DTSTART:19870405T020000
-X-BAD/SLASH:TRUE
-X-BAD_UNDERSCORE:TRUE
-UID:EC9439B1-FF65-11D6-9973-003065F99D04
-END:VEVENT
-END:VCALENDAR"""
-
-vcardtest =r"""BEGIN:VCARD
-VERSION:3.0
-FN:Daffy Duck Knudson (with Bugs Bunny and Mr. Pluto)
-N:Knudson;Daffy Duck (with Bugs Bunny and Mr. Pluto)
-NICKNAME:gnat and gnu and pluto
-BDAY;value=date:02-10
-TEL;type=HOME:+01-(0)2-765.43.21
-TEL;type=CELL:+01-(0)5-555.55.55
-ACCOUNT;type=HOME:010-1234567-05
-ADR;type=HOME:;;Haight Street 512\;\nEscape\, Test;Novosibirsk;;80214;Gnuland
-TEL;type=HOME:+01-(0)2-876.54.32
-ORG:University of Novosibirsk\, Department of Octopus
- Parthenogenesis
-END:VCARD"""
-
-vcardWithGroups = r"""home.begin:vcard
-version:3.0
-source:ldap://cn=Meister%20Berger,o=Universitaet%20Goerlitz,c=DE
-name:Meister Berger
-fn:Meister Berger
-n:Berger;Meister
-bday;value=date:1963-09-21
-o:Universit=E6t G=F6rlitz
-title:Mayor
-title;language=de;value=text:Burgermeister
-note:The Mayor of the great city of
- Goerlitz in the great country of Germany.\nNext line.
-email;internet:mb@goerlitz.de
-home.tel;type=fax,voice;type=msg:+49 3581 123456
-home.label:Hufenshlagel 1234\n
- 02828 Goerlitz\n
- Deutschland
-END:VCARD"""
-
-lowercaseComponentNames = r"""begin:vcard
-fn:Anders Bobo
-n:Bobo;Anders
-org:Bobo A/S;Vice President, Technical Support
-adr:Rockfeller Center;;Mekastreet;Bobocity;;2100;Myworld
-email;internet:bobo@example.com
-tel;work:+123455
-tel;fax:+123456
-tel;cell:+123457
-x-mozilla-html:FALSE
-url:http://www.example.com
-version:2.1
-end:vcard"""
-
-icalWeirdTrigger = r"""BEGIN:VCALENDAR
-CALSCALE:GREGORIAN
-X-WR-TIMEZONE;VALUE=TEXT:US/Pacific
-METHOD:PUBLISH
-PRODID:-//Apple Computer\, Inc//iCal 1.0//EN
-X-WR-CALNAME;VALUE=TEXT:Example
-VERSION:2.0
-BEGIN:VEVENT
-DTSTART:20021028T140000Z
-BEGIN:VALARM
-TRIGGER:20021028T120000Z
-ACTION:DISPLAY
-DESCRIPTION:This trigger is a date-time without a VALUE=DATE-TIME parameter
-END:VALARM
-END:VEVENT
-END:VCALENDAR"""
-
-badstream = r"""BEGIN:VCALENDAR
-CALSCALE:GREGORIAN
-X-WR-TIMEZONE;VALUE=TEXT:US/Pacific
-METHOD:PUBLISH
-PRODID:-//Apple Computer\, Inc//iCal 1.0//EN
-X-WR-CALNAME;VALUE=TEXT:Example
-VERSION:2.0
-BEGIN:VEVENT
-DTSTART:20021028T140000Z
-BEGIN:VALARM
-TRIGGER:a20021028120000
-ACTION:DISPLAY
-DESCRIPTION:This trigger has a nonsensical value
-END:VALARM
-END:VEVENT
-END:VCALENDAR"""
-
-timezones = r"""
-
-BEGIN:VTIMEZONE
-TZID:US/Pacific
-BEGIN:STANDARD
-DTSTART:19671029T020000
-RRULE:FREQ=YEARLY;BYDAY=-1SU;BYMONTH=10
-TZOFFSETFROM:-0700
-TZOFFSETTO:-0800
-TZNAME:PST
-END:STANDARD
-BEGIN:DAYLIGHT
-DTSTART:19870405T020000
-RRULE:FREQ=YEARLY;BYDAY=1SU;BYMONTH=4
-TZOFFSETFROM:-0800
-TZOFFSETTO:-0700
-TZNAME:PDT
-END:DAYLIGHT
-END:VTIMEZONE
-
-BEGIN:VTIMEZONE
-TZID:US/Eastern
-BEGIN:STANDARD
-DTSTART:19671029T020000
-RRULE:FREQ=YEARLY;BYDAY=-1SU;BYMONTH=10
-TZOFFSETFROM:-0400
-TZOFFSETTO:-0500
-TZNAME:EST
-END:STANDARD
-BEGIN:DAYLIGHT
-DTSTART:19870405T020000
-RRULE:FREQ=YEARLY;BYDAY=1SU;BYMONTH=4
-TZOFFSETFROM:-0500
-TZOFFSETTO:-0400
-TZNAME:EDT
-END:DAYLIGHT
-END:VTIMEZONE
-
-BEGIN:VTIMEZONE
-TZID:Santiago
-BEGIN:STANDARD
-DTSTART:19700314T000000
-TZOFFSETFROM:-0300
-TZOFFSETTO:-0400
-RRULE:FREQ=YEARLY;BYMONTH=3;BYDAY=2SA
-TZNAME:Pacific SA Standard Time
-END:STANDARD
-BEGIN:DAYLIGHT
-DTSTART:19701010T000000
-TZOFFSETFROM:-0400
-TZOFFSETTO:-0300
-RRULE:FREQ=YEARLY;BYMONTH=10;BYDAY=2SA
-TZNAME:Pacific SA Daylight Time
-END:DAYLIGHT
-END:VTIMEZONE
-
-BEGIN:VTIMEZONE
-TZID:W. Europe
-BEGIN:STANDARD
-DTSTART:19701025T030000
-TZOFFSETFROM:+0200
-TZOFFSETTO:+0100
-RRULE:FREQ=YEARLY;BYMONTH=10;BYDAY=-1SU
-TZNAME:W. Europe Standard Time
-END:STANDARD
-BEGIN:DAYLIGHT
-DTSTART:19700329T020000
-TZOFFSETFROM:+0100
-TZOFFSETTO:+0200
-RRULE:FREQ=YEARLY;BYMONTH=3;BYDAY=-1SU
-TZNAME:W. Europe Daylight Time
-END:DAYLIGHT
-END:VTIMEZONE
-
-BEGIN:VTIMEZONE
-TZID:US/Fictitious-Eastern
-LAST-MODIFIED:19870101T000000Z
-BEGIN:STANDARD
-DTSTART:19671029T020000
-RRULE:FREQ=YEARLY;BYDAY=-1SU;BYMONTH=10
-TZOFFSETFROM:-0400
-TZOFFSETTO:-0500
-TZNAME:EST
-END:STANDARD
-BEGIN:DAYLIGHT
-DTSTART:19870405T020000
-RRULE:FREQ=YEARLY;BYDAY=1SU;BYMONTH=4;UNTIL=20050403T070000Z
-TZOFFSETFROM:-0500
-TZOFFSETTO:-0400
-TZNAME:EDT
-END:DAYLIGHT
-END:VTIMEZONE
-
-BEGIN:VTIMEZONE
-TZID:America/Montreal
-LAST-MODIFIED:20051013T233643Z
-BEGIN:DAYLIGHT
-DTSTART:20050403T070000
-TZOFFSETTO:-0400
-TZOFFSETFROM:+0000
-TZNAME:EDT
-END:DAYLIGHT
-BEGIN:STANDARD
-DTSTART:20051030T020000
-TZOFFSETTO:-0500
-TZOFFSETFROM:-0400
-TZNAME:EST
-END:STANDARD
-END:VTIMEZONE
-
-"""
-
-__test__ = { "Test readOne" :
- r"""
- >>> silly = base.readOne(testSilly, findBegin=False)
- >>> silly
- <SILLYPROFILE| [<MORESTUFF{}this line is not folded, but in practice probably ought to be, as it is exceptionally long, and moreover demonstratively stupid>, <SILLYNAME{}name>, <STUFF{}foldedline>]>
- >>> silly.stuff
- <STUFF{}foldedline>
- >>> original = silly.serialize()
- >>> f3 = StringIO.StringIO(original.decode("utf-8"))
- >>> silly2 = base.readOne(f3)
- >>> silly2.serialize()==original
- True
- >>> s3 = StringIO.StringIO('cn:Babs Jensen\r\ncn:Barbara J Jensen\r\nsn:Jensen\r\nemail:babs@umich.edu\r\nphone:+1 313 747-4454\r\nx-id:1234567890\r\n')
- >>> ex1 = base.readOne(s3, findBegin=False)
- >>> ex1
- <*unnamed*| [<CN{}Babs Jensen>, <CN{}Barbara J Jensen>, <EMAIL{}babs@umich.edu>, <PHONE{}+1 313 747-4454>, <SN{}Jensen>, <X-ID{}1234567890>]>
- >>> ex1.serialize()
- 'CN:Babs Jensen\r\nCN:Barbara J Jensen\r\nEMAIL:babs@umich.edu\r\nPHONE:+1 313 747-4454\r\nSN:Jensen\r\nX-ID:1234567890\r\n'
- """,
-
- "Import icaltest" :
- r"""
- >>> c = base.readOne(icaltest, validate=True)
- >>> c.vevent.valarm.trigger
- <TRIGGER{}-1 day, 0:00:00>
- >>> c.vevent.dtstart.value
- datetime.datetime(2002, 10, 28, 14, 0, tzinfo=<tzicalvtz 'US/Pacific'>)
- >>> c.vevent.dtend.value
- datetime.datetime(2002, 10, 28, 15, 0, tzinfo=<tzicalvtz 'US/Pacific'>)
- >>> c.vevent.dtstamp.value
- datetime.datetime(2002, 10, 28, 1, 17, 6, tzinfo=tzutc())
- >>> c.vevent.valarm.description.value
- u'Event reminder, with comma\nand line feed'
- >>> c.vevent.valarm.description.serialize()
- 'DESCRIPTION:Event reminder\\, with comma\\nand line feed\r\n'
- >>> vevent = c.vevent.transformFromNative()
- >>> vevent.rrule
- <RRULE{}FREQ=Weekly;COUNT=10>
- """,
-
- "Parsing tests" :
- """
- >>> parseRDate = icalendar.MultiDateBehavior.transformToNative
- >>> icalendar.stringToTextValues('')
- ['']
- >>> icalendar.stringToTextValues('abcd,efgh')
- ['abcd', 'efgh']
- >>> icalendar.stringToPeriod("19970101T180000Z/19970102T070000Z")
- (datetime.datetime(1997, 1, 1, 18, 0, tzinfo=tzutc()), datetime.datetime(1997, 1, 2, 7, 0, tzinfo=tzutc()))
- >>> icalendar.stringToPeriod("19970101T180000Z/PT1H")
- (datetime.datetime(1997, 1, 1, 18, 0, tzinfo=tzutc()), datetime.timedelta(0, 3600))
- >>> parseRDate(base.textLineToContentLine("RDATE;VALUE=DATE:19970304,19970504,19970704,19970904"))
- <RDATE{'VALUE': ['DATE']}[datetime.date(1997, 3, 4), datetime.date(1997, 5, 4), datetime.date(1997, 7, 4), datetime.date(1997, 9, 4)]>
- >>> parseRDate(base.textLineToContentLine("RDATE;VALUE=PERIOD:19960403T020000Z/19960403T040000Z,19960404T010000Z/PT3H"))
- <RDATE{'VALUE': ['PERIOD']}[(datetime.datetime(1996, 4, 3, 2, 0, tzinfo=tzutc()), datetime.datetime(1996, 4, 3, 4, 0, tzinfo=tzutc())), (datetime.datetime(1996, 4, 4, 1, 0, tzinfo=tzutc()), datetime.timedelta(0, 10800))]>
- """,
-
- "read failure" :
- """
- >>> vevent = base.readOne(badstream)
- Traceback (most recent call last):
- ...
- ParseError: At line 11: TRIGGER with no VALUE not recognized as DURATION or as DATE-TIME
- >>> cal = base.readOne(badLineTest)
- Traceback (most recent call last):
- ...
- ParseError: At line 6: Failed to parse line: X-BAD/SLASH:TRUE
- >>> cal = base.readOne(badLineTest, ignoreUnreadable=True)
- >>> cal.vevent.x_bad_slash
- Traceback (most recent call last):
- ...
- AttributeError: x_bad_slash
- >>> cal.vevent.x_bad_underscore
- <X-BAD-UNDERSCORE{}TRUE>
- """,
-
- "ical trigger workaround" :
- """
-
- >>> badical = base.readOne(icalWeirdTrigger)
- >>> badical.vevent.valarm.description.value
- u'This trigger is a date-time without a VALUE=DATE-TIME parameter'
- >>> badical.vevent.valarm.trigger.value
- datetime.datetime(2002, 10, 28, 12, 0, tzinfo=tzutc())
- """,
-
- "unicode test" :
- r"""
- >>> f = resource_stream(__name__, 'test_files/utf8_test.ics')
- >>> vevent = base.readOne(f).vevent
- >>> vevent.summary.value
- u'The title \u3053\u3093\u306b\u3061\u306f\u30ad\u30c6\u30a3'
- >>> summary = vevent.summary.value
- >>> test = str(vevent.serialize()),
- """,
-
- # make sure date valued UNTILs in rrules are in a reasonable timezone,
- # and include that day (12/28 in this test)
- "recurrence test" :
- r"""
- >>> f = resource_stream(__name__, 'test_files/recurrence.ics')
- >>> cal = base.readOne(f)
- >>> dates = list(cal.vevent.rruleset)
- >>> dates[0]
- datetime.datetime(2006, 1, 26, 23, 0, tzinfo=tzutc())
- >>> dates[1]
- datetime.datetime(2006, 2, 23, 23, 0, tzinfo=tzutc())
- >>> dates[-1]
- datetime.datetime(2006, 12, 28, 23, 0, tzinfo=tzutc())
- """,
-
-
- "regular expression test" :
- """
- >>> re.findall(base.patterns['name'], '12foo-bar:yay')
- ['12foo-bar', 'yay']
- >>> re.findall(base.patterns['safe_char'], 'a;b"*,cd')
- ['a', 'b', '*', 'c', 'd']
- >>> re.findall(base.patterns['qsafe_char'], 'a;b"*,cd')
- ['a', ';', 'b', '*', ',', 'c', 'd']
- >>> re.findall(base.patterns['param_value'], '"quoted";not-quoted;start"after-illegal-quote', re.VERBOSE)
- ['"quoted"', '', 'not-quoted', '', 'start', '', 'after-illegal-quote', '']
- >>> match = base.line_re.match('TEST;ALTREP="http://www.wiz.org":value:;"')
- >>> match.group('value')
- 'value:;"'
- >>> match.group('name')
- 'TEST'
- >>> match.group('params')
- ';ALTREP="http://www.wiz.org"'
- """,
-
- "VTIMEZONE creation test:" :
-
- """
- >>> f = StringIO.StringIO(timezones)
- >>> tzs = dateutil.tz.tzical(f)
- >>> tzs.get("US/Pacific")
- <tzicalvtz 'US/Pacific'>
- >>> icalendar.TimezoneComponent(_)
- <VTIMEZONE | <TZID{}US/Pacific>>
- >>> pacific = _
- >>> print pacific.serialize()
- BEGIN:VTIMEZONE
- TZID:US/Pacific
- BEGIN:STANDARD
- DTSTART:20001029T020000
- RRULE:FREQ=YEARLY;BYDAY=-1SU;BYMONTH=10
- TZNAME:PST
- TZOFFSETFROM:-0700
- TZOFFSETTO:-0800
- END:STANDARD
- BEGIN:DAYLIGHT
- DTSTART:20000402T020000
- RRULE:FREQ=YEARLY;BYDAY=1SU;BYMONTH=4
- TZNAME:PDT
- TZOFFSETFROM:-0800
- TZOFFSETTO:-0700
- END:DAYLIGHT
- END:VTIMEZONE
- >>> (_)
- <VTIMEZONE | <TZID{}US/Pacific>>
- >>> santiago = icalendar.TimezoneComponent(tzs.get('Santiago'))
- >>> ser = santiago.serialize()
- >>> print ser
- BEGIN:VTIMEZONE
- TZID:Santiago
- BEGIN:STANDARD
- DTSTART:20000311T000000
- RRULE:FREQ=YEARLY;BYDAY=2SA;BYMONTH=3
- TZNAME:Pacific SA Standard Time
- TZOFFSETFROM:-0300
- TZOFFSETTO:-0400
- END:STANDARD
- BEGIN:DAYLIGHT
- DTSTART:20001014T000000
- RRULE:FREQ=YEARLY;BYDAY=2SA;BYMONTH=10
- TZNAME:Pacific SA Daylight Time
- TZOFFSETFROM:-0400
- TZOFFSETTO:-0300
- END:DAYLIGHT
- END:VTIMEZONE
- >>> roundtrip = dateutil.tz.tzical(StringIO.StringIO(str(ser))).get()
- >>> for year in range(2001, 2010):
- ... for month in (2, 9):
- ... dt = datetime.datetime(year, month, 15, tzinfo = roundtrip)
- ... if dt.replace(tzinfo=tzs.get('Santiago')) != dt:
- ... print "Failed for:", dt
- >>> fict = icalendar.TimezoneComponent(tzs.get('US/Fictitious-Eastern'))
- >>> print fict.serialize()
- BEGIN:VTIMEZONE
- TZID:US/Fictitious-Eastern
- BEGIN:STANDARD
- DTSTART:20001029T020000
- RRULE:FREQ=YEARLY;BYDAY=-1SU;BYMONTH=10
- TZNAME:EST
- TZOFFSETFROM:-0400
- TZOFFSETTO:-0500
- END:STANDARD
- BEGIN:DAYLIGHT
- DTSTART:20000402T020000
- RRULE:FREQ=YEARLY;BYDAY=1SU;BYMONTH=4;UNTIL=20050403T070000Z
- TZNAME:EDT
- TZOFFSETFROM:-0500
- TZOFFSETTO:-0400
- END:DAYLIGHT
- END:VTIMEZONE
- """,
-
- "Create iCalendar from scratch" :
-
- """
- >>> cal = base.newFromBehavior('vcalendar', '2.0')
- >>> cal.add('vevent')
- <VEVENT| []>
- >>> cal.vevent.add('dtstart').value = datetime.datetime(2006, 5, 9)
- >>> cal.vevent.add('description').value = "Test event"
- >>> pacific = dateutil.tz.tzical(StringIO.StringIO(timezones)).get('US/Pacific')
- >>> cal.vevent.add('created').value = datetime.datetime(2006, 1, 1, 10, tzinfo=pacific)
- >>> cal.vevent.add('uid').value = "Not very random UID"
- >>> print cal.serialize()
- BEGIN:VCALENDAR
- VERSION:2.0
- PRODID:-//PYVOBJECT//NONSGML Version 1//EN
- BEGIN:VEVENT
- UID:Not very random UID
- DTSTART:20060509T000000
- CREATED:20060101T180000Z
- DESCRIPTION:Test event
- END:VEVENT
- END:VCALENDAR
- """,
-
- "Serializing with timezones test" :
-
- """
- >>> from dateutil.rrule import rrule, rruleset, WEEKLY, MONTHLY
- >>> pacific = dateutil.tz.tzical(StringIO.StringIO(timezones)).get('US/Pacific')
- >>> cal = base.Component('VCALENDAR')
- >>> cal.setBehavior(icalendar.VCalendar2_0)
- >>> ev = cal.add('vevent')
- >>> ev.add('dtstart').value = datetime.datetime(2005, 10, 12, 9, tzinfo = pacific)
- >>> set = rruleset()
- >>> set.rrule(rrule(WEEKLY, interval=2, byweekday=[2,4], until=datetime.datetime(2005, 12, 15, 9)))
- >>> set.rrule(rrule(MONTHLY, bymonthday=[-1,-5]))
- >>> set.exdate(datetime.datetime(2005, 10, 14, 9, tzinfo = pacific))
- >>> ev.rruleset = set
- >>> ev.add('duration').value = datetime.timedelta(hours=1)
- >>> print cal.serialize()
- BEGIN:VCALENDAR
- VERSION:2.0
- PRODID:-//PYVOBJECT//NONSGML Version 1//EN
- BEGIN:VTIMEZONE
- TZID:US/Pacific
- BEGIN:STANDARD
- DTSTART:20001029T020000
- RRULE:FREQ=YEARLY;BYDAY=-1SU;BYMONTH=10
- TZNAME:PST
- TZOFFSETFROM:-0700
- TZOFFSETTO:-0800
- END:STANDARD
- BEGIN:DAYLIGHT
- DTSTART:20000402T020000
- RRULE:FREQ=YEARLY;BYDAY=1SU;BYMONTH=4
- TZNAME:PDT
- TZOFFSETFROM:-0800
- TZOFFSETTO:-0700
- END:DAYLIGHT
- END:VTIMEZONE
- BEGIN:VEVENT
- UID:...
- DTSTART;TZID=US/Pacific:20051012T090000
- DURATION:PT1H
- EXDATE;TZID=US/Pacific:20051014T090000
- RRULE:FREQ=WEEKLY;BYDAY=WE,FR;INTERVAL=2;UNTIL=20051215T090000
- RRULE:FREQ=MONTHLY;BYMONTHDAY=-1,-5
- END:VEVENT
- END:VCALENDAR
- >>> apple = dateutil.tz.tzical(StringIO.StringIO(timezones)).get('America/Montreal')
- >>> ev.dtstart.value = datetime.datetime(2005, 10, 12, 9, tzinfo = apple)
- >>> print cal.serialize()
- BEGIN:VCALENDAR
- VERSION:2.0
- PRODID:-//PYVOBJECT//NONSGML Version 1//EN
- BEGIN:VTIMEZONE
- TZID:US/Pacific
- BEGIN:STANDARD
- DTSTART:20001029T020000
- RRULE:FREQ=YEARLY;BYDAY=-1SU;BYMONTH=10
- TZNAME:PST
- TZOFFSETFROM:-0700
- TZOFFSETTO:-0800
- END:STANDARD
- BEGIN:DAYLIGHT
- DTSTART:20000402T020000
- RRULE:FREQ=YEARLY;BYDAY=1SU;BYMONTH=4
- TZNAME:PDT
- TZOFFSETFROM:-0800
- TZOFFSETTO:-0700
- END:DAYLIGHT
- END:VTIMEZONE
- BEGIN:VTIMEZONE
- TZID:America/Montreal
- BEGIN:STANDARD
- DTSTART:20000101T000000
- RRULE:FREQ=YEARLY;BYMONTH=1;UNTIL=20040101T050000Z
- TZNAME:EST
- TZOFFSETFROM:-0500
- TZOFFSETTO:-0500
- END:STANDARD
- BEGIN:STANDARD
- DTSTART:20051030T020000
- RRULE:FREQ=YEARLY;BYDAY=5SU;BYMONTH=10
- TZNAME:EST
- TZOFFSETFROM:-0400
- TZOFFSETTO:-0500
- END:STANDARD
- BEGIN:DAYLIGHT
- DTSTART:20050403T070000
- RRULE:FREQ=YEARLY;BYDAY=1SU;BYMONTH=4;UNTIL=20050403T120000Z
- TZNAME:EDT
- TZOFFSETFROM:-0500
- TZOFFSETTO:-0400
- END:DAYLIGHT
- END:VTIMEZONE
- BEGIN:VEVENT
- UID:...
- DTSTART;TZID=America/Montreal:20051012T090000
- DURATION:PT1H
- EXDATE;TZID=US/Pacific:20051014T090000
- RRULE:FREQ=WEEKLY;BYDAY=WE,FR;INTERVAL=2;UNTIL=20051215T090000
- RRULE:FREQ=MONTHLY;BYMONTHDAY=-1,-5
- END:VEVENT
- END:VCALENDAR
- """,
-
- "Handling DATE without a VALUE=DATE" :
-
- """
- >>> cal = base.readOne(badDtStartTest)
- >>> cal.vevent.dtstart.value
- datetime.date(2002, 10, 28)
- """,
-
- "Serializing iCalendar to hCalendar" :
-
- """
- >>> cal = base.newFromBehavior('hcalendar')
- >>> cal.behavior
- <class 'vobject.hcalendar.HCalendar'>
- >>> pacific = dateutil.tz.tzical(StringIO.StringIO(timezones)).get('US/Pacific')
- >>> cal.add('vevent')
- <VEVENT| []>
- >>> cal.vevent.add('summary').value = "this is a note"
- >>> cal.vevent.add('url').value = "http://microformats.org/code/hcalendar/creator"
- >>> cal.vevent.add('dtstart').value = datetime.date(2006,2,27)
- >>> cal.vevent.add('location').value = "a place"
- >>> cal.vevent.add('dtend').value = datetime.date(2006,2,27) + datetime.timedelta(days = 2)
- >>> event2 = cal.add('vevent')
- >>> event2.add('summary').value = "Another one"
- >>> event2.add('description').value = "The greatest thing ever!"
- >>> event2.add('dtstart').value = datetime.datetime(1998, 12, 17, 16, 42, tzinfo = pacific)
- >>> event2.add('location').value = "somewhere else"
- >>> event2.add('dtend').value = event2.dtstart.value + datetime.timedelta(days = 6)
- >>> hcal = cal.serialize()
- >>> print hcal
- <span class="vevent">
- <a class="url" href="http://microformats.org/code/hcalendar/creator">
- <span class="summary">this is a note</span>:
- <abbr class="dtstart", title="20060227">Monday, February 27</abbr>
- - <abbr class="dtend", title="20060301">Tuesday, February 28</abbr>
- at <span class="location">a place</span>
- </a>
- </span>
- <span class="vevent">
- <span class="summary">Another one</span>:
- <abbr class="dtstart", title="19981217T164200-0800">Thursday, December 17, 16:42</abbr>
- - <abbr class="dtend", title="19981223T164200-0800">Wednesday, December 23, 16:42</abbr>
- at <span class="location">somewhere else</span>
- <div class="description">The greatest thing ever!</div>
- </span>
- """,
-
- "Generate UIDs automatically test:" :
-
- """
- >>> cal = base.newFromBehavior('vcalendar')
- >>> cal.add('vevent').add('dtstart').value = datetime.datetime(2006,2,2,10)
- >>> ser = cal.serialize()
- >>> len(cal.vevent.uid_list)
- 1
- """,
-
- "VCARD 3.0 parse test:" :
-
- r"""
- >>> card = base.readOne(vcardtest)
- >>> card.adr.value
- <Address: Haight Street 512;\nEscape, Test\nNovosibirsk, 80214\nGnuland>
- >>> print card.adr.value
- Haight Street 512;
- Escape, Test
- Novosibirsk, 80214
- Gnuland
- >>> card.org.value
- [u'University of Novosibirsk, Department of Octopus Parthenogenesis']
- >>> print card.serialize()
- BEGIN:VCARD
- VERSION:3.0
- ACCOUNT;TYPE=HOME:010-1234567-05
- ADR;TYPE=HOME:;;Haight Street 512\;\nEscape\, Test;Novosibirsk;;80214;Gnul
- and
- BDAY;VALUE=date:02-10
- FN:Daffy Duck Knudson (with Bugs Bunny and Mr. Pluto)
- N:Knudson;Daffy Duck (with Bugs Bunny and Mr. Pluto);;;
- NICKNAME:gnat and gnu and pluto
- ORG:University of Novosibirsk\, Department of Octopus Parthenogenesis
- TEL;TYPE=HOME:+01-(0)2-765.43.21
- TEL;TYPE=CELL:+01-(0)5-555.55.55
- TEL;TYPE=HOME:+01-(0)2-876.54.32
- END:VCARD
- """,
-
- "Multi-text serialization test:" :
-
- """
- >>> category = base.newFromBehavior('categories')
- >>> category.value = ['Random category']
- >>> print category.serialize().strip()
- CATEGORIES:Random category
- >>> category.value.append('Other category')
- >>> print category.serialize().strip()
- CATEGORIES:Random category,Other category
- """,
-
- "Semi-colon separated multi-text serialization test:" :
-
- """
- >>> requestStatus = base.newFromBehavior('request-status')
- >>> requestStatus.value = ['5.1', 'Service unavailable']
- >>> print requestStatus.serialize().strip()
- REQUEST-STATUS:5.1;Service unavailable
- """,
-
- "vCard groups test:" :
-
- """
- >>> card = base.readOne(vcardWithGroups)
- >>> card.group
- u'home'
- >>> card.tel.group
- u'home'
- >>> card.group = card.tel.group = 'new'
- >>> card.tel.serialize().strip()
- 'new.TEL;TYPE=fax,voice,msg:+49 3581 123456'
- >>> card.serialize().splitlines()[0]
- 'new.BEGIN:VCARD'
- >>> dtstart = base.newFromBehavior('dtstart')
- >>> dtstart.group = "badgroup"
- >>> dtstart.serialize()
- Traceback (most recent call last):
- ...
- VObjectError: "<DTSTART{}> has a group, but this object doesn't support groups"
- """,
-
- "Lowercase components test:" :
-
- """
- >>> card = base.readOne(lowercaseComponentNames)
- >>> card.version
- <VERSION{}2.1>
- """,
-
- "Default behavior test" :
-
- """
- >>> card = base.readOne(vcardWithGroups)
- >>> base.getBehavior('note') == None
- True
- >>> card.note.behavior
- <class 'vobject.vcard.VCardTextBehavior'>
- >>> print card.note.value
- The Mayor of the great city of Goerlitz in the great country of Germany.
- Next line.
- """
- }
diff --git a/tests.py b/tests.py new file mode 100644 index 0000000..2073930 --- /dev/null +++ b/tests.py @@ -0,0 +1,877 @@ +# -*- coding: utf-8 -*-
+
+from __future__ import print_function
+
+import datetime
+import dateutil
+import re
+import sys
+import unittest
+import json
+
+from dateutil.tz import tzutc
+from dateutil.rrule import rrule, rruleset, WEEKLY, MONTHLY
+
+from vobject import base, iCalendar
+from vobject import icalendar
+
+from vobject.base import __behaviorRegistry as behavior_registry
+from vobject.base import ContentLine, parseLine, ParseError
+from vobject.base import readComponents, textLineToContentLine
+
+from vobject.change_tz import change_tz
+
+from vobject.icalendar import MultiDateBehavior, PeriodBehavior, \
+ RecurringComponent, utc
+from vobject.icalendar import parseDtstart, stringToTextValues, \
+ stringToPeriod, timedeltaToString
+
+two_hours = datetime.timedelta(hours=2)
+
+
+def get_test_file(path):
+ """
+ Helper function to open and read test files.
+ """
+ filepath = "test_files/{}".format(path)
+ if sys.version_info[0] < 3:
+ # On python 2, this library operates on bytes.
+ f = open(filepath, 'r')
+ else:
+ # On python 3, it operates on unicode. We need to specify an encoding
+ # for systems for which the preferred encoding isn't utf-8 (e.g windows)
+ f = open(filepath, 'r', encoding='utf-8')
+ text = f.read()
+ f.close()
+ return text
+
+
+class TestCalendarSerializing(unittest.TestCase):
+ """
+ Test creating an iCalendar file
+ """
+ max_diff = None
+
+ def test_scratchbuild(self):
+ """
+ CreateCalendar 2.0 format from scratch
+ """
+ test_cal = get_test_file("simple_2_0_test.ics")
+ cal = base.newFromBehavior('vcalendar', '2.0')
+ cal.add('vevent')
+ cal.vevent.add('dtstart').value = datetime.datetime(2006, 5, 9)
+ cal.vevent.add('description').value = "Test event"
+ cal.vevent.add('created').value = \
+ datetime.datetime(2006, 1, 1, 10,
+ tzinfo=dateutil.tz.tzical(
+ "test_files/timezones.ics").get('US/Pacific'))
+ cal.vevent.add('uid').value = "Not very random UID"
+
+ # Note we're normalizing line endings, because no one got time for that.
+ self.assertEqual(
+ cal.serialize().replace('\r\n', '\n'),
+ test_cal.replace('\r\n', '\n')
+ )
+
+ def test_unicode(self):
+ """
+ Test unicode characters
+ """
+ test_cal = get_test_file("utf8_test.ics")
+ vevent = base.readOne(test_cal).vevent
+ vevent2 = base.readOne(vevent.serialize())
+ self.assertEqual(str(vevent), str(vevent2))
+
+ self.assertEqual(
+ vevent.summary.value,
+ 'The title こんにちはキティ'
+ )
+
+ if sys.version_info[0] < 3:
+ test_cal = test_cal.decode('utf-8')
+ vevent = base.readOne(test_cal).vevent
+ vevent2 = base.readOne(vevent.serialize())
+ self.assertEqual(str(vevent), str(vevent2))
+ self.assertEqual(
+ vevent.summary.value,
+ 'The title こんにちはキティ'
+ )
+
+ def test_wrapping(self):
+ """
+ Should support input file with a long text field covering multiple lines
+ """
+ test_journal = get_test_file("journal.ics")
+ vobj = base.readOne(test_journal)
+ vjournal = base.readOne(vobj.serialize())
+ self.assertTrue('Joe, Lisa, and Bob' in vjournal.description.value)
+ self.assertTrue('Tuesday.\n2.' in vjournal.description.value)
+
+ def test_multiline(self):
+ """
+ Multi-text serialization test
+ """
+ category = base.newFromBehavior('categories')
+ category.value = ['Random category']
+ self.assertEqual(
+ category.serialize().strip(),
+ "CATEGORIES:Random category"
+ )
+
+ category.value.append('Other category')
+ self.assertEqual(
+ category.serialize().strip(),
+ "CATEGORIES:Random category,Other category"
+ )
+
+ def test_semicolon_separated(self):
+ """
+ Semi-colon separated multi-text serialization test
+ """
+ request_status = base.newFromBehavior('request-status')
+ request_status.value = ['5.1', 'Service unavailable']
+ self.assertEqual(
+ request_status.serialize().strip(),
+ "REQUEST-STATUS:5.1;Service unavailable"
+ )
+
+ @staticmethod
+ def test_unicode_multiline():
+ """
+ Test multiline unicode characters
+ """
+ cal = iCalendar()
+ cal.add('method').value = 'REQUEST'
+ cal.add('vevent')
+ cal.vevent.add('created').value = datetime.datetime.now()
+ cal.vevent.add('summary').value = 'Классное событие'
+ cal.vevent.add('description').value = ('Классное событие Классное событие Классное событие Классное событие '
+ 'Классное событие Классsdssdное событие')
+
+ # json tries to encode as utf-8 and it would break if some chars could not be encoded
+ json.dumps(cal.serialize())
+
+ @staticmethod
+ def test_ical_to_hcal():
+ """
+ Serializing iCalendar to hCalendar.
+
+ Since Hcalendar is experimental and the behavior doesn't seem to want to load,
+ This test will have to wait.
+
+
+ tzs = dateutil.tz.tzical("test_files/timezones.ics")
+ cal = base.newFromBehavior('hcalendar')
+ self.assertEqual(
+ str(cal.behavior),
+ "<class 'vobject.hcalendar.HCalendar'>"
+ )
+ cal.add('vevent')
+ cal.vevent.add('summary').value = "this is a note"
+ cal.vevent.add('url').value = "http://microformats.org/code/hcalendar/creator"
+ cal.vevent.add('dtstart').value = datetime.date(2006,2,27)
+ cal.vevent.add('location').value = "a place"
+ cal.vevent.add('dtend').value = datetime.date(2006,2,27) + datetime.timedelta(days = 2)
+
+ event2 = cal.add('vevent')
+ event2.add('summary').value = "Another one"
+ event2.add('description').value = "The greatest thing ever!"
+ event2.add('dtstart').value = datetime.datetime(1998, 12, 17, 16, 42, tzinfo = tzs.get('US/Pacific'))
+ event2.add('location').value = "somewhere else"
+ event2.add('dtend').value = event2.dtstart.value + datetime.timedelta(days = 6)
+ hcal = cal.serialize()
+ """
+ #self.assertEqual(
+ # str(hcal),
+ # """<span class="vevent">
+ # <a class="url" href="http://microformats.org/code/hcalendar/creator">
+ # <span class="summary">this is a note</span>:
+ # <abbr class="dtstart", title="20060227">Monday, February 27</abbr>
+ # - <abbr class="dtend", title="20060301">Tuesday, February 28</abbr>
+ # at <span class="location">a place</span>
+ # </a>
+ # </span>
+ # <span class="vevent">
+ # <span class="summary">Another one</span>:
+ # <abbr class="dtstart", title="19981217T164200-0800">Thursday, December 17, 16:42</abbr>
+ # - <abbr class="dtend", title="19981223T164200-0800">Wednesday, December 23, 16:42</abbr>
+ # at <span class="location">somewhere else</span>
+ # <div class="description">The greatest thing ever!</div>
+ # </span>
+ # """
+ #)
+
+
+class TestBehaviors(unittest.TestCase):
+ """
+ Test Behaviors
+ """
+ def test_general_behavior(self):
+ """
+ Tests for behavior registry, getting and creating a behavior.
+ """
+ # Check expected behavior registry.
+ self.assertEqual(
+ sorted(behavior_registry.keys()),
+ ['', 'ACTION', 'ADR', 'AVAILABLE', 'BUSYTYPE', 'CALSCALE',
+ 'CATEGORIES', 'CLASS', 'COMMENT', 'COMPLETED', 'CONTACT',
+ 'CREATED', 'DAYLIGHT', 'DESCRIPTION', 'DTEND', 'DTSTAMP',
+ 'DTSTART', 'DUE', 'DURATION', 'EXDATE', 'EXRULE', 'FN', 'FREEBUSY',
+ 'LABEL', 'LAST-MODIFIED', 'LOCATION', 'METHOD', 'N', 'ORG',
+ 'PHOTO', 'PRODID', 'RDATE', 'RECURRENCE-ID', 'RELATED-TO',
+ 'REQUEST-STATUS', 'RESOURCES', 'RRULE', 'STANDARD', 'STATUS',
+ 'SUMMARY', 'TRANSP', 'TRIGGER', 'UID', 'VALARM', 'VAVAILABILITY',
+ 'VCALENDAR', 'VCARD', 'VEVENT', 'VFREEBUSY', 'VJOURNAL',
+ 'VTIMEZONE', 'VTODO']
+ )
+
+ # test get_behavior
+ behavior = base.getBehavior('VCALENDAR')
+ self.assertEqual(
+ str(behavior),
+ "<class 'vobject.icalendar.VCalendar2_0'>"
+ )
+ self.assertTrue(behavior.isComponent)
+
+ self.assertEqual(
+ base.getBehavior("invalid_name"),
+ None
+ )
+ # test for ContentLine (not a component)
+ non_component_behavior = base.getBehavior('RDATE')
+ self.assertFalse(non_component_behavior.isComponent)
+
+ def test_MultiDateBehavior(self):
+ """
+ Test MultiDateBehavior
+ """
+ parseRDate = MultiDateBehavior.transformToNative
+ self.assertEqual(
+ str(parseRDate(textLineToContentLine("RDATE;VALUE=DATE:19970304,19970504,19970704,19970904"))),
+ "<RDATE{'VALUE': ['DATE']}[datetime.date(1997, 3, 4), datetime.date(1997, 5, 4), datetime.date(1997, 7, 4), datetime.date(1997, 9, 4)]>"
+ )
+ self.assertEqual(
+ str(parseRDate(textLineToContentLine("RDATE;VALUE=PERIOD:19960403T020000Z/19960403T040000Z,19960404T010000Z/PT3H"))),
+ "<RDATE{'VALUE': ['PERIOD']}[(datetime.datetime(1996, 4, 3, 2, 0, tzinfo=tzutc()), datetime.datetime(1996, 4, 3, 4, 0, tzinfo=tzutc())), (datetime.datetime(1996, 4, 4, 1, 0, tzinfo=tzutc()), datetime.timedelta(0, 10800))]>"
+ )
+
+ def test_periodBehavior(self):
+ """
+ Test PeriodBehavior
+ """
+ line = ContentLine('test', [], '', isNative=True)
+ line.behavior = PeriodBehavior
+ line.value = [(datetime.datetime(2006, 2, 16, 10), two_hours)]
+
+ self.assertEqual(
+ line.transformFromNative().value,
+ '20060216T100000/PT2H'
+ )
+ self.assertEqual(
+ line.transformToNative().value,
+ [(datetime.datetime(2006, 2, 16, 10, 0),
+ datetime.timedelta(0, 7200))]
+ )
+
+ line.value.append((datetime.datetime(2006, 5, 16, 10), two_hours))
+
+ self.assertEqual(
+ line.serialize().strip(),
+ 'TEST:20060216T100000/PT2H,20060516T100000/PT2H'
+ )
+
+
+class TestVTodo(unittest.TestCase):
+ """
+ VTodo Tests
+ """
+ def test_vtodo(self):
+ """
+ Test VTodo
+ """
+ vtodo = get_test_file("vtodo.ics")
+ obj = base.readOne(vtodo)
+ obj.vtodo.add('completed')
+ obj.vtodo.completed.value = datetime.datetime(2015,5,5,13,30)
+ self.assertEqual(obj.vtodo.completed.serialize()[0:23],
+ 'COMPLETED:20150505T1330')
+ obj = base.readOne(obj.serialize())
+ self.assertEqual(obj.vtodo.completed.value,
+ datetime.datetime(2015,5,5,13,30))
+
+
+class TestVobject(unittest.TestCase):
+ """
+ VObject Tests
+ """
+ max_diff = None
+
+ @classmethod
+ def setUpClass(cls):
+ """
+ Method for setting up class fixture before running tests in the class.
+ Fetches test file.
+ """
+ cls.simple_test_cal = get_test_file("simple_test.ics")
+
+ def test_readComponents(self):
+ """
+ Test if reading components correctly
+ """
+ cal = next(readComponents(self.simple_test_cal))
+
+ self.assertEqual(str(cal), "<VCALENDAR| [<VEVENT| [<SUMMARY{'BLAH': ['hi!']}Bastille Day Party>]>]>")
+ self.assertEqual(str(cal.vevent.summary), "<SUMMARY{'BLAH': ['hi!']}Bastille Day Party>")
+
+ def test_parseLine(self):
+ """
+ Test line parsing
+ """
+ self.assertEqual(parseLine("BLAH:"), ('BLAH', [], '', None))
+ self.assertEqual(
+ parseLine("RDATE:VALUE=DATE:19970304,19970504,19970704,19970904"),
+ ('RDATE', [], 'VALUE=DATE:19970304,19970504,19970704,19970904', None)
+ )
+ self.assertEqual(
+ parseLine('DESCRIPTION;ALTREP="http://www.wiz.org":The Fall 98 Wild Wizards Conference - - Las Vegas, NV, USA'),
+ ('DESCRIPTION', [['ALTREP', 'http://www.wiz.org']], 'The Fall 98 Wild Wizards Conference - - Las Vegas, NV, USA', None)
+ )
+ self.assertEqual(
+ parseLine("EMAIL;PREF;INTERNET:john@nowhere.com"),
+ ('EMAIL', [['PREF'], ['INTERNET']], 'john@nowhere.com', None)
+ )
+ self.assertEqual(
+ parseLine('EMAIL;TYPE="blah",hah;INTERNET="DIGI",DERIDOO:john@nowhere.com'),
+ ('EMAIL', [['TYPE', 'blah', 'hah'], ['INTERNET', 'DIGI', 'DERIDOO']], 'john@nowhere.com', None)
+ )
+ self.assertEqual(
+ parseLine('item1.ADR;type=HOME;type=pref:;;Reeperbahn 116;Hamburg;;20359;'),
+ ('ADR', [['type', 'HOME'], ['type', 'pref']], ';;Reeperbahn 116;Hamburg;;20359;', 'item1')
+ )
+ self.assertRaises(ParseError, parseLine, ":")
+
+
+class TestGeneralFileParsing(unittest.TestCase):
+ """
+ General tests for parsing ics files.
+ """
+ def test_readOne(self):
+ """
+ Test reading first component of ics
+ """
+ cal = get_test_file("silly_test.ics")
+ silly = base.readOne(cal)
+ self.assertEqual(
+ str(silly),
+ "<SILLYPROFILE| [<MORESTUFF{}this line is not folded, but in practice probably ought to be, as it is exceptionally long, and moreover demonstratively stupid>, <SILLYNAME{}name>, <STUFF{}foldedline>]>"
+ )
+ self.assertEqual(
+ str(silly.stuff),
+ "<STUFF{}foldedline>"
+ )
+
+ def test_importing(self):
+ """
+ Test importing ics
+ """
+ cal = get_test_file("standard_test.ics")
+ c = base.readOne(cal, validate=True)
+ self.assertEqual(
+ str(c.vevent.valarm.trigger),
+ "<TRIGGER{}-1 day, 0:00:00>"
+ )
+
+ self.assertEqual(
+ str(c.vevent.dtstart.value),
+ "2002-10-28 14:00:00-08:00"
+ )
+ self.assertTrue(
+ isinstance(c.vevent.dtstart.value, datetime.datetime)
+ )
+ self.assertEqual(
+ str(c.vevent.dtend.value),
+ "2002-10-28 15:00:00-08:00"
+ )
+ self.assertTrue(
+ isinstance(c.vevent.dtend.value, datetime.datetime)
+ )
+ self.assertEqual(
+ c.vevent.dtstamp.value,
+ datetime.datetime(2002, 10, 28, 1, 17, 6, tzinfo=tzutc())
+ )
+
+ vevent = c.vevent.transformFromNative()
+ self.assertEqual(
+ str(vevent.rrule),
+ "<RRULE{}FREQ=Weekly;COUNT=10>"
+ )
+
+ def test_bad_stream(self):
+ """
+ Test bad ics stream
+ """
+ cal = get_test_file("badstream.ics")
+ self.assertRaises(ParseError, base.readOne, cal)
+
+ def test_bad_line(self):
+ """
+ Test bad line in ics file
+ """
+ cal = get_test_file("badline.ics")
+ self.assertRaises(ParseError, base.readOne, cal)
+
+ newcal = base.readOne(cal, ignoreUnreadable=True)
+ self.assertEqual(
+ str(newcal.vevent.x_bad_underscore),
+ '<X-BAD-UNDERSCORE{}TRUE>'
+ )
+
+ def test_parseParams(self):
+ """
+ Test parsing parameters
+ """
+ self.assertEqual(
+ base.parseParams(';ALTREP="http://www.wiz.org"'),
+ [['ALTREP', 'http://www.wiz.org']]
+ )
+ self.assertEqual(
+ base.parseParams(';ALTREP="http://www.wiz.org;;",Blah,Foo;NEXT=Nope;BAR'),
+ [['ALTREP', 'http://www.wiz.org;;', 'Blah', 'Foo'],
+ ['NEXT', 'Nope'], ['BAR']]
+ )
+
+
+class TestVcards(unittest.TestCase):
+ """
+ Test VCards
+ """
+ @classmethod
+ def setUpClass(cls):
+ """
+ Method for setting up class fixture before running tests in the class.
+ Fetches test file.
+ """
+ cls.test_file = get_test_file("vcard_with_groups.ics")
+ cls.card = base.readOne(cls.test_file)
+
+ def test_vcard_creation(self):
+ """
+ Test creating a vCard
+ """
+ vcard = base.newFromBehavior('vcard', '3.0')
+ self.assertEqual(
+ str(vcard),
+ "<VCARD| []>"
+ )
+
+ def test_default_behavior(self):
+ """
+ Default behavior test.
+ """
+ card = self.card
+ self.assertEqual(
+ base.getBehavior('note'),
+ None
+ )
+ self.assertEqual(
+ str(card.note.value),
+ "The Mayor of the great city of Goerlitz in the great country of Germany.\nNext line."
+ )
+
+ def test_with_groups(self):
+ """
+ vCard groups test
+ """
+ card = self.card
+ self.assertEqual(
+ str(card.group),
+ 'home'
+ )
+ self.assertEqual(
+ str(card.tel.group),
+ 'home'
+ )
+
+ card.group = card.tel.group = 'new'
+ self.assertEqual(
+ str(card.tel.serialize().strip()),
+ 'new.TEL;TYPE=fax,voice,msg:+49 3581 123456'
+ )
+ self.assertEqual(
+ str(card.serialize().splitlines()[0]),
+ 'new.BEGIN:VCARD'
+ )
+
+
+ def test_vcard_3_parsing(self):
+ """
+ VCARD 3.0 parse test
+ """
+ test_file = get_test_file("simple_3_0_test.ics")
+ card = base.readOne(test_file)
+ # value not rendering correctly?
+ #self.assertEqual(
+ # card.adr.value,
+ # "<Address: Haight Street 512;\nEscape, Test\nNovosibirsk, 80214\nGnuland>"
+ #)
+ self.assertEqual(
+ card.org.value,
+ "University of Novosibirsk, Department of Octopus Parthenogenesis"
+ )
+
+
+class TestIcalendar(unittest.TestCase):
+ """
+ Tests for icalendar.py
+ """
+ max_diff = None
+ def test_parseDTStart(self):
+ """
+ Should take a content line and return a datetime object.
+ """
+ self.assertEqual(
+ parseDtstart(textLineToContentLine("DTSTART:20060509T000000")),
+ datetime.datetime(2006, 5, 9, 0, 0)
+ )
+
+ def test_regexes(self):
+ """
+ Test regex patterns
+ """
+ self.assertEqual(
+ re.findall(base.patterns['name'], '12foo-bar:yay'),
+ ['12foo-bar', 'yay']
+ )
+ self.assertEqual(
+ re.findall(base.patterns['safe_char'], 'a;b"*,cd'),
+ ['a', 'b', '*', 'c', 'd']
+ )
+ self.assertEqual(
+ re.findall(base.patterns['qsafe_char'], 'a;b"*,cd'),
+ ['a', ';', 'b', '*', ',', 'c', 'd']
+ )
+ self.assertEqual(
+ re.findall(base.patterns['param_value'],
+ '"quoted";not-quoted;start"after-illegal-quote',
+ re.VERBOSE),
+ ['"quoted"', '', 'not-quoted', '', 'start', '',
+ 'after-illegal-quote', '']
+ )
+ match = base.line_re.match('TEST;ALTREP="http://www.wiz.org":value:;"')
+ self.assertEqual(
+ match.group('value'),
+ 'value:;"'
+ )
+ self.assertEqual(
+ match.group('name'),
+ 'TEST'
+ )
+ self.assertEqual(
+ match.group('params'),
+ ';ALTREP="http://www.wiz.org"'
+ )
+
+ def test_stringToTextValues(self):
+ """
+ Test string lists
+ """
+ self.assertEqual(
+ stringToTextValues(''),
+ ['']
+ )
+ self.assertEqual(
+ stringToTextValues('abcd,efgh'),
+ ['abcd', 'efgh']
+ )
+
+ def test_stringToPeriod(self):
+ """
+ Test datetime strings
+ """
+ self.assertEqual(
+ stringToPeriod("19970101T180000Z/19970102T070000Z"),
+ (datetime.datetime(1997, 1, 1, 18, 0, tzinfo=tzutc()),
+ datetime.datetime(1997, 1, 2, 7, 0, tzinfo=tzutc()))
+ )
+ self.assertEqual(
+ stringToPeriod("19970101T180000Z/PT1H"),
+ (datetime.datetime(1997, 1, 1, 18, 0, tzinfo=tzutc()),
+ datetime.timedelta(0, 3600))
+ )
+
+ def test_timedeltaToString(self):
+ """
+ Test timedelta strings
+ """
+ self.assertEqual(
+ timedeltaToString(two_hours),
+ 'PT2H'
+ )
+ self.assertEqual(
+ timedeltaToString(datetime.timedelta(minutes=20)),
+ 'PT20M'
+ )
+
+ def test_vtimezone_creation(self):
+ """
+ Test timezones
+ """
+ tzs = dateutil.tz.tzical("test_files/timezones.ics")
+ pacific = icalendar.TimezoneComponent(tzs.get('US/Pacific'))
+ self.assertEqual(
+ str(pacific),
+ "<VTIMEZONE | <TZID{}US/Pacific>>"
+ )
+ santiago = icalendar.TimezoneComponent(tzs.get('Santiago'))
+ self.assertEqual(
+ str(santiago),
+ "<VTIMEZONE | <TZID{}Santiago>>"
+ )
+ for year in range(2001, 2010):
+ for month in (2, 9):
+ dt = datetime.datetime(year, month, 15,
+ tzinfo=tzs.get('Santiago'))
+ self.assertTrue(dt.replace(tzinfo=tzs.get('Santiago')), dt)
+
+ @staticmethod
+ def test_timezone_serializing():
+ """
+ Serializing with timezones test
+ """
+ tzs = dateutil.tz.tzical("test_files/timezones.ics")
+ pacific = tzs.get('US/Pacific')
+ cal = base.Component('VCALENDAR')
+ cal.setBehavior(icalendar.VCalendar2_0)
+ ev = cal.add('vevent')
+ ev.add('dtstart').value = datetime.datetime(2005, 10, 12, 9,
+ tzinfo=pacific)
+ evruleset = rruleset()
+ evruleset.rrule(rrule(WEEKLY, interval=2, byweekday=[2,4],
+ until=datetime.datetime(2005, 12, 15, 9)))
+ evruleset.rrule(rrule(MONTHLY, bymonthday=[-1,-5]))
+ evruleset.exdate(datetime.datetime(2005, 10, 14, 9, tzinfo=pacific))
+ ev.rruleset = evruleset
+ ev.add('duration').value = datetime.timedelta(hours=1)
+
+ apple = tzs.get('America/Montreal')
+ ev.dtstart.value = datetime.datetime(2005, 10, 12, 9, tzinfo=apple)
+
+ def test_freeBusy(self):
+ """
+ Test freebusy components
+ """
+ test_cal = get_test_file("freebusy.ics")
+
+ vfb = base.newFromBehavior('VFREEBUSY')
+ vfb.add('uid').value = 'test'
+ vfb.add('dtstart').value = datetime.datetime(2006, 2, 16, 1, tzinfo=utc)
+ vfb.add('dtend').value = vfb.dtstart.value + two_hours
+ vfb.add('freebusy').value = [(vfb.dtstart.value, two_hours / 2)]
+ vfb.add('freebusy').value = [(vfb.dtstart.value, vfb.dtend.value)]
+
+ self.assertEqual(
+ vfb.serialize().replace('\r\n', '\n'),
+ test_cal.replace('\r\n', '\n')
+ )
+
+ def test_availablity(self):
+ """
+ Test availability components
+ """
+ test_cal = get_test_file("availablity.ics")
+
+ vcal = base.newFromBehavior('VAVAILABILITY')
+ vcal.add('uid').value = 'test'
+ vcal.add('dtstamp').value = datetime.datetime(2006, 2, 15, 0, tzinfo=utc)
+ vcal.add('dtstart').value = datetime.datetime(2006, 2, 16, 0, tzinfo=utc)
+ vcal.add('dtend').value = datetime.datetime(2006, 2, 17, 0, tzinfo=utc)
+ vcal.add('busytype').value = "BUSY"
+
+ av = base.newFromBehavior('AVAILABLE')
+ av.add('uid').value = 'test1'
+ av.add('dtstamp').value = datetime.datetime(2006, 2, 15, 0, tzinfo=utc)
+ av.add('dtstart').value = datetime.datetime(2006, 2, 16, 9, tzinfo=utc)
+ av.add('dtend').value = datetime.datetime(2006, 2, 16, 12, tzinfo=utc)
+ av.add('summary').value = "Available in the morning"
+
+ vcal.add(av)
+
+ self.assertEqual(
+ vcal.serialize().replace('\r\n', '\n'),
+ test_cal.replace('\r\n', '\n')
+ )
+
+ def test_recurrence(self):
+ """
+ Ensure date valued UNTILs in rrules are in a reasonable timezone,
+ and include that day (12/28 in this test)
+ """
+ test_file = get_test_file("recurrence.ics")
+ cal = base.readOne(test_file)
+ dates = list(cal.vevent.getrruleset())
+ self.assertEqual(
+ dates[0],
+ datetime.datetime(2006, 1, 26, 23, 0, tzinfo=tzutc())
+ )
+ self.assertEqual(
+ dates[1],
+ datetime.datetime(2006, 2, 23, 23, 0, tzinfo=tzutc())
+ )
+ self.assertEqual(
+ dates[-1],
+ datetime.datetime(2006, 12, 28, 23, 0, tzinfo=tzutc())
+ )
+
+ def test_recurring_component(self):
+ """
+ Test recurring events
+ """
+ vevent = RecurringComponent(name='VEVENT')
+
+ # init
+ self.assertTrue(vevent.isNative)
+
+ # rruleset should be None at this point.
+ # No rules have been passed or created.
+ self.assertEqual(vevent.rruleset, None)
+
+ # Now add start and rule for recurring event
+ vevent.add('dtstart').value = datetime.datetime(2005, 1, 19, 9)
+ vevent.add('rrule').value =u"FREQ=WEEKLY;COUNT=2;INTERVAL=2;BYDAY=TU,TH"
+ self.assertEqual(
+ list(vevent.rruleset),
+ [datetime.datetime(2005, 1, 20, 9, 0), datetime.datetime(2005, 2, 1, 9, 0)]
+ )
+ self.assertEqual(
+ list(vevent.getrruleset(addRDate=True)),
+ [datetime.datetime(2005, 1, 19, 9, 0), datetime.datetime(2005, 1, 20, 9, 0)]
+ )
+
+ # Also note that dateutil will expand all-day events (datetime.date values)
+ # to datetime.datetime value with time 0 and no timezone.
+ vevent.dtstart.value = datetime.date(2005,3,18)
+ self.assertEqual(
+ list(vevent.rruleset),
+ [datetime.datetime(2005, 3, 29, 0, 0), datetime.datetime(2005, 3, 31, 0, 0)]
+ )
+ self.assertEqual(
+ list(vevent.getrruleset(True)),
+ [datetime.datetime(2005, 3, 18, 0, 0), datetime.datetime(2005, 3, 29, 0, 0)]
+ )
+
+
+class TestChangeTZ(unittest.TestCase):
+ """
+ Tests for change_tz.change_tz
+ """
+ class StubCal(object):
+ class StubEvent(object):
+ class Node(object):
+ def __init__(self, value):
+ self.value = value
+
+ def __init__(self, dtstart, dtend):
+ self.dtstart = self.Node(dtstart)
+ self.dtend = self.Node(dtend)
+
+ def __init__(self, dates):
+ """
+ dates is a list of tuples (dtstart, dtend)
+ """
+ self.vevent_list = [self.StubEvent(*d) for d in dates]
+
+ def test_change_tz(self):
+ """
+ Change the timezones of events in a component to a different
+ timezone
+ """
+
+ # Setup - create a stub vevent list
+ old_tz = dateutil.tz.gettz('UTC') # 0:00
+ new_tz = dateutil.tz.gettz('America/Chicago') # -5:00
+
+ dates = [
+ (datetime.datetime(1999, 12, 31, 23, 59, 59, 0, tzinfo=old_tz),
+ datetime.datetime(2000, 1, 1, 0, 0, 0, 0, tzinfo=old_tz)),
+ (datetime.datetime(2010, 12, 31, 23, 59, 59, 0, tzinfo=old_tz),
+ datetime.datetime(2011, 1, 2, 3, 0, 0, 0, tzinfo=old_tz))]
+
+ cal = self.StubCal(dates)
+
+ # Exercise - change the timezone
+ change_tz(cal, new_tz, dateutil.tz.gettz('UTC'))
+
+ # Test - that the tzs were converted correctly
+ expected_new_dates = [
+ (datetime.datetime(1999, 12, 31, 17, 59, 59, 0, tzinfo=new_tz),
+ datetime.datetime(1999, 12, 31, 18, 0, 0, 0, tzinfo=new_tz)),
+ (datetime.datetime(2010, 12, 31, 17, 59, 59, 0, tzinfo=new_tz),
+ datetime.datetime(2011, 1, 1, 21, 0, 0, 0, tzinfo=new_tz))]
+
+ for vevent, expected_datepair in zip(cal.vevent_list,
+ expected_new_dates):
+ self.assertEqual(vevent.dtstart.value, expected_datepair[0])
+ self.assertEqual(vevent.dtend.value, expected_datepair[1])
+
+ def test_change_tz_utc_only(self):
+ """
+ Change any UTC timezones of events in a component to a different
+ timezone
+ """
+
+ # Setup - create a stub vevent list
+ utc_tz = dateutil.tz.gettz('UTC') # 0:00
+ non_utc_tz = dateutil.tz.gettz('America/Santiago') # -4:00
+ new_tz = dateutil.tz.gettz('America/Chicago') # -5:00
+
+ dates = [
+ (datetime.datetime(1999, 12, 31, 23, 59, 59, 0, tzinfo=utc_tz),
+ datetime.datetime(2000, 1, 1, 0, 0, 0, 0, tzinfo=non_utc_tz))]
+
+ cal = self.StubCal(dates)
+
+ # Exercise - change the timezone passing utc_only=True
+ change_tz(cal, new_tz, dateutil.tz.gettz('UTC'), utc_only=True)
+
+ # Test - that only the utc item has changed
+ expected_new_dates = [
+ (datetime.datetime(1999, 12, 31, 17, 59, 59, 0, tzinfo=new_tz),
+ dates[0][1])]
+
+ for vevent, expected_datepair in zip(cal.vevent_list,
+ expected_new_dates):
+ self.assertEqual(vevent.dtstart.value, expected_datepair[0])
+ self.assertEqual(vevent.dtend.value, expected_datepair[1])
+
+ def test_change_tz_default(self):
+ """
+ Change the timezones of events in a component to a different
+ timezone, passing a default timezone that is assumed when the events
+ don't have one
+ """
+
+ # Setup - create a stub vevent list
+ new_tz = dateutil.tz.gettz('America/Chicago') # -5:00
+
+ dates = [
+ (datetime.datetime(1999, 12, 31, 23, 59, 59, 0, tzinfo=None),
+ datetime.datetime(2000, 1, 1, 0, 0, 0, 0, tzinfo=None))]
+
+ cal = self.StubCal(dates)
+
+ # Exercise - change the timezone
+ change_tz(cal, new_tz, dateutil.tz.gettz('UTC'))
+
+ # Test - that the tzs were converted correctly
+ expected_new_dates = [
+ (datetime.datetime(1999, 12, 31, 17, 59, 59, 0, tzinfo=new_tz),
+ datetime.datetime(1999, 12, 31, 18, 0, 0, 0, tzinfo=new_tz))]
+
+ for vevent, expected_datepair in zip(cal.vevent_list,
+ expected_new_dates):
+ self.assertEqual(vevent.dtstart.value, expected_datepair[0])
+ self.assertEqual(vevent.dtend.value, expected_datepair[1])
+
+
+if __name__ == '__main__':
+ unittest.main()
diff --git a/vobject.egg-info/PKG-INFO b/vobject.egg-info/PKG-INFO deleted file mode 100644 index a8007d7..0000000 --- a/vobject.egg-info/PKG-INFO +++ /dev/null @@ -1,55 +0,0 @@ -Metadata-Version: 1.0 -Name: vobject -Version: 0.8.1c -Summary: VObject: module for reading vCard and vCalendar files -Home-page: http://vobject.skyhouseconsulting.com -Author: Jeffrey Harris -Author-email: jeffrey@osafoundation.org -License: Apache -Description: Description - ----------- - - Parses iCalendar and vCard files into Python data structures, decoding the relevant encodings. Also serializes vobject data structures to iCalendar, vCard, or (experimentally) hCalendar unicode strings. - - Requirements - ------------ - - Requires python 2.4 or later, dateutil (http://labix.org/python-dateutil) 1.1 or later. - - Recent changes - -------------- - - Make change_tz.py compatible with python 2.4, so the entire package stays compatible - - Fall back to default (the most recent standard) behavior if a VCARD - or VCALENDAR doesn't have a recognized VERSION - - Fixed a bad performance bug when parsing large text bodies, thanks to Morgen Sagen at Apple - - Changed license to Apache 2.0 from Apache 1.1 - - Worked around an issue with Apple Address Book's vcard PHOTO parser - - Added change_tz module and script for quickly changing event timezones for an - ics file. Requires PyICU. - - Add support for BYMONTHDAY=-1 (days before the end of the month) when setting rrules - from a dateutil rrule - - Tolerate a Ruby iCalendar library escaping semi-colons in RRULEs - - Make vobjects pickle-able - - Add introspection help for IPython so tab completion works with - vobject's custom __getattr__ - - Allow Outlook's technically illegal use of commas in TZIDs - - Allow unicode names for TZIDs - - Worked around Lotus Notes use of underscores in names by just silently replacing - with dashes - - When allowing quoted-printable data, honor CHARSET for each line, defaulting to - iso-8859-1 - - Simplified directory layout, unit tests are now available via setup.py test - - For older changes, see - - http://vobject.skyhouseconsulting.com/history.html or - - http://websvn.osafoundation.org/listing.php?repname=vobject&path=/trunk/ - -Platform: any -Classifier: Development Status :: 5 - Production/Stable -Classifier: Environment :: Console -Classifier: License :: OSI Approved :: BSD License -Classifier: Intended Audience :: Developers -Classifier: Natural Language :: English -Classifier: Programming Language :: Python -Classifier: Operating System :: OS Independent -Classifier: Topic :: Text Processing diff --git a/vobject.egg-info/SOURCES.txt b/vobject.egg-info/SOURCES.txt deleted file mode 100644 index 43a217a..0000000 --- a/vobject.egg-info/SOURCES.txt +++ /dev/null @@ -1,29 +0,0 @@ -ACKNOWLEDGEMENTS.txt -LICENSE-2.0.txt -README.txt -setup.py -test_vobject.py -ez_setup/README.txt -ez_setup/__init__.py -test_files/more_tests.txt -test_files/ms_tzid.ics -test_files/recurrence.ics -test_files/ruby_rrule.ics -test_files/tzid_8bit.ics -test_files/utf8_test.ics -vobject/__init__.py -vobject/base.py -vobject/behavior.py -vobject/change_tz.py -vobject/hcalendar.py -vobject/icalendar.py -vobject/ics_diff.py -vobject/vcard.py -vobject/win32tz.py -vobject.egg-info/PKG-INFO -vobject.egg-info/SOURCES.txt -vobject.egg-info/dependency_links.txt -vobject.egg-info/entry_points.txt -vobject.egg-info/requires.txt -vobject.egg-info/top_level.txt -vobject.egg-info/zip-safe
\ No newline at end of file diff --git a/vobject.egg-info/dependency_links.txt b/vobject.egg-info/dependency_links.txt deleted file mode 100644 index 8b13789..0000000 --- a/vobject.egg-info/dependency_links.txt +++ /dev/null @@ -1 +0,0 @@ - diff --git a/vobject.egg-info/entry_points.txt b/vobject.egg-info/entry_points.txt deleted file mode 100644 index d076c85..0000000 --- a/vobject.egg-info/entry_points.txt +++ /dev/null @@ -1,4 +0,0 @@ -[console_scripts] -change_tz = vobject.change_tz:main -ics_diff = vobject.ics_diff:main - diff --git a/vobject.egg-info/requires.txt b/vobject.egg-info/requires.txt deleted file mode 100644 index 21aa035..0000000 --- a/vobject.egg-info/requires.txt +++ /dev/null @@ -1 +0,0 @@ -python-dateutil >= 1.1
\ No newline at end of file diff --git a/vobject.egg-info/top_level.txt b/vobject.egg-info/top_level.txt deleted file mode 100644 index 52a5040..0000000 --- a/vobject.egg-info/top_level.txt +++ /dev/null @@ -1 +0,0 @@ -vobject diff --git a/vobject.egg-info/zip-safe b/vobject.egg-info/zip-safe deleted file mode 100644 index 8b13789..0000000 --- a/vobject.egg-info/zip-safe +++ /dev/null @@ -1 +0,0 @@ - diff --git a/vobject/__init__.py b/vobject/__init__.py index d5daf30..30ba3f0 100644 --- a/vobject/__init__.py +++ b/vobject/__init__.py @@ -22,7 +22,7 @@ VObject Overview L{Component<base.Component>}s. To validate, an object must have all required children. There (TODO: will be) a toggle to raise an exception or just log unrecognized, non-experimental children and parameters. - + Creating objects programatically -------------------------------- A L{Component<base.Component>} can be created from scratch. No encoding @@ -31,7 +31,7 @@ VObject Overview Serializing objects ------------------- - Serialization: + Serialization: - Looks for missing required children that can be automatically generated, like a UID or a PRODID, and adds them - Encodes all values that can be automatically encoded @@ -39,10 +39,10 @@ VObject Overview explicitly disabled) - Appends the serialized object to a buffer, or fills a new buffer and returns it - + Examples -------- - + >>> import datetime >>> import dateutil.rrule as rrule >>> x = iCalendar() @@ -73,14 +73,14 @@ VObject Overview RRULE:FREQ=WEEKLY;COUNT=2 END:VEVENT END:VCALENDAR - + """ -import base, icalendar, vcard -from base import readComponents, readOne, newFromBehavior +from .base import newFromBehavior, readOne, readComponents +from . import icalendar, vcard def iCalendar(): return newFromBehavior('vcalendar', '2.0') def vCard(): - return newFromBehavior('vcard', '3.0')
\ No newline at end of file + return newFromBehavior('vcard', '3.0') diff --git a/vobject/base.py b/vobject/base.py index b56c36a..03fe38e 100644 --- a/vobject/base.py +++ b/vobject/base.py @@ -1,44 +1,93 @@ """vobject module for reading vCard and vCalendar files.""" +from __future__ import print_function + import copy +import logging import re +import six import sys -import logging -import StringIO, cStringIO -import string -import exceptions -import codecs -#------------------------------------ Logging ---------------------------------- +# ------------------------------------ Python 2/3 compatibility challenges ---- +# Python 3 no longer has a basestring type, so.... +try: + basestring = basestring +except NameError: + basestring = (str,bytes) + +# One more problem ... in python2 the str operator breaks on unicode +# objects containing non-ascii characters +try: + unicode + def str_(s): + """ + Return string with correct encoding + """ + if type(s) == unicode: + return s.encode('utf-8') + else: + return str(s) +except NameError: + def str_(s): + """ + Return string + """ + return s + +if not isinstance(b'', type('')): + unicode_type = str +else: + unicode_type = unicode # noqa + + +def to_unicode(value): + """Converts a string argument to a unicode string. + + If the argument is already a unicode string, it is returned + unchanged. Otherwise it must be a byte string and is decoded as utf8. + """ + if isinstance(value, unicode_type): + return value + + return value.decode('utf-8') + + +def to_basestring(s): + """Converts a string argument to a byte string. + + If the argument is already a byte string, it is returned unchanged. + Otherwise it must be a unicode string and is encoded as utf8. + """ + if isinstance(s, bytes): + return s + + return s.encode('utf-8') + +# ------------------------------------ Logging --------------------------------- logger = logging.getLogger(__name__) if not logging.getLogger().handlers: handler = logging.StreamHandler() formatter = logging.Formatter('%(name)s %(levelname)s %(message)s') handler.setFormatter(formatter) logger.addHandler(handler) -logger.setLevel(logging.ERROR) # Log errors -DEBUG = False # Don't waste time on debug calls -#----------------------------------- Constants --------------------------------- +logger.setLevel(logging.ERROR) # Log errors +DEBUG = False # Don't waste time on debug calls + +# ----------------------------------- Constants -------------------------------- CR = '\r' LF = '\n' CRLF = CR + LF SPACE = ' ' TAB = '\t' SPACEORTAB = SPACE + TAB -#-------------------------------- Useful modules ------------------------------- -# use doctest, it kills two birds with one stone and docstrings often become -# more readable to boot (see parseLine's docstring). -# use logging, then when debugging we can just set our verbosity. -# use epydoc syntax for documenting code, please document every class and non- -# trivial method (see http://epydoc.sourceforge.net/epytext.html -# and http://epydoc.sourceforge.net/fields.html). Also, please -# follow http://www.python.org/peps/pep-0257.html for docstrings. -#------------------------------------------------------------------------------- - -#--------------------------------- Main classes -------------------------------- + +# --------------------------------- Main classes ------------------------------- + + class VBase(object): - """Base class for ContentLine and Component. - + """ + Base class for ContentLine and Component. + @ivar behavior: The Behavior class associated with this object, which controls validation, transformations, and encoding. @@ -47,43 +96,52 @@ class VBase(object): @ivar isNative: Boolean describing whether this component is a Native instance. @ivar group: - An optional group prefix, should be used only to indicate sort order in - vCards, according to RFC2426 + An optional group prefix, should be used only to indicate sort order in + vCards, according to spec. + + Current spec: 4.0 (http://tools.ietf.org/html/rfc6350) """ def __init__(self, group=None, *args, **kwds): super(VBase, self).__init__(*args, **kwds) - self.group = group - self.behavior = None + self.group = group + self.behavior = None self.parentBehavior = None self.isNative = False - + def copy(self, copyit): self.group = copyit.group self.behavior = copyit.behavior self.parentBehavior = copyit.parentBehavior self.isNative = copyit.isNative - + def validate(self, *args, **kwds): - """Call the behavior's validate method, or return True.""" + """ + Call the behavior's validate method, or return True. + """ if self.behavior: return self.behavior.validate(self, *args, **kwds) - else: return True + return True def getChildren(self): - """Return an iterable containing the contents of the object.""" + """ + Return an iterable containing the contents of the object. + """ return [] def clearBehavior(self, cascade=True): - """Set behavior to None. Do for all descendants if cascading.""" + """ + Set behavior to None. Do for all descendants if cascading. + """ self.behavior=None - if cascade: self.transformChildrenFromNative() + if cascade: + self.transformChildrenFromNative() def autoBehavior(self, cascade=False): - """Set behavior if name is in self.parentBehavior.knownChildren. - + """ + Set behavior if name is in self.parentBehavior.knownChildren. + If cascade is True, unset behavior and parentBehavior for all descendants, then recalculate behavior and parentBehavior. - """ parentBehavior = self.parentBehavior if parentBehavior is not None: @@ -95,62 +153,65 @@ class VBase(object): if isinstance(self, ContentLine) and self.encoded: self.behavior.decode(self) elif isinstance(self, ContentLine): - self.behavior = parentBehavior.defaultBehavior + self.behavior = parentBehavior.defaultBehavior if self.encoded and self.behavior: self.behavior.decode(self) def setBehavior(self, behavior, cascade=True): - """Set behavior. If cascade is True, autoBehavior all descendants.""" - self.behavior=behavior + """ + Set behavior. If cascade is True, autoBehavior all descendants. + """ + self.behavior = behavior if cascade: for obj in self.getChildren(): - obj.parentBehavior=behavior + obj.parentBehavior = behavior obj.autoBehavior(True) def transformToNative(self): - """Transform this object into a custom VBase subclass. - + """ + Transform this object into a custom VBase subclass. + transformToNative should always return a representation of this object. It may do so by modifying self in place then returning self, or by creating a new object. - """ if self.isNative or not self.behavior or not self.behavior.hasNative: return self else: try: return self.behavior.transformToNative(self) - except Exception, e: + except Exception as e: # wrap errors in transformation in a ParseError lineNumber = getattr(self, 'lineNumber', None) + if isinstance(e, ParseError): if lineNumber is not None: e.lineNumber = lineNumber raise else: - msg = "In transformToNative, unhandled exception: %s: %s" - msg = msg % (sys.exc_info()[0], sys.exc_info()[1]) - new_error = ParseError(msg, lineNumber) - raise ParseError, new_error, sys.exc_info()[2] - + msg = "In transformToNative, unhandled exception on " \ + "line %s: %s: %s" + msg = msg % (lineNumber, sys.exc_info()[0], + sys.exc_info()[1]) + raise ParseError(msg, lineNumber) def transformFromNative(self): - """Return self transformed into a ContentLine or Component if needed. - + """ + Return self transformed into a ContentLine or Component if needed. + May have side effects. If it does, transformFromNative and transformToNative MUST have perfectly inverse side effects. Allowing such side effects is convenient for objects whose transformations only change a few attributes. - + Note that it isn't always possible for transformFromNative to be a perfect inverse of transformToNative, in such cases transformFromNative should return a new object, not self after modifications. - """ if self.isNative and self.behavior and self.behavior.hasNative: try: return self.behavior.transformFromNative(self) - except Exception, e: + except Exception as e: # wrap errors in transformation in a NativeError lineNumber = getattr(self, 'lineNumber', None) if isinstance(e, NativeError): @@ -158,44 +219,49 @@ class VBase(object): e.lineNumber = lineNumber raise else: - msg = "In transformFromNative, unhandled exception: %s: %s" - msg = msg % (sys.exc_info()[0], sys.exc_info()[1]) - new_error = NativeError(msg, lineNumber) - raise NativeError, new_error, sys.exc_info()[2] - else: return self + msg = "In transformFromNative, unhandled exception " \ + "on line %s %s: %s" + msg = msg % (lineNumber, sys.exc_info()[0], + sys.exc_info()[1]) + raise NativeError(msg, lineNumber) + else: + return self def transformChildrenToNative(self): - """Recursively replace children with their native representation.""" + """ + Recursively replace children with their native representation. + """ pass def transformChildrenFromNative(self, clearBehavior=True): - """Recursively transform native children to vanilla representations.""" + """ + Recursively transform native children to vanilla representations. + """ pass def serialize(self, buf=None, lineLength=75, validate=True, behavior=None): - """Serialize to buf if it exists, otherwise return a string. - + """ + Serialize to buf if it exists, otherwise return a string. + Use self.behavior.serialize if behavior exists. - """ if not behavior: behavior = self.behavior - + if behavior: - if DEBUG: logger.debug("serializing %s with behavior" % self.name) + if DEBUG: + logger.debug("serializing {0!s} with behavior {1!s}".format(self.name, behavior)) return behavior.serialize(self, buf, lineLength, validate) else: - if DEBUG: logger.debug("serializing %s without behavior" % self.name) + if DEBUG: + logger.debug("serializing {0!s} without behavior".format(self.name)) return defaultSerialize(self, buf, lineLength) -def ascii(s): - """Turn s into a printable string. Won't work for 8-bit ASCII.""" - return unicode(s).encode('ascii', 'replace') def toVName(name, stripNum = 0, upper = False): """ - Turn a Python name into an iCalendar style name, optionally uppercase and - with characters stripped off. + Turn a Python name into an iCalendar style name, + optionally uppercase and with characters stripped off. """ if upper: name = name.upper() @@ -203,8 +269,10 @@ def toVName(name, stripNum = 0, upper = False): name = name[:-stripNum] return name.replace('_', '-') + class ContentLine(VBase): - """Holds one content line for formats like vCard and vCalendar. + """ + Holds one content line for formats like vCard and vCalendar. For example:: <SUMMARY{u'param1' : [u'val1'], u'param2' : [u'val2']}Bastille Day Party> @@ -228,26 +296,32 @@ class ContentLine(VBase): @ivar lineNumber: An optional line number associated with the contentline. """ - def __init__(self, name, params, value, group=None, - encoded=False, isNative=False, - lineNumber = None, *args, **kwds): - """Take output from parseLine, convert params list to dictionary.""" - # group is used as a positional argument to match parseLine's return + def __init__(self, name, params, value, group=None, encoded=False, + isNative=False, lineNumber = None, *args, **kwds): + """ + Take output from parseLine, convert params list to dictionary. + + Group is used as a positional argument to match parseLine's return + """ super(ContentLine, self).__init__(group, *args, **kwds) - self.name = name.upper() - self.value = value - self.encoded = encoded - self.params = {} + + self.name = name.upper() + self.encoded = encoded + self.params = {} self.singletonparams = [] self.isNative = isNative self.lineNumber = lineNumber + self.value = value + def updateTable(x): if len(x) == 1: self.singletonparams += x else: paramlist = self.params.setdefault(x[0].upper(), []) paramlist.extend(x[1:]) - map(updateTable, params) + + list(map(updateTable, params)) + qp = False if 'ENCODING' in self.params: if 'QUOTED-PRINTABLE' in self.params['ENCODING']: @@ -259,18 +333,7 @@ class ContentLine(VBase): qp = True self.singletonparams.remove('QUOTED-PRINTABLE') if qp: - self.value = str(self.value).decode('quoted-printable') - - # self.value should be unicode for iCalendar, but if quoted-printable - # is used, or if the quoted-printable state machine is used, text may be - # encoded - if type(self.value) is str: - charset = 'iso-8859-1' - if 'CHARSET' in self.params: - charsets = self.params.pop('CHARSET') - if charsets: - charset = charsets[0] - self.value = unicode(self.value, charset) + self.value = self.value.decode('quoted-printable') @classmethod def duplicate(clz, copyit): @@ -284,34 +347,24 @@ class ContentLine(VBase): self.value = copy.copy(copyit.value) self.encoded = self.encoded self.params = copy.copy(copyit.params) + for k, v in self.params.items(): + self.params[k] = copy.copy(v) self.singletonparams = copy.copy(copyit.singletonparams) self.lineNumber = copyit.lineNumber - + def __eq__(self, other): try: - return (self.name == other.name) and (self.params == other.params) and (self.value == other.value) - except: + return (self.name == other.name) and (self.params == other.params) \ + and (self.value == other.value) + except Exception: return False - def _getAttributeNames(self): - """Return a list of attributes of the object. - - Python 2.6 will add __dir__ to customize what attributes are returned - by dir, for now copy PyCrust so that IPython can accurately do - completion. - - """ - keys = self.params.keys() - params = [param + '_param' for param in keys] - params.extend(param + '_paramlist' for param in keys) - return params - def __getattr__(self, name): - """Make params accessible via self.foo_param or self.foo_paramlist. + """ + Make params accessible via self.foo_param or self.foo_paramlist. Underscores, legal in python variable names, are converted to dashes, which are legal in IANA tokens. - """ try: if name.endswith('_param'): @@ -319,16 +372,16 @@ class ContentLine(VBase): elif name.endswith('_paramlist'): return self.params[toVName(name, 10, True)] else: - raise exceptions.AttributeError, name + raise AttributeError(name) except KeyError: - raise exceptions.AttributeError, name + raise AttributeError(name) def __setattr__(self, name, value): - """Make params accessible via self.foo_param or self.foo_paramlist. + """ + Make params accessible via self.foo_param or self.foo_paramlist. Underscores, legal in python variable names, are converted to dashes, which are legal in IANA tokens. - """ if name.endswith('_param'): if type(value) == list: @@ -356,34 +409,37 @@ class ContentLine(VBase): else: object.__delattr__(self, name) except KeyError: - raise exceptions.AttributeError, name + raise AttributeError(name) def valueRepr( self ): - """transform the representation of the value according to the behavior, - if any""" + """ + Transform the representation of the value + according to the behavior, if any. + """ v = self.value if self.behavior: v = self.behavior.valueRepr( self ) - return ascii( v ) - + return v + def __str__(self): - return "<"+ascii(self.name)+ascii(self.params)+self.valueRepr()+">" + return "<{0}{1}{2}>".format(self.name, self.params, self.valueRepr()) def __repr__(self): - return self.__str__().replace('\n', '\\n') + return self.__str__() def prettyPrint(self, level = 0, tabwidth=3): pre = ' ' * level * tabwidth - print pre, self.name + ":", self.valueRepr() + print(pre, self.name + ":", self.valueRepr()) if self.params: - lineKeys= self.params.keys() - print pre, "params for ", self.name +':' - for aKey in lineKeys: - print pre + ' ' * tabwidth, aKey, ascii(self.params[aKey]) + print(pre, "params for ", self.name + ':') + for k in self.params.keys(): + print(pre + ' ' * tabwidth, k, self.params[k]) + class Component(VBase): - """A complex property that can contain multiple ContentLines. - + """ + A complex property that can contain multiple ContentLines. + For our purposes, a component must start with a BEGIN:xxxx line and end with END:xxxx, or have a PROFILE:xxx line if a top-level component. @@ -397,7 +453,6 @@ class Component(VBase): @ivar useBegin: A boolean flag determining whether BEGIN: and END: lines should be serialized. - """ def __init__(self, name=None, *args, **kwds): super(Component, self).__init__(*args, **kwds) @@ -408,7 +463,7 @@ class Component(VBase): else: self.name = '' self.useBegin = False - + self.autoBehavior() @classmethod @@ -419,7 +474,7 @@ class Component(VBase): def copy(self, copyit): super(Component, self).copy(copyit) - + # deep copy of contents self.contents = {} for key, lvalue in copyit.contents.items(): @@ -431,56 +486,46 @@ class Component(VBase): self.name = copyit.name self.useBegin = copyit.useBegin - + def setProfile(self, name): - """Assign a PROFILE to this unnamed component. - + """ + Assign a PROFILE to this unnamed component. + Used by vCard, not by vCalendar. - """ if self.name or self.useBegin: - if self.name == name: return - raise VObjectError("This component already has a PROFILE or uses BEGIN.") + if self.name == name: + return + raise VObjectError("This component already has a PROFILE or " + "uses BEGIN.") self.name = name.upper() - def _getAttributeNames(self): - """Return a list of attributes of the object. - - Python 2.6 will add __dir__ to customize what attributes are returned - by dir, for now copy PyCrust so that IPython can accurately do - completion. - + def __getattr__(self, name): """ - names = self.contents.keys() - names.extend(name + '_list' for name in self.contents.keys()) - return names + For convenience, make self.contents directly accessible. - def __getattr__(self, name): - """For convenience, make self.contents directly accessible. - Underscores, legal in python variable names, are converted to dashes, which are legal in IANA tokens. - """ # if the object is being re-created by pickle, self.contents may not # be set, don't get into an infinite loop over the issue if name == 'contents': - return object.__getattribute__(self, name) + return object.__getattribute__(self, name) try: if name.endswith('_list'): return self.contents[toVName(name, 5)] else: return self.contents[toVName(name)][0] except KeyError: - raise exceptions.AttributeError, name + raise AttributeError(name) normal_attributes = ['contents','name','behavior','parentBehavior','group'] def __setattr__(self, name, value): - """For convenience, make self.contents directly accessible. + """ + For convenience, make self.contents directly accessible. Underscores, legal in python variable names, are converted to dashes, which are legal in IANA tokens. - """ if name not in self.normal_attributes and name.lower()==name: if type(value) == list: @@ -508,10 +553,12 @@ class Component(VBase): else: object.__delattr__(self, name) except KeyError: - raise exceptions.AttributeError, name + raise AttributeError(name) def getChildValue(self, childName, default = None, childNumber = 0): - """Return a child's value (the first, by default), or None.""" + """ + Return a child's value (the first, by default), or None. + """ child = self.contents.get(toVName(childName)) if child is None: return default @@ -519,13 +566,13 @@ class Component(VBase): return child[childNumber].value def add(self, objOrName, group = None): - """Add objOrName to contents, set behavior if it can be inferred. - + """ + Add objOrName to contents, set behavior if it can be inferred. + If objOrName is a string, create an empty component or line based on behavior. If no behavior is found for the object, add a ContentLine. - group is an optional prefix to the name of the object (see - RFC 2425). + group is an optional prefix to the name of the object (see RFC 2425). """ if isinstance(objOrName, VBase): obj = objOrName @@ -543,7 +590,7 @@ class Component(VBase): obj = ContentLine(name, [], '', group) obj.parentBehavior = self.behavior obj.behavior = behavior - obj = obj.transformToNative() + obj = obj.transformToNative() except (KeyError, AttributeError): obj = ContentLine(objOrName, [], '', group) if obj.behavior is None and self.behavior is not None: @@ -553,7 +600,9 @@ class Component(VBase): return obj def remove(self, obj): - """Remove obj from contents.""" + """ + Remove obj from contents. + """ named = self.contents.get(obj.name.lower()) if named: try: @@ -564,22 +613,28 @@ class Component(VBase): pass; def getChildren(self): - """Return an iterable of all children.""" + """ + Return an iterable of all children. + """ for objList in self.contents.values(): for obj in objList: yield obj def components(self): - """Return an iterable of all Component children.""" + """ + Return an iterable of all Component children. + """ return (i for i in self.getChildren() if isinstance(i, Component)) def lines(self): - """Return an iterable of all ContentLine children.""" + """ + Return an iterable of all ContentLine children. + """ return (i for i in self.getChildren() if isinstance(i, ContentLine)) def sortChildKeys(self): try: first = [s for s in self.behavior.sortFirst if s in self.contents] - except: + except Exception: first = [] return first + sorted(k for k in self.contents.keys() if k not in first) @@ -587,75 +642,85 @@ class Component(VBase): return [obj for k in self.sortChildKeys() for obj in self.contents[k]] def setBehaviorFromVersionLine(self, versionLine): - """Set behavior if one matches name, versionLine.value.""" - v=getBehavior(self.name, versionLine.value) - if v: self.setBehavior(v) + """ + Set behavior if one matches name, versionLine.value. + """ + v = getBehavior(self.name, versionLine.value) + if v: + self.setBehavior(v) def transformChildrenToNative(self): - """Recursively replace children with their native representation.""" - #sort to get dependency order right, like vtimezone before vevent + """ + Recursively replace children with their native representation. + + Sort to get dependency order right, like vtimezone before vevent. + """ for childArray in (self.contents[k] for k in self.sortChildKeys()): - for i in xrange(len(childArray)): - childArray[i]=childArray[i].transformToNative() - childArray[i].transformChildrenToNative() + for child in childArray: + child = child.transformToNative() + child.transformChildrenToNative() def transformChildrenFromNative(self, clearBehavior=True): - """Recursively transform native children to vanilla representations.""" + """ + Recursively transform native children to vanilla representations. + """ for childArray in self.contents.values(): - for i in xrange(len(childArray)): - childArray[i]=childArray[i].transformFromNative() - childArray[i].transformChildrenFromNative(clearBehavior) + for child in childArray: + child = child.transformFromNative() + child.transformChildrenFromNative(clearBehavior) if clearBehavior: - childArray[i].behavior = None - childArray[i].parentBehavior = None - + child.behavior = None + child.parentBehavior = None + def __str__(self): if self.name: - return "<" + self.name + "| " + str(self.getSortedChildren()) + ">" + return "<{0}| {1}>".format(self.name, self.getSortedChildren()) else: - return '<' + '*unnamed*' + '| ' + str(self.getSortedChildren()) + '>' + return u'<*unnamed*| {0}>'.format(self.getSortedChildren()) def __repr__(self): return self.__str__() def prettyPrint(self, level = 0, tabwidth=3): pre = ' ' * level * tabwidth - print pre, self.name + print(pre, self.name) if isinstance(self, Component): for line in self.getChildren(): line.prettyPrint(level + 1, tabwidth) - print + class VObjectError(Exception): - def __init__(self, message, lineNumber=None): - self.message = message + def __init__(self, msg, lineNumber=None): + self.msg = msg if lineNumber is not None: self.lineNumber = lineNumber + def __str__(self): if hasattr(self, 'lineNumber'): - return "At line %s: %s" % \ - (self.lineNumber, self.message) + return "At line {0!s}: {1!s}".format(self.lineNumber, self.msg) else: - return repr(self.message) + return repr(self.msg) + class ParseError(VObjectError): pass + class ValidateError(VObjectError): pass + class NativeError(VObjectError): pass -#-------------------------- Parsing functions ---------------------------------- -# parseLine regular expressions +# --------- Parsing functions and parseLine regular expressions ---------------- patterns = {} # Note that underscore is not legal for names, it's included because # Lotus Notes uses it -patterns['name'] = '[a-zA-Z0-9\-_]+' +patterns['name'] = '[a-zA-Z0-9\-_]+' patterns['safe_char'] = '[^";:,]' patterns['qsafe_char'] = '[^"]' @@ -664,41 +729,41 @@ patterns['qsafe_char'] = '[^"]' # param_value is any number of safe_chars or any number of qsaf_chars surrounded # by double quotes. -patterns['param_value'] = ' "%(qsafe_char)s * " | %(safe_char)s * ' % patterns +patterns['param_value'] = ' "{qsafe_char!s} * " | {safe_char!s} * '.format(**patterns) # get a tuple of two elements, one will be empty, the other will have the value patterns['param_value_grouped'] = """ -" ( %(qsafe_char)s * )" | ( %(safe_char)s + ) -""" % patterns +" ( {qsafe_char!s} * )" | ( {safe_char!s} + ) +""".format(**patterns) # get a parameter and its values, without any saved groups patterns['param'] = r""" -; (?: %(name)s ) # parameter name +; (?: {name!s} ) # parameter name (?: - (?: = (?: %(param_value)s ) )? # 0 or more parameter values, multiple - (?: , (?: %(param_value)s ) )* # parameters are comma separated -)* -""" % patterns + (?: = (?: {param_value!s} ) )? # 0 or more parameter values, multiple + (?: , (?: {param_value!s} ) )* # parameters are comma separated +)* +""".format(**patterns) # get a parameter, saving groups for name and value (value still needs parsing) patterns['params_grouped'] = r""" -; ( %(name)s ) +; ( {name!s} ) (?: = ( - (?: (?: %(param_value)s ) )? # 0 or more parameter values, multiple - (?: , (?: %(param_value)s ) )* # parameters are comma separated + (?: (?: {param_value!s} ) )? # 0 or more parameter values, multiple + (?: , (?: {param_value!s} ) )* # parameters are comma separated ) )? -""" % patterns +""".format(**patterns) # get a full content line, break it up into group, name, parameters, and value patterns['line'] = r""" -^ ((?P<group> %(name)s)\.)?(?P<name> %(name)s) # name group - (?P<params> (?: %(param)s )* ) # params group (may be empty) +^ ((?P<group> {name!s})\.)?(?P<name> {name!s}) # name group + (?P<params> (?: {param!s} )* ) # params group (may be empty) : (?P<value> .* )$ # value group -""" % patterns +""".format(**patterns) ' "%(qsafe_char)s*" | %(safe_char)s* ' @@ -710,17 +775,12 @@ begin_re = re.compile('BEGIN', re.IGNORECASE) def parseParams(string): """ - >>> parseParams(';ALTREP="http://www.wiz.org"') - [['ALTREP', 'http://www.wiz.org']] - >>> parseParams('') - [] - >>> parseParams(';ALTREP="http://www.wiz.org;;",Blah,Foo;NEXT=Nope;BAR') - [['ALTREP', 'http://www.wiz.org;;', 'Blah', 'Foo'], ['NEXT', 'Nope'], ['BAR']] + Parse parameters """ all = params_re.findall(string) allParameters = [] for tup in all: - paramList = [tup[0]] # tup looks like (name, valuesString) + paramList = [tup[0]] # tup looks like (name, valuesString) for pair in param_values_re.findall(tup[1]): # pair looks like ('', value) or (value, '') if pair[0] != '': @@ -731,46 +791,30 @@ def parseParams(string): return allParameters -def parseLine(line, lineNumber = None): +def parseLine(line, lineNumber=None): """ - >>> parseLine("BLAH:") - ('BLAH', [], '', None) - >>> parseLine("RDATE:VALUE=DATE:19970304,19970504,19970704,19970904") - ('RDATE', [], 'VALUE=DATE:19970304,19970504,19970704,19970904', None) - >>> parseLine('DESCRIPTION;ALTREP="http://www.wiz.org":The Fall 98 Wild Wizards Conference - - Las Vegas, NV, USA') - ('DESCRIPTION', [['ALTREP', 'http://www.wiz.org']], 'The Fall 98 Wild Wizards Conference - - Las Vegas, NV, USA', None) - >>> parseLine("EMAIL;PREF;INTERNET:john@nowhere.com") - ('EMAIL', [['PREF'], ['INTERNET']], 'john@nowhere.com', None) - >>> parseLine('EMAIL;TYPE="blah",hah;INTERNET="DIGI",DERIDOO:john@nowhere.com') - ('EMAIL', [['TYPE', 'blah', 'hah'], ['INTERNET', 'DIGI', 'DERIDOO']], 'john@nowhere.com', None) - >>> parseLine('item1.ADR;type=HOME;type=pref:;;Reeperbahn 116;Hamburg;;20359;') - ('ADR', [['type', 'HOME'], ['type', 'pref']], ';;Reeperbahn 116;Hamburg;;20359;', 'item1') - >>> parseLine(":") - Traceback (most recent call last): - ... - ParseError: 'Failed to parse line: :' + Parse line """ - match = line_re.match(line) if match is None: - raise ParseError("Failed to parse line: %s" % line, lineNumber) + raise ParseError("Failed to parse line: {0!s}".format(line), lineNumber) # Underscores are replaced with dash to work around Lotus Notes - return (match.group('name').replace('_','-'), + return (match.group('name').replace('_','-'), parseParams(match.group('params')), match.group('value'), match.group('group')) # logical line regular expressions patterns['lineend'] = r'(?:\r\n|\r|\n|$)' -patterns['wrap'] = r'%(lineend)s [\t ]' % patterns +patterns['wrap'] = r'{lineend!s} [\t ]'.format(**patterns) patterns['logicallines'] = r""" ( - (?: [^\r\n] | %(wrap)s )* - %(lineend)s + (?: [^\r\n] | {wrap!s} )* + {lineend!s} ) -""" % patterns +""".format(**patterns) -patterns['wraporend'] = r'(%(wrap)s | %(lineend)s )' % patterns +patterns['wraporend'] = r'({wrap!s} | {lineend!s} )'.format(**patterns) wrap_re = re.compile(patterns['wraporend'], re.VERBOSE) logical_lines_re = re.compile(patterns['logicallines'], re.VERBOSE) @@ -784,51 +828,31 @@ Line 1;encoding=quoted-printable:this is an evil= Line 2 is a new line, it does not start with whitespace. """ -def getLogicalLines(fp, allowQP=True, findBegin=False): - """Iterate through a stream, yielding one logical line at a time. +def getLogicalLines(fp, allowQP=True): + """ + Iterate through a stream, yielding one logical line at a time. Because many applications still use vCard 2.1, we have to deal with the quoted-printable encoding for long lines, as well as the vCard 3.0 and vCalendar line folding technique, a whitespace character at the start of the line. - + Quoted-printable data will be decoded in the Behavior decoding phase. - - >>> import StringIO - >>> f=StringIO.StringIO(testLines) + + # We're leaving this test in for awhile, because the unittest was ugly and dumb. + >>> from six import StringIO + >>> f=StringIO(testLines) >>> for n, l in enumerate(getLogicalLines(f)): - ... print "Line %s: %s" % (n, l[0]) + ... print("Line %s: %s" % (n, l[0])) ... Line 0: Line 0 text, Line 0 continued. Line 1: Line 1;encoding=quoted-printable:this is an evil= evil= format. Line 2: Line 2 is a new line, it does not start with whitespace. - """ if not allowQP: - bytes = fp.read(-1) - if len(bytes) > 0: - if type(bytes[0]) == unicode: - val = bytes - elif not findBegin: - val = bytes.decode('utf-8') - else: - for encoding in 'utf-8', 'utf-16-LE', 'utf-16-BE', 'iso-8859-1': - try: - val = bytes.decode(encoding) - if begin_re.search(val) is not None: - break - except UnicodeDecodeError: - pass - else: - raise ParseError, 'Could not find BEGIN when trying to determine encoding' - else: - val = bytes - - # strip off any UTF8 BOMs which Python's UTF8 decoder leaves - - val = val.lstrip( unicode( codecs.BOM_UTF8, "utf8" ) ) + val = fp.read(-1) lineNumber = 1 for match in logical_lines_re.finditer(val): @@ -836,10 +860,10 @@ def getLogicalLines(fp, allowQP=True, findBegin=False): if line != '': yield line, lineNumber lineNumber += n - + else: - quotedPrintable=False - newbuffer = StringIO.StringIO + quotedPrintable = False + newbuffer = six.StringIO logicalLine = newbuffer() lineNumber = 0 lineStartNumber = 0 @@ -851,20 +875,20 @@ def getLogicalLines(fp, allowQP=True, findBegin=False): line = line.rstrip(CRLF) lineNumber += 1 if line.rstrip() == '': - if logicalLine.pos > 0: + if logicalLine.tell() > 0: yield logicalLine.getvalue(), lineStartNumber lineStartNumber = lineNumber logicalLine = newbuffer() - quotedPrintable=False + quotedPrintable = False continue - + if quotedPrintable and allowQP: logicalLine.write('\n') logicalLine.write(line) - quotedPrintable=False + quotedPrintable = False elif line[0] in SPACEORTAB: logicalLine.write(line[1:]) - elif logicalLine.pos > 0: + elif logicalLine.tell() > 0: yield logicalLine.getvalue(), lineStartNumber lineStartNumber = lineNumber logicalLine = newbuffer() @@ -872,24 +896,26 @@ def getLogicalLines(fp, allowQP=True, findBegin=False): else: logicalLine = newbuffer() logicalLine.write(line) - - # hack to deal with the fact that vCard 2.1 allows parameters to be - # encoded without a parameter name. False positives are unlikely, but - # possible. + + # vCard 2.1 allows parameters to be encoded without a parameter name + # False positives are unlikely, but possible. val = logicalLine.getvalue() if val[-1]=='=' and val.lower().find('quoted-printable') >= 0: quotedPrintable=True - - if logicalLine.pos > 0: + + if logicalLine.tell() > 0: yield logicalLine.getvalue(), lineStartNumber def textLineToContentLine(text, n=None): - return ContentLine(*parseLine(text, n), **{'encoded':True, 'lineNumber' : n}) - + return ContentLine(*parseLine(text, n), **{'encoded':True, + 'lineNumber' : n}) + def dquoteEscape(param): - """Return param, or "param" if ',' or ';' or ':' is in param.""" + """ + Return param, or "param" if ',' or ';' or ':' is in param. + """ if param.find('"') >= 0: raise VObjectError("Double quotes aren't allowed in parameter values.") for char in ',;:': @@ -898,40 +924,60 @@ def dquoteEscape(param): return param def foldOneLine(outbuf, input, lineLength = 75): - # Folding line procedure that ensures multi-byte utf-8 sequences are not broken - # across lines + """ + Folding line procedure that ensures multi-byte utf-8 sequences are not + broken across lines + TO-DO: This all seems odd. Is it still needed, especially in python3? + """ if len(input) < lineLength: # Optimize for unfolded line case - outbuf.write(input) + try: + outbuf.write(bytes(input, 'UTF-8')) + except Exception: + # fall back on py2 syntax + outbuf.write(str_(input)) + else: # Look for valid utf8 range and write that out start = 0 written = 0 - while written < len(input): - # Start max length -1 chars on from where we are - offset = start + lineLength - 1 - if offset >= len(input): - line = input[start:] - outbuf.write(line) - written = len(input) + counter = 0 # counts line size in bytes + decoded = to_unicode(input) + length = len(to_basestring(input)) + while written < length: + s = decoded[start] # take one char + size = len(to_basestring(s)) # calculate it's size in bytes + if counter + size > lineLength: + try: + outbuf.write(bytes("\r\n ", 'UTF-8')) + except Exception: + # fall back on py2 syntax + outbuf.write("\r\n ") + + counter = 1 # one for space + + if str is unicode_type: + outbuf.write(to_unicode(s)) else: - # Check whether next char is valid utf8 lead byte - while (input[offset] > 0x7F) and ((ord(input[offset]) & 0xC0) == 0x80): - # Step back until we have a valid char - offset -= 1 - - line = input[start:offset] - outbuf.write(line) - outbuf.write("\r\n ") - written += offset - start - start = offset - outbuf.write("\r\n") + # fall back on py2 syntax + outbuf.write(s.encode('utf-8')) -def defaultSerialize(obj, buf, lineLength): - """Encode and fold obj and its children, write to buf or return a string.""" + written += size + counter += size + start += 1 + try: + outbuf.write(bytes("\r\n", 'UTF-8')) + except Exception: + # fall back on py2 syntax + outbuf.write("\r\n") - outbuf = buf or cStringIO.StringIO() + +def defaultSerialize(obj, buf, lineLength): + """ + Encode and fold obj and its children, write to buf or return a string. + """ + outbuf = buf or six.StringIO() if isinstance(obj, Component): if obj.group is None: @@ -939,35 +985,36 @@ def defaultSerialize(obj, buf, lineLength): else: groupString = obj.group + '.' if obj.useBegin: - foldOneLine(outbuf, str(groupString + u"BEGIN:" + obj.name), lineLength) + foldOneLine(outbuf, "{0}BEGIN:{1}".format(groupString, obj.name), + lineLength) for child in obj.getSortedChildren(): - #validate is recursive, we only need to validate once + # validate is recursive, we only need to validate once child.serialize(outbuf, lineLength, validate=False) if obj.useBegin: - foldOneLine(outbuf, str(groupString + u"END:" + obj.name), lineLength) - + foldOneLine(outbuf, "{0}END:{1}".format(groupString, obj.name), + lineLength) + elif isinstance(obj, ContentLine): startedEncoded = obj.encoded - if obj.behavior and not startedEncoded: obj.behavior.encode(obj) - s=codecs.getwriter('utf-8')(cStringIO.StringIO()) #unfolded buffer + if obj.behavior and not startedEncoded: + obj.behavior.encode(obj) + + s = six.StringIO() + if obj.group is not None: s.write(obj.group + '.') s.write(obj.name.upper()) - for key, paramvals in obj.params.iteritems(): - s.write(';' + key + '=' + ','.join(dquoteEscape(p) for p in paramvals)) - s.write(':' + obj.value) - if obj.behavior and not startedEncoded: obj.behavior.decode(obj) + keys = sorted(obj.params.keys()) + for key in keys: + paramstr = ','.join(dquoteEscape(p) for p in obj.params[key]) + s.write(";{0}={1}".format(key, paramstr)) + s.write(":{0}".format(str_(obj.value))) + if obj.behavior and not startedEncoded: + obj.behavior.decode(obj) foldOneLine(outbuf, s.getvalue(), lineLength) - - return buf or outbuf.getvalue() + return buf or outbuf.getvalue() -testVCalendar=""" -BEGIN:VCALENDAR -BEGIN:VEVENT -SUMMARY;blah=hi!:Bastille Day Party -END:VEVENT -END:VCALENDAR""" class Stack: def __init__(self): @@ -987,27 +1034,22 @@ class Stack: else: new = Component() self.push(new) - new.add(item) #add sets behavior for item and children - def push(self, obj): self.stack.append(obj) - def pop(self): return self.stack.pop() + new.add(item) # add sets behavior for item and children + + def push(self, obj): + self.stack.append(obj) + + def pop(self): + return self.stack.pop() def readComponents(streamOrString, validate=False, transform=True, - findBegin=True, ignoreUnreadable=False, - allowQP=False): - """Generate one Component at a time from a stream. - - >>> import StringIO - >>> f = StringIO.StringIO(testVCalendar) - >>> cal=readComponents(f).next() - >>> cal - <VCALENDAR| [<VEVENT| [<SUMMARY{u'BLAH': [u'hi!']}Bastille Day Party>]>]> - >>> cal.vevent.summary - <SUMMARY{u'BLAH': [u'hi!']}Bastille Day Party> - + ignoreUnreadable=False, allowQP=False): + """ + Generate one Component at a time from a stream. """ if isinstance(streamOrString, basestring): - stream = StringIO.StringIO(streamOrString) + stream = six.StringIO(str_(streamOrString)) else: stream = streamOrString @@ -1015,80 +1057,92 @@ def readComponents(streamOrString, validate=False, transform=True, stack = Stack() versionLine = None n = 0 - for line, n in getLogicalLines(stream, allowQP, findBegin): + for line, n in getLogicalLines(stream, allowQP): if ignoreUnreadable: try: vline = textLineToContentLine(line, n) - except VObjectError, e: + except VObjectError as e: if e.lineNumber is not None: msg = "Skipped line %(lineNumber)s, message: %(msg)s" else: msg = "Skipped a line, message: %(msg)s" - logger.error(msg % {'lineNumber' : e.lineNumber, - 'msg' : e.message}) + logger.error(msg % {'lineNumber' : e.lineNumber, + 'msg' : str(e)}) continue else: vline = textLineToContentLine(line, n) - if vline.name == "VERSION": + if vline.name == "VERSION": versionLine = vline stack.modifyTop(vline) elif vline.name == "BEGIN": stack.push(Component(vline.value, group=vline.group)) elif vline.name == "PROFILE": - if not stack.top(): stack.push(Component()) + if not stack.top(): + stack.push(Component()) stack.top().setProfile(vline.value) elif vline.name == "END": if len(stack) == 0: - err = "Attempted to end the %s component, \ - but it was never opened" % vline.value + err = "Attempted to end the %s component but it was " \ + "never opened" % vline.value raise ParseError(err, n) - if vline.value.upper() == stack.topName(): #START matches END + + if vline.value.upper() == stack.topName(): # START matches END if len(stack) == 1: - component=stack.pop() + component = stack.pop() if versionLine is not None: component.setBehaviorFromVersionLine(versionLine) else: behavior = getBehavior(component.name) if behavior: component.setBehavior(behavior) - if validate: component.validate(raiseException=True) - if transform: component.transformChildrenToNative() - yield component #EXIT POINT - else: stack.modifyTop(stack.pop()) + if validate: + component.validate(raiseException=True) + if transform: + component.transformChildrenToNative() + yield component # EXIT POINT + else: + stack.modifyTop(stack.pop()) else: - err = "%s component wasn't closed" + err = "%s component wasn't closed" raise ParseError(err % stack.topName(), n) - else: stack.modifyTop(vline) #not a START or END line + else: + stack.modifyTop(vline) # not a START or END line if stack.top(): if stack.topName() is None: logger.warning("Top level component was never named") elif stack.top().useBegin: - raise ParseError("Component %s was never closed" % (stack.topName()), n) + raise ParseError("Component {0!s} was never closed".format( + (stack.topName())), n) yield stack.pop() - except ParseError, e: + except ParseError as e: e.input = streamOrString raise -def readOne(stream, validate=False, transform=True, findBegin=True, - ignoreUnreadable=False, allowQP=False): - """Return the first component from stream.""" - return readComponents(stream, validate, transform, findBegin, - ignoreUnreadable, allowQP).next() +def readOne(stream, validate=False, transform=True, ignoreUnreadable=False, + allowQP=False): + """ + Return the first component from stream. + """ + return next(readComponents(stream, validate, transform, ignoreUnreadable, + allowQP)) + -#--------------------------- version registry ---------------------------------- +# --------------------------- version registry --------------------------------- __behaviorRegistry={} def registerBehavior(behavior, name=None, default=False, id=None): - """Register the given behavior. - - If default is True (or if this is the first version registered with this + """ + Register the given behavior. + + If default is True (or if this is the first version registered with this name), the version will be the default if no id is given. - """ - if not name: name=behavior.name.upper() - if id is None: id=behavior.versionString + if not name: + name=behavior.name.upper() + if id is None: + id=behavior.versionString if name in __behaviorRegistry: if default: __behaviorRegistry[name].insert(0, (id, behavior)) @@ -1098,10 +1152,10 @@ def registerBehavior(behavior, name=None, default=False, id=None): __behaviorRegistry[name]=[(id, behavior)] def getBehavior(name, id=None): - """Return a matching behavior if it exists, or None. - + """ + Return a matching behavior if it exists, or None. + If id is None, return the default for name. - """ name=name.upper() if name in __behaviorRegistry: @@ -1114,11 +1168,13 @@ def getBehavior(name, id=None): return None def newFromBehavior(name, id=None): - """Given a name, return a behaviored ContentLine or Component.""" + """ + Given a name, return a behaviored ContentLine or Component. + """ name = name.upper() behavior = getBehavior(name, id) if behavior is None: - raise VObjectError("No behavior found named %s" % name) + raise VObjectError("No behavior found named {0!s}".format(name)) if behavior.isComponent: obj = Component(name) else: @@ -1128,12 +1184,7 @@ def newFromBehavior(name, id=None): return obj -#--------------------------- Helper function ----------------------------------- +# --------------------------- Helper function ---------------------------------- def backslashEscape(s): - s=s.replace("\\","\\\\").replace(";","\;").replace(",","\,") + s = s.replace("\\","\\\\").replace(";","\;").replace(",","\,") return s.replace("\r\n", "\\n").replace("\n","\\n").replace("\r","\\n") - -#------------------- Testing and running functions ----------------------------- -if __name__ == '__main__': - import tests - tests._test() diff --git a/vobject/behavior.py b/vobject/behavior.py index 226c0cc..451cd82 100644 --- a/vobject/behavior.py +++ b/vobject/behavior.py @@ -1,17 +1,18 @@ -"""Behavior (validation, encoding, and transformations) for vobjects.""" - -import base +from . import base #------------------------ Abstract class for behavior -------------------------- class Behavior(object): - """Abstract class to describe vobject options, requirements and encodings. - + """ + Behavior (validation, encoding, and transformations) for vobjects. + + Abstract class to describe vobject options, requirements and encodings. + Behaviors are used for root components like VCALENDAR, for subcomponents like VEVENT, and for individual lines in components. - + Behavior subclasses are not meant to be instantiated, all methods should be classmethods. - + @cvar name: The uppercase name of the object described by the class, or a generic name if the class defines behavior for many objects. @@ -56,11 +57,11 @@ class Behavior(object): def __init__(self): err="Behavior subclasses are not meant to be instantiated" raise base.VObjectError(err) - + @classmethod def validate(cls, obj, raiseException=False, complainUnrecognized=False): """Check if the object satisfies this behavior's requirements. - + @param obj: The L{ContentLine<base.ContentLine>} or L{Component<base.Component>} to be validated. @@ -73,7 +74,7 @@ class Behavior(object): """ if not cls.allowGroup and obj.group is not None: - err = str(obj) + " has a group, but this object doesn't support groups" + err = "{0} has a group, but this object doesn't support groups".format(obj) raise base.VObjectError(err) if isinstance(obj, base.ContentLine): return cls.lineValidate(obj, raiseException, complainUnrecognized) @@ -84,8 +85,8 @@ class Behavior(object): return False name=child.name.upper() count[name] = count.get(name, 0) + 1 - for key, val in cls.knownChildren.iteritems(): - if count.get(key,0) < val[0]: + for key, val in cls.knownChildren.items(): + if count.get(key,0) < val[0]: if raiseException: m = "%s components must contain at least %i %s" raise base.ValidateError(m % (cls.name, val[0], key)) @@ -97,9 +98,9 @@ class Behavior(object): return False return True else: - err = str(obj) + " is not a Component or Contentline" + err = "{0} is not a Component or Contentline".format(obj) raise base.VObjectError(err) - + @classmethod def lineValidate(cls, line, raiseException, complainUnrecognized): """Examine a line's parameters and values, return True if valid.""" @@ -108,57 +109,62 @@ class Behavior(object): @classmethod def decode(cls, line): if line.encoded: line.encoded=0 - + @classmethod def encode(cls, line): if not line.encoded: line.encoded=1 @classmethod def transformToNative(cls, obj): - """Turn a ContentLine or Component into a Python-native representation. - + """ + Turn a ContentLine or Component into a Python-native representation. + If appropriate, turn dates or datetime strings into Python objects. Components containing VTIMEZONEs turn into VtimezoneComponents. - + """ return obj - + @classmethod def transformFromNative(cls, obj): - """Inverse of transformToNative.""" + """ + Inverse of transformToNative. + """ raise base.NativeError("No transformFromNative defined") - + @classmethod def generateImplicitParameters(cls, obj): """Generate any required information that don't yet exist.""" pass - + @classmethod def serialize(cls, obj, buf, lineLength, validate=True): - """Set implicit parameters, do encoding, return unicode string. - + """ + Set implicit parameters, do encoding, return unicode string. + If validate is True, raise VObjectError if the line doesn't validate after implicit parameters are generated. - + Default is to call base.defaultSerialize. - + """ - + cls.generateImplicitParameters(obj) if validate: cls.validate(obj, raiseException=True) - + if obj.isNative: transformed = obj.transformFromNative() undoTransform = True else: transformed = obj undoTransform = False - + out = base.defaultSerialize(transformed, buf, lineLength) - if undoTransform: obj.transformToNative() + if undoTransform: + obj.transformToNative() return out - + @classmethod def valueRepr( cls, line ): """return the representation of the given content line value""" - return line.value
\ No newline at end of file + return line.value diff --git a/vobject/change_tz.py b/vobject/change_tz.py index 4f9ae1e..db430f5 100644 --- a/vobject/change_tz.py +++ b/vobject/change_tz.py @@ -2,7 +2,7 @@ from optparse import OptionParser from vobject import icalendar, base -import sys + try: import PyICU except: @@ -11,6 +11,19 @@ except: from datetime import datetime def change_tz(cal, new_timezone, default, utc_only=False, utc_tz=icalendar.utc): + """ + Change the timezone of the specified component. + + Args: + cal (Component): the component to change + new_timezone (tzinfo): the timezone to change to + default (tzinfo): a timezone to assume if the dtstart or dtend in cal + doesn't have an existing timezone + utc_only (bool): only convert dates that are in utc + utc_tz (tzinfo): the tzinfo to compare to for UTC when processing + utc_only=True + """ + for vevent in getattr(cal, 'vevent_list', []): start = getattr(vevent, 'dtstart', None) end = getattr(vevent, 'dtend', None) @@ -18,7 +31,7 @@ def change_tz(cal, new_timezone, default, utc_only=False, utc_tz=icalendar.utc): if node: dt = node.value if (isinstance(dt, datetime) and - (not utc_only or dt.tzinfo == utc_tz)): + (not utc_only or dt.tzinfo == utc_tz)): if dt.tzinfo is None: dt = dt.replace(tzinfo = default) node.value = dt.astimezone(new_timezone) @@ -26,37 +39,38 @@ def change_tz(cal, new_timezone, default, utc_only=False, utc_tz=icalendar.utc): def main(): options, args = get_options() if PyICU is None: - print "Failure. change_tz requires PyICU, exiting" + print("Failure. change_tz requires PyICU, exiting") elif options.list: for tz_string in PyICU.TimeZone.createEnumeration(): - print tz_string + print(tz_string) elif args: utc_only = options.utc if utc_only: which = "only UTC" else: which = "all" - print "Converting %s events" % which + print("Converting {0!s} events".format(which)) ics_file = args[0] if len(args) > 1: timezone = PyICU.ICUtzinfo.getInstance(args[1]) else: timezone = PyICU.ICUtzinfo.default - print "... Reading %s" % ics_file - cal = base.readOne(file(ics_file)) + print("... Reading {0!s}".format(ics_file)) + cal = base.readOne(open(ics_file)) change_tz(cal, timezone, PyICU.ICUtzinfo.default, utc_only) out_name = ics_file + '.converted' - print "... Writing %s" % out_name + print("... Writing {0!s}".format(out_name)) + out = file(out_name, 'wb') cal.serialize(out) - print "Done" + print("Done") version = "0.1" def get_options(): - ##### Configuration options ##### + # Configuration options usage = """usage: %prog [options] ics_file [timezone]""" parser = OptionParser(usage=usage, version=version) @@ -67,12 +81,11 @@ def get_options(): parser.add_option("-l", "--list", dest="list", action="store_true", default=False, help="List available timezones") - (cmdline_options, args) = parser.parse_args() if not args and not cmdline_options.list: - print "error: too few arguments given" + print("error: too few arguments given") print - print parser.format_help() + print(parser.format_help()) return False, False return cmdline_options, args @@ -81,4 +94,4 @@ if __name__ == "__main__": try: main() except KeyboardInterrupt: - print "Aborted" + print("Aborted") diff --git a/vobject/hcalendar.py b/vobject/hcalendar.py index 93614ab..7f24649 100644 --- a/vobject/hcalendar.py +++ b/vobject/hcalendar.py @@ -20,7 +20,7 @@ and an equivalent event in hCalendar format with various elements optimized appr <span class="vevent"> <a class="url" href="http://www.web2con.com/"> - <span class="summary">Web 2.0 Conference</span>: + <span class="summary">Web 2.0 Conference</span>: <abbr class="dtstart" title="2005-10-05">October 5</abbr>- <abbr class="dtend" title="2005-10-08">7</abbr>, at the <span class="location">Argent Hotel, San Francisco, CA</span> @@ -28,39 +28,42 @@ and an equivalent event in hCalendar format with various elements optimized appr </span> """ -from base import foldOneLine, CRLF, registerBehavior -from icalendar import VCalendar2_0 +import six + from datetime import date, datetime, timedelta -import StringIO + +from .base import CRLF, registerBehavior +from .icalendar import VCalendar2_0 + class HCalendar(VCalendar2_0): name = 'HCALENDAR' - + @classmethod def serialize(cls, obj, buf=None, lineLength=None, validate=True): """ Serialize iCalendar to HTML using the hCalendar microformat (http://microformats.org/wiki/hcalendar) """ - - outbuf = buf or StringIO.StringIO() - level = 0 # holds current indentation level + + outbuf = buf or six.StringIO() + level = 0 # holds current indentation level tabwidth = 3 - + def indent(): return ' ' * level * tabwidth - + def out(s): outbuf.write(indent()) outbuf.write(s) - + # not serializing optional vcalendar wrapper - + vevents = obj.vevent_list - + for event in vevents: out('<span class="vevent">' + CRLF) level += 1 - + # URL url = event.getChildValue("url") if url: @@ -70,7 +73,7 @@ class HCalendar(VCalendar2_0): summary = event.getChildValue("summary") if summary: out('<span class="summary">' + summary + '</span>:' + CRLF) - + # DTSTART dtstart = event.getChildValue("dtstart") if dtstart: @@ -83,10 +86,11 @@ class HCalendar(VCalendar2_0): #TODO: Handle non-datetime formats? #TODO: Spec says we should handle when dtstart isn't included - - out('<abbr class="dtstart", title="%s">%s</abbr>\r\n' % - (dtstart.strftime(machine), dtstart.strftime(timeformat))) - + + out('<abbr class="dtstart", title="{0!s}">{1!s}</abbr>\r\n' + .format(dtstart.strftime(machine), + dtstart.strftime(timeformat))) + # DTEND dtend = event.getChildValue("dtend") if not dtend: @@ -94,32 +98,33 @@ class HCalendar(VCalendar2_0): if duration: dtend = duration + dtstart # TODO: If lacking dtend & duration? - + if dtend: human = dtend # TODO: Human readable part could be smarter, excluding repeated data if type(dtend) == date: human = dtend - timedelta(days=1) - - out('- <abbr class="dtend", title="%s">%s</abbr>\r\n' % - (dtend.strftime(machine), human.strftime(timeformat))) - # LOCATION + out('- <abbr class="dtend", title="{0!s}">{1!s}</abbr>\r\n' + .format(dtend.strftime(machine), + human.strftime(timeformat))) + + # LOCATION location = event.getChildValue("location") if location: out('at <span class="location">' + location + '</span>' + CRLF) - + description = event.getChildValue("description") if description: out('<div class="description">' + description + '</div>' + CRLF) - + if url: level -= 1 out('</a>' + CRLF) - - level -= 1 + + level -= 1 out('</span>' + CRLF) # close vevent return buf or outbuf.getvalue() - -registerBehavior(HCalendar)
\ No newline at end of file + +registerBehavior(HCalendar) diff --git a/vobject/icalendar.py b/vobject/icalendar.py index 4a1da7c..c49dbbb 100644 --- a/vobject/icalendar.py +++ b/vobject/icalendar.py @@ -1,20 +1,22 @@ """Definitions and behavior for iCalendar, also known as vCalendar 2.0""" -import string -import behavior -import dateutil.rrule -import dateutil.tz -import StringIO, cStringIO +from __future__ import print_function + import datetime -import socket, random #for generating a UID -import itertools +import random # for generating a UID +import six +import socket +import string + +from dateutil import rrule, tz -from base import (VObjectError, NativeError, ValidateError, ParseError, - VBase, Component, ContentLine, logger, defaultSerialize, - registerBehavior, backslashEscape, foldOneLine, - newFromBehavior, CRLF, LF, ascii) +from . import behavior +from .base import (VObjectError, NativeError, ValidateError, ParseError, + Component, ContentLine, logger, registerBehavior, + backslashEscape, foldOneLine, str_) -#------------------------------- Constants ------------------------------------- + +# ------------------------------- Constants ------------------------------------ DATENAMES = ("rdate", "exdate") RULENAMES = ("exrule", "rrule") DATESANDRULES = ("exrule", "rrule", "rdate", "exdate") @@ -27,45 +29,65 @@ FREQUENCIES = ('YEARLY', 'MONTHLY', 'WEEKLY', 'DAILY', 'HOURLY', 'MINUTELY', zeroDelta = datetime.timedelta(0) twoHours = datetime.timedelta(hours=2) -#---------------------------- TZID registry ------------------------------------ + +# ---------------------------- TZID registry ----------------------------------- __tzidMap={} def toUnicode(s): - """Take a string or unicode, turn it into unicode, decoding as utf-8""" - if isinstance(s, str): + """ + Take a string or unicode, turn it into unicode, decoding as utf-8 + """ + if isinstance(s, six.binary_type): s = s.decode('utf-8') return s def registerTzid(tzid, tzinfo): - """Register a tzid -> tzinfo mapping.""" + """ + Register a tzid -> tzinfo mapping. + """ __tzidMap[toUnicode(tzid)]=tzinfo -def getTzid(tzid): - """Return the tzid if it exists, or None.""" - return __tzidMap.get(toUnicode(tzid), None) - -utc = dateutil.tz.tzutc() +def getTzid(tzid, smart=True): + """ + Return the tzid if it exists, or None. + """ + tz = __tzidMap.get(toUnicode(tzid), None) + if smart and tzid and not tz: + try: + from pytz import timezone, UnknownTimeZoneError + try: + tz = timezone(tzid) + registerTzid(toUnicode(tzid), tz) + except UnknownTimeZoneError as e: + print("Error: {0}".format(e)) + except ImportError as e: + print("Error: {0}".format(e)) + return tz + +utc = tz.tzutc() registerTzid("UTC", utc) -#-------------------- Helper subclasses ---------------------------------------- +# -------------------- Helper subclasses --------------------------------------- class TimezoneComponent(Component): - """A VTIMEZONE object. - - VTIMEZONEs are parsed by dateutil.tz.tzical, the resulting datetime.tzinfo + """ + A VTIMEZONE object. + + VTIMEZONEs are parsed by tz.tzical, the resulting datetime.tzinfo subclass is stored in self.tzinfo, self.tzid stores the TZID associated with this timezone. - + @ivar name: The uppercased name of the object, in this case always 'VTIMEZONE'. @ivar tzinfo: A datetime.tzinfo subclass representing this timezone. @ivar tzid: The string used to refer to this timezone. - - """ + """ def __init__(self, tzinfo=None, *args, **kwds): - """Accept an existing Component or a tzinfo class.""" + """ + Accept an existing Component or a tzinfo class. + """ super(TimezoneComponent, self).__init__(*args, **kwds) self.isNative=True # hack to make sure a behavior is assigned @@ -79,9 +101,11 @@ class TimezoneComponent(Component): @classmethod def registerTzinfo(obj, tzinfo): - """Register tzinfo if it's not already registered, return its tzid.""" + """ + Register tzinfo if it's not already registered, return its tzid. + """ tzid = obj.pickTzid(tzinfo) - if tzid and not getTzid(tzid): + if tzid and not getTzid(tzid, False): registerTzid(tzid, tzinfo) return tzid @@ -90,7 +114,7 @@ class TimezoneComponent(Component): good_lines = ('rdate', 'rrule', 'dtstart', 'tzname', 'tzoffsetfrom', 'tzoffsetto', 'tzid') # serialize encodes as utf-8, cStringIO will leave utf-8 alone - buffer = cStringIO.StringIO() + buffer = six.StringIO() # allow empty VTIMEZONEs if len(self.contents) == 0: return None @@ -104,14 +128,15 @@ class TimezoneComponent(Component): customSerialize(comp) foldOneLine(buffer, u"END:" + obj.name) customSerialize(self) - buffer.seek(0) # tzical wants to read a stream - return dateutil.tz.tzical(buffer).get() + buffer.seek(0) # tzical wants to read a stream + return tz.tzical(buffer).get() def settzinfo(self, tzinfo, start=2000, end=2030): - """Create appropriate objects in self to represent tzinfo. - + """ + Create appropriate objects in self to represent tzinfo. + Collapse DST transitions to rrules as much as possible. - + Assumptions: - DST <-> Standard transitions occur on the hour - never within a month of one another @@ -120,10 +145,11 @@ class TimezoneComponent(Component): - DST always moves offset exactly one hour later - tzinfo classes dst method always treats times that could be in either offset as being in the later regime - - """ + """ def fromLastWeek(dt): - """How many weeks from the end of the month dt is, starting from 1.""" + """ + How many weeks from the end of the month dt is, starting from 1. + """ weekDelta = datetime.timedelta(weeks=1) n = 1 current = dt + weekDelta @@ -131,20 +157,20 @@ class TimezoneComponent(Component): n += 1 current += weekDelta return n - + # lists of dictionaries defining rules which are no longer in effect completed = {'daylight' : [], 'standard' : []} - + # dictionary defining rules which are currently in effect working = {'daylight' : None, 'standard' : None} - - # rule may be based on the nth week of the month or the nth from the last - for year in xrange(start, end + 1): + + # rule may be based on nth week of the month or the nth from the last + for year in range(start, end + 1): newyear = datetime.datetime(year, 1, 1) for transitionTo in 'daylight', 'standard': transition = getTransition(transitionTo, year, tzinfo) oldrule = working[transitionTo] - + if transition == newyear: # transitionTo is in effect for the whole year rule = {'end' : None, @@ -162,7 +188,7 @@ class TimezoneComponent(Component): working[transitionTo] = rule else: # transitionTo was already in effect - if (oldrule['offset'] != + if (oldrule['offset'] != tzinfo.utcoffset(newyear)): # old rule was different, it shouldn't continue oldrule['end'] = year - 1 @@ -178,22 +204,23 @@ class TimezoneComponent(Component): else: # an offset transition was found old_offset = tzinfo.utcoffset(transition - twoHours) - rule = {'end' : None, # None, or an integer year - 'start' : transition, # the datetime of transition + rule = {'end' : None, # None, or an integer year + 'start' : transition, # the datetime of transition 'month' : transition.month, 'weekday' : transition.weekday(), 'hour' : transition.hour, 'name' : tzinfo.tzname(transition), - 'plus' : (transition.day - 1)/ 7 + 1,#nth week of the month - 'minus' : fromLastWeek(transition), #nth from last week - 'offset' : tzinfo.utcoffset(transition), + 'plus' : int( + (transition.day - 1)/ 7 + 1), # nth week of the month + 'minus' : fromLastWeek(transition), # nth from last week + 'offset' : tzinfo.utcoffset(transition), 'offsetfrom' : old_offset} - - if oldrule is None: + + if oldrule is None: working[transitionTo] = rule else: - plusMatch = rule['plus'] == oldrule['plus'] - minusMatch = rule['minus'] == oldrule['minus'] + plusMatch = rule['plus'] == oldrule['plus'] + minusMatch = rule['minus'] == oldrule['minus'] truth = plusMatch or minusMatch for key in 'month', 'weekday', 'hour', 'offset': truth = truth and rule[key] == oldrule[key] @@ -208,18 +235,18 @@ class TimezoneComponent(Component): oldrule['end'] = year - 1 completed[transitionTo].append(oldrule) working[transitionTo] = rule - + for transitionTo in 'daylight', 'standard': if working[transitionTo] is not None: completed[transitionTo].append(working[transitionTo]) - + self.tzid = [] self.daylight = [] self.standard = [] - + self.add('tzid').value = self.pickTzid(tzinfo, True) - - old = None + + # old = None # unused? for transitionTo in 'daylight', 'standard': for rule in completed[transitionTo]: comp = self.add(transitionTo) @@ -231,7 +258,7 @@ class TimezoneComponent(Component): line.value = deltaToOffset(rule['offset']) line = comp.add('tzoffsetfrom') line.value = deltaToOffset(rule['offsetfrom']) - + if rule['plus'] is not None: num = rule['plus'] elif rule['minus'] is not None: @@ -247,8 +274,8 @@ class TimezoneComponent(Component): # all year offset, with no rule endDate = datetime.datetime(rule['end'], 1, 1) else: - weekday = dateutil.rrule.weekday(rule['weekday'], num) - du_rule = dateutil.rrule.rrule(dateutil.rrule.YEARLY, + weekday = rrule.weekday(rule['weekday'], num) + du_rule = rrule.rrule(rrule.YEARLY, bymonth = rule['month'],byweekday = weekday, dtstart = datetime.datetime( rule['end'], 1, 1, rule['hour']) @@ -258,10 +285,10 @@ class TimezoneComponent(Component): endString = ";UNTIL="+ dateTimeToString(endDate) else: endString = '' - rulestring = "FREQ=YEARLY%s;BYMONTH=%s%s" % \ - (dayString, str(rule['month']), endString) - - comp.add('rrule').value = rulestring + new_rule = "FREQ=YEARLY{0!s};BYMONTH={1!s}{2!s}"\ + .format(dayString, rule['month'], endString) + + comp.add('rrule').value = new_rule tzinfo = property(gettzinfo, settzinfo) # prevent Component's __setattr__ from overriding the tzinfo property @@ -273,12 +300,12 @@ class TimezoneComponent(Component): Given a tzinfo class, use known APIs to determine TZID, or use tzname. """ if tzinfo is None or (not allowUTC and tzinfo_eq(tzinfo, utc)): - #If tzinfo is UTC, we don't need a TZID + # If tzinfo is UTC, we don't need a TZID return None # try PyICU's tzid key if hasattr(tzinfo, 'tzid'): return toUnicode(tzinfo.tzid) - + # try pytz zone key if hasattr(tzinfo, 'zone'): return toUnicode(tzinfo.zone) @@ -289,32 +316,35 @@ class TimezoneComponent(Component): else: # return tzname for standard (non-DST) time notDST = datetime.timedelta(0) - for month in xrange(1,13): + for month in range(1, 13): dt = datetime.datetime(2000, month, 1) if tzinfo.dst(dt) == notDST: return toUnicode(tzinfo.tzname(dt)) # there was no standard time in 2000! - raise VObjectError("Unable to guess TZID for tzinfo %s" % str(tzinfo)) + raise VObjectError("Unable to guess TZID for tzinfo {0!s}" + .format(tzinfo)) def __str__(self): - return "<VTIMEZONE | " + str(getattr(self, 'tzid', 'No TZID')) +">" - + return "<VTIMEZONE | {0}>".format(getattr(self, 'tzid', 'No TZID')) + def __repr__(self): return self.__str__() - + def prettyPrint(self, level, tabwidth): pre = ' ' * level * tabwidth - print pre, self.name - print pre, "TZID:", self.tzid - print + print(pre, self.name) + print(pre, "TZID:", self.tzid) + print('') + class RecurringComponent(Component): - """A vCalendar component like VEVENT or VTODO which may recur. - + """ + A vCalendar component like VEVENT or VTODO which may recur. + Any recurring component can have one or multiple RRULE, RDATE, EXRULE, or EXDATE lines, and one or zero DTSTART lines. It can also have a - variety of children that don't have any recurrence information. - + variety of children that don't have any recurrence information. + In the example below, note that dtstart is included in the rruleset. This is not the default behavior for dateutil's rrule implementation unless dtstart would already have been a member of the recurrence rule, and as a @@ -322,49 +352,26 @@ class RecurringComponent(Component): adjusting count down by one if an rrule has a count and dtstart isn't in its result set, but by default, the rruleset property doesn't do this work around, to access it getrruleset must be called with addRDate set True. - - >>> import dateutil.rrule, datetime - >>> vevent = RecurringComponent(name='VEVENT') - >>> vevent.add('rrule').value =u"FREQ=WEEKLY;COUNT=2;INTERVAL=2;BYDAY=TU,TH" - >>> vevent.add('dtstart').value = datetime.datetime(2005, 1, 19, 9) - - When creating rrule's programmatically it should be kept in - mind that count doesn't necessarily mean what rfc2445 says. - - >>> list(vevent.rruleset) - [datetime.datetime(2005, 1, 20, 9, 0), datetime.datetime(2005, 2, 1, 9, 0)] - >>> list(vevent.getrruleset(addRDate=True)) - [datetime.datetime(2005, 1, 19, 9, 0), datetime.datetime(2005, 1, 20, 9, 0)] - - Also note that dateutil will expand all-day events (datetime.date values) to - datetime.datetime value with time 0 and no timezone. - - >>> vevent.dtstart.value = datetime.date(2005,3,18) - >>> list(vevent.rruleset) - [datetime.datetime(2005, 3, 29, 0, 0), datetime.datetime(2005, 3, 31, 0, 0)] - >>> list(vevent.getrruleset(True)) - [datetime.datetime(2005, 3, 18, 0, 0), datetime.datetime(2005, 3, 29, 0, 0)] - + @ivar rruleset: A U{rruleset<https://moin.conectiva.com.br/DateUtil>}. """ def __init__(self, *args, **kwds): super(RecurringComponent, self).__init__(*args, **kwds) - self.isNative=True - #self.clobberedRDates=[] + self.isNative=True def getrruleset(self, addRDate = False): - """Get an rruleset created from self. - + """ + Get an rruleset created from self. + If addRDate is True, add an RDATE for dtstart if it's not included in an RRULE, and count is decremented if it exists. - + Note that for rules which don't match DTSTART, DTSTART may not appear in list(rruleset), although it should. By default, an RDATE is not created in these cases, and count isn't updated, so dateutil may list a spurious occurrence. - """ rruleset = None for name in DATESANDRULES: @@ -372,9 +379,9 @@ class RecurringComponent(Component): for line in self.contents.get(name, ()): # don't bother creating a rruleset unless there's a rule if rruleset is None: - rruleset = dateutil.rrule.rruleset() + rruleset = rrule.rruleset() if addfunc is None: - addfunc=getattr(rruleset, name) + addfunc = getattr(rruleset, name) if name in DATENAMES: if type(line.value[0]) == datetime.datetime: @@ -388,27 +395,29 @@ class RecurringComponent(Component): elif name in RULENAMES: try: dtstart = self.dtstart.value - except AttributeError, KeyError: + except (AttributeError, KeyError): # Special for VTODO - try DUE property instead try: if self.name == "VTODO": dtstart = self.due.value else: # if there's no dtstart, just return None + print('failed to get dtstart with VTODO') return None - except AttributeError, KeyError: + except (AttributeError, KeyError): # if there's no due, just return None + print('failed to find DUE at all.') return None - # rrulestr complains about unicode, so cast to str # a Ruby iCalendar library escapes semi-colons in rrules, # so also remove any backslashes - value = str(line.value).replace('\\', '') - rule = dateutil.rrule.rrulestr(value, dtstart=dtstart) - until = rule._until - if until is not None and \ - isinstance(dtstart, datetime.datetime) and \ - (until.tzinfo != dtstart.tzinfo): + value = str_(line.value).replace('\\', '') + rule = rrule.rrulestr(value, dtstart=dtstart) + until = rule._until + + if until is not None and isinstance(dtstart, + datetime.datetime) and \ + (until.tzinfo != dtstart.tzinfo): # dateutil converts the UNTIL date to a datetime, # check to see if the UNTIL parameter value was a date vals = dict(pair.split('=') for pair in @@ -417,26 +426,42 @@ class RecurringComponent(Component): until = datetime.datetime.combine(until.date(), dtstart.time()) # While RFC2445 says UNTIL MUST be UTC, Chandler allows - # floating recurring events, and uses floating UNTIL values. - # Also, some odd floating UNTIL but timezoned DTSTART values - # have shown up in the wild, so put floating UNTIL values - # DTSTART's timezone + # floating recurring events, and uses floating UNTIL + # values. Also, some odd floating UNTIL but timezoned + # DTSTART values have shown up in the wild, so put + # floating UNTIL values DTSTART's timezone if until.tzinfo is None: until = until.replace(tzinfo=dtstart.tzinfo) if dtstart.tzinfo is not None: until = until.astimezone(dtstart.tzinfo) + # RFC2445 actually states that UNTIL must be a UTC + # value. Whilst the changes above work OK, one problem + # case is if DTSTART is floating but UNTIL is properly + # specified as UTC (or with a TZID). In that case + # dateutil will fail datetime comparisons. There is no + # easy solution to this as there is no obvious timezone + # (at this point) to do proper floating time offset + # comparisons. The best we can do is treat the UNTIL + # value as floating. This could mean incorrect + # determination of the last instance. The better + # solution here is to encourage clients to use COUNT + # rather than UNTIL when DTSTART is floating. + if dtstart.tzinfo is None: + until = until.replace(tzinfo=None) + rule._until = until - + # add the rrule or exrule to the rruleset addfunc(rule) - + if name == 'rrule' and addRDate: try: - # dateutils does not work with all-day (datetime.date) items - # so we need to convert to a datetime.datetime - # (which is what dateutils does internally) + # dateutils does not work with all-day + # (datetime.date) items so we need to convert to a + # datetime.datetime (which is what dateutils + # does internally) if not isinstance(dtstart, datetime.datetime): adddtstart = datetime.datetime.fromordinal(dtstart.toordinal()) else: @@ -447,23 +472,22 @@ class RecurringComponent(Component): else: added = False except IndexError: - # it's conceivable that an rrule might have 0 datetimes + # it's conceivable that an rrule has 0 datetimes added = False if added and rruleset._rrule[-1]._count != None: rruleset._rrule[-1]._count -= 1 return rruleset def setrruleset(self, rruleset): - # Get DTSTART from component (or DUE if no DTSTART in a VTODO) try: dtstart = self.dtstart.value - except AttributeError, KeyError: + except (AttributeError, KeyError): if self.name == "VTODO": dtstart = self.due.value else: raise - + isDate = datetime.date == type(dtstart) if isDate: dtstart = datetime.datetime(dtstart.year,dtstart.month, dtstart.day) @@ -473,7 +497,7 @@ class RecurringComponent(Component): untilSerialize = lambda x: dateTimeToString(x, True) for name in DATESANDRULES: - if hasattr(self.contents, name): + if name in self.contents: del self.contents[name] setlist = getattr(rruleset, '_' + name) if name in DATENAMES: @@ -486,19 +510,19 @@ class RecurringComponent(Component): self.add(name).value = setlist elif name in RULENAMES: for rule in setlist: - buf = StringIO.StringIO() + buf = six.StringIO() buf.write('FREQ=') buf.write(FREQUENCIES[rule._freq]) - + values = {} - + if rule._interval != 1: values['INTERVAL'] = [str(rule._interval)] if rule._wkst != 0: # wkst defaults to Monday values['WKST'] = [WEEKDAYS[rule._wkst]] if rule._bysetpos is not None: values['BYSETPOS'] = [str(i) for i in rule._bysetpos] - + if rule._count is not None: values['COUNT'] = [str(rule._count)] elif rule._until is not None: @@ -506,22 +530,21 @@ class RecurringComponent(Component): days = [] if (rule._byweekday is not None and ( - dateutil.rrule.WEEKLY != rule._freq or - len(rule._byweekday) != 1 or + rrule.WEEKLY != rule._freq or + len(rule._byweekday) != 1 or rule._dtstart.weekday() != rule._byweekday[0])): # ignore byweekday if freq is WEEKLY and day correlates - # with dtstart because it was automatically set by - # dateutil - days.extend(WEEKDAYS[n] for n in rule._byweekday) - + # with dtstart because it was automatically set by dateutil + days.extend(WEEKDAYS[n] for n in rule._byweekday) + if rule._bynweekday is not None: - days.extend(str(n) + WEEKDAYS[day] for day, n in rule._bynweekday) - + days.extend(n + WEEKDAYS[day] for day, n in rule._bynweekday) + if len(days) > 0: - values['BYDAY'] = days - + values['BYDAY'] = days + if rule._bymonthday is not None and len(rule._bymonthday) > 0: - if not (rule._freq <= dateutil.rrule.MONTHLY and + if not (rule._freq <= rrule.MONTHLY and len(rule._bymonthday) == 1 and rule._bymonthday[0] == rule._dtstart.day): # ignore bymonthday if it's generated by dateutil @@ -533,7 +556,7 @@ class RecurringComponent(Component): if rule._bymonth is not None and len(rule._bymonth) > 0: if (rule._byweekday is not None or len(rule._bynweekday or ()) > 0 or - not (rule._freq == dateutil.rrule.YEARLY and + not (rule._freq == rrule.YEARLY and len(rule._bymonth) == 1 and rule._bymonth[0] == rule._dtstart.month)): # ignore bymonth if it's generated by dateutil @@ -546,8 +569,7 @@ class RecurringComponent(Component): # byhour, byminute, bysecond are always ignored for now - - for key, paramvals in values.iteritems(): + for key, paramvals in values.items(): buf.write(';') buf.write(key) buf.write('=') @@ -555,29 +577,32 @@ class RecurringComponent(Component): self.add(name).value = buf.getvalue() - - rruleset = property(getrruleset, setrruleset) def __setattr__(self, name, value): - """For convenience, make self.contents directly accessible.""" + """ + For convenience, make self.contents directly accessible. + """ if name == 'rruleset': self.setrruleset(value) else: super(RecurringComponent, self).__setattr__(name, value) + class TextBehavior(behavior.Behavior): - """Provide backslash escape encoding/decoding for single valued properties. - + """ + Provide backslash escape encoding/decoding for single valued properties. + TextBehavior also deals with base64 encoding if the ENCODING parameter is explicitly set to BASE64. - """ base64string = 'BASE64' # vCard uses B - + @classmethod def decode(cls, line): - """Remove backslash escaping from line.value.""" + """ + Remove backslash escaping from line.value. + """ if line.encoded: encoding = getattr(line, 'encoding_param', None) if encoding and encoding.upper() == cls.base64string: @@ -585,75 +610,86 @@ class TextBehavior(behavior.Behavior): else: line.value = stringToTextValues(line.value)[0] line.encoded=False - + @classmethod def encode(cls, line): - """Backslash escape line.value.""" + """ + Backslash escape line.value. + """ if not line.encoded: encoding = getattr(line, 'encoding_param', None) if encoding and encoding.upper() == cls.base64string: line.value = line.value.encode('base64').replace('\n', '') else: - line.value = backslashEscape(line.value) + line.value = backslashEscape(str_(line.value)) line.encoded=True + class VCalendarComponentBehavior(behavior.Behavior): defaultBehavior = TextBehavior isComponent = True + class RecurringBehavior(VCalendarComponentBehavior): - """Parent Behavior for components which should be RecurringComponents.""" + """ + Parent Behavior for components which should be RecurringComponents. + """ hasNative = True - + @staticmethod def transformToNative(obj): - """Turn a recurring Component into a RecurringComponent.""" + """ + Turn a recurring Component into a RecurringComponent. + """ if not obj.isNative: object.__setattr__(obj, '__class__', RecurringComponent) obj.isNative = True return obj - + @staticmethod def transformFromNative(obj): if obj.isNative: object.__setattr__(obj, '__class__', Component) obj.isNative = False return obj - - @staticmethod + + @staticmethod def generateImplicitParameters(obj): - """Generate a UID if one does not exist. - + """ + Generate a UID if one does not exist. + This is just a dummy implementation, for now. - """ if not hasattr(obj, 'uid'): - rand = str(int(random.random() * 100000)) + rand = int(random.random() * 100000) now = datetime.datetime.now(utc) now = dateTimeToString(now) host = socket.gethostname() - obj.add(ContentLine('UID', [], now + '-' + rand + '@' + host)) - - + obj.add(ContentLine('UID', [], "{0} - {1}@{2}".format(now, rand, + host))) + + class DateTimeBehavior(behavior.Behavior): - """Parent Behavior for ContentLines containing one DATE-TIME.""" + """ + Parent Behavior for ContentLines containing one DATE-TIME. + """ hasNative = True @staticmethod def transformToNative(obj): - """Turn obj.value into a datetime. + """ + Turn obj.value into a datetime. RFC2445 allows times without time zone information, "floating times" in some properties. Mostly, this isn't what you want, but when parsing a file, real floating times are noted by setting to 'TRUE' the X-VOBJ-FLOATINGTIME-ALLOWED parameter. - """ if obj.isNative: return obj obj.isNative = True if obj.value == '': return obj - obj.value=str(obj.value) - #we're cheating a little here, parseDtstart allows DATE + obj.value=obj.value + # we're cheating a little here, parseDtstart allows DATE obj.value=parseDtstart(obj) if obj.value.tzinfo is None: obj.params['X-VOBJ-FLOATINGTIME-ALLOWED'] = ['TRUE'] @@ -665,7 +701,9 @@ class DateTimeBehavior(behavior.Behavior): @classmethod def transformFromNative(cls, obj): - """Replace the datetime in obj.value with an ISO 8601 string.""" + """ + Replace the datetime in obj.value with an ISO 8601 string. + """ if obj.isNative: obj.isNative = False tzid = TimezoneComponent.registerTzinfo(obj.value.tzinfo) @@ -679,21 +717,31 @@ class DateTimeBehavior(behavior.Behavior): return obj + class UTCDateTimeBehavior(DateTimeBehavior): - """A value which must be specified in UTC.""" + """ + A value which must be specified in UTC. + """ forceUTC = True + class DateOrDateTimeBehavior(behavior.Behavior): - """Parent Behavior for ContentLines containing one DATE or DATE-TIME.""" + """ + Parent Behavior for ContentLines containing one DATE or DATE-TIME. + """ hasNative = True @staticmethod def transformToNative(obj): - """Turn obj.value into a date or datetime.""" - if obj.isNative: return obj + """ + Turn obj.value into a date or datetime. + """ + if obj.isNative: + return obj obj.isNative = True - if obj.value == '': return obj - obj.value=str(obj.value) + if obj.value == '': + return obj + obj.value=obj.value obj.value=parseDtstart(obj, allowSignatureMismatch=True) if getattr(obj, 'value_param', 'DATE-TIME').upper() == 'DATE-TIME': if hasattr(obj, 'tzid_param'): @@ -704,19 +752,22 @@ class DateOrDateTimeBehavior(behavior.Behavior): @staticmethod def transformFromNative(obj): - """Replace the date or datetime in obj.value with an ISO 8601 string.""" + """ + Replace the date or datetime in obj.value with an ISO 8601 string. + """ if type(obj.value) == datetime.date: obj.isNative = False obj.value_param = 'DATE' obj.value = dateToString(obj.value) return obj - else: return DateTimeBehavior.transformFromNative(obj) + else: + return DateTimeBehavior.transformFromNative(obj) + class MultiDateBehavior(behavior.Behavior): """ Parent Behavior for ContentLines containing one or more DATE, DATE-TIME, or PERIOD. - """ hasNative = True @@ -725,7 +776,6 @@ class MultiDateBehavior(behavior.Behavior): """ Turn obj.value into a list of dates, datetimes, or (datetime, timedelta) tuples. - """ if obj.isNative: return obj @@ -749,7 +799,6 @@ class MultiDateBehavior(behavior.Behavior): """ Replace the date, datetime or period tuples in obj.value with appropriate strings. - """ if obj.value and type(obj.value[0]) == datetime.date: obj.isNative = False @@ -771,43 +820,52 @@ class MultiDateBehavior(behavior.Behavior): obj.value = ','.join(transformed) return obj + class MultiTextBehavior(behavior.Behavior): - """Provide backslash escape encoding/decoding of each of several values. - + """ + Provide backslash escape encoding/decoding of each of several values. + After transformation, value is a list of strings. - """ listSeparator = "," @classmethod def decode(cls, line): - """Remove backslash escaping from line.value, then split on commas.""" + """ + Remove backslash escaping from line.value, then split on commas. + """ if line.encoded: line.value = stringToTextValues(line.value, listSeparator=cls.listSeparator) line.encoded=False - + @classmethod def encode(cls, line): - """Backslash escape line.value.""" + """ + Backslash escape line.value. + """ if not line.encoded: - line.value = cls.listSeparator.join(backslashEscape(val) for val in line.value) + line.value = cls.listSeparator.join(backslashEscape(val) + for val in line.value) line.encoded=True - + class SemicolonMultiTextBehavior(MultiTextBehavior): listSeparator = ";" -#------------------------ Registered Behavior subclasses ----------------------- + +# ------------------------ Registered Behavior subclasses ---------------------- class VCalendar2_0(VCalendarComponentBehavior): - """vCalendar 2.0 behavior. With added VAVAILABILITY support.""" + """ + vCalendar 2.0 behavior. With added VAVAILABILITY support. + """ name = 'VCALENDAR' description = 'vCalendar 2.0, also known as iCalendar.' versionString = '2.0' sortFirst = ('version', 'calscale', 'method', 'prodid', 'vtimezone') - knownChildren = {'CALSCALE': (0, 1, None),#min, max, behaviorRegistry id + knownChildren = {'CALSCALE': (0, 1, None), # min, max, behaviorRegistry id 'METHOD': (0, 1, None), - 'VERSION': (0, 1, None),#required, but auto-generated + 'VERSION': (0, 1, None), # required, but auto-generated 'PRODID': (1, 1, None), 'VTIMEZONE': (0, None, None), 'VEVENT': (0, None, None), @@ -816,14 +874,14 @@ class VCalendar2_0(VCalendarComponentBehavior): 'VFREEBUSY': (0, None, None), 'VAVAILABILITY': (0, None, None), } - + @classmethod def generateImplicitParameters(cls, obj): - """Create PRODID, VERSION, and VTIMEZONEs if needed. - + """ + Create PRODID, VERSION, and VTIMEZONEs if needed. + VTIMEZONEs will need to exist whenever TZID parameters exist or when datetimes with tzinfo exist. - """ for comp in obj.components(): if comp.behavior is not None: @@ -854,7 +912,7 @@ class VCalendar2_0(VCalendarComponentBehavior): for child in obj.getChildren(): if obj.name != 'VTIMEZONE': findTzids(child, table) - + findTzids(obj, tzidsUsed) oldtzids = [toUnicode(x.tzid.value) for x in getattr(obj, 'vtimezone_list', [])] for tzid in tzidsUsed.keys(): @@ -863,17 +921,20 @@ class VCalendar2_0(VCalendarComponentBehavior): obj.add(TimezoneComponent(tzinfo=getTzid(tzid))) registerBehavior(VCalendar2_0) + class VTimezone(VCalendarComponentBehavior): - """Timezone behavior.""" + """ + Timezone behavior. + """ name = 'VTIMEZONE' hasNative = True description = 'A grouping of component properties that defines a time zone.' sortFirst = ('tzid', 'last-modified', 'tzurl', 'standard', 'daylight') - knownChildren = {'TZID': (1, 1, None),#min, max, behaviorRegistry id + knownChildren = {'TZID': (1, 1, None), # min, max, behaviorRegistry id 'LAST-MODIFIED':(0, 1, None), 'TZURL': (0, 1, None), - 'STANDARD': (0, None, None),#NOTE: One of Standard or - 'DAYLIGHT': (0, None, None) # Daylight must appear + 'STANDARD': (0, None, None), # NOTE: One of Standard or + 'DAYLIGHT': (0, None, None) # Daylight must appear } @classmethod @@ -882,8 +943,8 @@ class VTimezone(VCalendarComponentBehavior): if raiseException: m = "VTIMEZONE components must contain a valid TZID" raise ValidateError(m) - return False - if obj.contents.has_key('standard') or obj.contents.has_key('daylight'): + return False + if 'standard' in obj.contents or 'daylight' in obj.contents: return super(VTimezone, cls).validate(obj, raiseException, *args) else: if raiseException: @@ -906,9 +967,11 @@ class VTimezone(VCalendarComponentBehavior): return obj registerBehavior(VTimezone) + class TZID(behavior.Behavior): - """Don't use TextBehavior for TZID. - + """ + Don't use TextBehavior for TZID. + RFC2445 only allows TZID lines to be paramtext, so they shouldn't need any encoding or decoding. Unfortunately, some Microsoft products use commas in TZIDs which should NOT be treated as a multi-valued text property, nor @@ -917,9 +980,10 @@ class TZID(behavior.Behavior): """ registerBehavior(TZID) + class DaylightOrStandard(VCalendarComponentBehavior): hasNative = False - knownChildren = {'DTSTART': (1, 1, None),#min, max, behaviorRegistry id + knownChildren = {'DTSTART': (1, 1, None), # min, max, behaviorRegistry id 'RRULE': (0, 1, None)} registerBehavior(DaylightOrStandard, 'STANDARD') @@ -927,32 +991,34 @@ registerBehavior(DaylightOrStandard, 'DAYLIGHT') class VEvent(RecurringBehavior): - """Event behavior.""" + """ + Event behavior. + """ name='VEVENT' sortFirst = ('uid', 'recurrence-id', 'dtstart', 'duration', 'dtend') description='A grouping of component properties, and possibly including \ "VALARM" calendar components, that represents a scheduled \ amount of time on a calendar.' - knownChildren = {'DTSTART': (0, 1, None),#min, max, behaviorRegistry id - 'CLASS': (0, 1, None), + knownChildren = {'DTSTART': (0, 1, None), # min, max, behaviorRegistry id + 'CLASS': (0, 1, None), 'CREATED': (0, 1, None), - 'DESCRIPTION': (0, 1, None), - 'GEO': (0, 1, None), + 'DESCRIPTION': (0, 1, None), + 'GEO': (0, 1, None), 'LAST-MODIFIED':(0, 1, None), - 'LOCATION': (0, 1, None), - 'ORGANIZER': (0, 1, None), - 'PRIORITY': (0, 1, None), + 'LOCATION': (0, 1, None), + 'ORGANIZER': (0, 1, None), + 'PRIORITY': (0, 1, None), 'DTSTAMP': (0, 1, None), - 'SEQUENCE': (0, 1, None), - 'STATUS': (0, 1, None), - 'SUMMARY': (0, 1, None), - 'TRANSP': (0, 1, None), - 'UID': (1, 1, None), - 'URL': (0, 1, None), - 'RECURRENCE-ID':(0, 1, None), - 'DTEND': (0, 1, None), #NOTE: Only one of DtEnd or - 'DURATION': (0, 1, None), # Duration can appear + 'SEQUENCE': (0, 1, None), + 'STATUS': (0, 1, None), + 'SUMMARY': (0, 1, None), + 'TRANSP': (0, 1, None), + 'UID': (1, 1, None), + 'URL': (0, 1, None), + 'RECURRENCE-ID':(0, 1, None), + 'DTEND': (0, 1, None), # NOTE: Only one of DtEnd or + 'DURATION': (0, 1, None), # Duration can appear 'ATTACH': (0, None, None), 'ATTENDEE': (0, None, None), 'CATEGORIES': (0, None, None), @@ -970,7 +1036,7 @@ class VEvent(RecurringBehavior): @classmethod def validate(cls, obj, raiseException, *args): - if obj.contents.has_key('dtend') and obj.contents.has_key('duration'): + if 'dtend' in obj.contents and 'duration' in obj.contents: if raiseException: m = "VEVENT components cannot contain both DTEND and DURATION\ components" @@ -978,36 +1044,38 @@ class VEvent(RecurringBehavior): return False else: return super(VEvent, cls).validate(obj, raiseException, *args) - + registerBehavior(VEvent) class VTodo(RecurringBehavior): - """To-do behavior.""" + """ + To-do behavior. + """ name='VTODO' description='A grouping of component properties and possibly "VALARM" \ calendar components that represent an action-item or \ assignment.' - knownChildren = {'DTSTART': (0, 1, None),#min, max, behaviorRegistry id + knownChildren = {'DTSTART': (0, 1, None), # min, max, behaviorRegistry id 'CLASS': (0, 1, None), 'COMPLETED': (0, 1, None), 'CREATED': (0, 1, None), - 'DESCRIPTION': (0, 1, None), - 'GEO': (0, 1, None), + 'DESCRIPTION': (0, 1, None), + 'GEO': (0, 1, None), 'LAST-MODIFIED':(0, 1, None), - 'LOCATION': (0, 1, None), - 'ORGANIZER': (0, 1, None), - 'PERCENT': (0, 1, None), - 'PRIORITY': (0, 1, None), + 'LOCATION': (0, 1, None), + 'ORGANIZER': (0, 1, None), + 'PERCENT': (0, 1, None), + 'PRIORITY': (0, 1, None), 'DTSTAMP': (0, 1, None), - 'SEQUENCE': (0, 1, None), - 'STATUS': (0, 1, None), + 'SEQUENCE': (0, 1, None), + 'STATUS': (0, 1, None), 'SUMMARY': (0, 1, None), - 'UID': (0, 1, None), - 'URL': (0, 1, None), - 'RECURRENCE-ID':(0, 1, None), - 'DUE': (0, 1, None), #NOTE: Only one of Due or - 'DURATION': (0, 1, None), # Duration can appear + 'UID': (0, 1, None), + 'URL': (0, 1, None), + 'RECURRENCE-ID':(0, 1, None), + 'DUE': (0, 1, None), # NOTE: Only one of Due or + 'DURATION': (0, 1, None), # Duration can appear 'ATTACH': (0, None, None), 'ATTENDEE': (0, None, None), 'CATEGORIES': (0, None, None), @@ -1025,7 +1093,7 @@ class VTodo(RecurringBehavior): @classmethod def validate(cls, obj, raiseException, *args): - if obj.contents.has_key('due') and obj.contents.has_key('duration'): + if 'due' in obj.contents and 'duration' in obj.contents: if raiseException: m = "VTODO components cannot contain both DUE and DURATION\ components" @@ -1033,26 +1101,28 @@ class VTodo(RecurringBehavior): return False else: return super(VTodo, cls).validate(obj, raiseException, *args) - + registerBehavior(VTodo) class VJournal(RecurringBehavior): - """Journal entry behavior.""" + """ + Journal entry behavior. + """ name='VJOURNAL' - knownChildren = {'DTSTART': (0, 1, None),#min, max, behaviorRegistry id - 'CLASS': (0, 1, None), + knownChildren = {'DTSTART': (0, 1, None), # min, max, behaviorRegistry id + 'CLASS': (0, 1, None), 'CREATED': (0, 1, None), - 'DESCRIPTION': (0, 1, None), + 'DESCRIPTION': (0, 1, None), 'LAST-MODIFIED':(0, 1, None), - 'ORGANIZER': (0, 1, None), + 'ORGANIZER': (0, 1, None), 'DTSTAMP': (0, 1, None), - 'SEQUENCE': (0, 1, None), - 'STATUS': (0, 1, None), - 'SUMMARY': (0, 1, None), - 'UID': (0, 1, None), - 'URL': (0, 1, None), - 'RECURRENCE-ID':(0, 1, None), + 'SEQUENCE': (0, 1, None), + 'STATUS': (0, 1, None), + 'SUMMARY': (0, 1, None), + 'UID': (0, 1, None), + 'URL': (0, 1, None), + 'RECURRENCE-ID':(0, 1, None), 'ATTACH': (0, None, None), 'ATTENDEE': (0, None, None), 'CATEGORIES': (0, None, None), @@ -1069,37 +1139,22 @@ registerBehavior(VJournal) class VFreeBusy(VCalendarComponentBehavior): - """Free/busy state behavior. - - >>> vfb = newFromBehavior('VFREEBUSY') - >>> vfb.add('uid').value = 'test' - >>> vfb.add('dtstart').value = datetime.datetime(2006, 2, 16, 1, tzinfo=utc) - >>> vfb.add('dtend').value = vfb.dtstart.value + twoHours - >>> vfb.add('freebusy').value = [(vfb.dtstart.value, twoHours / 2)] - >>> vfb.add('freebusy').value = [(vfb.dtstart.value, vfb.dtend.value)] - >>> print vfb.serialize() - BEGIN:VFREEBUSY - UID:test - DTSTART:20060216T010000Z - DTEND:20060216T030000Z - FREEBUSY:20060216T010000Z/PT1H - FREEBUSY:20060216T010000Z/20060216T030000Z - END:VFREEBUSY - + """ + Free/busy state behavior. """ name='VFREEBUSY' description='A grouping of component properties that describe either a \ request for free/busy time, describe a response to a request \ for free/busy time or describe a published set of busy time.' sortFirst = ('uid', 'dtstart', 'duration', 'dtend') - knownChildren = {'DTSTART': (0, 1, None),#min, max, behaviorRegistry id + knownChildren = {'DTSTART': (0, 1, None), # min, max, behaviorRegistry id 'CONTACT': (0, 1, None), 'DTEND': (0, 1, None), 'DURATION': (0, 1, None), - 'ORGANIZER': (0, 1, None), - 'DTSTAMP': (0, 1, None), - 'UID': (0, 1, None), - 'URL': (0, 1, None), + 'ORGANIZER': (0, 1, None), + 'DTSTAMP': (0, 1, None), + 'UID': (0, 1, None), + 'URL': (0, 1, None), 'ATTENDEE': (0, None, None), 'COMMENT': (0, None, None), 'FREEBUSY': (0, None, None), @@ -1109,12 +1164,14 @@ registerBehavior(VFreeBusy) class VAlarm(VCalendarComponentBehavior): - """Alarm behavior.""" + """ + Alarm behavior. + """ name='VALARM' description='Alarms describe when and how to provide alerts about events \ and to-dos.' - knownChildren = {'ACTION': (1, 1, None),#min, max, behaviorRegistry id - 'TRIGGER': (1, 1, None), + knownChildren = {'ACTION': (1, 1, None), # min, max, behaviorRegistry id + 'TRIGGER': (1, 1, None), 'DURATION': (0, 1, None), 'REPEAT': (0, 1, None), 'DESCRIPTION': (0, 1, None) @@ -1122,7 +1179,9 @@ class VAlarm(VCalendarComponentBehavior): @staticmethod def generateImplicitParameters(obj): - """Create default ACTION and TRIGGER if they're not set.""" + """ + Create default ACTION and TRIGGER if they're not set. + """ try: obj.action except AttributeError: @@ -1136,73 +1195,7 @@ class VAlarm(VCalendarComponentBehavior): @classmethod def validate(cls, obj, raiseException, *args): """ - #TODO - audioprop = 2*( - - ; 'action' and 'trigger' are both REQUIRED, - ; but MUST NOT occur more than once - - action / trigger / - - ; 'duration' and 'repeat' are both optional, - ; and MUST NOT occur more than once each, - ; but if one occurs, so MUST the other - - duration / repeat / - - ; the following is optional, - ; but MUST NOT occur more than once - - attach / - - dispprop = 3*( - - ; the following are all REQUIRED, - ; but MUST NOT occur more than once - - action / description / trigger / - - ; 'duration' and 'repeat' are both optional, - ; and MUST NOT occur more than once each, - ; but if one occurs, so MUST the other - - duration / repeat / - - emailprop = 5*( - - ; the following are all REQUIRED, - ; but MUST NOT occur more than once - - action / description / trigger / summary - - ; the following is REQUIRED, - ; and MAY occur more than once - - attendee / - - ; 'duration' and 'repeat' are both optional, - ; and MUST NOT occur more than once each, - ; but if one occurs, so MUST the other - - duration / repeat / - - procprop = 3*( - - ; the following are all REQUIRED, - ; but MUST NOT occur more than once - - action / attach / trigger / - - ; 'duration' and 'repeat' are both optional, - ; and MUST NOT occur more than once each, - ; but if one occurs, so MUST the other - - duration / repeat / - - ; 'description' is optional, - ; and MUST NOT occur more than once - - description / + # TODO if obj.contents.has_key('dtend') and obj.contents.has_key('duration'): if raiseException: m = "VEVENT components cannot contain both DTEND and DURATION\ @@ -1213,46 +1206,19 @@ class VAlarm(VCalendarComponentBehavior): return super(VEvent, cls).validate(obj, raiseException, *args) """ return True - registerBehavior(VAlarm) + class VAvailability(VCalendarComponentBehavior): - """Availability state behavior. - - >>> vav = newFromBehavior('VAVAILABILITY') - >>> vav.add('uid').value = 'test' - >>> vav.add('dtstamp').value = datetime.datetime(2006, 2, 15, 0, tzinfo=utc) - >>> vav.add('dtstart').value = datetime.datetime(2006, 2, 16, 0, tzinfo=utc) - >>> vav.add('dtend').value = datetime.datetime(2006, 2, 17, 0, tzinfo=utc) - >>> vav.add('busytype').value = "BUSY" - >>> av = newFromBehavior('AVAILABLE') - >>> av.add('uid').value = 'test1' - >>> av.add('dtstamp').value = datetime.datetime(2006, 2, 15, 0, tzinfo=utc) - >>> av.add('dtstart').value = datetime.datetime(2006, 2, 16, 9, tzinfo=utc) - >>> av.add('dtend').value = datetime.datetime(2006, 2, 16, 12, tzinfo=utc) - >>> av.add('summary').value = "Available in the morning" - >>> ignore = vav.add(av) - >>> print vav.serialize() - BEGIN:VAVAILABILITY - UID:test - DTSTART:20060216T000000Z - DTEND:20060217T000000Z - BEGIN:AVAILABLE - UID:test1 - DTSTART:20060216T090000Z - DTEND:20060216T120000Z - DTSTAMP:20060215T000000Z - SUMMARY:Available in the morning - END:AVAILABLE - BUSYTYPE:BUSY - DTSTAMP:20060215T000000Z - END:VAVAILABILITY + """ + Availability state behavior. + Used to represent user's available time slots. """ name='VAVAILABILITY' description='A component used to represent a user\'s available time slots.' sortFirst = ('uid', 'dtstart', 'duration', 'dtend') - knownChildren = {'UID': (1, 1, None),#min, max, behaviorRegistry id + knownChildren = {'UID': (1, 1, None), # min, max, behaviorRegistry id 'DTSTAMP': (1, 1, None), 'BUSYTYPE': (0, 1, None), 'CREATED': (0, 1, None), @@ -1272,33 +1238,34 @@ class VAvailability(VCalendarComponentBehavior): @classmethod def validate(cls, obj, raiseException, *args): - if obj.contents.has_key('dtend') and obj.contents.has_key('duration'): + if 'dtend' in obj.contents and 'duration' in obj.contents: if raiseException: - m = "VAVAILABILITY components cannot contain both DTEND and DURATION\ - components" + m = "VAVAILABILITY components cannot contain both DTEND and DURATION components" raise ValidateError(m) return False else: return super(VAvailability, cls).validate(obj, raiseException, *args) - registerBehavior(VAvailability) + class Available(RecurringBehavior): - """Event behavior.""" + """ + Event behavior. + """ name='AVAILABLE' sortFirst = ('uid', 'recurrence-id', 'dtstart', 'duration', 'dtend') description='Defines a period of time in which a user is normally available.' - knownChildren = {'DTSTAMP': (1, 1, None),#min, max, behaviorRegistry id + knownChildren = {'DTSTAMP': (1, 1, None), # min, max, behaviorRegistry id 'DTSTART': (1, 1, None), - 'UID': (1, 1, None), - 'DTEND': (0, 1, None), #NOTE: One of DtEnd or - 'DURATION': (0, 1, None), # Duration must appear, but not both + 'UID': (1, 1, None), + 'DTEND': (0, 1, None), # NOTE: One of DtEnd or + 'DURATION': (0, 1, None), # Duration must appear, but not both 'CREATED': (0, 1, None), 'LAST-MODIFIED':(0, 1, None), - 'RECURRENCE-ID':(0, 1, None), + 'RECURRENCE-ID':(0, 1, None), 'RRULE': (0, 1, None), - 'SUMMARY': (0, 1, None), + 'SUMMARY': (0, 1, None), 'CATEGORIES': (0, None, None), 'COMMENT': (0, None, None), 'CONTACT': (0, None, None), @@ -1308,8 +1275,8 @@ class Available(RecurringBehavior): @classmethod def validate(cls, obj, raiseException, *args): - has_dtend = obj.contents.has_key('dtend') - has_duration = obj.contents.has_key('duration') + has_dtend = 'dtend' in obj.contents + has_duration = 'duration' in obj.contents if has_dtend and has_duration: if raiseException: m = "AVAILABLE components cannot contain both DTEND and DURATION\ @@ -1324,25 +1291,30 @@ class Available(RecurringBehavior): return False else: return super(Available, cls).validate(obj, raiseException, *args) - registerBehavior(Available) + class Duration(behavior.Behavior): - """Behavior for Duration ContentLines. Transform to datetime.timedelta.""" + """ + Behavior for Duration ContentLines. Transform to datetime.timedelta. + """ name = 'DURATION' hasNative = True @staticmethod def transformToNative(obj): - """Turn obj.value into a datetime.timedelta.""" - if obj.isNative: return obj + """ + Turn obj.value into a datetime.timedelta. + """ + if obj.isNative: + return obj obj.isNative = True - obj.value=str(obj.value) + obj.value=obj.value if obj.value == '': return obj else: deltalist=stringToDurations(obj.value) - #When can DURATION have multiple durations? For now: + # When can DURATION have multiple durations? For now: if len(deltalist) == 1: obj.value = deltalist[0] return obj @@ -1351,17 +1323,21 @@ class Duration(behavior.Behavior): @staticmethod def transformFromNative(obj): - """Replace the datetime.timedelta in obj.value with an RFC2445 string. """ - if not obj.isNative: return obj + Replace the datetime.timedelta in obj.value with an RFC2445 string. + """ + if not obj.isNative: + return obj obj.isNative = False obj.value = timedeltaToString(obj.value) return obj - registerBehavior(Duration) + class Trigger(behavior.Behavior): - """DATE-TIME or DURATION""" + """ + DATE-TIME or DURATION + """ name='TRIGGER' description='This property specifies when an alarm will trigger.' hasNative = True @@ -1369,8 +1345,11 @@ class Trigger(behavior.Behavior): @staticmethod def transformToNative(obj): - """Turn obj.value into a timedelta or datetime.""" - if obj.isNative: return obj + """ + Turn obj.value into a timedelta or datetime. + """ + if obj.isNative: + return obj value = getattr(obj, 'value_param', 'DURATION').upper() if hasattr(obj, 'value_param'): del obj.value_param @@ -1381,7 +1360,7 @@ class Trigger(behavior.Behavior): try: return Duration.transformToNative(obj) except ParseError: - logger.warn("TRIGGER not recognized as DURATION, trying " + logger.warning("TRIGGER not recognized as DURATION, trying " "DATE-TIME, because iCal sometimes exports " "DATE-TIMEs without setting VALUE=DATE-TIME") try: @@ -1393,11 +1372,11 @@ class Trigger(behavior.Behavior): "or as DATE-TIME" raise ParseError(msg) elif value == 'DATE-TIME': - #TRIGGERs with DATE-TIME values must be in UTC, we could validate - #that fact, for now we take it on faith. + # TRIGGERs with DATE-TIME values must be in UTC, we could validate + # that fact, for now we take it on faith. return DateTimeBehavior.transformToNative(obj) else: - raise ParseError("VALUE must be DURATION or DATE-TIME") + raise ParseError("VALUE must be DURATION or DATE-TIME") @staticmethod def transformFromNative(obj): @@ -1407,29 +1386,22 @@ class Trigger(behavior.Behavior): elif type(obj.value) == datetime.timedelta: return Duration.transformFromNative(obj) else: - raise NativeError("Native TRIGGER values must be timedelta or datetime") - + raise NativeError("Native TRIGGER values must be timedelta or " + "datetime") registerBehavior(Trigger) + class PeriodBehavior(behavior.Behavior): - """A list of (date-time, timedelta) tuples. - - >>> line = ContentLine('test', [], '', isNative=True) - >>> line.behavior = PeriodBehavior - >>> line.value = [(datetime.datetime(2006, 2, 16, 10), twoHours)] - >>> line.transformFromNative().value - '20060216T100000/PT2H' - >>> line.transformToNative().value - [(datetime.datetime(2006, 2, 16, 10, 0), datetime.timedelta(0, 7200))] - >>> line.value.append((datetime.datetime(2006, 5, 16, 10), twoHours)) - >>> print line.serialize().strip() - TEST:20060216T100000/PT2H,20060516T100000/PT2H + """ + A list of (date-time, timedelta) tuples. """ hasNative = True - + @staticmethod def transformToNative(obj): - """Convert comma separated periods into tuples.""" + """ + Convert comma separated periods into tuples. + """ if obj.isNative: return obj obj.isNative = True @@ -1439,10 +1411,12 @@ class PeriodBehavior(behavior.Behavior): tzinfo = getTzid(getattr(obj, 'tzid_param', None)) obj.value = [stringToPeriod(x, tzinfo) for x in obj.value.split(",")] return obj - + @classmethod def transformFromNative(cls, obj): - """Convert the list of tuples in obj.value to strings.""" + """ + Convert the list of tuples in obj.value to strings. + """ if obj.isNative: obj.isNative = False transformed = [] @@ -1452,16 +1426,20 @@ class PeriodBehavior(behavior.Behavior): tzid = TimezoneComponent.registerTzinfo(tup[0].tzinfo) if not cls.forceUTC and tzid is not None: obj.tzid_param = tzid - + obj.value = ','.join(transformed) return obj + class FreeBusy(PeriodBehavior): - """Free or busy period of time, must be specified in UTC.""" + """ + Free or busy period of time, must be specified in UTC. + """ name = 'FREEBUSY' forceUTC = True -registerBehavior(FreeBusy) +registerBehavior(FreeBusy, 'FREEBUSY') + class RRule(behavior.Behavior): """ @@ -1471,15 +1449,15 @@ class RRule(behavior.Behavior): registerBehavior(RRule, 'RRULE') registerBehavior(RRule, 'EXRULE') -#------------------------ Registration of common classes ----------------------- +# ------------------------ Registration of common classes ---------------------- utcDateTimeList = ['LAST-MODIFIED', 'CREATED', 'COMPLETED', 'DTSTAMP'] -map(lambda x: registerBehavior(UTCDateTimeBehavior, x), utcDateTimeList) +list(map(lambda x: registerBehavior(UTCDateTimeBehavior, x), utcDateTimeList)) dateTimeOrDateList = ['DTEND', 'DTSTART', 'DUE', 'RECURRENCE-ID'] -map(lambda x: registerBehavior(DateOrDateTimeBehavior, x), - dateTimeOrDateList) - +list(map(lambda x: registerBehavior(DateOrDateTimeBehavior, x), + dateTimeOrDateList)) + registerBehavior(MultiDateBehavior, 'RDATE') registerBehavior(MultiDateBehavior, 'EXDATE') @@ -1487,16 +1465,18 @@ registerBehavior(MultiDateBehavior, 'EXDATE') textList = ['CALSCALE', 'METHOD', 'PRODID', 'CLASS', 'COMMENT', 'DESCRIPTION', 'LOCATION', 'STATUS', 'SUMMARY', 'TRANSP', 'CONTACT', 'RELATED-TO', 'UID', 'ACTION', 'BUSYTYPE'] -map(lambda x: registerBehavior(TextBehavior, x), textList) +list(map(lambda x: registerBehavior(TextBehavior, x), textList)) -multiTextList = ['CATEGORIES', 'RESOURCES'] -map(lambda x: registerBehavior(MultiTextBehavior, x), multiTextList) +list(map(lambda x: registerBehavior(MultiTextBehavior, x), ['CATEGORIES', + 'RESOURCES'])) registerBehavior(SemicolonMultiTextBehavior, 'REQUEST-STATUS') -#------------------------ Serializing helper functions ------------------------- +# ------------------------ Serializing helper functions ------------------------ def numToDigits(num, places): - """Helper, for converting numbers to textual digits.""" + """ + Helper, for converting numbers to textual digits. + """ s = str(num) if len(s) < places: return ("0" * (places - len(s))) + s @@ -1506,37 +1486,45 @@ def numToDigits(num, places): return s def timedeltaToString(delta): - """Convert timedelta to an rfc2445 DURATION.""" - if delta.days == 0: sign = 1 - else: sign = delta.days / abs(delta.days) + """ + Convert timedelta to an ical DURATION. + """ + if delta.days == 0: + sign = 1 + else: + sign = delta.days / abs(delta.days) delta = abs(delta) days = delta.days - hours = delta.seconds / 3600 - minutes = (delta.seconds % 3600) / 60 - seconds = delta.seconds % 60 - out = '' - if sign == -1: out = '-' - out += 'P' - if days: out += str(days) + 'D' - if hours or minutes or seconds: out += 'T' - elif not days: #Deal with zero duration - out += 'T0S' - if hours: out += str(hours) + 'H' - if minutes: out += str(minutes) + 'M' - if seconds: out += str(seconds) + 'S' - return out + hours = int(delta.seconds / 3600) + minutes = int((delta.seconds % 3600) / 60) + seconds = int(delta.seconds % 60) + + output = '' + if sign == -1: + output += '-' + output += 'P' + if days: + output += '{}D'.format(days) + if hours or minutes or seconds: + output += 'T' + elif not days: # Deal with zero duration + output += 'T0S' + if hours: + output += '{}H'.format(hours) + if minutes: + output += '{}M'.format(minutes) + if seconds: + output += '{}S'.format(seconds) + return output def timeToString(dateOrDateTime): """ Wraps dateToString and dateTimeToString, returning the results of either based on the type of the argument """ - # Didn't use isinstance here as date and datetime sometimes evalutes as both - if (type(dateOrDateTime) == datetime.date): - return dateToString(dateOrDateTime) - elif(type(dateOrDateTime) == datetime.datetime): + if hasattr(dateOrDateTime, 'hour'): return dateTimeToString(dateOrDateTime) - + return dateToString(dateOrDateTime) def dateToString(date): year = numToDigits( date.year, 4 ) @@ -1545,24 +1533,27 @@ def dateToString(date): return year + month + day def dateTimeToString(dateTime, convertToUTC=False): - """Ignore tzinfo unless convertToUTC. Output string.""" + """ + Ignore tzinfo unless convertToUTC. Output string. + """ if dateTime.tzinfo and convertToUTC: dateTime = dateTime.astimezone(utc) - if tzinfo_eq(dateTime.tzinfo, utc): utcString = "Z" - else: utcString = "" - year = numToDigits( dateTime.year, 4 ) - month = numToDigits( dateTime.month, 2 ) - day = numToDigits( dateTime.day, 2 ) - hour = numToDigits( dateTime.hour, 2 ) - mins = numToDigits( dateTime.minute, 2 ) - secs = numToDigits( dateTime.second, 2 ) - - return year + month + day + "T" + hour + mins + secs + utcString + datestr = "{0}{1}{2}T{3}{4}{5}".format( + numToDigits( dateTime.year, 4), + numToDigits( dateTime.month, 2), + numToDigits( dateTime.day, 2), + numToDigits( dateTime.hour, 2), + numToDigits( dateTime.minute, 2), + numToDigits( dateTime.second, 2), + ) + if tzinfo_eq(dateTime.tzinfo, utc): + datestr += "Z" + return datestr def deltaToOffset(delta): absDelta = abs(delta) - hours = absDelta.seconds / 3600 + hours = int(absDelta.seconds / 3600) hoursString = numToDigits(hours, 2) minutesString = '00' if absDelta == delta: @@ -1579,11 +1570,11 @@ def periodToString(period, convertToUTC=False): txtend = dateTimeToString(period[1], convertToUTC) return txtstart + "/" + txtend -#----------------------- Parsing functions ------------------------------------- +# ----------------------- Parsing functions ------------------------------------ def isDuration(s): - s = string.upper(s) - return (string.find(s, "P") != -1) and (string.find(s, "P") < 2) + s = s.upper() + return (s.find("P") != -1) and (s.find("P") < 2) def stringToDate(s): year = int( s[0:4] ) @@ -1592,7 +1583,9 @@ def stringToDate(s): return datetime.date(year,month,day) def stringToDateTime(s, tzinfo=None): - """Returns datetime.datetime object.""" + """ + Returns datetime.datetime object. + """ try: year = int( s[0:4] ) month = int( s[4:6] ) @@ -1604,7 +1597,8 @@ def stringToDateTime(s, tzinfo=None): if s[15] == 'Z': tzinfo = utc except: - raise ParseError("'%s' is not a valid DATE-TIME" % s) + raise ParseError("'{0!s}' is not a valid DATE-TIME".format(s)) + year = year and year or 2000 return datetime.datetime(year, month, day, hour, minute, second, 0, tzinfo) @@ -1613,8 +1607,9 @@ def stringToDateTime(s, tzinfo=None): escapableCharList = '\\;,Nn"' def stringToTextValues(s, listSeparator=',', charList=None, strict=False): - """Returns list of strings.""" - + """ + Returns list of strings. + """ if charList is None: charList = escapableCharList @@ -1625,10 +1620,9 @@ def stringToTextValues(s, listSeparator=',', charList=None, strict=False): if strict: raise ParseError(msg) else: - #logger.error(msg) - print msg + print(msg) - #vars which control state machine + # vars which control state machine charIterator = enumerate(s) state = "read normal" @@ -1637,7 +1631,7 @@ def stringToTextValues(s, listSeparator=',', charList=None, strict=False): while True: try: - charIndex, char = charIterator.next() + charIndex, char = next(charIterator) except: char = "eof" @@ -1658,7 +1652,7 @@ def stringToTextValues(s, listSeparator=',', charList=None, strict=False): elif state == "read escaped char": if escapableChar(char): state = "read normal" - if char in 'nN': + if char in 'nN': current.append('\n') else: current.append(char) @@ -1667,56 +1661,57 @@ def stringToTextValues(s, listSeparator=',', charList=None, strict=False): # leave unrecognized escaped characters for later passes current.append('\\' + char) - elif state == "end": #an end state + elif state == "end": # an end state if len(current) or len(results) == 0: current = "".join(current) results.append(current) return results - elif state == "error": #an end state + elif state == "error": # an end state return results else: state = "error" - error("error: unknown state: '%s' reached in %s" % (state, s)) + error("error: unknown state: '{0!s}' reached in {1!s}".format(state, s)) def stringToDurations(s, strict=False): - """Returns list of timedelta objects.""" + """ + Returns list of timedelta objects. + """ def makeTimedelta(sign, week, day, hour, minute, sec): if sign == "-": sign = -1 else: sign = 1 - week = int(week) - day = int(day) - hour = int(hour) - minute = int(minute) - sec = int(sec) - return sign * datetime.timedelta(weeks=week, days=day, hours=hour, minutes=minute, seconds=sec) + week = int(week) + day = int(day) + hour = int(hour) + minute = int(minute) + sec = int(sec) + return sign * datetime.timedelta(weeks=week, days=day, hours=hour, + minutes=minute, seconds=sec) def error(msg): if strict: raise ParseError(msg) else: raise ParseError(msg) - #logger.error(msg) - - #vars which control state machine + + # vars which control state machine charIterator = enumerate(s) - state = "start" + state = "start" durations = [] - current = "" - sign = None - week = 0 - day = 0 - hour = 0 - minute = 0 - sec = 0 + current = "" + sign = None + week = 0 + day = 0 + hour = 0 + minute = 0 + sec = 0 while True: try: - charIndex, char = charIterator.next() + charIndex, char = next(charIterator) except: - charIndex += 1 char = "eof" if state == "start": @@ -1733,16 +1728,16 @@ def stringToDurations(s, strict=False): error("got end-of-line while reading in duration: " + s) elif char in string.digits: state = "read field" - current = current + char #update this part when updating "read field" + current = current + char # update this part when updating "read field" else: state = "error" - print "got unexpected character %s reading in duration: %s" % (char, s) - error("got unexpected character %s reading in duration: %s" % (char, s)) + error("got unexpected character {0} reading in duration: {1}" + .format(char, s)) elif state == "read field": if (char in string.digits): state = "read field" - current = current + char #update part above when updating "read field" + current = current + char # update part above when updating "read field" elif char.upper() == 'T': state = "read field" elif char.upper() == 'W': @@ -1767,42 +1762,42 @@ def stringToDurations(s, strict=False): current = "" elif char == ",": state = "start" - durations.append( makeTimedelta(sign, week, day, hour, minute, sec) ) - current = "" - sign = None - week = None - day = None - hour = None - minute = None - sec = None + durations.append(makeTimedelta(sign, week, day, hour, minute, + sec)) + current = "" + sign = None + week = None + day = None + hour = None + minute = None + sec = None elif char == "eof": state = "end" else: state = "error" error("got unexpected character reading in duration: " + s) - - elif state == "end": #an end state - #print "stuff: %s, durations: %s" % ([current, sign, week, day, hour, minute, sec], durations) + elif state == "end": # an end state if (sign or week or day or hour or minute or sec): - durations.append( makeTimedelta(sign, week, day, hour, minute, sec) ) + durations.append(makeTimedelta(sign, week, day, hour, minute, + sec)) return durations - elif state == "error": #an end state + elif state == "error": # an end state error("in error state") return durations else: state = "error" - error("error: unknown state: '%s' reached in %s" % (state, s)) + error("error: unknown state: '{0!s}' reached in {1!s}".format(state, s)) def parseDtstart(contentline, allowSignatureMismatch=False): - """Convert a contentline's value into a date or date-time. - + """ + Convert a contentline's value into a date or date-time. + A variety of clients don't serialize dates with the appropriate VALUE parameter, so rather than failing on these (technically invalid) lines, if allowSignatureMismatch is True, try to parse both varieties. - """ tzinfo = getTzid(getattr(contentline, 'tzid_param', None)) valueParam = getattr(contentline, 'value_param', 'DATE-TIME').upper() @@ -1818,10 +1813,10 @@ def parseDtstart(contentline, allowSignatureMismatch=False): raise def stringToPeriod(s, tzinfo=None): - values = string.split(s, "/") + values = s.split("/") start = stringToDateTime(values[0], tzinfo) valEnd = values[1] - if isDuration(valEnd): #period-start = date-time "/" dur-value + if isDuration(valEnd): # period-start = date-time "/" dur-value delta = stringToDurations(valEnd)[0] return (start, delta) else: @@ -1829,8 +1824,9 @@ def stringToPeriod(s, tzinfo=None): def getTransition(transitionTo, year, tzinfo): - """Return the datetime of the transition to/from DST, or None.""" - + """ + Return the datetime of the transition to/from DST, or None. + """ def firstTransition(iterDates, test): """ Return the last date not matching test, or None if all tests matched. @@ -1845,7 +1841,9 @@ def getTransition(transitionTo, year, tzinfo): return success # may be None def generateDates(year, month=None, day=None): - """Iterate over possible dates with unspecified values.""" + """ + Iterate over possible dates with unspecified values. + """ months = range(1, 13) days = range(1, 32) hours = range(0, 24) @@ -1888,12 +1886,14 @@ def getTransition(transitionTo, year, tzinfo): return uncorrected + datetime.timedelta(hours=1) def tzinfo_eq(tzinfo1, tzinfo2, startYear = 2000, endYear=2020): - """Compare offsets and DST transitions from startYear to endYear.""" + """ + Compare offsets and DST transitions from startYear to endYear. + """ if tzinfo1 == tzinfo2: return True elif tzinfo1 is None or tzinfo2 is None: return False - + def dt_test(dt): if dt is None: return True @@ -1901,7 +1901,7 @@ def tzinfo_eq(tzinfo1, tzinfo2, startYear = 2000, endYear=2020): if not dt_test(datetime.datetime(startYear, 1, 1)): return False - for year in xrange(startYear, endYear): + for year in range(startYear, endYear): for transitionTo in 'daylight', 'standard': t1=getTransition(transitionTo, year, tzinfo1) t2=getTransition(transitionTo, year, tzinfo2) @@ -1910,7 +1910,7 @@ def tzinfo_eq(tzinfo1, tzinfo2, startYear = 2000, endYear=2020): return True -#------------------- Testing and running functions ----------------------------- +# ------------------- Testing and running functions ---------------------------- if __name__ == '__main__': import tests tests._test() diff --git a/vobject/ics_diff.py b/vobject/ics_diff.py index 4aaaef9..fe8b45b 100644 --- a/vobject/ics_diff.py +++ b/vobject/ics_diff.py @@ -1,28 +1,35 @@ -"""Compare VTODOs and VEVENTs in two iCalendar sources.""" -from base import Component, getBehavior, newFromBehavior +from __future__ import print_function + +from optparse import OptionParser + +from .base import Component, getBehavior, newFromBehavior, readOne + +""" +Compare VTODOs and VEVENTs in two iCalendar sources. +""" def getSortKey(component): def getUID(component): return component.getChildValue('uid', '') - - # it's not quite as simple as getUID, need to account for recurrenceID and + + # it's not quite as simple as getUID, need to account for recurrenceID and # sequence def getSequence(component): sequence = component.getChildValue('sequence', 0) - return "%05d" % int(sequence) - + return "{0:05d}".format(int(sequence)) + def getRecurrenceID(component): recurrence_id = component.getChildValue('recurrence_id', None) if recurrence_id is None: return '0000-00-00' else: return recurrence_id.isoformat() - + return getUID(component) + getSequence(component) + getRecurrenceID(component) def sortByUID(components): - return sorted(components, key=getSortKey) + return sorted(components, key=getSortKey) def deleteExtraneous(component, ignore_dtstamp=False): """ @@ -41,21 +48,21 @@ def diff(left, right): """ Take two VCALENDAR components, compare VEVENTs and VTODOs in them, return a list of object pairs containing just UID and the bits - that didn't match, using None for objects that weren't present in one + that didn't match, using None for objects that weren't present in one version or the other. - + When there are multiple ContentLines in one VEVENT, for instance many - DESCRIPTION lines, such lines original order is assumed to be + DESCRIPTION lines, such lines original order is assumed to be meaningful. Order is also preserved when comparing (the unlikely case of) multiple parameters of the same type in a ContentLine - - """ - + + """ + def processComponentLists(leftList, rightList): output = [] rightIndex = 0 rightListSize = len(rightList) - + for comp in leftList: if rightIndex >= rightListSize: output.append((comp, None)) @@ -67,12 +74,12 @@ def diff(left, right): output.append((None, rightComp)) rightIndex += 1 if rightIndex >= rightListSize: - output.append((comp, None)) + output.append((comp, None)) break else: rightComp = rightList[rightIndex] rightKey = getSortKey(rightComp) - + if leftKey < rightKey: output.append((comp, None)) elif leftKey == rightKey: @@ -80,7 +87,7 @@ def diff(left, right): matchResult = processComponentPair(comp, rightComp) if matchResult is not None: output.append(matchResult) - + return output def newComponent(name, body): @@ -96,14 +103,14 @@ def diff(left, right): """ Return None if a match, or a pair of components including UIDs and any differing children. - - """ + + """ leftChildKeys = leftComp.contents.keys() rightChildKeys = rightComp.contents.keys() - + differentContentLines = [] differentComponents = {} - + for key in leftChildKeys: rightList = rightComp.contents.get(key, []) if isinstance(leftComp.contents[key][0], Component): @@ -111,18 +118,18 @@ def diff(left, right): rightList) if len(compDifference) > 0: differentComponents[key] = compDifference - + elif leftComp.contents[key] != rightList: differentContentLines.append((leftComp.contents[key], rightList)) - + for key in rightChildKeys: if key not in leftChildKeys: if isinstance(rightComp.contents[key][0], Component): differentComponents[key] = ([], rightComp.contents[key]) else: differentContentLines.append(([], rightComp.contents[key])) - + if len(differentContentLines) == 0 and len(differentComponents) == 0: return None else: @@ -134,8 +141,8 @@ def diff(left, right): if uid is not None: left.add( 'uid').value = uid right.add('uid').value = uid - - for name, childPairList in differentComponents.iteritems(): + + for name, childPairList in differentComponents.items(): leftComponents, rightComponents = zip(*childPairList) if len(leftComponents) > 0: # filter out None @@ -143,7 +150,7 @@ def diff(left, right): if len(rightComponents) > 0: # filter out None right.contents[name] = filter(None, rightComponents) - + for leftChildLine, rightChildLine in differentContentLines: nonEmpty = leftChildLine or rightChildLine name = nonEmpty[0].name @@ -151,42 +158,37 @@ def diff(left, right): left.contents[name] = leftChildLine if rightChildLine is not None: right.contents[name] = rightChildLine - + return left, right vevents = processComponentLists(sortByUID(getattr(left, 'vevent_list', [])), sortByUID(getattr(right, 'vevent_list', []))) - + vtodos = processComponentLists(sortByUID(getattr(left, 'vtodo_list', [])), sortByUID(getattr(right, 'vtodo_list', []))) - + return vevents + vtodos def prettyDiff(leftObj, rightObj): for left, right in diff(leftObj, rightObj): - print "<<<<<<<<<<<<<<<" + print("<<<<<<<<<<<<<<<") if left is not None: left.prettyPrint() - print "===============" + print("===============") if right is not None: right.prettyPrint() - print ">>>>>>>>>>>>>>>" + print(">>>>>>>>>>>>>>>") print - - -from optparse import OptionParser -import icalendar, base -import os -import codecs + def main(): options, args = getOptions() if args: ignore_dtstamp = options.ignore ics_file1, ics_file2 = args - cal1 = base.readOne(file(ics_file1)) - cal2 = base.readOne(file(ics_file2)) + cal1 = readOne(file(ics_file1)) + cal2 = readOne(file(ics_file2)) deleteExtraneous(cal1, ignore_dtstamp=ignore_dtstamp) deleteExtraneous(cal2, ignore_dtstamp=ignore_dtstamp) prettyDiff(cal1, cal2) @@ -205,9 +207,9 @@ def getOptions(): (cmdline_options, args) = parser.parse_args() if len(args) < 2: - print "error: too few arguments given" + print("error: too few arguments given") print - print parser.format_help() + print(parser.format_help()) return False, False return cmdline_options, args @@ -216,4 +218,4 @@ if __name__ == "__main__": try: main() except KeyboardInterrupt: - print "Aborted" + print("Aborted") diff --git a/vobject/vcard.py b/vobject/vcard.py index 068ce29..dd60b73 100644 --- a/vobject/vcard.py +++ b/vobject/vcard.py @@ -1,28 +1,36 @@ """Definitions and behavior for vCard 3.0""" -import behavior -import itertools +from . import behavior -from base import VObjectError, NativeError, ValidateError, ParseError, \ - VBase, Component, ContentLine, logger, defaultSerialize, \ - registerBehavior, backslashEscape, ascii -from icalendar import stringToTextValues +from .base import ContentLine, registerBehavior, backslashEscape +from .icalendar import stringToTextValues -#------------------------ vCard structs ---------------------------------------- + +# Python 3 no longer has a basestring type, so.... +try: + basestring = basestring +except NameError: + basestring = (str,bytes) + +# ------------------------ vCard structs --------------------------------------- class Name(object): def __init__(self, family = '', given = '', additional = '', prefix = '', suffix = ''): - """Each name attribute can be a string or a list of strings.""" + """ + Each name attribute can be a string or a list of strings. + """ self.family = family self.given = given self.additional = additional self.prefix = prefix self.suffix = suffix - + @staticmethod def toString(val): - """Turn a string or array value into a string.""" + """ + Turn a string or array value into a string. + """ if type(val) in (list, tuple): return ' '.join(val) return val @@ -30,10 +38,10 @@ class Name(object): def __str__(self): eng_order = ('prefix', 'given', 'additional', 'family', 'suffix') out = ' '.join(self.toString(getattr(self, val)) for val in eng_order) - return ascii(out) + return out def __repr__(self): - return "<Name: %s>" % self.__str__() + return "<Name: {0!s}>".format(self.__str__()) def __eq__(self, other): try: @@ -45,10 +53,13 @@ class Name(object): except: return False + class Address(object): def __init__(self, street = '', city = '', region = '', code = '', country = '', box = '', extended = ''): - """Each name attribute can be a string or a list of strings.""" + """ + Each name attribute can be a string or a list of strings. + """ self.box = box self.extended = extended self.street = street @@ -56,10 +67,12 @@ class Address(object): self.region = region self.code = code self.country = country - + @staticmethod def toString(val, join_char='\n'): - """Turn a string or array value into a string.""" + """ + Turn a string or array value into a string. + """ if type(val) in (list, tuple): return join_char.join(val) return val @@ -68,15 +81,17 @@ class Address(object): one_line = ('city', 'region', 'code') def __str__(self): - lines = '\n'.join(self.toString(getattr(self, val)) for val in self.lines if getattr(self, val)) - one_line = tuple(self.toString(getattr(self, val), ' ') for val in self.one_line) - lines += "\n%s, %s %s" % one_line + lines = '\n'.join(self.toString(getattr(self, val)) + for val in self.lines if getattr(self, val)) + one_line = tuple(self.toString(getattr(self, val), ' ') + for val in self.one_line) + lines += "\n{0!s}, {1!s} {2!s}".format(*one_line) if self.country: lines += '\n' + self.toString(self.country) - return ascii(lines) + return lines def __repr__(self): - return "<Address: %s>" % repr(str(self))[1:-1] + return "<Address: {0!s}>".format(self) def __eq__(self, other): try: @@ -88,29 +103,31 @@ class Address(object): self.code == other.code and self.country == other.country) except: - False - + return False -#------------------------ Registered Behavior subclasses ----------------------- + +# ------------------------ Registered Behavior subclasses ---------------------- class VCardTextBehavior(behavior.Behavior): - """Provide backslash escape encoding/decoding for single valued properties. - + """ + Provide backslash escape encoding/decoding for single valued properties. + TextBehavior also deals with base64 encoding if the ENCODING parameter is explicitly set to BASE64. - """ allowGroup = True base64string = 'B' - + @classmethod def decode(cls, line): - """Remove backslash escaping from line.valueDecode line, either to remove + """ + Remove backslash escaping from line.valueDecode line, either to remove backslash espacing, or to decode base64 encoding. The content line should contain a ENCODING=b for base64 encoding, but Apple Addressbook seems to export a singleton parameter of 'BASE64', which does not match the 3.0 vCard spec. If we encouter that, then we transform the parameter to - ENCODING=b""" + ENCODING=b + """ if line.encoded: if 'BASE64' in line.singletonparams: line.singletonparams.remove('BASE64') @@ -121,10 +138,12 @@ class VCardTextBehavior(behavior.Behavior): else: line.value = stringToTextValues(line.value)[0] line.encoded=False - + @classmethod def encode(cls, line): - """Backslash escape line.value.""" + """ + Backslash escape line.value. + """ if not line.encoded: encoding = getattr(line, 'encoding_param', None) if encoding and encoding.upper() == cls.base64string: @@ -138,16 +157,19 @@ class VCardBehavior(behavior.Behavior): allowGroup = True defaultBehavior = VCardTextBehavior + class VCard3_0(VCardBehavior): - """vCard 3.0 behavior.""" + """ + vCard 3.0 behavior. + """ name = 'VCARD' description = 'vCard 3.0, defined in rfc2426' versionString = '3.0' isComponent = True sortFirst = ('version', 'prodid', 'uid') - knownChildren = {'N': (1, 1, None),#min, max, behaviorRegistry id + knownChildren = {'N': (1, 1, None), # min, max, behaviorRegistry id 'FN': (1, 1, None), - 'VERSION': (1, 1, None),#required, auto-generated + 'VERSION': (1, 1, None), # required, auto-generated 'PRODID': (0, 1, None), 'LABEL': (0, None, None), 'UID': (0, None, None), @@ -156,19 +178,20 @@ class VCard3_0(VCardBehavior): 'PHOTO': (0, None, None), 'CATEGORIES':(0, None, None) } - + @classmethod def generateImplicitParameters(cls, obj): - """Create PRODID, VERSION, and VTIMEZONEs if needed. - + """ + Create PRODID, VERSION, and VTIMEZONEs if needed. + VTIMEZONEs will need to exist whenever TZID parameters exist or when datetimes with tzinfo exist. - """ if not hasattr(obj, 'version'): obj.add(ContentLine('VERSION', [], cls.versionString)) registerBehavior(VCard3_0, default=True) + class FN(VCardTextBehavior): name = "FN" description = 'Formatted name' @@ -182,18 +205,21 @@ registerBehavior(Label) wacky_apple_photo_serialize = True REALLY_LARGE = 1E50 + class Photo(VCardTextBehavior): name = "Photo" description = 'Photograph' @classmethod def valueRepr( cls, line ): - return " (BINARY PHOTO DATA at 0x%s) " % id( line.value ) + return " (BINARY PHOTO DATA at 0x{0!s}) ".format(id( line.value )) @classmethod def serialize(cls, obj, buf, lineLength, validate): - """Apple's Address Book is *really* weird with images, it expects - base64 data to have very specific whitespace. It seems Address Book - can handle PHOTO if it's not wrapped, so don't wrap it.""" + """ + Apple's Address Book is *really* weird with images, it expects + base64 data to have very specific whitespace. It seems Address Book + can handle PHOTO if it's not wrapped, so don't wrap it. + """ if wacky_apple_photo_serialize: lineLength = REALLY_LARGE VCardTextBehavior.serialize(obj, buf, lineLength, validate) @@ -208,7 +234,9 @@ def toListOrString(string): return stringList def splitFields(string): - """Return a list of strings or lists from a Name or Address.""" + """ + Return a list of strings or lists from a Name or Address. + """ return [toListOrString(i) for i in stringToTextValues(string, listSeparator=';', charList=';')] @@ -218,8 +246,9 @@ def toList(stringOrList): return stringOrList def serializeFields(obj, order=None): - """Turn an object's fields into a ';' and ',' seperated string. - + """ + Turn an object's fields into a ';' and ',' seperated string. + If order is None, obj should be a list, backslash escape each field and return a ';' separated string. """ @@ -230,72 +259,95 @@ def serializeFields(obj, order=None): for field in order: escapedValueList = [backslashEscape(val) for val in toList(getattr(obj, field))] - fields.append(','.join(escapedValueList)) + fields.append(','.join(escapedValueList)) return ';'.join(fields) + NAME_ORDER = ('family', 'given', 'additional', 'prefix', 'suffix') +ADDRESS_ORDER = ('box', 'extended', 'street', 'city', 'region', 'code', + 'country') + class NameBehavior(VCardBehavior): - """A structured name.""" + """ + A structured name. + """ hasNative = True @staticmethod def transformToNative(obj): - """Turn obj.value into a Name.""" - if obj.isNative: return obj + """ + Turn obj.value into a Name. + """ + if obj.isNative: + return obj obj.isNative = True obj.value = Name(**dict(zip(NAME_ORDER, splitFields(obj.value)))) return obj @staticmethod def transformFromNative(obj): - """Replace the Name in obj.value with a string.""" + """ + Replace the Name in obj.value with a string. + """ obj.isNative = False obj.value = serializeFields(obj.value, NAME_ORDER) return obj registerBehavior(NameBehavior, 'N') -ADDRESS_ORDER = ('box', 'extended', 'street', 'city', 'region', 'code', - 'country') class AddressBehavior(VCardBehavior): - """A structured address.""" + """ + A structured address. + """ hasNative = True @staticmethod def transformToNative(obj): - """Turn obj.value into an Address.""" - if obj.isNative: return obj + """ + Turn obj.value into an Address. + """ + if obj.isNative: + return obj obj.isNative = True obj.value = Address(**dict(zip(ADDRESS_ORDER, splitFields(obj.value)))) return obj @staticmethod def transformFromNative(obj): - """Replace the Address in obj.value with a string.""" + """ + Replace the Address in obj.value with a string. + """ obj.isNative = False obj.value = serializeFields(obj.value, ADDRESS_ORDER) return obj registerBehavior(AddressBehavior, 'ADR') - + + class OrgBehavior(VCardBehavior): - """A list of organization values and sub-organization values.""" + """ + A list of organization values and sub-organization values. + """ hasNative = True @staticmethod def transformToNative(obj): - """Turn obj.value into a list.""" - if obj.isNative: return obj + """ + Turn obj.value into a list. + """ + if obj.isNative: + return obj obj.isNative = True - obj.value = splitFields(obj.value) return obj @staticmethod def transformFromNative(obj): - """Replace the list in obj.value with a string.""" - if not obj.isNative: return obj + """ + Replace the list in obj.value with a string. + """ + if not obj.isNative: + return obj obj.isNative = False obj.value = serializeFields(obj.value) return obj registerBehavior(OrgBehavior, 'ORG') - diff --git a/vobject/win32tz.py b/vobject/win32tz.py index 35f997b..cf30865 100644 --- a/vobject/win32tz.py +++ b/vobject/win32tz.py @@ -69,7 +69,7 @@ class win32tz(datetime.tzinfo): else: return True def __repr__(self): - return "<win32tz - %s>" % self.data.display + return "<win32tz - {0!s}>".format(self.data.display) def pickNthWeekday(year, month, dayofweek, hour, minute, whichweek): """dayofweek == 0 means Sunday, whichweek > 4 means last instance""" |