Commit | Line | Data |
---|---|---|
920dae64 AT |
1 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
2 | <html> | |
3 | <head> | |
4 | <link rel="STYLESHEET" href="lib.css" type='text/css' /> | |
5 | <link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" /> | |
6 | <link rel='start' href='../index.html' title='Python Documentation Index' /> | |
7 | <link rel="first" href="lib.html" title='Python Library Reference' /> | |
8 | <link rel='contents' href='contents.html' title="Contents" /> | |
9 | <link rel='index' href='genindex.html' title='Index' /> | |
10 | <link rel='last' href='about.html' title='About this document...' /> | |
11 | <link rel='help' href='about.html' title='About this document...' /> | |
12 | <link rel="next" href="xmlrpc-client-example.html" /> | |
13 | <link rel="prev" href="node559.html" /> | |
14 | <link rel="parent" href="module-xmlrpclib.html" /> | |
15 | <link rel="next" href="xmlrpc-client-example.html" /> | |
16 | <meta name='aesop' content='information' /> | |
17 | <title>11.22.8 Convenience Functions</title> | |
18 | </head> | |
19 | <body> | |
20 | <DIV CLASS="navigation"> | |
21 | <div id='top-navigation-panel' xml:id='top-navigation-panel'> | |
22 | <table align="center" width="100%" cellpadding="0" cellspacing="2"> | |
23 | <tr> | |
24 | <td class='online-navigation'><a rel="prev" title="11.22.7 MultiCall Objects" | |
25 | href="node559.html"><img src='../icons/previous.png' | |
26 | border='0' height='32' alt='Previous Page' width='32' /></A></td> | |
27 | <td class='online-navigation'><a rel="parent" title="11.22 xmlrpclib " | |
28 | href="module-xmlrpclib.html"><img src='../icons/up.png' | |
29 | border='0' height='32' alt='Up One Level' width='32' /></A></td> | |
30 | <td class='online-navigation'><a rel="next" title="11.22.9 Example of Client" | |
31 | href="xmlrpc-client-example.html"><img src='../icons/next.png' | |
32 | border='0' height='32' alt='Next Page' width='32' /></A></td> | |
33 | <td align="center" width="100%">Python Library Reference</td> | |
34 | <td class='online-navigation'><a rel="contents" title="Table of Contents" | |
35 | href="contents.html"><img src='../icons/contents.png' | |
36 | border='0' height='32' alt='Contents' width='32' /></A></td> | |
37 | <td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png' | |
38 | border='0' height='32' alt='Module Index' width='32' /></a></td> | |
39 | <td class='online-navigation'><a rel="index" title="Index" | |
40 | href="genindex.html"><img src='../icons/index.png' | |
41 | border='0' height='32' alt='Index' width='32' /></A></td> | |
42 | </tr></table> | |
43 | <div class='online-navigation'> | |
44 | <b class="navlabel">Previous:</b> | |
45 | <a class="sectref" rel="prev" href="node559.html">11.22.7 MultiCall Objects</A> | |
46 | <b class="navlabel">Up:</b> | |
47 | <a class="sectref" rel="parent" href="module-xmlrpclib.html">11.22 xmlrpclib </A> | |
48 | <b class="navlabel">Next:</b> | |
49 | <a class="sectref" rel="next" href="xmlrpc-client-example.html">11.22.9 Example of Client</A> | |
50 | </div> | |
51 | <hr /></div> | |
52 | </DIV> | |
53 | <!--End of Navigation Panel--> | |
54 | ||
55 | <H2><A NAME="SECTION00132280000000000000000"> | |
56 | 11.22.8 Convenience Functions</A> | |
57 | </H2> | |
58 | ||
59 | <P> | |
60 | <dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"> | |
61 | <td><nobr><b><tt id='l2h-3715' xml:id='l2h-3715' class="function">boolean</tt></b>(</nobr></td> | |
62 | <td><var>value</var>)</td></tr></table></dt> | |
63 | <dd> | |
64 | Convert any Python value to one of the XML-RPC Boolean constants, | |
65 | <code>True</code> or <code>False</code>. | |
66 | </dl> | |
67 | ||
68 | <P> | |
69 | <dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"> | |
70 | <td><nobr><b><tt id='l2h-3716' xml:id='l2h-3716' class="function">binary</tt></b>(</nobr></td> | |
71 | <td><var>data</var>)</td></tr></table></dt> | |
72 | <dd> | |
73 | Trivially convert any Python string to a <tt class="class">Binary</tt> object. | |
74 | </dl> | |
75 | ||
76 | <P> | |
77 | <dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"> | |
78 | <td><nobr><b><tt id='l2h-3717' xml:id='l2h-3717' class="function">dumps</tt></b>(</nobr></td> | |
79 | <td><var>params</var><big>[</big><var>, methodname</var><big>[</big><var>, | |
80 | methodresponse</var><big>[</big><var>, encoding</var><big>[</big><var>, | |
81 | allow_none</var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var><big>]</big><var></var>)</td></tr></table></dt> | |
82 | <dd> | |
83 | ||
84 | <P> | |
85 | Convert <var>params</var> into an XML-RPC request. | |
86 | or into a response if <var>methodresponse</var> is true. | |
87 | <var>params</var> can be either a tuple of arguments or an instance of the | |
88 | <tt class="exception">Fault</tt> exception class. If <var>methodresponse</var> is true, | |
89 | only a single value can be returned, meaning that <var>params</var> must be of length 1. | |
90 | <var>encoding</var>, if supplied, is the encoding to use in the generated | |
91 | XML; the default is UTF-8. Python's <tt class="constant">None</tt> value cannot be | |
92 | used in standard XML-RPC; to allow using it via an extension, | |
93 | provide a true value for <var>allow_none</var>. | |
94 | </dl> | |
95 | ||
96 | <P> | |
97 | <dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"> | |
98 | <td><nobr><b><tt id='l2h-3718' xml:id='l2h-3718' class="function">loads</tt></b>(</nobr></td> | |
99 | <td><var>data</var>)</td></tr></table></dt> | |
100 | <dd> | |
101 | Convert an XML-RPC request or response into Python objects, a | |
102 | <code>(<var>params</var>, <var>methodname</var>)</code>. <var>params</var> is a tuple of argument; <var>methodname</var> | |
103 | is a string, or <code>None</code> if no method name is present in the packet. | |
104 | If the XML-RPC packet represents a fault condition, this | |
105 | function will raise a <tt class="exception">Fault</tt> exception. | |
106 | </dl> | |
107 | ||
108 | <P> | |
109 | ||
110 | <DIV CLASS="navigation"> | |
111 | <div class='online-navigation'> | |
112 | <p></p><hr /> | |
113 | <table align="center" width="100%" cellpadding="0" cellspacing="2"> | |
114 | <tr> | |
115 | <td class='online-navigation'><a rel="prev" title="11.22.7 MultiCall Objects" | |
116 | href="node559.html"><img src='../icons/previous.png' | |
117 | border='0' height='32' alt='Previous Page' width='32' /></A></td> | |
118 | <td class='online-navigation'><a rel="parent" title="11.22 xmlrpclib " | |
119 | href="module-xmlrpclib.html"><img src='../icons/up.png' | |
120 | border='0' height='32' alt='Up One Level' width='32' /></A></td> | |
121 | <td class='online-navigation'><a rel="next" title="11.22.9 Example of Client" | |
122 | href="xmlrpc-client-example.html"><img src='../icons/next.png' | |
123 | border='0' height='32' alt='Next Page' width='32' /></A></td> | |
124 | <td align="center" width="100%">Python Library Reference</td> | |
125 | <td class='online-navigation'><a rel="contents" title="Table of Contents" | |
126 | href="contents.html"><img src='../icons/contents.png' | |
127 | border='0' height='32' alt='Contents' width='32' /></A></td> | |
128 | <td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png' | |
129 | border='0' height='32' alt='Module Index' width='32' /></a></td> | |
130 | <td class='online-navigation'><a rel="index" title="Index" | |
131 | href="genindex.html"><img src='../icons/index.png' | |
132 | border='0' height='32' alt='Index' width='32' /></A></td> | |
133 | </tr></table> | |
134 | <div class='online-navigation'> | |
135 | <b class="navlabel">Previous:</b> | |
136 | <a class="sectref" rel="prev" href="node559.html">11.22.7 MultiCall Objects</A> | |
137 | <b class="navlabel">Up:</b> | |
138 | <a class="sectref" rel="parent" href="module-xmlrpclib.html">11.22 xmlrpclib </A> | |
139 | <b class="navlabel">Next:</b> | |
140 | <a class="sectref" rel="next" href="xmlrpc-client-example.html">11.22.9 Example of Client</A> | |
141 | </div> | |
142 | </div> | |
143 | <hr /> | |
144 | <span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span> | |
145 | </DIV> | |
146 | <!--End of Navigation Panel--> | |
147 | <ADDRESS> | |
148 | See <i><a href="about.html">About this document...</a></i> for information on suggesting changes. | |
149 | </ADDRESS> | |
150 | </BODY> | |
151 | </HTML> |