Gecko [ v99win.today ]

Name	Size	Permission
2to3.html	63.71 KB	-rw-r--r--
__builtin__.html	11.79 KB	-rw-r--r--
__future__.html	15.58 KB	-rw-r--r--
__main__.html	8.33 KB	-rw-r--r--
_winreg.html	73.99 KB	-rw-r--r--
abc.html	26.82 KB	-rw-r--r--
aepack.html	15.47 KB	-rw-r--r--
aetools.html	18.79 KB	-rw-r--r--
aetypes.html	27.08 KB	-rw-r--r--
aifc.html	29.59 KB	-rw-r--r--
al.html	22.13 KB	-rw-r--r--
allos.html	35.48 KB	-rw-r--r--
anydbm.html	19.31 KB	-rw-r--r--
archiving.html	10.64 KB	-rw-r--r--
argparse.html	269.59 KB	-rw-r--r--
array.html	35.35 KB	-rw-r--r--
ast.html	42.42 KB	-rw-r--r--
asynchat.html	35.84 KB	-rw-r--r--
asyncore.html	43.22 KB	-rw-r--r--
atexit.html	19.23 KB	-rw-r--r--
audioop.html	41.32 KB	-rw-r--r--
autogil.html	9.77 KB	-rw-r--r--
base64.html	24.8 KB	-rw-r--r--
basehttpserver.html	40.6 KB	-rw-r--r--
bastion.html	13.02 KB	-rw-r--r--
bdb.html	50.06 KB	-rw-r--r--
binascii.html	26.64 KB	-rw-r--r--
binhex.html	12.66 KB	-rw-r--r--
bisect.html	28.52 KB	-rw-r--r--
bsddb.html	32.02 KB	-rw-r--r--
bz2.html	31.92 KB	-rw-r--r--
calendar.html	50.16 KB	-rw-r--r--
carbon.html	54.14 KB	-rw-r--r--
cd.html	35.24 KB	-rw-r--r--
cgi.html	58.4 KB	-rw-r--r--
cgihttpserver.html	15.12 KB	-rw-r--r--
cgitb.html	13.5 KB	-rw-r--r--
chunk.html	17.41 KB	-rw-r--r--
cmath.html	32.41 KB	-rw-r--r--
cmd.html	32.69 KB	-rw-r--r--
code.html	28.92 KB	-rw-r--r--
codecs.html	125.92 KB	-rw-r--r--
codeop.html	16.42 KB	-rw-r--r--
collections.html	150.36 KB	-rw-r--r--
colorpicker.html	9.02 KB	-rw-r--r--
colorsys.html	14.38 KB	-rw-r--r--
commands.html	16.63 KB	-rw-r--r--
compileall.html	21.18 KB	-rw-r--r--
compiler.html	78.14 KB	-rw-r--r--
configparser.html	73.92 KB	-rw-r--r--
constants.html	14.68 KB	-rw-r--r--
contextlib.html	22.91 KB	-rw-r--r--
cookie.html	45.38 KB	-rw-r--r--
cookielib.html	102.78 KB	-rw-r--r--
copy.html	14.21 KB	-rw-r--r--
copy_reg.html	15.82 KB	-rw-r--r--
crypt.html	11.62 KB	-rw-r--r--
crypto.html	8.35 KB	-rw-r--r--
csv.html	82.79 KB	-rw-r--r--
ctypes.html	280.57 KB	-rw-r--r--
curses.ascii.html	28.97 KB	-rw-r--r--
curses.html	200.94 KB	-rw-r--r--
curses.panel.html	18.43 KB	-rw-r--r--
custominterp.html	8.59 KB	-rw-r--r--
datatypes.html	18.84 KB	-rw-r--r--
datetime.html	261.02 KB	-rw-r--r--
dbhash.html	18.4 KB	-rw-r--r--
dbm.html	14.75 KB	-rw-r--r--
debug.html	11.28 KB	-rw-r--r--
decimal.html	239.14 KB	-rw-r--r--
development.html	15.27 KB	-rw-r--r--
difflib.html	96.93 KB	-rw-r--r--
dircache.html	13.66 KB	-rw-r--r--
dis.html	96.52 KB	-rw-r--r--
distribution.html	8.27 KB	-rw-r--r--
distutils.html	10.97 KB	-rw-r--r--
dl.html	19.27 KB	-rw-r--r--
doctest.html	193.18 KB	-rw-r--r--
docxmlrpcserver.html	20.02 KB	-rw-r--r--
dumbdbm.html	16.74 KB	-rw-r--r--
dummy_thread.html	11.04 KB	-rw-r--r--
dummy_threading.html	9.96 KB	-rw-r--r--
easydialogs.html	38.83 KB	-rw-r--r--
email-examples.html	47.2 KB	-rw-r--r--
email.charset.html	32.45 KB	-rw-r--r--
email.encoders.html	14.09 KB	-rw-r--r--
email.errors.html	19.2 KB	-rw-r--r--
email.generator.html	24.78 KB	-rw-r--r--
email.header.html	31.12 KB	-rw-r--r--
email.html	55.3 KB	-rw-r--r--
email.iterators.html	14.22 KB	-rw-r--r--
email.message.html	74.91 KB	-rw-r--r--
email.mime.html	34.51 KB	-rw-r--r--
email.parser.html	37.09 KB	-rw-r--r--
email.utils.html	30.04 KB	-rw-r--r--
ensurepip.html	20.21 KB	-rw-r--r--
errno.html	52.31 KB	-rw-r--r--
exceptions.html	73.4 KB	-rw-r--r--
fcntl.html	27.85 KB	-rw-r--r--
filecmp.html	26.49 KB	-rw-r--r--
fileformats.html	10.21 KB	-rw-r--r--
fileinput.html	29.36 KB	-rw-r--r--
filesys.html	11.55 KB	-rw-r--r--
fl.html	71.58 KB	-rw-r--r--
fm.html	15 KB	-rw-r--r--
fnmatch.html	17.78 KB	-rw-r--r--
formatter.html	43.91 KB	-rw-r--r--
fpectl.html	17.84 KB	-rw-r--r--
fpformat.html	12.65 KB	-rw-r--r--
fractions.html	27.17 KB	-rw-r--r--
framework.html	44.24 KB	-rw-r--r--
frameworks.html	8.11 KB	-rw-r--r--
ftplib.html	56.56 KB	-rw-r--r--
functions.html	216.84 KB	-rw-r--r--
functools.html	31.06 KB	-rw-r--r--
future_builtins.html	15.9 KB	-rw-r--r--
gc.html	30.74 KB	-rw-r--r--
gdbm.html	19.35 KB	-rw-r--r--
gensuitemodule.html	14.54 KB	-rw-r--r--
getopt.html	26.56 KB	-rw-r--r--
getpass.html	12.5 KB	-rw-r--r--
gettext.html	91.32 KB	-rw-r--r--
gl.html	26.71 KB	-rw-r--r--
glob.html	15.42 KB	-rw-r--r--
grp.html	12.33 KB	-rw-r--r--
gzip.html	21.95 KB	-rw-r--r--
hashlib.html	27.4 KB	-rw-r--r--
heapq.html	36.72 KB	-rw-r--r--
hmac.html	15.97 KB	-rw-r--r--
hotshot.html	22.69 KB	-rw-r--r--
htmllib.html	29.9 KB	-rw-r--r--
htmlparser.html	45.11 KB	-rw-r--r--
httplib.html	78.55 KB	-rw-r--r--
i18n.html	10.61 KB	-rw-r--r--
ic.html	22.03 KB	-rw-r--r--
idle.html	45.74 KB	-rw-r--r--
imageop.html	20.94 KB	-rw-r--r--
imaplib.html	69.9 KB	-rw-r--r--
imgfile.html	14.91 KB	-rw-r--r--
imghdr.html	13.43 KB	-rw-r--r--
imp.html	41.48 KB	-rw-r--r--
importlib.html	10.27 KB	-rw-r--r--
imputil.html	36.11 KB	-rw-r--r--
index.html	82.54 KB	-rw-r--r--
inspect.html	64.31 KB	-rw-r--r--
internet.html	26.77 KB	-rw-r--r--
intro.html	9.76 KB	-rw-r--r--
io.html	122.3 KB	-rw-r--r--
ipc.html	17.18 KB	-rw-r--r--
itertools.html	129.91 KB	-rw-r--r--
jpeg.html	15.36 KB	-rw-r--r--
json.html	79.09 KB	-rw-r--r--
keyword.html	9.27 KB	-rw-r--r--
language.html	12.35 KB	-rw-r--r--
linecache.html	12.7 KB	-rw-r--r--
locale.html	68.54 KB	-rw-r--r--
logging.config.html	82.23 KB	-rw-r--r--
logging.handlers.html	91.96 KB	-rw-r--r--
logging.html	123.15 KB	-rw-r--r--
mac.html	24.49 KB	-rw-r--r--
macos.html	18.51 KB	-rw-r--r--
macosa.html	14.55 KB	-rw-r--r--
macostools.html	19.67 KB	-rw-r--r--
macpath.html	9.19 KB	-rw-r--r--
mailbox.html	185.53 KB	-rw-r--r--
mailcap.html	15.3 KB	-rw-r--r--
markup.html	20.37 KB	-rw-r--r--
marshal.html	19.88 KB	-rw-r--r--
math.html	50.52 KB	-rw-r--r--
md5.html	16.65 KB	-rw-r--r--
mhlib.html	30.04 KB	-rw-r--r--
mimetools.html	23.84 KB	-rw-r--r--
mimetypes.html	35.82 KB	-rw-r--r--
mimewriter.html	18.19 KB	-rw-r--r--
mimify.html	16.96 KB	-rw-r--r--
miniaeframe.html	14.5 KB	-rw-r--r--
misc.html	7.77 KB	-rw-r--r--
mm.html	10.19 KB	-rw-r--r--
mmap.html	33.52 KB	-rw-r--r--
modulefinder.html	19.85 KB	-rw-r--r--
modules.html	9.68 KB	-rw-r--r--
msilib.html	72.78 KB	-rw-r--r--
msvcrt.html	24.1 KB	-rw-r--r--
multifile.html	28.82 KB	-rw-r--r--
multiprocessing.html	423.97 KB	-rw-r--r--
mutex.html	13.56 KB	-rw-r--r--
netdata.html	19.28 KB	-rw-r--r--
netrc.html	15.51 KB	-rw-r--r--
new.html	16.1 KB	-rw-r--r--
nis.html	13.19 KB	-rw-r--r--
nntplib.html	51.08 KB	-rw-r--r--
numbers.html	40.91 KB	-rw-r--r--
numeric.html	14.85 KB	-rw-r--r--
operator.html	118.32 KB	-rw-r--r--
optparse.html	251.08 KB	-rw-r--r--
os.html	270.49 KB	-rw-r--r--
os.path.html	48.87 KB	-rw-r--r--
ossaudiodev.html	49.79 KB	-rw-r--r--
othergui.html	9.98 KB	-rw-r--r--
parser.html	44.52 KB	-rw-r--r--
pdb.html	41.44 KB	-rw-r--r--
persistence.html	16.25 KB	-rw-r--r--
pickle.html	107.94 KB	-rw-r--r--
pickletools.html	13.21 KB	-rw-r--r--
pipes.html	21.85 KB	-rw-r--r--
pkgutil.html	30.59 KB	-rw-r--r--
platform.html	40.14 KB	-rw-r--r--
plistlib.html	20.96 KB	-rw-r--r--
popen2.html	30.13 KB	-rw-r--r--
poplib.html	27.93 KB	-rw-r--r--
posix.html	17.27 KB	-rw-r--r--
posixfile.html	23.68 KB	-rw-r--r--
pprint.html	36.42 KB	-rw-r--r--
profile.html	76.65 KB	-rw-r--r--
pty.html	11.42 KB	-rw-r--r--
pwd.html	13.53 KB	-rw-r--r--
py_compile.html	13.33 KB	-rw-r--r--
pyclbr.html	18.14 KB	-rw-r--r--
pydoc.html	14.33 KB	-rw-r--r--
pyexpat.html	93.28 KB	-rw-r--r--
python.html	13.53 KB	-rw-r--r--
queue.html	29.64 KB	-rw-r--r--
quopri.html	14.5 KB	-rw-r--r--
random.html	47.78 KB	-rw-r--r--
re.html	163.11 KB	-rw-r--r--
readline.html	41.2 KB	-rw-r--r--
repr.html	24.57 KB	-rw-r--r--
resource.html	30.86 KB	-rw-r--r--
restricted.html	12.69 KB	-rw-r--r--
rexec.html	43.59 KB	-rw-r--r--
rfc822.html	51.25 KB	-rw-r--r--
rlcompleter.html	15.29 KB	-rw-r--r--
robotparser.html	15.01 KB	-rw-r--r--
runpy.html	23.55 KB	-rw-r--r--
sched.html	21.76 KB	-rw-r--r--
scrolledtext.html	10.67 KB	-rw-r--r--
select.html	50.17 KB	-rw-r--r--
sets.html	39.92 KB	-rw-r--r--
sgi.html	11.09 KB	-rw-r--r--
sgmllib.html	38.77 KB	-rw-r--r--
sha.html	14.55 KB	-rw-r--r--
shelve.html	32.93 KB	-rw-r--r--
shlex.html	38.43 KB	-rw-r--r--
shutil.html	49.49 KB	-rw-r--r--
signal.html	36.52 KB	-rw-r--r--
simplehttpserver.html	21.57 KB	-rw-r--r--
simplexmlrpcserver.html	40.41 KB	-rw-r--r--
site.html	29 KB	-rw-r--r--
smtpd.html	15.64 KB	-rw-r--r--
smtplib.html	51.86 KB	-rw-r--r--
sndhdr.html	12.05 KB	-rw-r--r--
socket.html	126.94 KB	-rw-r--r--
socketserver.html	81.38 KB	-rw-r--r--
someos.html	17.09 KB	-rw-r--r--
spwd.html	12.25 KB	-rw-r--r--
sqlite3.html	154.12 KB	-rw-r--r--
ssl.html	214.5 KB	-rw-r--r--
stat.html	41.11 KB	-rw-r--r--
statvfs.html	13.24 KB	-rw-r--r--
stdtypes.html	309.83 KB	-rw-r--r--
string.html	129.58 KB	-rw-r--r--
stringio.html	21.1 KB	-rw-r--r--
stringprep.html	21.4 KB	-rw-r--r--
strings.html	16.42 KB	-rw-r--r--
struct.html	47.68 KB	-rw-r--r--
subprocess.html	117 KB	-rw-r--r--
sun.html	7.83 KB	-rw-r--r--
sunau.html	35.43 KB	-rw-r--r--
sunaudio.html	21.05 KB	-rw-r--r--
symbol.html	9.06 KB	-rw-r--r--
symtable.html	29.03 KB	-rw-r--r--
sys.html	118.12 KB	-rw-r--r--
sysconfig.html	28.8 KB	-rw-r--r--
syslog.html	21.29 KB	-rw-r--r--
tabnanny.html	12.78 KB	-rw-r--r--
tarfile.html	99.54 KB	-rw-r--r--
telnetlib.html	30.46 KB	-rw-r--r--
tempfile.html	35.02 KB	-rw-r--r--
termios.html	19.22 KB	-rw-r--r--
test.html	61.42 KB	-rw-r--r--
textwrap.html	32.28 KB	-rw-r--r--
thread.html	22.67 KB	-rw-r--r--
threading.html	92.04 KB	-rw-r--r--
time.html	65.55 KB	-rw-r--r--
timeit.html	44.38 KB	-rw-r--r--
tix.html	56.73 KB	-rw-r--r--
tk.html	26.76 KB	-rw-r--r--
tkinter.html	86.67 KB	-rw-r--r--
token.html	27.31 KB	-rw-r--r--
tokenize.html	21.69 KB	-rw-r--r--
trace.html	33.91 KB	-rw-r--r--
traceback.html	44.22 KB	-rw-r--r--
ttk.html	123.83 KB	-rw-r--r--
tty.html	10.95 KB	-rw-r--r--
turtle.html	246.17 KB	-rw-r--r--
types.html	33.66 KB	-rw-r--r--
undoc.html	25.54 KB	-rw-r--r--
unicodedata.html	22.64 KB	-rw-r--r--
unittest.html	246.75 KB	-rw-r--r--
unix.html	11.9 KB	-rw-r--r--
urllib.html	71.61 KB	-rw-r--r--
urllib2.html	128.77 KB	-rw-r--r--
urlparse.html	49.04 KB	-rw-r--r--
user.html	13.41 KB	-rw-r--r--
userdict.html	32.96 KB	-rw-r--r--
uu.html	13.25 KB	-rw-r--r--
uuid.html	33.55 KB	-rw-r--r--
warnings.html	51.86 KB	-rw-r--r--
wave.html	29.08 KB	-rw-r--r--
weakref.html	41.14 KB	-rw-r--r--
webbrowser.html	29.53 KB	-rw-r--r--
whichdb.html	10.44 KB	-rw-r--r--
windows.html	10.37 KB	-rw-r--r--
winsound.html	22.56 KB	-rw-r--r--
wsgiref.html	94.38 KB	-rw-r--r--
xdrlib.html	38.05 KB	-rw-r--r--
xml.dom.html	110.39 KB	-rw-r--r--
xml.dom.minidom.html	45.23 KB	-rw-r--r--
xml.dom.pulldom.html	16.32 KB	-rw-r--r--
xml.etree.elementtree.html	124.2 KB	-rw-r--r--
xml.html	18.76 KB	-rw-r--r--
xml.sax.handler.html	47.5 KB	-rw-r--r--
xml.sax.html	26.04 KB	-rw-r--r--
xml.sax.reader.html	51.4 KB	-rw-r--r--
xml.sax.utils.html	18.11 KB	-rw-r--r--
xmlrpclib.html	71.79 KB	-rw-r--r--
zipfile.html	67.26 KB	-rw-r--r--
zipimport.html	24.32 KB	-rw-r--r--
zlib.html	34.41 KB	-rw-r--r--

