springsuite: planemo/lib/python3.7/site-packages/future/backports/xmlrpc/client.py annotate

annotate planemo/lib/python3.7/site-packages/future/backports/xmlrpc/client.py @ 1:56ad4e20f292 draft

"planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1"

author	guerler
date	Fri, 31 Jul 2020 00:32:28 -0400
parents	d30785e31577
children

rev	line source
0 d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1 #
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	2 # XML-RPC CLIENT LIBRARY
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	3 # $Id$
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	4 #
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	5 # an XML-RPC client interface for Python.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	6 #
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	7 # the marshalling and response parser code can also be used to
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	8 # implement XML-RPC servers.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	9 #
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	10 # Notes:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	11 # this version is designed to work with Python 2.1 or newer.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	12 #
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	13 # History:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	14 # 1999-01-14 fl Created
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	15 # 1999-01-15 fl Changed dateTime to use localtime
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	16 # 1999-01-16 fl Added Binary/base64 element, default to RPC2 service
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	17 # 1999-01-19 fl Fixed array data element (from Skip Montanaro)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	18 # 1999-01-21 fl Fixed dateTime constructor, etc.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	19 # 1999-02-02 fl Added fault handling, handle empty sequences, etc.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	20 # 1999-02-10 fl Fixed problem with empty responses (from Skip Montanaro)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	21 # 1999-06-20 fl Speed improvements, pluggable parsers/transports (0.9.8)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	22 # 2000-11-28 fl Changed boolean to check the truth value of its argument
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	23 # 2001-02-24 fl Added encoding/Unicode/SafeTransport patches
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	24 # 2001-02-26 fl Added compare support to wrappers (0.9.9/1.0b1)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	25 # 2001-03-28 fl Make sure response tuple is a singleton
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	26 # 2001-03-29 fl Don't require empty params element (from Nicholas Riley)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	27 # 2001-06-10 fl Folded in _xmlrpclib accelerator support (1.0b2)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	28 # 2001-08-20 fl Base xmlrpclib.Error on built-in Exception (from Paul Prescod)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	29 # 2001-09-03 fl Allow Transport subclass to override getparser
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	30 # 2001-09-10 fl Lazy import of urllib, cgi, xmllib (20x import speedup)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	31 # 2001-10-01 fl Remove containers from memo cache when done with them
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	32 # 2001-10-01 fl Use faster escape method (80% dumps speedup)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	33 # 2001-10-02 fl More dumps microtuning
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	34 # 2001-10-04 fl Make sure import expat gets a parser (from Guido van Rossum)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	35 # 2001-10-10 sm Allow long ints to be passed as ints if they don't overflow
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	36 # 2001-10-17 sm Test for int and long overflow (allows use on 64-bit systems)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	37 # 2001-11-12 fl Use repr() to marshal doubles (from Paul Felix)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	38 # 2002-03-17 fl Avoid buffered read when possible (from James Rucker)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	39 # 2002-04-07 fl Added pythondoc comments
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	40 # 2002-04-16 fl Added __str__ methods to datetime/binary wrappers
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	41 # 2002-05-15 fl Added error constants (from Andrew Kuchling)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	42 # 2002-06-27 fl Merged with Python CVS version
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	43 # 2002-10-22 fl Added basic authentication (based on code from Phillip Eby)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	44 # 2003-01-22 sm Add support for the bool type
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	45 # 2003-02-27 gvr Remove apply calls
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	46 # 2003-04-24 sm Use cStringIO if available
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	47 # 2003-04-25 ak Add support for nil
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	48 # 2003-06-15 gn Add support for time.struct_time
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	49 # 2003-07-12 gp Correct marshalling of Faults
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	50 # 2003-10-31 mvl Add multicall support
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	51 # 2004-08-20 mvl Bump minimum supported Python version to 2.1
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	52 #
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	53 # Copyright (c) 1999-2002 by Secret Labs AB.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	54 # Copyright (c) 1999-2002 by Fredrik Lundh.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	55 #
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	56 # info@pythonware.com
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	57 # http://www.pythonware.com
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	58 #
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	59 # --------------------------------------------------------------------
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	60 # The XML-RPC client interface is
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	61 #
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	62 # Copyright (c) 1999-2002 by Secret Labs AB
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	63 # Copyright (c) 1999-2002 by Fredrik Lundh
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	64 #
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	65 # By obtaining, using, and/or copying this software and/or its
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	66 # associated documentation, you agree that you have read, understood,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	67 # and will comply with the following terms and conditions:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	68 #
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	69 # Permission to use, copy, modify, and distribute this software and
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	70 # its associated documentation for any purpose and without fee is
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	71 # hereby granted, provided that the above copyright notice appears in
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	72 # all copies, and that both that copyright notice and this permission
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	73 # notice appear in supporting documentation, and that the name of
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	74 # Secret Labs AB or the author not be used in advertising or publicity
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	75 # pertaining to distribution of the software without specific, written
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	76 # prior permission.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	77 #
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	78 # SECRET LABS AB AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	79 # TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANT-
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	80 # ABILITY AND FITNESS. IN NO EVENT SHALL SECRET LABS AB OR THE AUTHOR
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	81 # BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	82 # DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	83 # WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	84 # ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	85 # OF THIS SOFTWARE.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	86 # --------------------------------------------------------------------
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	87
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	88 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	89 Ported using Python-Future from the Python 3.3 standard library.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	90
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	91 An XML-RPC client interface for Python.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	92
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	93 The marshalling and response parser code can also be used to
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	94 implement XML-RPC servers.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	95
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	96 Exported exceptions:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	97
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	98 Error Base class for client errors
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	99 ProtocolError Indicates an HTTP protocol error
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	100 ResponseError Indicates a broken response package
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	101 Fault Indicates an XML-RPC fault package
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	102
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	103 Exported classes:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	104
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	105 ServerProxy Represents a logical connection to an XML-RPC server
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	106
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	107 MultiCall Executor of boxcared xmlrpc requests
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	108 DateTime dateTime wrapper for an ISO 8601 string or time tuple or
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	109 localtime integer value to generate a "dateTime.iso8601"
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	110 XML-RPC value
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	111 Binary binary data wrapper
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	112
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	113 Marshaller Generate an XML-RPC params chunk from a Python data structure
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	114 Unmarshaller Unmarshal an XML-RPC response from incoming XML event message
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	115 Transport Handles an HTTP transaction to an XML-RPC server
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	116 SafeTransport Handles an HTTPS transaction to an XML-RPC server
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	117
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	118 Exported constants:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	119
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	120 (none)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	121
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	122 Exported functions:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	123
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	124 getparser Create instance of the fastest available parser & attach
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	125 to an unmarshalling object
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	126 dumps Convert an argument tuple or a Fault instance to an XML-RPC
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	127 request (or response, if the methodresponse option is used).
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	128 loads Convert an XML-RPC packet to unmarshalled data plus a method
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	129 name (None if not present).
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	130 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	131
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	132 from __future__ import (absolute_import, division, print_function,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	133 unicode_literals)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	134 from future.builtins import bytes, dict, int, range, str
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	135
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	136 import base64
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	137 # Py2.7 compatibility hack
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	138 base64.encodebytes = base64.encodestring
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	139 base64.decodebytes = base64.decodestring
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	140 import sys
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	141 import time
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	142 from datetime import datetime
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	143 from future.backports.http import client as http_client
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	144 from future.backports.urllib import parse as urllib_parse
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	145 from future.utils import ensure_new_type
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	146 from xml.parsers import expat
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	147 import socket
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	148 import errno
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	149 from io import BytesIO
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	150 try:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	151 import gzip
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	152 except ImportError:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	153 gzip = None #python can be built without zlib/gzip support
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	154
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	155 # --------------------------------------------------------------------
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	156 # Internal stuff
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	157
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	158 def escape(s):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	159 s = s.replace("&", "&")
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	160 s = s.replace("<", "<")
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	161 return s.replace(">", ">",)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	162
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	163 # used in User-Agent header sent
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	164 __version__ = sys.version[:3]
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	165
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	166 # xmlrpc integer limits
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	167 MAXINT = 2**31-1
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	168 MININT = -2**31
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	169
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	170 # --------------------------------------------------------------------
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	171 # Error constants (from Dan Libby's specification at
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	172 # http://xmlrpc-epi.sourceforge.net/specs/rfc.fault_codes.php)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	173
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	174 # Ranges of errors
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	175 PARSE_ERROR = -32700
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	176 SERVER_ERROR = -32600
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	177 APPLICATION_ERROR = -32500
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	178 SYSTEM_ERROR = -32400
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	179 TRANSPORT_ERROR = -32300
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	180
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	181 # Specific errors
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	182 NOT_WELLFORMED_ERROR = -32700
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	183 UNSUPPORTED_ENCODING = -32701
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	184 INVALID_ENCODING_CHAR = -32702
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	185 INVALID_XMLRPC = -32600
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	186 METHOD_NOT_FOUND = -32601
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	187 INVALID_METHOD_PARAMS = -32602
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	188 INTERNAL_ERROR = -32603
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	189
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	190 # --------------------------------------------------------------------
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	191 # Exceptions
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	192
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	193 ##
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	194 # Base class for all kinds of client-side errors.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	195
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	196 class Error(Exception):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	197 """Base class for client errors."""
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	198 def __str__(self):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	199 return repr(self)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	200
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	201 ##
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	202 # Indicates an HTTP-level protocol error. This is raised by the HTTP
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	203 # transport layer, if the server returns an error code other than 200
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	204 # (OK).
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	205 #
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	206 # @param url The target URL.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	207 # @param errcode The HTTP error code.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	208 # @param errmsg The HTTP error message.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	209 # @param headers The HTTP header dictionary.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	210
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	211 class ProtocolError(Error):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	212 """Indicates an HTTP protocol error."""
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	213 def __init__(self, url, errcode, errmsg, headers):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	214 Error.__init__(self)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	215 self.url = url
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	216 self.errcode = errcode
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	217 self.errmsg = errmsg
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	218 self.headers = headers
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	219 def __repr__(self):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	220 return (
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	221 "<ProtocolError for %s: %s %s>" %
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	222 (self.url, self.errcode, self.errmsg)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	223 )
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	224
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	225 ##
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	226 # Indicates a broken XML-RPC response package. This exception is
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	227 # raised by the unmarshalling layer, if the XML-RPC response is
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	228 # malformed.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	229
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	230 class ResponseError(Error):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	231 """Indicates a broken response package."""
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	232 pass
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	233
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	234 ##
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	235 # Indicates an XML-RPC fault response package. This exception is
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	236 # raised by the unmarshalling layer, if the XML-RPC response contains
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	237 # a fault string. This exception can also be used as a class, to
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	238 # generate a fault XML-RPC message.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	239 #
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	240 # @param faultCode The XML-RPC fault code.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	241 # @param faultString The XML-RPC fault string.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	242
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	243 class Fault(Error):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	244 """Indicates an XML-RPC fault package."""
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	245 def __init__(self, faultCode, faultString, **extra):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	246 Error.__init__(self)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	247 self.faultCode = faultCode
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	248 self.faultString = faultString
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	249 def __repr__(self):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	250 return "<Fault %s: %r>" % (ensure_new_type(self.faultCode),
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	251 ensure_new_type(self.faultString))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	252
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	253 # --------------------------------------------------------------------
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	254 # Special values
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	255
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	256 ##
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	257 # Backwards compatibility
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	258
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	259 boolean = Boolean = bool
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	260
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	261 ##
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	262 # Wrapper for XML-RPC DateTime values. This converts a time value to
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	263 # the format used by XML-RPC.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	264 # <p>
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	265 # The value can be given as a datetime object, as a string in the
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	266 # format "yyyymmddThh:mm:ss", as a 9-item time tuple (as returned by
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	267 # time.localtime()), or an integer value (as returned by time.time()).
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	268 # The wrapper uses time.localtime() to convert an integer to a time
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	269 # tuple.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	270 #
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	271 # @param value The time, given as a datetime object, an ISO 8601 string,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	272 # a time tuple, or an integer time value.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	273
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	274
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	275 ### For Python-Future:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	276 def _iso8601_format(value):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	277 return "%04d%02d%02dT%02d:%02d:%02d" % (
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	278 value.year, value.month, value.day,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	279 value.hour, value.minute, value.second)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	280 ###
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	281 # Issue #13305: different format codes across platforms
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	282 # _day0 = datetime(1, 1, 1)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	283 # if _day0.strftime('%Y') == '0001': # Mac OS X
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	284 # def _iso8601_format(value):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	285 # return value.strftime("%Y%m%dT%H:%M:%S")
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	286 # elif _day0.strftime('%4Y') == '0001': # Linux
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	287 # def _iso8601_format(value):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	288 # return value.strftime("%4Y%m%dT%H:%M:%S")
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	289 # else:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	290 # def _iso8601_format(value):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	291 # return value.strftime("%Y%m%dT%H:%M:%S").zfill(17)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	292 # del _day0
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	293
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	294
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	295 def _strftime(value):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	296 if isinstance(value, datetime):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	297 return _iso8601_format(value)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	298
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	299 if not isinstance(value, (tuple, time.struct_time)):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	300 if value == 0:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	301 value = time.time()
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	302 value = time.localtime(value)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	303
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	304 return "%04d%02d%02dT%02d:%02d:%02d" % value[:6]
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	305
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	306 class DateTime(object):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	307 """DateTime wrapper for an ISO 8601 string or time tuple or
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	308 localtime integer value to generate 'dateTime.iso8601' XML-RPC
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	309 value.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	310 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	311
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	312 def __init__(self, value=0):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	313 if isinstance(value, str):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	314 self.value = value
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	315 else:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	316 self.value = _strftime(value)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	317
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	318 def make_comparable(self, other):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	319 if isinstance(other, DateTime):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	320 s = self.value
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	321 o = other.value
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	322 elif isinstance(other, datetime):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	323 s = self.value
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	324 o = _iso8601_format(other)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	325 elif isinstance(other, str):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	326 s = self.value
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	327 o = other
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	328 elif hasattr(other, "timetuple"):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	329 s = self.timetuple()
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	330 o = other.timetuple()
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	331 else:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	332 otype = (hasattr(other, "__class__")
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	333 and other.__class__.__name__
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	334 or type(other))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	335 raise TypeError("Can't compare %s and %s" %
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	336 (self.__class__.__name__, otype))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	337 return s, o
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	338
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	339 def __lt__(self, other):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	340 s, o = self.make_comparable(other)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	341 return s < o
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	342
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	343 def __le__(self, other):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	344 s, o = self.make_comparable(other)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	345 return s <= o
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	346
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	347 def __gt__(self, other):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	348 s, o = self.make_comparable(other)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	349 return s > o
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	350
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	351 def __ge__(self, other):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	352 s, o = self.make_comparable(other)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	353 return s >= o
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	354
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	355 def __eq__(self, other):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	356 s, o = self.make_comparable(other)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	357 return s == o
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	358
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	359 def __ne__(self, other):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	360 s, o = self.make_comparable(other)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	361 return s != o
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	362
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	363 def timetuple(self):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	364 return time.strptime(self.value, "%Y%m%dT%H:%M:%S")
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	365
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	366 ##
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	367 # Get date/time value.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	368 #
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	369 # @return Date/time value, as an ISO 8601 string.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	370
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	371 def __str__(self):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	372 return self.value
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	373
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	374 def __repr__(self):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	375 return "<DateTime %r at %x>" % (ensure_new_type(self.value), id(self))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	376
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	377 def decode(self, data):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	378 self.value = str(data).strip()
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	379
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	380 def encode(self, out):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	381 out.write("<value><dateTime.iso8601>")
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	382 out.write(self.value)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	383 out.write("</dateTime.iso8601></value>\n")
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	384
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	385 def _datetime(data):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	386 # decode xml element contents into a DateTime structure.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	387 value = DateTime()
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	388 value.decode(data)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	389 return value
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	390
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	391 def _datetime_type(data):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	392 return datetime.strptime(data, "%Y%m%dT%H:%M:%S")
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	393
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	394 ##
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	395 # Wrapper for binary data. This can be used to transport any kind
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	396 # of binary data over XML-RPC, using BASE64 encoding.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	397 #
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	398 # @param data An 8-bit string containing arbitrary data.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	399
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	400 class Binary(object):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	401 """Wrapper for binary data."""
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	402
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	403 def __init__(self, data=None):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	404 if data is None:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	405 data = b""
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	406 else:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	407 if not isinstance(data, (bytes, bytearray)):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	408 raise TypeError("expected bytes or bytearray, not %s" %
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	409 data.__class__.__name__)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	410 data = bytes(data) # Make a copy of the bytes!
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	411 self.data = data
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	412
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	413 ##
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	414 # Get buffer contents.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	415 #
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	416 # @return Buffer contents, as an 8-bit string.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	417
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	418 def __str__(self):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	419 return str(self.data, "latin-1") # XXX encoding?!
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	420
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	421 def __eq__(self, other):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	422 if isinstance(other, Binary):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	423 other = other.data
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	424 return self.data == other
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	425
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	426 def __ne__(self, other):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	427 if isinstance(other, Binary):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	428 other = other.data
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	429 return self.data != other
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	430
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	431 def decode(self, data):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	432 self.data = base64.decodebytes(data)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	433
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	434 def encode(self, out):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	435 out.write("<value><base64>\n")
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	436 encoded = base64.encodebytes(self.data)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	437 out.write(encoded.decode('ascii'))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	438 out.write("</base64></value>\n")
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	439
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	440 def _binary(data):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	441 # decode xml element contents into a Binary structure
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	442 value = Binary()
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	443 value.decode(data)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	444 return value
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	445
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	446 WRAPPERS = (DateTime, Binary)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	447
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	448 # --------------------------------------------------------------------
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	449 # XML parsers
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	450
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	451 class ExpatParser(object):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	452 # fast expat parser for Python 2.0 and later.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	453 def __init__(self, target):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	454 self._parser = parser = expat.ParserCreate(None, None)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	455 self._target = target
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	456 parser.StartElementHandler = target.start
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	457 parser.EndElementHandler = target.end
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	458 parser.CharacterDataHandler = target.data
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	459 encoding = None
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	460 target.xml(encoding, None)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	461
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	462 def feed(self, data):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	463 self._parser.Parse(data, 0)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	464
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	465 def close(self):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	466 self._parser.Parse("", 1) # end of data
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	467 del self._target, self._parser # get rid of circular references
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	468
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	469 # --------------------------------------------------------------------
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	470 # XML-RPC marshalling and unmarshalling code
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	471
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	472 ##
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	473 # XML-RPC marshaller.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	474 #
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	475 # @param encoding Default encoding for 8-bit strings. The default
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	476 # value is None (interpreted as UTF-8).
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	477 # @see dumps
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	478
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	479 class Marshaller(object):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	480 """Generate an XML-RPC params chunk from a Python data structure.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	481
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	482 Create a Marshaller instance for each set of parameters, and use
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	483 the "dumps" method to convert your data (represented as a tuple)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	484 to an XML-RPC params chunk. To write a fault response, pass a
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	485 Fault instance instead. You may prefer to use the "dumps" module
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	486 function for this purpose.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	487 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	488
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	489 # by the way, if you don't understand what's going on in here,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	490 # that's perfectly ok.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	491
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	492 def __init__(self, encoding=None, allow_none=False):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	493 self.memo = {}
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	494 self.data = None
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	495 self.encoding = encoding
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	496 self.allow_none = allow_none
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	497
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	498 dispatch = {}
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	499
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	500 def dumps(self, values):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	501 out = []
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	502 write = out.append
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	503 dump = self.__dump
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	504 if isinstance(values, Fault):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	505 # fault instance
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	506 write("<fault>\n")
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	507 dump({'faultCode': values.faultCode,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	508 'faultString': values.faultString},
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	509 write)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	510 write("</fault>\n")
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	511 else:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	512 # parameter block
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	513 # FIXME: the xml-rpc specification allows us to leave out
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	514 # the entire <params> block if there are no parameters.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	515 # however, changing this may break older code (including
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	516 # old versions of xmlrpclib.py), so this is better left as
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	517 # is for now. See @XMLRPC3 for more information. /F
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	518 write("<params>\n")
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	519 for v in values:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	520 write("<param>\n")
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	521 dump(v, write)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	522 write("</param>\n")
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	523 write("</params>\n")
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	524 result = "".join(out)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	525 return str(result)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	526
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	527 def __dump(self, value, write):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	528 try:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	529 f = self.dispatch[type(ensure_new_type(value))]
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	530 except KeyError:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	531 # check if this object can be marshalled as a structure
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	532 if not hasattr(value, '__dict__'):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	533 raise TypeError("cannot marshal %s objects" % type(value))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	534 # check if this class is a sub-class of a basic type,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	535 # because we don't know how to marshal these types
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	536 # (e.g. a string sub-class)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	537 for type_ in type(value).__mro__:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	538 if type_ in self.dispatch.keys():
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	539 raise TypeError("cannot marshal %s objects" % type(value))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	540 # XXX(twouters): using "_arbitrary_instance" as key as a quick-fix
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	541 # for the p3yk merge, this should probably be fixed more neatly.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	542 f = self.dispatch["_arbitrary_instance"]
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	543 f(self, value, write)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	544
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	545 def dump_nil (self, value, write):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	546 if not self.allow_none:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	547 raise TypeError("cannot marshal None unless allow_none is enabled")
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	548 write("<value><nil/></value>")
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	549 dispatch[type(None)] = dump_nil
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	550
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	551 def dump_bool(self, value, write):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	552 write("<value><boolean>")
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	553 write(value and "1" or "0")
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	554 write("</boolean></value>\n")
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	555 dispatch[bool] = dump_bool
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	556
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	557 def dump_long(self, value, write):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	558 if value > MAXINT or value < MININT:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	559 raise OverflowError("long int exceeds XML-RPC limits")
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	560 write("<value><int>")
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	561 write(str(int(value)))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	562 write("</int></value>\n")
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	563 dispatch[int] = dump_long
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	564
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	565 # backward compatible
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	566 dump_int = dump_long
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	567
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	568 def dump_double(self, value, write):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	569 write("<value><double>")
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	570 write(repr(ensure_new_type(value)))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	571 write("</double></value>\n")
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	572 dispatch[float] = dump_double
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	573
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	574 def dump_unicode(self, value, write, escape=escape):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	575 write("<value><string>")
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	576 write(escape(value))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	577 write("</string></value>\n")
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	578 dispatch[str] = dump_unicode
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	579
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	580 def dump_bytes(self, value, write):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	581 write("<value><base64>\n")
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	582 encoded = base64.encodebytes(value)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	583 write(encoded.decode('ascii'))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	584 write("</base64></value>\n")
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	585 dispatch[bytes] = dump_bytes
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	586 dispatch[bytearray] = dump_bytes
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	587
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	588 def dump_array(self, value, write):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	589 i = id(value)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	590 if i in self.memo:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	591 raise TypeError("cannot marshal recursive sequences")
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	592 self.memo[i] = None
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	593 dump = self.__dump
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	594 write("<value><array><data>\n")
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	595 for v in value:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	596 dump(v, write)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	597 write("</data></array></value>\n")
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	598 del self.memo[i]
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	599 dispatch[tuple] = dump_array
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	600 dispatch[list] = dump_array
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	601
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	602 def dump_struct(self, value, write, escape=escape):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	603 i = id(value)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	604 if i in self.memo:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	605 raise TypeError("cannot marshal recursive dictionaries")
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	606 self.memo[i] = None
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	607 dump = self.__dump
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	608 write("<value><struct>\n")
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	609 for k, v in value.items():
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	610 write("<member>\n")
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	611 if not isinstance(k, str):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	612 raise TypeError("dictionary key must be string")
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	613 write("<name>%s</name>\n" % escape(k))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	614 dump(v, write)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	615 write("</member>\n")
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	616 write("</struct></value>\n")
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	617 del self.memo[i]
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	618 dispatch[dict] = dump_struct
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	619
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	620 def dump_datetime(self, value, write):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	621 write("<value><dateTime.iso8601>")
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	622 write(_strftime(value))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	623 write("</dateTime.iso8601></value>\n")
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	624 dispatch[datetime] = dump_datetime
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	625
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	626 def dump_instance(self, value, write):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	627 # check for special wrappers
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	628 if value.__class__ in WRAPPERS:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	629 self.write = write
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	630 value.encode(self)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	631 del self.write
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	632 else:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	633 # store instance attributes as a struct (really?)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	634 self.dump_struct(value.__dict__, write)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	635 dispatch[DateTime] = dump_instance
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	636 dispatch[Binary] = dump_instance
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	637 # XXX(twouters): using "_arbitrary_instance" as key as a quick-fix
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	638 # for the p3yk merge, this should probably be fixed more neatly.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	639 dispatch["_arbitrary_instance"] = dump_instance
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	640
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	641 ##
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	642 # XML-RPC unmarshaller.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	643 #
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	644 # @see loads
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	645
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	646 class Unmarshaller(object):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	647 """Unmarshal an XML-RPC response, based on incoming XML event
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	648 messages (start, data, end). Call close() to get the resulting
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	649 data structure.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	650
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	651 Note that this reader is fairly tolerant, and gladly accepts bogus
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	652 XML-RPC data without complaining (but not bogus XML).
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	653 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	654
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	655 # and again, if you don't understand what's going on in here,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	656 # that's perfectly ok.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	657
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	658 def __init__(self, use_datetime=False, use_builtin_types=False):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	659 self._type = None
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	660 self._stack = []
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	661 self._marks = []
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	662 self._data = []
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	663 self._methodname = None
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	664 self._encoding = "utf-8"
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	665 self.append = self._stack.append
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	666 self._use_datetime = use_builtin_types or use_datetime
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	667 self._use_bytes = use_builtin_types
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	668
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	669 def close(self):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	670 # return response tuple and target method
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	671 if self._type is None or self._marks:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	672 raise ResponseError()
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	673 if self._type == "fault":
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	674 raise Fault(**self._stack[0])
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	675 return tuple(self._stack)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	676
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	677 def getmethodname(self):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	678 return self._methodname
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	679
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	680 #
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	681 # event handlers
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	682
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	683 def xml(self, encoding, standalone):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	684 self._encoding = encoding
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	685 # FIXME: assert standalone == 1 ???
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	686
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	687 def start(self, tag, attrs):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	688 # prepare to handle this element
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	689 if tag == "array" or tag == "struct":
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	690 self._marks.append(len(self._stack))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	691 self._data = []
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	692 self._value = (tag == "value")
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	693
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	694 def data(self, text):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	695 self._data.append(text)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	696
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	697 def end(self, tag):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	698 # call the appropriate end tag handler
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	699 try:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	700 f = self.dispatch[tag]
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	701 except KeyError:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	702 pass # unknown tag ?
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	703 else:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	704 return f(self, "".join(self._data))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	705
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	706 #
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	707 # accelerator support
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	708
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	709 def end_dispatch(self, tag, data):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	710 # dispatch data
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	711 try:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	712 f = self.dispatch[tag]
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	713 except KeyError:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	714 pass # unknown tag ?
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	715 else:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	716 return f(self, data)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	717
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	718 #
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	719 # element decoders
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	720
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	721 dispatch = {}
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	722
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	723 def end_nil (self, data):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	724 self.append(None)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	725 self._value = 0
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	726 dispatch["nil"] = end_nil
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	727
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	728 def end_boolean(self, data):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	729 if data == "0":
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	730 self.append(False)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	731 elif data == "1":
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	732 self.append(True)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	733 else:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	734 raise TypeError("bad boolean value")
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	735 self._value = 0
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	736 dispatch["boolean"] = end_boolean
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	737
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	738 def end_int(self, data):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	739 self.append(int(data))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	740 self._value = 0
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	741 dispatch["i4"] = end_int
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	742 dispatch["i8"] = end_int
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	743 dispatch["int"] = end_int
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	744
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	745 def end_double(self, data):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	746 self.append(float(data))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	747 self._value = 0
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	748 dispatch["double"] = end_double
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	749
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	750 def end_string(self, data):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	751 if self._encoding:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	752 data = data.decode(self._encoding)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	753 self.append(data)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	754 self._value = 0
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	755 dispatch["string"] = end_string
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	756 dispatch["name"] = end_string # struct keys are always strings
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	757
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	758 def end_array(self, data):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	759 mark = self._marks.pop()
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	760 # map arrays to Python lists
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	761 self._stack[mark:] = [self._stack[mark:]]
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	762 self._value = 0
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	763 dispatch["array"] = end_array
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	764
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	765 def end_struct(self, data):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	766 mark = self._marks.pop()
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	767 # map structs to Python dictionaries
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	768 dict = {}
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	769 items = self._stack[mark:]
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	770 for i in range(0, len(items), 2):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	771 dict[items[i]] = items[i+1]
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	772 self._stack[mark:] = [dict]
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	773 self._value = 0
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	774 dispatch["struct"] = end_struct
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	775
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	776 def end_base64(self, data):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	777 value = Binary()
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	778 value.decode(data.encode("ascii"))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	779 if self._use_bytes:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	780 value = value.data
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	781 self.append(value)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	782 self._value = 0
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	783 dispatch["base64"] = end_base64
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	784
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	785 def end_dateTime(self, data):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	786 value = DateTime()
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	787 value.decode(data)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	788 if self._use_datetime:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	789 value = _datetime_type(data)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	790 self.append(value)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	791 dispatch["dateTime.iso8601"] = end_dateTime
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	792
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	793 def end_value(self, data):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	794 # if we stumble upon a value element with no internal
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	795 # elements, treat it as a string element
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	796 if self._value:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	797 self.end_string(data)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	798 dispatch["value"] = end_value
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	799
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	800 def end_params(self, data):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	801 self._type = "params"
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	802 dispatch["params"] = end_params
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	803
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	804 def end_fault(self, data):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	805 self._type = "fault"
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	806 dispatch["fault"] = end_fault
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	807
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	808 def end_methodName(self, data):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	809 if self._encoding:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	810 data = data.decode(self._encoding)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	811 self._methodname = data
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	812 self._type = "methodName" # no params
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	813 dispatch["methodName"] = end_methodName
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	814
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	815 ## Multicall support
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	816 #
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	817
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	818 class _MultiCallMethod(object):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	819 # some lesser magic to store calls made to a MultiCall object
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	820 # for batch execution
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	821 def __init__(self, call_list, name):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	822 self.__call_list = call_list
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	823 self.__name = name
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	824 def __getattr__(self, name):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	825 return _MultiCallMethod(self.__call_list, "%s.%s" % (self.__name, name))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	826 def __call__(self, *args):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	827 self.__call_list.append((self.__name, args))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	828
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	829 class MultiCallIterator(object):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	830 """Iterates over the results of a multicall. Exceptions are
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	831 raised in response to xmlrpc faults."""
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	832
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	833 def __init__(self, results):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	834 self.results = results
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	835
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	836 def __getitem__(self, i):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	837 item = self.results[i]
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	838 if isinstance(type(item), dict):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	839 raise Fault(item['faultCode'], item['faultString'])
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	840 elif type(item) == type([]):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	841 return item[0]
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	842 else:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	843 raise ValueError("unexpected type in multicall result")
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	844
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	845 class MultiCall(object):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	846 """server -> a object used to boxcar method calls
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	847
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	848 server should be a ServerProxy object.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	849
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	850 Methods can be added to the MultiCall using normal
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	851 method call syntax e.g.:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	852
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	853 multicall = MultiCall(server_proxy)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	854 multicall.add(2,3)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	855 multicall.get_address("Guido")
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	856
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	857 To execute the multicall, call the MultiCall object e.g.:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	858
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	859 add_result, address = multicall()
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	860 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	861
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	862 def __init__(self, server):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	863 self.__server = server
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	864 self.__call_list = []
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	865
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	866 def __repr__(self):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	867 return "<MultiCall at %x>" % id(self)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	868
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	869 __str__ = __repr__
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	870
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	871 def __getattr__(self, name):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	872 return _MultiCallMethod(self.__call_list, name)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	873
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	874 def __call__(self):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	875 marshalled_list = []
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	876 for name, args in self.__call_list:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	877 marshalled_list.append({'methodName' : name, 'params' : args})
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	878
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	879 return MultiCallIterator(self.__server.system.multicall(marshalled_list))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	880
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	881 # --------------------------------------------------------------------
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	882 # convenience functions
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	883
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	884 FastMarshaller = FastParser = FastUnmarshaller = None
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	885
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	886 ##
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	887 # Create a parser object, and connect it to an unmarshalling instance.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	888 # This function picks the fastest available XML parser.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	889 #
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	890 # return A (parser, unmarshaller) tuple.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	891
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	892 def getparser(use_datetime=False, use_builtin_types=False):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	893 """getparser() -> parser, unmarshaller
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	894
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	895 Create an instance of the fastest available parser, and attach it
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	896 to an unmarshalling object. Return both objects.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	897 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	898 if FastParser and FastUnmarshaller:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	899 if use_builtin_types:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	900 mkdatetime = _datetime_type
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	901 mkbytes = base64.decodebytes
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	902 elif use_datetime:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	903 mkdatetime = _datetime_type
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	904 mkbytes = _binary
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	905 else:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	906 mkdatetime = _datetime
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	907 mkbytes = _binary
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	908 target = FastUnmarshaller(True, False, mkbytes, mkdatetime, Fault)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	909 parser = FastParser(target)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	910 else:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	911 target = Unmarshaller(use_datetime=use_datetime, use_builtin_types=use_builtin_types)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	912 if FastParser:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	913 parser = FastParser(target)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	914 else:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	915 parser = ExpatParser(target)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	916 return parser, target
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	917
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	918 ##
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	919 # Convert a Python tuple or a Fault instance to an XML-RPC packet.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	920 #
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	921 # @def dumps(params, **options)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	922 # @param params A tuple or Fault instance.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	923 # @keyparam methodname If given, create a methodCall request for
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	924 # this method name.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	925 # @keyparam methodresponse If given, create a methodResponse packet.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	926 # If used with a tuple, the tuple must be a singleton (that is,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	927 # it must contain exactly one element).
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	928 # @keyparam encoding The packet encoding.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	929 # @return A string containing marshalled data.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	930
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	931 def dumps(params, methodname=None, methodresponse=None, encoding=None,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	932 allow_none=False):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	933 """data [,options] -> marshalled data
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	934
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	935 Convert an argument tuple or a Fault instance to an XML-RPC
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	936 request (or response, if the methodresponse option is used).
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	937
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	938 In addition to the data object, the following options can be given
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	939 as keyword arguments:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	940
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	941 methodname: the method name for a methodCall packet
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	942
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	943 methodresponse: true to create a methodResponse packet.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	944 If this option is used with a tuple, the tuple must be
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	945 a singleton (i.e. it can contain only one element).
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	946
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	947 encoding: the packet encoding (default is UTF-8)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	948
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	949 All byte strings in the data structure are assumed to use the
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	950 packet encoding. Unicode strings are automatically converted,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	951 where necessary.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	952 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	953
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	954 assert isinstance(params, (tuple, Fault)), "argument must be tuple or Fault instance"
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	955 if isinstance(params, Fault):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	956 methodresponse = 1
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	957 elif methodresponse and isinstance(params, tuple):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	958 assert len(params) == 1, "response tuple must be a singleton"
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	959
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	960 if not encoding:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	961 encoding = "utf-8"
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	962
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	963 if FastMarshaller:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	964 m = FastMarshaller(encoding)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	965 else:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	966 m = Marshaller(encoding, allow_none)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	967
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	968 data = m.dumps(params)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	969
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	970 if encoding != "utf-8":
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	971 xmlheader = "<?xml version='1.0' encoding='%s'?>\n" % str(encoding)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	972 else:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	973 xmlheader = "<?xml version='1.0'?>\n" # utf-8 is default
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	974
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	975 # standard XML-RPC wrappings
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	976 if methodname:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	977 # a method call
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	978 if not isinstance(methodname, str):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	979 methodname = methodname.encode(encoding)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	980 data = (
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	981 xmlheader,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	982 "<methodCall>\n"
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	983 "<methodName>", methodname, "</methodName>\n",
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	984 data,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	985 "</methodCall>\n"
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	986 )
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	987 elif methodresponse:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	988 # a method response, or a fault structure
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	989 data = (
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	990 xmlheader,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	991 "<methodResponse>\n",
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	992 data,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	993 "</methodResponse>\n"
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	994 )
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	995 else:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	996 return data # return as is
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	997 return str("").join(data)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	998
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	999 ##
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1000 # Convert an XML-RPC packet to a Python object. If the XML-RPC packet
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1001 # represents a fault condition, this function raises a Fault exception.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1002 #
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1003 # @param data An XML-RPC packet, given as an 8-bit string.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1004 # @return A tuple containing the unpacked data, and the method name
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1005 # (None if not present).
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1006 # @see Fault
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1007
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1008 def loads(data, use_datetime=False, use_builtin_types=False):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1009 """data -> unmarshalled data, method name
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1010
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1011 Convert an XML-RPC packet to unmarshalled data plus a method
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1012 name (None if not present).
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1013
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1014 If the XML-RPC packet represents a fault condition, this function
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1015 raises a Fault exception.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1016 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1017 p, u = getparser(use_datetime=use_datetime, use_builtin_types=use_builtin_types)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1018 p.feed(data)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1019 p.close()
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1020 return u.close(), u.getmethodname()
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1021
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1022 ##
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1023 # Encode a string using the gzip content encoding such as specified by the
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1024 # Content-Encoding: gzip
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1025 # in the HTTP header, as described in RFC 1952
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1026 #
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1027 # @param data the unencoded data
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1028 # @return the encoded data
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1029
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1030 def gzip_encode(data):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1031 """data -> gzip encoded data
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1032
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1033 Encode data using the gzip content encoding as described in RFC 1952
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1034 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1035 if not gzip:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1036 raise NotImplementedError
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1037 f = BytesIO()
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1038 gzf = gzip.GzipFile(mode="wb", fileobj=f, compresslevel=1)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1039 gzf.write(data)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1040 gzf.close()
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1041 encoded = f.getvalue()
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1042 f.close()
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1043 return encoded
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1044
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1045 ##
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1046 # Decode a string using the gzip content encoding such as specified by the
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1047 # Content-Encoding: gzip
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1048 # in the HTTP header, as described in RFC 1952
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1049 #
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1050 # @param data The encoded data
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1051 # @return the unencoded data
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1052 # @raises ValueError if data is not correctly coded.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1053
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1054 def gzip_decode(data):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1055 """gzip encoded data -> unencoded data
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1056
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1057 Decode data using the gzip content encoding as described in RFC 1952
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1058 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1059 if not gzip:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1060 raise NotImplementedError
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1061 f = BytesIO(data)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1062 gzf = gzip.GzipFile(mode="rb", fileobj=f)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1063 try:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1064 decoded = gzf.read()
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1065 except IOError:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1066 raise ValueError("invalid data")
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1067 f.close()
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1068 gzf.close()
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1069 return decoded
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1070
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1071 ##
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1072 # Return a decoded file-like object for the gzip encoding
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1073 # as described in RFC 1952.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1074 #
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1075 # @param response A stream supporting a read() method
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1076 # @return a file-like object that the decoded data can be read() from
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1077
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1078 class GzipDecodedResponse(gzip.GzipFile if gzip else object):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1079 """a file-like object to decode a response encoded with the gzip
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1080 method, as described in RFC 1952.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1081 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1082 def __init__(self, response):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1083 #response doesn't support tell() and read(), required by
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1084 #GzipFile
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1085 if not gzip:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1086 raise NotImplementedError
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1087 self.io = BytesIO(response.read())
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1088 gzip.GzipFile.__init__(self, mode="rb", fileobj=self.io)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1089
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1090 def close(self):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1091 gzip.GzipFile.close(self)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1092 self.io.close()
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1093
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1094
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1095 # --------------------------------------------------------------------
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1096 # request dispatcher
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1097
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1098 class _Method(object):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1099 # some magic to bind an XML-RPC method to an RPC server.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1100 # supports "nested" methods (e.g. examples.getStateName)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1101 def __init__(self, send, name):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1102 self.__send = send
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1103 self.__name = name
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1104 def __getattr__(self, name):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1105 return _Method(self.__send, "%s.%s" % (self.__name, name))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1106 def __call__(self, *args):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1107 return self.__send(self.__name, args)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1108
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1109 ##
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1110 # Standard transport class for XML-RPC over HTTP.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1111 # <p>
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1112 # You can create custom transports by subclassing this method, and
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1113 # overriding selected methods.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1114
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1115 class Transport(object):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1116 """Handles an HTTP transaction to an XML-RPC server."""
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1117
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1118 # client identifier (may be overridden)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1119 user_agent = "Python-xmlrpc/%s" % __version__
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1120
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1121 #if true, we'll request gzip encoding
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1122 accept_gzip_encoding = True
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1123
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1124 # if positive, encode request using gzip if it exceeds this threshold
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1125 # note that many server will get confused, so only use it if you know
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1126 # that they can decode such a request
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1127 encode_threshold = None #None = don't encode
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1128
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1129 def __init__(self, use_datetime=False, use_builtin_types=False):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1130 self._use_datetime = use_datetime
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1131 self._use_builtin_types = use_builtin_types
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1132 self._connection = (None, None)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1133 self._extra_headers = []
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1134
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1135 ##
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1136 # Send a complete request, and parse the response.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1137 # Retry request if a cached connection has disconnected.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1138 #
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1139 # @param host Target host.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1140 # @param handler Target PRC handler.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1141 # @param request_body XML-RPC request body.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1142 # @param verbose Debugging flag.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1143 # @return Parsed response.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1144
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1145 def request(self, host, handler, request_body, verbose=False):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1146 #retry request once if cached connection has gone cold
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1147 for i in (0, 1):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1148 try:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1149 return self.single_request(host, handler, request_body, verbose)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1150 except socket.error as e:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1151 if i or e.errno not in (errno.ECONNRESET, errno.ECONNABORTED, errno.EPIPE):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1152 raise
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1153 except http_client.BadStatusLine: #close after we sent request
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1154 if i:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1155 raise
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1156
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1157 def single_request(self, host, handler, request_body, verbose=False):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1158 # issue XML-RPC request
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1159 try:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1160 http_conn = self.send_request(host, handler, request_body, verbose)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1161 resp = http_conn.getresponse()
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1162 if resp.status == 200:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1163 self.verbose = verbose
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1164 return self.parse_response(resp)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1165
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1166 except Fault:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1167 raise
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1168 except Exception:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1169 #All unexpected errors leave connection in
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1170 # a strange state, so we clear it.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1171 self.close()
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1172 raise
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1173
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1174 #We got an error response.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1175 #Discard any response data and raise exception
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1176 if resp.getheader("content-length", ""):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1177 resp.read()
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1178 raise ProtocolError(
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1179 host + handler,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1180 resp.status, resp.reason,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1181 dict(resp.getheaders())
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1182 )
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1183
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1184
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1185 ##
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1186 # Create parser.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1187 #
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1188 # @return A 2-tuple containing a parser and a unmarshaller.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1189
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1190 def getparser(self):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1191 # get parser and unmarshaller
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1192 return getparser(use_datetime=self._use_datetime,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1193 use_builtin_types=self._use_builtin_types)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1194
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1195 ##
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1196 # Get authorization info from host parameter
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1197 # Host may be a string, or a (host, x509-dict) tuple; if a string,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1198 # it is checked for a "user:pw@host" format, and a "Basic
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1199 # Authentication" header is added if appropriate.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1200 #
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1201 # @param host Host descriptor (URL or (URL, x509 info) tuple).
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1202 # @return A 3-tuple containing (actual host, extra headers,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1203 # x509 info). The header and x509 fields may be None.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1204
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1205 def get_host_info(self, host):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1206
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1207 x509 = {}
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1208 if isinstance(host, tuple):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1209 host, x509 = host
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1210
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1211 auth, host = urllib_parse.splituser(host)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1212
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1213 if auth:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1214 auth = urllib_parse.unquote_to_bytes(auth)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1215 auth = base64.encodebytes(auth).decode("utf-8")
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1216 auth = "".join(auth.split()) # get rid of whitespace
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1217 extra_headers = [
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1218 ("Authorization", "Basic " + auth)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1219 ]
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1220 else:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1221 extra_headers = []
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1222
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1223 return host, extra_headers, x509
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1224
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1225 ##
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1226 # Connect to server.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1227 #
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1228 # @param host Target host.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1229 # @return An HTTPConnection object
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1230
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1231 def make_connection(self, host):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1232 #return an existing connection if possible. This allows
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1233 #HTTP/1.1 keep-alive.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1234 if self._connection and host == self._connection[0]:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1235 return self._connection[1]
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1236 # create a HTTP connection object from a host descriptor
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1237 chost, self._extra_headers, x509 = self.get_host_info(host)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1238 self._connection = host, http_client.HTTPConnection(chost)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1239 return self._connection[1]
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1240
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1241 ##
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1242 # Clear any cached connection object.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1243 # Used in the event of socket errors.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1244 #
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1245 def close(self):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1246 if self._connection[1]:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1247 self._connection[1].close()
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1248 self._connection = (None, None)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1249
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1250 ##
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1251 # Send HTTP request.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1252 #
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1253 # @param host Host descriptor (URL or (URL, x509 info) tuple).
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1254 # @param handler Targer RPC handler (a path relative to host)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1255 # @param request_body The XML-RPC request body
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1256 # @param debug Enable debugging if debug is true.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1257 # @return An HTTPConnection.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1258
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1259 def send_request(self, host, handler, request_body, debug):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1260 connection = self.make_connection(host)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1261 headers = self._extra_headers[:]
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1262 if debug:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1263 connection.set_debuglevel(1)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1264 if self.accept_gzip_encoding and gzip:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1265 connection.putrequest("POST", handler, skip_accept_encoding=True)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1266 headers.append(("Accept-Encoding", "gzip"))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1267 else:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1268 connection.putrequest("POST", handler)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1269 headers.append(("Content-Type", "text/xml"))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1270 headers.append(("User-Agent", self.user_agent))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1271 self.send_headers(connection, headers)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1272 self.send_content(connection, request_body)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1273 return connection
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1274
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1275 ##
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1276 # Send request headers.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1277 # This function provides a useful hook for subclassing
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1278 #
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1279 # @param connection httpConnection.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1280 # @param headers list of key,value pairs for HTTP headers
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1281
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1282 def send_headers(self, connection, headers):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1283 for key, val in headers:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1284 connection.putheader(key, val)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1285
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1286 ##
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1287 # Send request body.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1288 # This function provides a useful hook for subclassing
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1289 #
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1290 # @param connection httpConnection.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1291 # @param request_body XML-RPC request body.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1292
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1293 def send_content(self, connection, request_body):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1294 #optionally encode the request
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1295 if (self.encode_threshold is not None and
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1296 self.encode_threshold < len(request_body) and
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1297 gzip):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1298 connection.putheader("Content-Encoding", "gzip")
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1299 request_body = gzip_encode(request_body)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1300
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1301 connection.putheader("Content-Length", str(len(request_body)))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1302 connection.endheaders(request_body)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1303
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1304 ##
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1305 # Parse response.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1306 #
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1307 # @param file Stream.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1308 # @return Response tuple and target method.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1309
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1310 def parse_response(self, response):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1311 # read response data from httpresponse, and parse it
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1312 # Check for new http response object, otherwise it is a file object.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1313 if hasattr(response, 'getheader'):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1314 if response.getheader("Content-Encoding", "") == "gzip":
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1315 stream = GzipDecodedResponse(response)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1316 else:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1317 stream = response
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1318 else:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1319 stream = response
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1320
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1321 p, u = self.getparser()
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1322
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1323 while 1:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1324 data = stream.read(1024)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1325 if not data:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1326 break
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1327 if self.verbose:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1328 print("body:", repr(data))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1329 p.feed(data)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1330
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1331 if stream is not response:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1332 stream.close()
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1333 p.close()
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1334
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1335 return u.close()
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1336
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1337 ##
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1338 # Standard transport class for XML-RPC over HTTPS.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1339
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1340 class SafeTransport(Transport):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1341 """Handles an HTTPS transaction to an XML-RPC server."""
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1342
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1343 # FIXME: mostly untested
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1344
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1345 def make_connection(self, host):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1346 if self._connection and host == self._connection[0]:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1347 return self._connection[1]
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1348
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1349 if not hasattr(http_client, "HTTPSConnection"):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1350 raise NotImplementedError(
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1351 "your version of http.client doesn't support HTTPS")
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1352 # create a HTTPS connection object from a host descriptor
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1353 # host may be a string, or a (host, x509-dict) tuple
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1354 chost, self._extra_headers, x509 = self.get_host_info(host)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1355 self._connection = host, http_client.HTTPSConnection(chost,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1356 None, **(x509 or {}))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1357 return self._connection[1]
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1358
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1359 ##
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1360 # Standard server proxy. This class establishes a virtual connection
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1361 # to an XML-RPC server.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1362 # <p>
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1363 # This class is available as ServerProxy and Server. New code should
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1364 # use ServerProxy, to avoid confusion.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1365 #
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1366 # @def ServerProxy(uri, **options)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1367 # @param uri The connection point on the server.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1368 # @keyparam transport A transport factory, compatible with the
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1369 # standard transport class.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1370 # @keyparam encoding The default encoding used for 8-bit strings
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1371 # (default is UTF-8).
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1372 # @keyparam verbose Use a true value to enable debugging output.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1373 # (printed to standard output).
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1374 # @see Transport
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1375
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1376 class ServerProxy(object):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1377 """uri [,options] -> a logical connection to an XML-RPC server
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1378
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1379 uri is the connection point on the server, given as
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1380 scheme://host/target.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1381
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1382 The standard implementation always supports the "http" scheme. If
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1383 SSL socket support is available (Python 2.0), it also supports
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1384 "https".
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1385
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1386 If the target part and the slash preceding it are both omitted,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1387 "/RPC2" is assumed.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1388
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1389 The following options can be given as keyword arguments:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1390
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1391 transport: a transport factory
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1392 encoding: the request encoding (default is UTF-8)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1393
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1394 All 8-bit strings passed to the server proxy are assumed to use
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1395 the given encoding.
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1396 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1397
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1398 def __init__(self, uri, transport=None, encoding=None, verbose=False,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1399 allow_none=False, use_datetime=False, use_builtin_types=False):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1400 # establish a "logical" server connection
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1401
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1402 # get the url
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1403 type, uri = urllib_parse.splittype(uri)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1404 if type not in ("http", "https"):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1405 raise IOError("unsupported XML-RPC protocol")
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1406 self.__host, self.__handler = urllib_parse.splithost(uri)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1407 if not self.__handler:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1408 self.__handler = "/RPC2"
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1409
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1410 if transport is None:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1411 if type == "https":
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1412 handler = SafeTransport
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1413 else:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1414 handler = Transport
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1415 transport = handler(use_datetime=use_datetime,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1416 use_builtin_types=use_builtin_types)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1417 self.__transport = transport
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1418
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1419 self.__encoding = encoding or 'utf-8'
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1420 self.__verbose = verbose
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1421 self.__allow_none = allow_none
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1422
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1423 def __close(self):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1424 self.__transport.close()
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1425
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1426 def __request(self, methodname, params):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1427 # call a method on the remote server
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1428
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1429 request = dumps(params, methodname, encoding=self.__encoding,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1430 allow_none=self.__allow_none).encode(self.__encoding)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1431
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1432 response = self.__transport.request(
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1433 self.__host,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1434 self.__handler,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1435 request,
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1436 verbose=self.__verbose
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1437 )
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1438
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1439 if len(response) == 1:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1440 response = response[0]
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1441
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1442 return response
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1443
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1444 def __repr__(self):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1445 return (
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1446 "<ServerProxy for %s%s>" %
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1447 (self.__host, self.__handler)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1448 )
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1449
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1450 __str__ = __repr__
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1451
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1452 def __getattr__(self, name):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1453 # magic method dispatcher
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1454 return _Method(self.__request, name)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1455
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1456 # note: to call a remote object with an non-standard name, use
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1457 # result getattr(server, "strange-python-name")(args)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1458
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1459 def __call__(self, attr):
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1460 """A workaround to get special attributes on the ServerProxy
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1461 without interfering with the magic __getattr__
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1462 """
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1463 if attr == "close":
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1464 return self.__close
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1465 elif attr == "transport":
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1466 return self.__transport
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1467 raise AttributeError("Attribute %r not found" % (attr,))
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1468
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1469 # compatibility
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1470
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1471 Server = ServerProxy
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1472
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1473 # --------------------------------------------------------------------
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1474 # test code
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1475
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1476 if __name__ == "__main__":
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1477
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1478 # simple test program (from the XML-RPC specification)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1479
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1480 # local server, available from Lib/xmlrpc/server.py
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1481 server = ServerProxy("http://localhost:8000")
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1482
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1483 try:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1484 print(server.currentTime.getCurrentTime())
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1485 except Error as v:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1486 print("ERROR", v)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1487
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1488 multi = MultiCall(server)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1489 multi.getData()
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1490 multi.pow(2,9)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1491 multi.add(1,2)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1492 try:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1493 for response in multi():
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1494 print(response)
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1495 except Error as v:
d30785e31577 "planemo upload commit 6eee67778febed82ddd413c3ca40b3183a3898f1" guerler parents: diff changeset	1496 print("ERROR", v)

Mercurial > repos > guerler > springsuite

annotate planemo/lib/python3.7/site-packages/future/backports/xmlrpc/client.py @ 1:56ad4e20f292 draft