Added XEP-0082 plugin.
This should make things much easier for any stanza that uses timestamps.
This commit is contained in:
Lance Stout
parent
086bf89d69
commit
7ccc67c06d
1 changed files with 202 additions and 0 deletions
202
sleekxmpp/plugins/xep_0082.py
Normal file
202
sleekxmpp/plugins/xep_0082.py
Normal file
|
|
@ -0,0 +1,202 @@
|
|||
"""
|
||||
SleekXMPP: The Sleek XMPP Library
|
||||
Copyright (C) 2011 Nathanael C. Fritz, Lance J.T. Stout
|
||||
This file is part of SleekXMPP.
|
||||
|
||||
See the file LICENSE for copying permission.
|
||||
"""
|
||||
|
||||
import datetime as dt
|
||||
from dateutil import parser
|
||||
from dateutil.tz import tzoffset, tzutc
|
||||
from sleekxmpp.plugins.base import base_plugin
|
||||
|
||||
|
||||
# =====================================================================
|
||||
# To make it easier for stanzas without direct access to plugin objects
|
||||
# to use the XEP-0082 utility methods, we will define them as top-level
|
||||
# functions and then just reference them in the plugin itself.
|
||||
|
||||
def parse(time_str):
|
||||
"""
|
||||
Convert a string timestamp into a datetime object.
|
||||
|
||||
Arguments:
|
||||
time_str -- A formatted timestamp string.
|
||||
"""
|
||||
return parser.parse(time_str)
|
||||
|
||||
def format_date(time_obj):
|
||||
"""
|
||||
Return a formatted string version of a date object.
|
||||
|
||||
Format:
|
||||
YYYY-MM-DD
|
||||
|
||||
Arguments:
|
||||
time_obj -- A date or datetime object.
|
||||
"""
|
||||
if isinstance(time_obj, dt.datetime):
|
||||
time_obj = time_obj.date()
|
||||
return time_obj.isoformat()
|
||||
|
||||
def format_time(time_obj):
|
||||
"""
|
||||
Return a formatted string version of a time object.
|
||||
|
||||
format:
|
||||
hh:mm:ss[.sss][TZD
|
||||
|
||||
arguments:
|
||||
time_obj -- A time or datetime object.
|
||||
"""
|
||||
if isinstance(time_obj, dt.datetime):
|
||||
time_obj = time_obj.timetz()
|
||||
timestamp = time_obj.isoformat()
|
||||
if time_obj.tzinfo == tzutc():
|
||||
timestamp = timestamp[:-6]
|
||||
return '%sZ' % timestamp
|
||||
return timestamp
|
||||
|
||||
def format_datetime(time_obj):
|
||||
"""
|
||||
Return a formatted string version of a datetime object.
|
||||
|
||||
Format:
|
||||
YYYY-MM-DDThh:mm:ss[.sss]TZD
|
||||
|
||||
arguments:
|
||||
time_obj -- A datetime object.
|
||||
"""
|
||||
timestamp = time_obj.isoformat('T')
|
||||
if time_obj.tzinfo == tzutc():
|
||||
timestamp = timestamp[:-6]
|
||||
return '%sZ' % timestamp
|
||||
return timestamp
|
||||
|
||||
def date(year=None, month=None, day=None):
|
||||
"""
|
||||
Create a date only timestamp for the given instant.
|
||||
|
||||
Unspecified components default to their current counterparts.
|
||||
|
||||
Arguments:
|
||||
year -- Integer value of the year (4 digits)
|
||||
month -- Integer value of the month
|
||||
day -- Integer value of the day of the month.
|
||||
"""
|
||||
today = dt.datetime.today()
|
||||
if year is None:
|
||||
year = today.year
|
||||
if month is None:
|
||||
month = today.month
|
||||
if day is None:
|
||||
day = today.day
|
||||
return format_date(dt.date(year, month, day))
|
||||
|
||||
def time(hour=None, min=None, sec=None, micro=None, offset=None):
|
||||
"""
|
||||
Create a time only timestamp for the given instant.
|
||||
|
||||
Unspecified components default to their current counterparts.
|
||||
|
||||
Arguments:
|
||||
hour -- Integer value of the hour.
|
||||
min -- Integer value of the number of minutes.
|
||||
sec -- Integer value of the number of seconds.
|
||||
micro -- Integer value of the number of microseconds.
|
||||
offset -- A positive or negative number of seconds to
|
||||
offset from UTC to match a desired timezone.
|
||||
"""
|
||||
now = dt.datetime.utcnow()
|
||||
if hour is None:
|
||||
hour = now.hour
|
||||
if min is None:
|
||||
min = now.minute
|
||||
if sec is None:
|
||||
sec = now.second
|
||||
if micro is None:
|
||||
micro = now.microsecond
|
||||
if offset is None:
|
||||
offset = tzutc()
|
||||
else:
|
||||
offset = tzoffset(None, offset)
|
||||
time = dt.time(hour, min, sec, micro, offset)
|
||||
return format_time(time)
|
||||
|
||||
def datetime(year=None, month=None, day=None, hour=None,
|
||||
min=None, sec=None, micro=None, offset=None,
|
||||
separators=True):
|
||||
"""
|
||||
Create a datetime timestamp for the given instant.
|
||||
|
||||
Unspecified components default to their current counterparts.
|
||||
|
||||
Arguments:
|
||||
year -- Integer value of the year (4 digits)
|
||||
month -- Integer value of the month
|
||||
day -- Integer value of the day of the month.
|
||||
hour -- Integer value of the hour.
|
||||
min -- Integer value of the number of minutes.
|
||||
sec -- Integer value of the number of seconds.
|
||||
micro -- Integer value of the number of microseconds.
|
||||
offset -- A positive or negative number of seconds to
|
||||
offset from UTC to match a desired timezone.
|
||||
"""
|
||||
now = dt.datetime.utcnow()
|
||||
if year is None:
|
||||
year = now.year
|
||||
if month is None:
|
||||
month = now.month
|
||||
if day is None:
|
||||
day = now.day
|
||||
if hour is None:
|
||||
hour = now.hour
|
||||
if min is None:
|
||||
min = now.minute
|
||||
if sec is None:
|
||||
sec = now.second
|
||||
if micro is None:
|
||||
micro = now.microsecond
|
||||
if offset is None:
|
||||
offset = tzutc()
|
||||
else:
|
||||
offset = tzoffset(None, offset)
|
||||
|
||||
date = dt.datetime(year, month, day, hour,
|
||||
sec, min, micro, offset)
|
||||
return format_datetime(date)
|
||||
|
||||
class xep_0082(base_plugin):
|
||||
|
||||
"""
|
||||
XEP-0082: XMPP Date and Time Profiles
|
||||
|
||||
XMPP uses a subset of the formats allowed by ISO 8601 as a matter of
|
||||
pragmatism based on the relatively few formats historically used by
|
||||
the XMPP.
|
||||
|
||||
Also see <http://www.xmpp.org/extensions/xep-0082.html>.
|
||||
|
||||
Methods:
|
||||
date -- Create a time stamp using the Date profile.
|
||||
datetime -- Create a time stamp using the DateTime profile.
|
||||
time -- Create a time stamp using the Time profile.
|
||||
format_date -- Format an existing date object.
|
||||
format_datetime -- Format an existing datetime object.
|
||||
format_time -- Format an existing time object.
|
||||
parse -- Convert a time string into a Python datetime object.
|
||||
"""
|
||||
|
||||
def plugin_init(self):
|
||||
"""Start the XEP-0082 plugin."""
|
||||
self.xep = '0082'
|
||||
self.description = 'XMPP Date and Time Profiles'
|
||||
|
||||
self.date = date
|
||||
self.datetime = datetime
|
||||
self.time = time
|
||||
self.format_date = format_date
|
||||
self.format_datetime = format_datetime
|
||||
self.format_time = format_time
|
||||
self.parse = parse
|
||||
Loading…
Reference in a new issue