Code Editor : xmlrpclib.html

<!DOCTYPE html>

<title>20.23. xmlrpclib — XML-RPC client access &#8212; Python 2.7.18 documentation</title>
 <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
 <link rel="stylesheet" type="text/css" href="../_static/classic.css" />
 
 <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
 <script src="../_static/jquery.js"></script>
 <script src="../_static/underscore.js"></script>
 <script src="../_static/doctools.js"></script>
 
 <script src="../_static/sidebar.js"></script>
 
 <link rel="search" type="application/opensearchdescription+xml"
 title="Search within Python 2.7.18 documentation"
 href="../_static/opensearch.xml"/>
 <link rel="author" title="About these documents" href="../about.html" />
 <link rel="index" title="Index" href="../genindex.html" />
 <link rel="search" title="Search" href="../search.html" />
 <link rel="copyright" title="Copyright" href="../copyright.html" />
 <link rel="next" title="20.24. SimpleXMLRPCServer — Basic XML-RPC server" href="simplexmlrpcserver.html" />
 <link rel="prev" title="20.22. Cookie — HTTP state management" href="cookie.html" />
 <link rel="shortcut icon" type="image/png" href="../_static/py.png" />
 <link rel="canonical" href="file:///usr/share/doc/python2.7/html/library/xmlrpclib.html" />
 <script type="text/javascript" src="../_static/copybutton.js"></script>

