Add better datetime support to xmlrpclib module. Closes patch #1120353.
diff --git a/Lib/test/test_xmlrpc.py b/Lib/test/test_xmlrpc.py
index df0893d..ed4c6d1 100644
--- a/Lib/test/test_xmlrpc.py
+++ b/Lib/test/test_xmlrpc.py
@@ -34,16 +34,48 @@
xmlrpclib.loads(xmlrpclib.dumps((alist,)))[0][0])
def test_dump_bare_datetime(self):
- # This checks that an unwrapped datetime object can be handled
- # by the marshalling code. This can't be done via
- # test_dump_load() since the unmarshaller doesn't produce base
- # datetime instances.
+ # This checks that an unwrapped datetime.date object can be handled
+ # by the marshalling code. This can't be done via test_dump_load()
+ # since with use_datetime set to 1 the unmarshaller would create
+ # datetime objects for the 'datetime[123]' keys as well
dt = datetime.datetime(2005, 02, 10, 11, 41, 23)
s = xmlrpclib.dumps((dt,))
- r, m = xmlrpclib.loads(s)
- self.assertEquals(r, (xmlrpclib.DateTime('20050210T11:41:23'),))
+ (newdt,), m = xmlrpclib.loads(s, use_datetime=1)
+ self.assertEquals(newdt, dt)
self.assertEquals(m, None)
+ (newdt,), m = xmlrpclib.loads(s, use_datetime=0)
+ self.assertEquals(newdt, xmlrpclib.DateTime('20050210T11:41:23'))
+
+ def test_dump_bare_date(self):
+ # This checks that an unwrapped datetime.date object can be handled
+ # by the marshalling code. This can't be done via test_dump_load()
+ # since the unmarshaller produces a datetime object
+ d = datetime.datetime(2005, 02, 10, 11, 41, 23).date()
+ s = xmlrpclib.dumps((d,))
+ (newd,), m = xmlrpclib.loads(s, use_datetime=1)
+ self.assertEquals(newd.date(), d)
+ self.assertEquals(newd.time(), datetime.time(0, 0, 0))
+ self.assertEquals(m, None)
+
+ (newdt,), m = xmlrpclib.loads(s, use_datetime=0)
+ self.assertEquals(newdt, xmlrpclib.DateTime('20050210T00:00:00'))
+
+ def test_dump_bare_time(self):
+ # This checks that an unwrapped datetime.time object can be handled
+ # by the marshalling code. This can't be done via test_dump_load()
+ # since the unmarshaller produces a datetime object
+ t = datetime.datetime(2005, 02, 10, 11, 41, 23).time()
+ s = xmlrpclib.dumps((t,))
+ (newt,), m = xmlrpclib.loads(s, use_datetime=1)
+ today = datetime.datetime.now().date().strftime("%Y%m%d")
+ self.assertEquals(newt.time(), t)
+ self.assertEquals(newt.date(), datetime.datetime.now().date())
+ self.assertEquals(m, None)
+
+ (newdt,), m = xmlrpclib.loads(s, use_datetime=0)
+ self.assertEquals(newdt, xmlrpclib.DateTime('%sT11:41:23'%today))
+
def test_dump_big_long(self):
self.assertRaises(OverflowError, xmlrpclib.dumps, (2L**99,))
diff --git a/Lib/xmlrpclib.py b/Lib/xmlrpclib.py
index 13a7562..069ebcc 100644
--- a/Lib/xmlrpclib.py
+++ b/Lib/xmlrpclib.py
@@ -357,7 +357,14 @@
if datetime and isinstance(value, datetime.datetime):
self.value = value.strftime("%Y%m%dT%H:%M:%S")
return
- elif not isinstance(value, (TupleType, time.struct_time)):
+ if datetime and isinstance(value, datetime.date):
+ self.value = value.strftime("%Y%m%dT%H:%M:%S")
+ return
+ if datetime and isinstance(value, datetime.time):
+ today = datetime.datetime.now().strftime("%Y%m%d")
+ self.value = value.strftime(today+"T%H:%M:%S")
+ return
+ if not isinstance(value, (TupleType, time.struct_time)):
if value == 0:
value = time.time()
value = time.localtime(value)
@@ -394,6 +401,10 @@
value.decode(data)
return value
+def _datetime_type(data):
+ t = time.strptime(data, "%Y%m%dT%H:%M:%S")
+ return datetime.datetime(*tuple(t)[:6])
+
##
# Wrapper for binary data. This can be used to transport any kind
# of binary data over XML-RPC, using BASE64 encoding.
@@ -714,6 +725,19 @@
write("</dateTime.iso8601></value>\n")
dispatch[datetime.datetime] = dump_datetime
+ def dump_date(self, value, write):
+ write("<value><dateTime.iso8601>")
+ write(value.strftime("%Y%m%dT00:00:00"))
+ write("</dateTime.iso8601></value>\n")
+ dispatch[datetime.date] = dump_date
+
+ def dump_time(self, value, write):
+ write("<value><dateTime.iso8601>")
+ write(datetime.datetime.now().date().strftime("%Y%m%dT"))
+ write(value.strftime("%H:%M:%S"))
+ write("</dateTime.iso8601></value>\n")
+ dispatch[datetime.time] = dump_time
+
def dump_instance(self, value, write):
# check for special wrappers
if value.__class__ in WRAPPERS:
@@ -742,7 +766,7 @@
# and again, if you don't understand what's going on in here,
# that's perfectly ok.
- def __init__(self):
+ def __init__(self, use_datetime=0):
self._type = None
self._stack = []
self._marks = []
@@ -750,6 +774,9 @@
self._methodname = None
self._encoding = "utf-8"
self.append = self._stack.append
+ self._use_datetime = use_datetime
+ if use_datetime and not datetime:
+ raise ValueError, "the datetime module is not available"
def close(self):
# return response tuple and target method
@@ -867,6 +894,8 @@
def end_dateTime(self, data):
value = DateTime()
value.decode(data)
+ if self._use_datetime:
+ value = _datetime_type(data)
self.append(value)
dispatch["dateTime.iso8601"] = end_dateTime
@@ -968,17 +997,23 @@
#
# return A (parser, unmarshaller) tuple.
-def getparser():
+def getparser(use_datetime=0):
"""getparser() -> parser, unmarshaller
Create an instance of the fastest available parser, and attach it
to an unmarshalling object. Return both objects.
"""
+ if use_datetime and not datetime:
+ raise ValueError, "the datetime module is not available"
if FastParser and FastUnmarshaller:
- target = FastUnmarshaller(True, False, _binary, _datetime, Fault)
+ if use_datetime:
+ mkdatetime = _datetime_type
+ else:
+ mkdatetime = _datetime
+ target = FastUnmarshaller(True, False, _binary, mkdatetime, Fault)
parser = FastParser(target)
else:
- target = Unmarshaller()
+ target = Unmarshaller(use_datetime=use_datetime)
if FastParser:
parser = FastParser(target)
elif SgmlopParser:
@@ -1081,7 +1116,7 @@
# (None if not present).
# @see Fault
-def loads(data):
+def loads(data, use_datetime=0):
"""data -> unmarshalled data, method name
Convert an XML-RPC packet to unmarshalled data plus a method
@@ -1090,7 +1125,7 @@
If the XML-RPC packet represents a fault condition, this function
raises a Fault exception.
"""
- p, u = getparser()
+ p, u = getparser(use_datetime=use_datetime)
p.feed(data)
p.close()
return u.close(), u.getmethodname()
@@ -1122,6 +1157,9 @@
# client identifier (may be overridden)
user_agent = "xmlrpclib.py/%s (by www.pythonware.com)" % __version__
+ def __init__(self, use_datetime=0):
+ self._use_datetime = use_datetime
+
##
# Send a complete request, and parse the response.
#
@@ -1168,7 +1206,7 @@
def getparser(self):
# get parser and unmarshaller
- return getparser()
+ return getparser(use_datetime=self._use_datetime)
##
# Get authorization info from host parameter
@@ -1362,7 +1400,7 @@
"""
def __init__(self, uri, transport=None, encoding=None, verbose=0,
- allow_none=0):
+ allow_none=0, use_datetime=0):
# establish a "logical" server connection
# get the url
@@ -1376,9 +1414,9 @@
if transport is None:
if type == "https":
- transport = SafeTransport()
+ transport = SafeTransport(use_datetime=use_datetime)
else:
- transport = Transport()
+ transport = Transport(use_datetime=use_datetime)
self.__transport = transport
self.__encoding = encoding