Documentation for PySO8601

PySO8601

PySO8601 aims to be a better Python module to parse ISO 8601 dates. It is inspired by the iso8601 currently available in the pypi repository, however this module is designed to accept any valid ISO8601 formatted string:

• Date including Week Dates (eg. 2011-W12-6) and Ordinal Dates (eg. 2012-003)
• Time including Time zone designations
• Combined Date & Time
• Durations
• Intervals

Truncated representations (YYYYMM, YYMMDD, hhmmss, etc) are also accepted.

USAGE

import PySO8601
spam = PySO8601.parse('2011-01-01T14:32')
print spam # prints: 2011-01-01 14:32:00
eggs = PySO8601.parse('2010W052') # Week 5, day 2
print eggs # prints: 2010-02-01 00:00:00

For full examples on usage please review the specs in the source.

IMPORTANT NOTES

Durations:

Due to the difficult nature of working with calendars, for the moment years specified in the duration format are set to 365 days and months are set to 30 days. This will hopefully be addressed in the near future.

Module Contents:

PySO8601.parse(representation)

Attempts to parse an ISO8601 formatted representation string, which could be of any valid ISO8601 format (date, time, duration, interval).

Return value is specific to representation.

PySO8601.parse_date(datestring)

Attepmts to parse an ISO8601 formatted datestring.

Returns a datetime.datetime object.

PySO8601.parse_time(timestring)

Attepmts to parse an ISO8601 formatted timestring.

Returns a datetime.datetime object.

PySO8601.parse_duration(duration)

Attepmts to parse an ISO8601 formatted duration.

Returns a datetime.timedelta object.

PySO8601.parse_interval(interval)

Attepmts to parse an ISO8601 formatted interval.

Returns a tuple of datetime.datetime and datetime.timedelta objects, order dependent on interval.

class PySO8601.Timezone(tzstring=None)

A subclass of datetime.tzinfo which handles timezone offsets for the various other methods in the module.

tzstring accepts a valid ISO8601 timezone string or None for UTC.

fromutc()

datetime in UTC -> datetime in local time.

tzname()

datetime -> string name of time zone.

exception PySO8601.ParseError

Returned when there is a formatting error with the argument(s)