</head><body>
<div id="outdated-warning" style="padding: .5em; text-align: center; background-color: #FFBABA; color: #6A0E0E;">
 This document is for an old version of Python that is <a href="https://devguide.python.org/devcycle/#end-of-life-branches">no longer supported</a>.
 You should install the python3 and python3-doc packages and read the 
 <a href="file:///usr/share/doc/python3-doc/html/library/xmlrpclib.html"> Python documentation for the Python3 version packaged in this release</a>.
</div>
 
 <div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 accesskey="I">index</a></li>
 <li class="right" >
 <a href="../py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="simplexmlrpcserver.html" title="20.24. SimpleXMLRPCServer — Basic XML-RPC server"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="cookie.html" title="20.22. Cookie — HTTP state management"
 accesskey="P">previous</a> |</li>
 <li><img src="../_static/py.png" alt=""
 style="vertical-align: middle; margin-top: -1px"/></li>
 <li><a href="https://www.python.org/">Python</a> &#187;</li>
 <li>
 <a href="../index.html">Python 2.7.18 documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="internet.html" accesskey="U">20. Internet Protocols and Support</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">20.23. <code class="xref py py-mod docutils literal notranslate">xmlrpclib</code> — XML-RPC client access</a></li> 
 </ul>
 </div>

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body" role="main">
 
 <section id="module-xmlrpclib">
