<!DOCTYPE html PUBLIC
"-//W3C//DTD HTML 4.0 Transitional//EN">
<link rel=
"STYLESHEET" href=
"lib.css" type='text/css'
/>
<link rel=
"SHORTCUT ICON" href=
"../icons/pyfav.png" type=
"image/png" />
<link rel='start' href='../index.html' title='Python Documentation Index'
/>
<link rel=
"first" href=
"lib.html" title='Python Library Reference'
/>
<link rel='contents' href='contents.html'
title=
"Contents" />
<link rel='index' href='genindex.html' title='Index'
/>
<link rel='last' href='about.html' title='About this document...'
/>
<link rel='help' href='about.html' title='About this document...'
/>
<link rel=
"next" href=
"xmlrpc-client-example.html" />
<link rel=
"prev" href=
"node559.html" />
<link rel=
"parent" href=
"module-xmlrpclib.html" />
<link rel=
"next" href=
"xmlrpc-client-example.html" />
<meta name='aesop' content='information'
/>
<title>11.22.8 Convenience Functions
</title>
<div id='top-navigation-panel' xml:id='top-navigation-panel'
>
<table align=
"center" width=
"100%" cellpadding=
"0" cellspacing=
"2">
<td class='online-navigation'
><a rel=
"prev" title=
"11.22.7 MultiCall Objects"
href=
"node559.html"><img src='../icons/previous.png'
border='
0' height='
32' alt='Previous Page' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"parent" title=
"11.22 xmlrpclib "
href=
"module-xmlrpclib.html"><img src='../icons/up.png'
border='
0' height='
32' alt='Up One Level' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"next" title=
"11.22.9 Example of Client"
href=
"xmlrpc-client-example.html"><img src='../icons/next.png'
border='
0' height='
32' alt='Next Page' width='
32'
/></A></td>
<td align=
"center" width=
"100%">Python Library Reference
</td>
<td class='online-navigation'
><a rel=
"contents" title=
"Table of Contents"
href=
"contents.html"><img src='../icons/contents.png'
border='
0' height='
32' alt='Contents' width='
32'
/></A></td>
<td class='online-navigation'
><a href=
"modindex.html" title=
"Module Index"><img src='../icons/modules.png'
border='
0' height='
32' alt='Module Index' width='
32'
/></a></td>
<td class='online-navigation'
><a rel=
"index" title=
"Index"
href=
"genindex.html"><img src='../icons/index.png'
border='
0' height='
32' alt='Index' width='
32'
/></A></td>
<div class='online-navigation'
>
<b class=
"navlabel">Previous:
</b>
<a class=
"sectref" rel=
"prev" href=
"node559.html">11.22.7 MultiCall Objects
</A>
<b class=
"navlabel">Up:
</b>
<a class=
"sectref" rel=
"parent" href=
"module-xmlrpclib.html">11.22 xmlrpclib
</A>
<b class=
"navlabel">Next:
</b>
<a class=
"sectref" rel=
"next" href=
"xmlrpc-client-example.html">11.22.9 Example of Client
</A>
<!--End of Navigation Panel-->
<H2><A NAME=
"SECTION00132280000000000000000">
11.22.8 Convenience Functions
</A>
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
3715' xml:id='l2h-
3715'
class=
"function">boolean
</tt></b>(
</nobr></td>
<td><var>value
</var>)
</td></tr></table></dt>
Convert any Python value to one of the XML-RPC Boolean constants,
<code>True
</code> or
<code>False
</code>.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
3716' xml:id='l2h-
3716'
class=
"function">binary
</tt></b>(
</nobr></td>
<td><var>data
</var>)
</td></tr></table></dt>
Trivially convert any Python string to a
<tt class=
"class">Binary
</tt> object.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
3717' xml:id='l2h-
3717'
class=
"function">dumps
</tt></b>(
</nobr></td>
<td><var>params
</var><big>[
</big><var>, methodname
</var><big>[
</big><var>,
methodresponse
</var><big>[
</big><var>, encoding
</var><big>[
</big><var>,
allow_none
</var><big>]
</big><var></var><big>]
</big><var></var><big>]
</big><var></var><big>]
</big><var></var>)
</td></tr></table></dt>
Convert
<var>params
</var> into an XML-RPC request.
or into a response if
<var>methodresponse
</var> is true.
<var>params
</var> can be either a tuple of arguments or an instance of the
<tt class=
"exception">Fault
</tt> exception class. If
<var>methodresponse
</var> is true,
only a single value can be returned, meaning that
<var>params
</var> must be of length
1.
<var>encoding
</var>, if supplied, is the encoding to use in the generated
XML; the default is UTF-
8. Python's
<tt class=
"constant">None
</tt> value cannot be
used in standard XML-RPC; to allow using it via an extension,
provide a true value for
<var>allow_none
</var>.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
3718' xml:id='l2h-
3718'
class=
"function">loads
</tt></b>(
</nobr></td>
<td><var>data
</var>)
</td></tr></table></dt>
Convert an XML-RPC request or response into Python objects, a
<code>(
<var>params
</var>,
<var>methodname
</var>)
</code>.
<var>params
</var> is a tuple of argument;
<var>methodname
</var>
is a string, or
<code>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
<tt class=
"exception">Fault
</tt> exception.
<div class='online-navigation'
>
<table align=
"center" width=
"100%" cellpadding=
"0" cellspacing=
"2">
<td class='online-navigation'
><a rel=
"prev" title=
"11.22.7 MultiCall Objects"
href=
"node559.html"><img src='../icons/previous.png'
border='
0' height='
32' alt='Previous Page' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"parent" title=
"11.22 xmlrpclib "
href=
"module-xmlrpclib.html"><img src='../icons/up.png'
border='
0' height='
32' alt='Up One Level' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"next" title=
"11.22.9 Example of Client"
href=
"xmlrpc-client-example.html"><img src='../icons/next.png'
border='
0' height='
32' alt='Next Page' width='
32'
/></A></td>
<td align=
"center" width=
"100%">Python Library Reference
</td>
<td class='online-navigation'
><a rel=
"contents" title=
"Table of Contents"
href=
"contents.html"><img src='../icons/contents.png'
border='
0' height='
32' alt='Contents' width='
32'
/></A></td>
<td class='online-navigation'
><a href=
"modindex.html" title=
"Module Index"><img src='../icons/modules.png'
border='
0' height='
32' alt='Module Index' width='
32'
/></a></td>
<td class='online-navigation'
><a rel=
"index" title=
"Index"
href=
"genindex.html"><img src='../icons/index.png'
border='
0' height='
32' alt='Index' width='
32'
/></A></td>
<div class='online-navigation'
>
<b class=
"navlabel">Previous:
</b>
<a class=
"sectref" rel=
"prev" href=
"node559.html">11.22.7 MultiCall Objects
</A>
<b class=
"navlabel">Up:
</b>
<a class=
"sectref" rel=
"parent" href=
"module-xmlrpclib.html">11.22 xmlrpclib
</A>
<b class=
"navlabel">Next:
</b>
<a class=
"sectref" rel=
"next" href=
"xmlrpc-client-example.html">11.22.9 Example of Client
</A>
<span class=
"release-info">Release
2.4.2, documentation updated on
28 September
2005.
</span>
<!--End of Navigation Panel-->
See
<i><a href=
"about.html">About this document...
</a></i> for information on suggesting changes.