<h1>20.23. <a class="reference internal" href="#module-xmlrpclib" title="xmlrpclib: XML-RPC client access."><code class="xref py py-mod docutils literal notranslate">xmlrpclib</code></a> — XML-RPC client access<a class="headerlink" href="#module-xmlrpclib" title="Permalink to this headline">¶</a></h1>
<div class="admonition note">
Note
The <a class="reference internal" href="#module-xmlrpclib" title="xmlrpclib: XML-RPC client access."><code class="xref py py-mod docutils literal notranslate">xmlrpclib</code></a> module has been renamed to <code class="xref py py-mod docutils literal notranslate">xmlrpc.client</code> in
Python 3. The <a class="reference internal" href="../glossary.html#term-2to3">2to3</a> tool will automatically adapt imports when
converting your sources to Python 3.
</div>
<div class="versionadded">
New in version 2.2.
</div>
Source code: <a class="reference external" href="https://github.com/python/cpython/tree/2.7/Lib/xmlrpclib.py">Lib/xmlrpclib.py</a>
<hr class="docutils" />
XML-RPC is a Remote Procedure Call method that uses XML passed via HTTP(S) as a
transport. With it, a client can call methods with parameters on a remote
server (the server is named by a URI) and get back structured data. This module
supports writing XML-RPC client code; it handles all the details of translating
between conformable Python objects and XML on the wire.
<div class="admonition warning">
Warning
The <a class="reference internal" href="#module-xmlrpclib" title="xmlrpclib: XML-RPC client access."><code class="xref py py-mod docutils literal notranslate">xmlrpclib</code></a> module is not secure against maliciously
constructed data. If you need to parse untrusted or unauthenticated data see
<a class="reference internal" href="xml.html#xml-vulnerabilities">XML vulnerabilities</a>.
</div>
<div class="versionchanged">
Changed in version 2.7.9: For HTTPS URIs, <a class="reference internal" href="#module-xmlrpclib" title="xmlrpclib: XML-RPC client access."><code class="xref py py-mod docutils literal notranslate">xmlrpclib</code></a> now performs all the necessary certificate
and hostname checks by default.
</div>
<dl class="py class">
<dt class="sig sig-object py" id="xmlrpclib.ServerProxy">
class xmlrpclib.ServerProxy(uri[, transport[, encoding[, verbose[, allow_none[, use_datetime[, context]]]]]])<a class="headerlink" href="#xmlrpclib.ServerProxy" title="Permalink to this definition">¶</a></dt>
<dd>A <a class="reference internal" href="#xmlrpclib.ServerProxy" title="xmlrpclib.ServerProxy"><code class="xref py py-class docutils literal notranslate">ServerProxy</code></a> instance is an object that manages communication with a
remote XML-RPC server. The required first argument is a URI (Uniform Resource
Indicator), and will normally be the URL of the server. The optional second
argument is a transport factory instance; by default it is an internal
<code class="xref py py-class docutils literal notranslate">SafeTransport</code> instance for https: URLs and an internal HTTP
<code class="xref py py-class docutils literal notranslate">Transport</code> instance otherwise. The optional third argument is an
encoding, by default UTF-8. The optional fourth argument is a debugging flag.
The following parameters govern the use of the returned proxy instance.
If allow_none is true, the Python constant <code class="docutils literal notranslate">None</code> will be translated into
XML; the default behaviour is for <code class="docutils literal notranslate">None</code> to raise a <code class="xref py py-exc docutils literal notranslate">TypeError</code>. This is
a commonly-used extension to the XML-RPC specification, but isn’t supported by
all clients and servers; see <a class="reference external" href="https://web.archive.org/web/20130120074804/http://ontosys.com/xml-rpc/extensions.php">http://ontosys.com/xml-rpc/extensions.php</a>
for a description.
The use_datetime flag can be used to cause date/time values to
be presented as <a class="reference internal" href="datetime.html#datetime.datetime" title="datetime.datetime"><code class="xref py py-class docutils literal notranslate">datetime.datetime</code></a> objects; this is false by default.
<a class="reference internal" href="datetime.html#datetime.datetime" title="datetime.datetime"><code class="xref py py-class docutils literal notranslate">datetime.datetime</code></a> objects may be passed to calls.
Both the HTTP and HTTPS transports support the URL syntax extension for HTTP
Basic Authentication: <code class="docutils literal notranslate">http://user:pass&#64;host:port/path</code>. The <code class="docutils literal notranslate">user:pass</code>
portion will be base64-encoded as an HTTP ‘Authorization’ header, and sent to
the remote server as part of the connection process when invoking an XML-RPC
method. You only need to use this if the remote server requires a Basic
Authentication user and password. If an HTTPS URL is provided, context may
be <a class="reference internal" href="ssl.html#ssl.SSLContext" title="ssl.SSLContext"><code class="xref py py-class docutils literal notranslate">ssl.SSLContext</code></a> and configures the SSL settings of the underlying
HTTPS connection.
The returned instance is a proxy object with methods that can be used to invoke
corresponding RPC calls on the remote server. If the remote server supports the
introspection API, the proxy can also be used to query the remote server for the
methods it supports (service discovery) and fetch other server-associated
metadata.
Types that are conformable (e.g. that can be marshalled through XML),
include the following (and except where noted, they are unmarshalled
as the same Python type):
<table class="docutils align-default">
<colgroup>
<col style="width: 29%" />
<col style="width: 71%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head">XML-RPC type</th>
<th class="head">Python type</th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><code class="docutils literal notranslate">boolean</code></td>
<td><a class="reference internal" href="functions.html#bool" title="bool"><code class="xref py py-class docutils literal notranslate">bool</code></a></td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate">int</code> or <code class="docutils literal notranslate">i4</code></td>
<td><a class="reference internal" href="functions.html#int" title="int"><code class="xref py py-class docutils literal notranslate">int</code></a> or <a class="reference internal" href="functions.html#long" title="long"><code class="xref py py-class docutils literal notranslate">long</code></a> in range from
-2147483648 to 2147483647.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate">double</code></td>
<td><a class="reference internal" href="functions.html#float" title="float"><code class="xref py py-class docutils literal notranslate">float</code></a></td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate">string</code></td>
<td><a class="reference internal" href="functions.html#str" title="str"><code class="xref py py-class docutils literal notranslate">str</code></a> or <a class="reference internal" href="functions.html#unicode" title="unicode"><code class="xref py py-class docutils literal notranslate">unicode</code></a></td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate">array</code></td>
<td><code class="xref py py-class docutils literal notranslate">list</code> or <a class="reference internal" href="functions.html#tuple" title="tuple"><code class="xref py py-class docutils literal notranslate">tuple</code></a> containing
conformable elements. Arrays are returned as
<code class="xref py py-class docutils literal notranslate">lists</code>.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate">struct</code></td>
<td><a class="reference internal" href="stdtypes.html#dict" title="dict"><code class="xref py py-class docutils literal notranslate">dict</code></a>. Keys must be strings, values may be
any conformable type. Objects of user-defined
classes can be passed in; only their
<a class="reference internal" href="stdtypes.html#object.__dict__" title="object.__dict__"><code class="xref py py-attr docutils literal notranslate">__dict__</code></a> attribute is transmitted.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate">dateTime.iso8601</code></td>
<td><a class="reference internal" href="#xmlrpclib.DateTime" title="xmlrpclib.DateTime"><code class="xref py py-class docutils literal notranslate">DateTime</code></a> or <a class="reference internal" href="datetime.html#datetime.datetime" title="datetime.datetime"><code class="xref py py-class docutils literal notranslate">datetime.datetime</code></a>.
Returned type depends on values of the use_datetime
flags.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate">base64</code></td>
<td><a class="reference internal" href="#xmlrpclib.Binary" title="xmlrpclib.Binary"><code class="xref py py-class docutils literal notranslate">Binary</code></a></td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate">nil</code></td>
<td>The <code class="docutils literal notranslate">None</code> constant. Passing is allowed only if
allow_none is true.</td>
</tr>
</tbody>
</table>
This is the full set of data types supported by XML-RPC. Method calls may also
raise a special <a class="reference internal" href="#xmlrpclib.Fault" title="xmlrpclib.Fault"><code class="xref py py-exc docutils literal notranslate">Fault</code></a> instance, used to signal XML-RPC server errors, or
<a class="reference internal" href="#xmlrpclib.ProtocolError" title="xmlrpclib.ProtocolError"><code class="xref py py-exc docutils literal notranslate">ProtocolError</code></a> used to signal an error in the HTTP/HTTPS transport layer.
Both <a class="reference internal" href="#xmlrpclib.Fault" title="xmlrpclib.Fault"><code class="xref py py-exc docutils literal notranslate">Fault</code></a> and <a class="reference internal" href="#xmlrpclib.ProtocolError" title="xmlrpclib.ProtocolError"><code class="xref py py-exc docutils literal notranslate">ProtocolError</code></a> derive from a base class called
<code class="xref py py-exc docutils literal notranslate">Error</code>. Note that even though starting with Python 2.2 you can subclass
built-in types, the xmlrpclib module currently does not marshal instances of such
subclasses.
When passing strings, characters special to XML such as <code class="docutils literal notranslate">&lt;</code>, <code class="docutils literal notranslate">&gt;</code>, and <code class="docutils literal notranslate">&amp;</code>
will be automatically escaped. However, it’s the caller’s responsibility to
ensure that the string is free of characters that aren’t allowed in XML, such as
the control characters with ASCII values between 0 and 31 (except, of course,
tab, newline and carriage return); failing to do this will result in an XML-RPC
request that isn’t well-formed XML. If you have to pass arbitrary strings via
XML-RPC, use the <a class="reference internal" href="#xmlrpclib.Binary" title="xmlrpclib.Binary"><code class="xref py py-class docutils literal notranslate">Binary</code></a> wrapper class described below.
<code class="xref py py-class docutils literal notranslate">Server</code> is retained as an alias for <a class="reference internal" href="#xmlrpclib.ServerProxy" title="xmlrpclib.ServerProxy"><code class="xref py py-class docutils literal notranslate">ServerProxy</code></a> for backwards
compatibility. New code should use <a class="reference internal" href="#xmlrpclib.ServerProxy" title="xmlrpclib.ServerProxy"><code class="xref py py-class docutils literal notranslate">ServerProxy</code></a>.
<div class="versionchanged">
Changed in version 2.5: The use_datetime flag was added.
</div>
<div class="versionchanged">
Changed in version 2.6: Instances of <a class="reference internal" href="../glossary.html#term-new-style-class">new-style class</a>es can be passed in if they have an
__dict__ attribute and don’t have a base class that is marshalled in a
special way.
</div>
<div class="versionchanged">
Changed in version 2.7.9: Added the context argument.
</div>
</dd></dl>

<div class="admonition seealso">
See also
<dl class="simple">
<dt><a class="reference external" href="http://www.tldp.org/HOWTO/XML-RPC-HOWTO/index.html">XML-RPC HOWTO</a></dt><dd>A good description of XML-RPC operation and client software in several languages.
Contains pretty much everything an XML-RPC client developer needs to know.
</dd>
<dt><a class="reference external" href="http://xmlrpc-c.sourceforge.net/introspection.html">XML-RPC Introspection</a></dt><dd>Describes the XML-RPC protocol extension for introspection.
</dd>
<dt><a class="reference external" href="http://www.xmlrpc.com/spec">XML-RPC Specification</a></dt><dd>The official specification.
</dd>
<dt><a class="reference external" href="http://effbot.org/zone/xmlrpc-errata.htm">Unofficial XML-RPC Errata</a></dt><dd>Fredrik Lundh’s “unofficial errata, intended to clarify certain
details in the XML-RPC specification, as well as hint at
‘best practices’ to use when designing your own XML-RPC
implementations.”
</dd>
</dl>
</div>
<section id="serverproxy-objects">
<h2>20.23.1. ServerProxy Objects<a class="headerlink" href="#serverproxy-objects" title="Permalink to this headline">¶</a></h2>
A <a class="reference internal" href="#xmlrpclib.ServerProxy" title="xmlrpclib.ServerProxy"><code class="xref py py-class docutils literal notranslate">ServerProxy</code></a> instance has a method corresponding to each remote
procedure call accepted by the XML-RPC server. Calling the method performs an
RPC, dispatched by both name and argument signature (e.g. the same method name
can be overloaded with multiple argument signatures). The RPC finishes by
returning a value, which may be either returned data in a conformant type or a
<a class="reference internal" href="#xmlrpclib.Fault" title="xmlrpclib.Fault"><code class="xref py py-class docutils literal notranslate">Fault</code></a> or <a class="reference internal" href="#xmlrpclib.ProtocolError" title="xmlrpclib.ProtocolError"><code class="xref py py-class docutils literal notranslate">ProtocolError</code></a> object indicating an error.
Servers that support the XML introspection API support some common methods
grouped under the reserved <code class="xref py py-attr docutils literal notranslate">system</code> attribute:
<dl class="py method">
<dt class="sig sig-object py" id="xmlrpclib.ServerProxy.system.listMethods">
ServerProxy.system.listMethods()<a class="headerlink" href="#xmlrpclib.ServerProxy.system.listMethods" title="Permalink to this definition">¶</a></dt>
<dd>This method returns a list of strings, one for each (non-system) method
supported by the XML-RPC server.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="xmlrpclib.ServerProxy.system.methodSignature">
ServerProxy.system.methodSignature(name)<a class="headerlink" href="#xmlrpclib.ServerProxy.system.methodSignature" title="Permalink to this definition">¶</a></dt>
<dd>This method takes one parameter, the name of a method implemented by the XML-RPC
server. It returns an array of possible signatures for this method. A signature
is an array of types. The first of these types is the return type of the method,
the rest are parameters.
Because multiple signatures (ie. overloading) is permitted, this method returns
a list of signatures rather than a singleton.
Signatures themselves are restricted to the top level parameters expected by a
method. For instance if a method expects one array of structs as a parameter,
and it returns a string, its signature is simply “string, array”. If it expects
three integers and returns a string, its signature is “string, int, int, int”.
If no signature is defined for the method, a non-array value is returned. In
Python this means that the type of the returned value will be something other
than list.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="xmlrpclib.ServerProxy.system.methodHelp">
ServerProxy.system.methodHelp(name)<a class="headerlink" href="#xmlrpclib.ServerProxy.system.methodHelp" title="Permalink to this definition">¶</a></dt>
<dd>This method takes one parameter, the name of a method implemented by the XML-RPC
server. It returns a documentation string describing the use of that method. If
no such string is available, an empty string is returned. The documentation
string may contain HTML markup.
</dd></dl>

</section>
<section id="boolean-objects">
<h2>20.23.2. Boolean Objects<a class="headerlink" href="#boolean-objects" title="Permalink to this headline">¶</a></h2>
This class may be initialized from any Python value; the instance returned
depends only on its truth value. It supports various Python operators through
<code class="xref py py-meth docutils literal notranslate">__cmp__()</code>, <code class="xref py py-meth docutils literal notranslate">__repr__()</code>, <code class="xref py py-meth docutils literal notranslate">__int__()</code>, and <code class="xref py py-meth docutils literal notranslate">__nonzero__()</code>
methods, all implemented in the obvious ways.
It also has the following method, supported mainly for internal use by the
unmarshalling code:
<dl class="py method">
<dt class="sig sig-object py" id="xmlrpclib.Boolean.encode">
Boolean.encode(out)<a class="headerlink" href="#xmlrpclib.Boolean.encode" title="Permalink to this definition">¶</a></dt>
<dd>Write the XML-RPC encoding of this Boolean item to the out stream object.
</dd></dl>

A working example follows. The server code:
<div class="highlight-default notranslate"><div class="highlight"><pre>import xmlrpclib
from SimpleXMLRPCServer import SimpleXMLRPCServer

def is_even(n):
 return n % 2 == 0

server = SimpleXMLRPCServer((&quot;localhost&quot;, 8000))
print &quot;Listening on port 8000...&quot;
server.register_function(is_even, &quot;is_even&quot;)
server.serve_forever()
</pre></div>
</div>
The client code for the preceding server:
<div class="highlight-default notranslate"><div class="highlight"><pre>import xmlrpclib

proxy = xmlrpclib.ServerProxy(&quot;http://localhost:8000/&quot;)
print &quot;3 is even: %s&quot; % str(proxy.is_even(3))
print &quot;100 is even: %s&quot; % str(proxy.is_even(100))
</pre></div>
</div>
</section>
<section id="datetime-objects">
<h2>20.23.3. DateTime Objects<a class="headerlink" href="#datetime-objects" title="Permalink to this headline">¶</a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="xmlrpclib.DateTime">
class xmlrpclib.DateTime<a class="headerlink" href="#xmlrpclib.DateTime" title="Permalink to this definition">¶</a></dt>
<dd>This class may be initialized with seconds since the epoch, a time
tuple, an ISO 8601 time/date string, or a <a class="reference internal" href="datetime.html#datetime.datetime" title="datetime.datetime"><code class="xref py py-class docutils literal notranslate">datetime.datetime</code></a>
instance. It has the following methods, supported mainly for internal
use by the marshalling/unmarshalling code:
<dl class="py method">
<dt class="sig sig-object py" id="xmlrpclib.DateTime.decode">
decode(string)<a class="headerlink" href="#xmlrpclib.DateTime.decode" title="Permalink to this definition">¶</a></dt>
<dd>Accept a string as the instance’s new time value.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="xmlrpclib.DateTime.encode">
encode(out)<a class="headerlink" href="#xmlrpclib.DateTime.encode" title="Permalink to this definition">¶</a></dt>
<dd>Write the XML-RPC encoding of this <a class="reference internal" href="#xmlrpclib.DateTime" title="xmlrpclib.DateTime"><code class="xref py py-class docutils literal notranslate">DateTime</code></a> item to the out stream
object.
</dd></dl>

It also supports certain of Python’s built-in operators through <code class="xref py py-meth docutils literal notranslate">__cmp__()</code>
and <code class="xref py py-meth docutils literal notranslate">__repr__()</code> methods.
</dd></dl>

A working example follows. The server code:
<div class="highlight-default notranslate"><div class="highlight"><pre>import datetime
from SimpleXMLRPCServer import SimpleXMLRPCServer
import xmlrpclib

def today():
 today = datetime.datetime.today()
 return xmlrpclib.DateTime(today)

server = SimpleXMLRPCServer((&quot;localhost&quot;, 8000))
print &quot;Listening on port 8000...&quot;
server.register_function(today, &quot;today&quot;)
server.serve_forever()
</pre></div>
</div>
The client code for the preceding server:
<div class="highlight-default notranslate"><div class="highlight"><pre>import xmlrpclib
import datetime

today = proxy.today()
# convert the ISO8601 string to a datetime object
converted = datetime.datetime.strptime(today.value, &quot;%Y%m%dT%H:%M:%S&quot;)
print &quot;Today: %s&quot; % converted.strftime(&quot;%d.%m.%Y, %H:%M&quot;)
</pre></div>
</div>
</section>
<section id="binary-objects">
<h2>20.23.4. Binary Objects<a class="headerlink" href="#binary-objects" title="Permalink to this headline">¶</a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="xmlrpclib.Binary">
class xmlrpclib.Binary<a class="headerlink" href="#xmlrpclib.Binary" title="Permalink to this definition">¶</a></dt>
<dd>This class may be initialized from string data (which may include NULs). The
primary access to the content of a <a class="reference internal" href="#xmlrpclib.Binary" title="xmlrpclib.Binary"><code class="xref py py-class docutils literal notranslate">Binary</code></a> object is provided by an
attribute:
<dl class="py attribute">
<dt class="sig sig-object py" id="xmlrpclib.Binary.data">
data<a class="headerlink" href="#xmlrpclib.Binary.data" title="Permalink to this definition">¶</a></dt>
<dd>The binary data encapsulated by the <a class="reference internal" href="#xmlrpclib.Binary" title="xmlrpclib.Binary"><code class="xref py py-class docutils literal notranslate">Binary</code></a> instance. The data is
provided as an 8-bit string.
</dd></dl>

<a class="reference internal" href="#xmlrpclib.Binary" title="xmlrpclib.Binary"><code class="xref py py-class docutils literal notranslate">Binary</code></a> objects have the following methods, supported mainly for
internal use by the marshalling/unmarshalling code:
<dl class="py method">
<dt class="sig sig-object py" id="xmlrpclib.Binary.decode">
decode(string)<a class="headerlink" href="#xmlrpclib.Binary.decode" title="Permalink to this definition">¶</a></dt>
<dd>Accept a base64 string and decode it as the instance’s new data.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="xmlrpclib.Binary.encode">
encode(out)<a class="headerlink" href="#xmlrpclib.Binary.encode" title="Permalink to this definition">¶</a></dt>
<dd>Write the XML-RPC base 64 encoding of this binary item to the out stream object.
The encoded data will have newlines every 76 characters as per
<a class="reference external" href="https://tools.ietf.org/html/rfc2045#section-6.8">RFC 2045 section 6.8</a>,
which was the de facto standard base64 specification when the
XML-RPC spec was written.
</dd></dl>

It also supports certain of Python’s built-in operators through a
<code class="xref py py-meth docutils literal notranslate">__cmp__()</code> method.
</dd></dl>

Example usage of the binary objects. We’re going to transfer an image over
XMLRPC:
<div class="highlight-default notranslate"><div class="highlight"><pre>from SimpleXMLRPCServer import SimpleXMLRPCServer
import xmlrpclib

def python_logo():
 with open(&quot;python_logo.jpg&quot;, &quot;rb&quot;) as handle:
 return xmlrpclib.Binary(handle.read())

server.serve_forever()
</pre></div>
</div>
The client gets the image and saves it to a file:
<div class="highlight-default notranslate"><div class="highlight"><pre>import xmlrpclib

proxy = xmlrpclib.ServerProxy(&quot;http://localhost:8000/&quot;)
with open(&quot;fetched_python_logo.jpg&quot;, &quot;wb&quot;) as handle:
 handle.write(proxy.python_logo().data)
</pre></div>
</div>
</section>
<section id="fault-objects">
<h2>20.23.5. Fault Objects<a class="headerlink" href="#fault-objects" title="Permalink to this headline">¶</a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="xmlrpclib.Fault">
class xmlrpclib.Fault<a class="headerlink" href="#xmlrpclib.Fault" title="Permalink to this definition">¶</a></dt>
<dd>A <a class="reference internal" href="#xmlrpclib.Fault" title="xmlrpclib.Fault"><code class="xref py py-class docutils literal notranslate">Fault</code></a> object encapsulates the content of an XML-RPC fault tag. Fault
objects have the following attributes:
<dl class="py attribute">
<dt class="sig sig-object py" id="xmlrpclib.Fault.faultCode">
faultCode<a class="headerlink" href="#xmlrpclib.Fault.faultCode" title="Permalink to this definition">¶</a></dt>
<dd>A string indicating the fault type.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="xmlrpclib.Fault.faultString">
faultString<a class="headerlink" href="#xmlrpclib.Fault.faultString" title="Permalink to this definition">¶</a></dt>
<dd>A string containing a diagnostic message associated with the fault.
</dd></dl>

</dd></dl>

In the following example we’re going to intentionally cause a <a class="reference internal" href="#xmlrpclib.Fault" title="xmlrpclib.Fault"><code class="xref py py-exc docutils literal notranslate">Fault</code></a> by
returning a complex type object. The server code:
<div class="highlight-default notranslate"><div class="highlight"><pre>from SimpleXMLRPCServer import SimpleXMLRPCServer

# A marshalling error is going to occur because we&#39;re returning a
# complex number
def add(x, y):
 return x+y+0j

server.serve_forever()
</pre></div>
</div>
The client code for the preceding server:
<div class="highlight-default notranslate"><div class="highlight"><pre>import xmlrpclib

proxy = xmlrpclib.ServerProxy(&quot;http://localhost:8000/&quot;)
try:
 proxy.add(2, 5)
except xmlrpclib.Fault as err:
 print &quot;A fault occurred&quot;
 print &quot;Fault code: %d&quot; % err.faultCode
 print &quot;Fault string: %s&quot; % err.faultString
</pre></div>
</div>
</section>
<section id="protocolerror-objects">
<h2>20.23.6. ProtocolError Objects<a class="headerlink" href="#protocolerror-objects" title="Permalink to this headline">¶</a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="xmlrpclib.ProtocolError">
class xmlrpclib.ProtocolError<a class="headerlink" href="#xmlrpclib.ProtocolError" title="Permalink to this definition">¶</a></dt>
<dd>A <a class="reference internal" href="#xmlrpclib.ProtocolError" title="xmlrpclib.ProtocolError"><code class="xref py py-class docutils literal notranslate">ProtocolError</code></a> object describes a protocol error in the underlying
transport layer (such as a 404 ‘not found’ error if the server named by the URI
does not exist). It has the following attributes:
<dl class="py attribute">
<dt class="sig sig-object py" id="xmlrpclib.ProtocolError.url">
url<a class="headerlink" href="#xmlrpclib.ProtocolError.url" title="Permalink to this definition">¶</a></dt>
<dd>The URI or URL that triggered the error.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="xmlrpclib.ProtocolError.errcode">
errcode<a class="headerlink" href="#xmlrpclib.ProtocolError.errcode" title="Permalink to this definition">¶</a></dt>
<dd>The error code.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="xmlrpclib.ProtocolError.errmsg">
errmsg<a class="headerlink" href="#xmlrpclib.ProtocolError.errmsg" title="Permalink to this definition">¶</a></dt>
<dd>The error message or diagnostic string.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="xmlrpclib.ProtocolError.headers">
headers<a class="headerlink" href="#xmlrpclib.ProtocolError.headers" title="Permalink to this definition">¶</a></dt>
<dd>A string containing the headers of the HTTP/HTTPS request that triggered the
error.
</dd></dl>

</dd></dl>

In the following example we’re going to intentionally cause a <a class="reference internal" href="#xmlrpclib.ProtocolError" title="xmlrpclib.ProtocolError"><code class="xref py py-exc docutils literal notranslate">ProtocolError</code></a>
by providing a URI that doesn’t point to an XMLRPC server:
<div class="highlight-default notranslate"><div class="highlight"><pre>import xmlrpclib

# create a ServerProxy with a URI that doesn&#39;t respond to XMLRPC requests
proxy = xmlrpclib.ServerProxy(&quot;http://www.google.com/&quot;)

try:
 proxy.some_method()
except xmlrpclib.ProtocolError as err:
 print &quot;A protocol error occurred&quot;
 print &quot;URL: %s&quot; % err.url
 print &quot;HTTP/HTTPS headers: %s&quot; % err.headers
 print &quot;Error code: %d&quot; % err.errcode
 print &quot;Error message: %s&quot; % err.errmsg
</pre></div>
</div>
</section>
<section id="multicall-objects">
<h2>20.23.7. MultiCall Objects<a class="headerlink" href="#multicall-objects" title="Permalink to this headline">¶</a></h2>
<div class="versionadded">
New in version 2.4.
</div>
The <a class="reference internal" href="#xmlrpclib.MultiCall" title="xmlrpclib.MultiCall"><code class="xref py py-class docutils literal notranslate">MultiCall</code></a> object provides a way to encapsulate multiple calls to a
remote server into a single request <a class="footnote-reference brackets" href="#id7" id="id6">1</a>.
<dl class="py class">
<dt class="sig sig-object py" id="xmlrpclib.MultiCall">
class xmlrpclib.MultiCall(server)<a class="headerlink" href="#xmlrpclib.MultiCall" title="Permalink to this definition">¶</a></dt>
<dd>Create an object used to boxcar method calls. server is the eventual target of
the call. Calls can be made to the result object, but they will immediately
return <code class="docutils literal notranslate">None</code>, and only store the call name and parameters in the
<a class="reference internal" href="#xmlrpclib.MultiCall" title="xmlrpclib.MultiCall"><code class="xref py py-class docutils literal notranslate">MultiCall</code></a> object. Calling the object itself causes all stored calls to
be transmitted as a single <code class="docutils literal notranslate">system.multicall</code> request. The result of this call
is a <a class="reference internal" href="../glossary.html#term-generator">generator</a>; iterating over this generator yields the individual
results.
</dd></dl>

A usage example of this class follows. The server code
<div class="highlight-default notranslate"><div class="highlight"><pre>from SimpleXMLRPCServer import SimpleXMLRPCServer

def add(x,y):
 return x+y

def subtract(x, y):
 return x-y

def multiply(x, y):
 return x*y

def divide(x, y):
 return x/y

# A simple server with simple arithmetic functions
server = SimpleXMLRPCServer((&quot;localhost&quot;, 8000))
print &quot;Listening on port 8000...&quot;
server.register_multicall_functions()
server.register_function(add, &#39;add&#39;)
server.register_function(subtract, &#39;subtract&#39;)
server.register_function(multiply, &#39;multiply&#39;)
server.register_function(divide, &#39;divide&#39;)
server.serve_forever()
</pre></div>
</div>
The client code for the preceding server:
<div class="highlight-default notranslate"><div class="highlight"><pre>import xmlrpclib

print &quot;7+3=%d, 7-3=%d, 7*3=%d, 7/3=%d&quot; % tuple(result)
</pre></div>
</div>
</section>
<section id="convenience-functions">
<h2>20.23.8. Convenience Functions<a class="headerlink" href="#convenience-functions" title="Permalink to this headline">¶</a></h2>
<dl class="py function">
<dt class="sig sig-object py" id="xmlrpclib.boolean">
xmlrpclib.boolean(value)<a class="headerlink" href="#xmlrpclib.boolean" title="Permalink to this definition">¶</a></dt>
<dd>Convert any Python value to one of the XML-RPC Boolean constants, <code class="docutils literal notranslate">True</code> or
<code class="docutils literal notranslate">False</code>.
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="xmlrpclib.dumps">
xmlrpclib.dumps(params[, methodname[, methodresponse[, encoding[, allow_none]]]])<a class="headerlink" href="#xmlrpclib.dumps" title="Permalink to this definition">¶</a></dt>
<dd>Convert params into an XML-RPC request. or into a response if methodresponse
is true. params can be either a tuple of arguments or an instance of the
<a class="reference internal" href="#xmlrpclib.Fault" title="xmlrpclib.Fault"><code class="xref py py-exc docutils literal notranslate">Fault</code></a> exception class. If methodresponse is true, only a single value
can be returned, meaning that params must be of length 1. encoding, if
supplied, is the encoding to use in the generated XML; the default is UTF-8.
Python’s <a class="reference internal" href="constants.html#None" title="None"><code class="xref py py-const docutils literal notranslate">None</code></a> value cannot be used in standard XML-RPC; to allow using
it via an extension, provide a true value for allow_none.
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="xmlrpclib.loads">
xmlrpclib.loads(data[, use_datetime])<a class="headerlink" href="#xmlrpclib.loads" title="Permalink to this definition">¶</a></dt>
<dd>Convert an XML-RPC request or response into Python objects, a <code class="docutils literal notranslate">(params,
methodname)</code>. params is a tuple of argument; methodname is a string, or
<code class="docutils literal notranslate">None</code> if no method name is present in the packet. If the XML-RPC packet
represents a fault condition, this function will raise a <a class="reference internal" href="#xmlrpclib.Fault" title="xmlrpclib.Fault"><code class="xref py py-exc docutils literal notranslate">Fault</code></a> exception.
The use_datetime flag can be used to cause date/time values to be presented as
<a class="reference internal" href="datetime.html#datetime.datetime" title="datetime.datetime"><code class="xref py py-class docutils literal notranslate">datetime.datetime</code></a> objects; this is false by default.
<div class="versionchanged">
Changed in version 2.5: The use_datetime flag was added.
</div>
</dd></dl>

</section>
<section id="example-of-client-usage">
<h2>20.23.9. Example of Client Usage<a class="headerlink" href="#example-of-client-usage" title="Permalink to this headline">¶</a></h2>
<div class="highlight-default notranslate"><div class="highlight"><pre># simple test program (from the XML-RPC specification)
from xmlrpclib import ServerProxy, Error

# server = ServerProxy(&quot;http://localhost:8000&quot;) # local server
server = ServerProxy(&quot;http://betty.userland.com&quot;)

print server

try:
 print server.examples.getStateName(41)
except Error as v:
 print &quot;ERROR&quot;, v
</pre></div>
</div>
To access an XML-RPC server through a HTTP proxy, you need to define a custom
transport. The following example shows how:
<div class="highlight-default notranslate"><div class="highlight"><pre>import xmlrpclib, httplib

class ProxiedTransport(xmlrpclib.Transport):
 def set_proxy(self, proxy):
 self.proxy = proxy

def make_connection(self, host):
 self.realhost = host
 h = httplib.HTTPConnection(self.proxy)
 return h

def send_request(self, connection, handler, request_body):
 connection.putrequest(&quot;POST&quot;, &#39;http://%s%s&#39; % (self.realhost, handler))

def send_host(self, connection, host):
 connection.putheader(&#39;Host&#39;, self.realhost)

p = ProxiedTransport()
p.set_proxy(&#39;proxy-server:8080&#39;)
server = xmlrpclib.ServerProxy(&#39;http://time.xmlrpc.com/RPC2&#39;, transport=p)
print server.currentTime.getCurrentTime()
</pre></div>
</div>
</section>
<section id="example-of-client-and-server-usage">
<h2>20.23.10. Example of Client and Server Usage<a class="headerlink" href="#example-of-client-and-server-usage" title="Permalink to this headline">¶</a></h2>
See <a class="reference internal" href="simplexmlrpcserver.html#simplexmlrpcserver-example">SimpleXMLRPCServer Example</a>.
Footnotes
<dl class="footnote brackets">
<dt class="label" id="id7"><a class="fn-backref" href="#id6">1</a></dt>
<dd>This approach has been first presented in <a class="reference external" href="https://web.archive.org/web/20060624230303/http://www.xmlrpc.com/discuss/msgReader$1208?mode=topic">a discussion on xmlrpc.com</a>.
</dd>
</dl>
</section>
</section>

<div class="clearer"></div>
 </div>
 </div>
 </div>
 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
 <div class="sphinxsidebarwrapper">
 <h3><a href="../contents.html">Table of Contents</a></h3>
 <ul>
<li><a class="reference internal" href="#">20.23. <code class="xref py py-mod docutils literal notranslate">xmlrpclib</code> — XML-RPC client access</a><ul>
<li><a class="reference internal" href="#serverproxy-objects">20.23.1. ServerProxy Objects</a></li>
<li><a class="reference internal" href="#boolean-objects">20.23.2. Boolean Objects</a></li>
<li><a class="reference internal" href="#datetime-objects">20.23.3. DateTime Objects</a></li>
<li><a class="reference internal" href="#binary-objects">20.23.4. Binary Objects</a></li>
<li><a class="reference internal" href="#fault-objects">20.23.5. Fault Objects</a></li>
<li><a class="reference internal" href="#protocolerror-objects">20.23.6. ProtocolError Objects</a></li>
<li><a class="reference internal" href="#multicall-objects">20.23.7. MultiCall Objects</a></li>
<li><a class="reference internal" href="#convenience-functions">20.23.8. Convenience Functions</a></li>
<li><a class="reference internal" href="#example-of-client-usage">20.23.9. Example of Client Usage</a></li>
<li><a class="reference internal" href="#example-of-client-and-server-usage">20.23.10. Example of Client and Server Usage</a></li>
</ul>
</li>
</ul>

<h4>Previous topic</h4>
 <a href="cookie.html"
 title="previous chapter">20.22. <code class="xref py py-mod docutils literal notranslate">Cookie</code> — HTTP state management</a>
 <h4>Next topic</h4>
 <a href="simplexmlrpcserver.html"
 title="next chapter">20.24. <code class="xref py py-mod docutils literal notranslate">SimpleXMLRPCServer</code> — Basic XML-RPC server</a>
 <div role="note" aria-label="source link">
 <h3>This Page</h3>
 <ul class="this-page-menu">
 <li><a href="../_sources/library/xmlrpclib.rst.txt"
 rel="nofollow">Show Source</a></li>
 </ul>
 </div>
<div id="searchbox" style="display: none" role="search">
 <h3 id="searchlabel">Quick search</h3>
 <div class="searchformwrapper">
 <form class="search" action="../search.html" method="get">
 <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 <input type="submit" value="Go" />
 </form>
 </div>
</div>
<script>$('#searchbox').show(0);</script>
 </div>
 </div>
 <div class="clearer"></div>
 </div> 
 <div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 >index</a></li>
 <li class="right" >
 <a href="../py-modindex.html" title="Python Module Index"
 >modules</a> |</li>
 <li class="right" >
 <a href="simplexmlrpcserver.html" title="20.24. SimpleXMLRPCServer — Basic XML-RPC server"
 >next</a> |</li>
 <li class="right" >
 <a href="cookie.html" title="20.22. Cookie — HTTP state management"
 >previous</a> |</li>
 <li><img src="../_static/py.png" alt=""
 style="vertical-align: middle; margin-top: -1px"/></li>
 <li><a href="https://www.python.org/">Python</a> &#187;</li>
 <li>
 <a href="../index.html">Python 2.7.18 documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>
 <li class="nav-item nav-item-2"><a href="internet.html" >20. Internet Protocols and Support</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">20.23. <code class="xref py py-mod docutils literal notranslate">xmlrpclib</code> — XML-RPC client access</a></li> 
 </ul>
 </div> 
 <div class="footer">
 &copy; <a href="../copyright.html">Copyright</a> 1990-2024, Python Software Foundation.
 
 The Python Software Foundation is a non-profit corporation.
 <a href="https://www.python.org/psf/donations/">Please donate.</a>
 
 Last updated on December 09, 2024.
 <a href="../bugs.html">Found a bug</a>?
 
 Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 4.3.2.
 </div>

</body>
</html>

${this.title}

Code Editor : xmlrpclib.html