Gecko [ fernandoquevedodop.com ]

Name	Size	Permission
2to3.html	70.96 KB	-rw-r--r--
__future__.html	20.75 KB	-rw-r--r--
__main__.html	44.87 KB	-rw-r--r--
_thread.html	30.39 KB	-rw-r--r--
abc.html	46.87 KB	-rw-r--r--
aifc.html	35.56 KB	-rw-r--r--
allos.html	34.33 KB	-rw-r--r--
archiving.html	17 KB	-rw-r--r--
argparse.html	300.89 KB	-rw-r--r--
array.html	37.28 KB	-rw-r--r--
ast.html	293.08 KB	-rw-r--r--
asynchat.html	37.41 KB	-rw-r--r--
asyncio-api-index.html	27.68 KB	-rw-r--r--
asyncio-dev.html	36.1 KB	-rw-r--r--
asyncio-eventloop.html	204.43 KB	-rw-r--r--
asyncio-exceptions.html	17.11 KB	-rw-r--r--
asyncio-future.html	38.23 KB	-rw-r--r--
asyncio-llapi-index.html	61.97 KB	-rw-r--r--
asyncio-platforms.html	21.77 KB	-rw-r--r--
asyncio-policy.html	39.56 KB	-rw-r--r--
asyncio-protocol.html	118.33 KB	-rw-r--r--
asyncio-queue.html	31.86 KB	-rw-r--r--
asyncio-stream.html	69.98 KB	-rw-r--r--
asyncio-subprocess.html	49.25 KB	-rw-r--r--
asyncio-sync.html	42.79 KB	-rw-r--r--
asyncio-task.html	109.14 KB	-rw-r--r--
asyncio.html	17.31 KB	-rw-r--r--
asyncore.html	49.36 KB	-rw-r--r--
atexit.html	22.87 KB	-rw-r--r--
audioop.html	46 KB	-rw-r--r--
audit_events.html	72.85 KB	-rw-r--r--
base64.html	48.09 KB	-rw-r--r--
bdb.html	66 KB	-rw-r--r--
binary.html	15.97 KB	-rw-r--r--
binascii.html	36.3 KB	-rw-r--r--
binhex.html	15.97 KB	-rw-r--r--
bisect.html	43.38 KB	-rw-r--r--
builtins.html	14.87 KB	-rw-r--r--
bz2.html	50.68 KB	-rw-r--r--
calendar.html	69.35 KB	-rw-r--r--
cgi.html	59.95 KB	-rw-r--r--
cgitb.html	19.96 KB	-rw-r--r--
chunk.html	22.21 KB	-rw-r--r--
cmath.html	43.89 KB	-rw-r--r--
cmd.html	50.42 KB	-rw-r--r--
code.html	35.38 KB	-rw-r--r--
codecs.html	157.96 KB	-rw-r--r--
codeop.html	18.26 KB	-rw-r--r--
collections.abc.html	79.17 KB	-rw-r--r--
collections.html	189.43 KB	-rw-r--r--
colorsys.html	17.31 KB	-rw-r--r--
compileall.html	50.68 KB	-rw-r--r--
concurrency.html	24.15 KB	-rw-r--r--
concurrent.futures.html	79.03 KB	-rw-r--r--
concurrent.html	11.56 KB	-rw-r--r--
configparser.html	159.4 KB	-rw-r--r--
constants.html	22.41 KB	-rw-r--r--
contextlib.html	117.2 KB	-rw-r--r--
contextvars.html	38.38 KB	-rw-r--r--
copy.html	17.92 KB	-rw-r--r--
copyreg.html	18.63 KB	-rw-r--r--
crypt.html	28.29 KB	-rw-r--r--
crypto.html	13.93 KB	-rw-r--r--
csv.html	82.89 KB	-rw-r--r--
ctypes.html	295.49 KB	-rw-r--r--
curses.ascii.html	32.04 KB	-rw-r--r--
curses.html	221.24 KB	-rw-r--r--
curses.panel.html	22.16 KB	-rw-r--r--
custominterp.html	11.85 KB	-rw-r--r--
dataclasses.html	113.16 KB	-rw-r--r--
datatypes.html	31.82 KB	-rw-r--r--
datetime.html	374.92 KB	-rw-r--r--
dbm.html	51.16 KB	-rw-r--r--
debug.html	17 KB	-rw-r--r--
decimal.html	270.12 KB	-rw-r--r--
development.html	32.34 KB	-rw-r--r--
devmode.html	31.72 KB	-rw-r--r--
dialog.html	43.03 KB	-rw-r--r--
difflib.html	111.99 KB	-rw-r--r--
dis.html	136.07 KB	-rw-r--r--
distribution.html	13.67 KB	-rw-r--r--
distutils.html	14.73 KB	-rw-r--r--
doctest.html	199.32 KB	-rw-r--r--
email.charset.html	31.92 KB	-rw-r--r--
email.compat32-message.html	97.74 KB	-rw-r--r--
email.contentmanager.html	37.02 KB	-rw-r--r--
email.encoders.html	18.47 KB	-rw-r--r--
email.errors.html	24.45 KB	-rw-r--r--
email.examples.html	60.49 KB	-rw-r--r--
email.generator.html	48.79 KB	-rw-r--r--
email.header.html	37.61 KB	-rw-r--r--
email.headerregistry.html	66.26 KB	-rw-r--r--
email.html	30.75 KB	-rw-r--r--
email.iterators.html	18.23 KB	-rw-r--r--
email.message.html	99.75 KB	-rw-r--r--
email.mime.html	44.89 KB	-rw-r--r--
email.parser.html	57.39 KB	-rw-r--r--
email.policy.html	84.24 KB	-rw-r--r--
email.utils.html	42.57 KB	-rw-r--r--
ensurepip.html	23.9 KB	-rw-r--r--
enum.html	151 KB	-rw-r--r--
errno.html	60.17 KB	-rw-r--r--
exceptions.html	108.44 KB	-rw-r--r--
faulthandler.html	31.5 KB	-rw-r--r--
fcntl.html	36.67 KB	-rw-r--r--
filecmp.html	32.08 KB	-rw-r--r--
fileformats.html	13.52 KB	-rw-r--r--
fileinput.html	40.37 KB	-rw-r--r--
filesys.html	16.78 KB	-rw-r--r--
fnmatch.html	21.02 KB	-rw-r--r--
fractions.html	35.29 KB	-rw-r--r--
frameworks.html	16.15 KB	-rw-r--r--
ftplib.html	71.97 KB	-rw-r--r--
functional.html	12.19 KB	-rw-r--r--
functions.html	260.33 KB	-rw-r--r--
functools.html	92.96 KB	-rw-r--r--
gc.html	40.97 KB	-rw-r--r--
getopt.html	29.4 KB	-rw-r--r--
getpass.html	16.01 KB	-rw-r--r--
gettext.html	98.02 KB	-rw-r--r--
glob.html	27.2 KB	-rw-r--r--
graphlib.html	34.82 KB	-rw-r--r--
grp.html	16.03 KB	-rw-r--r--
gzip.html	45.65 KB	-rw-r--r--
hashlib.html	93.19 KB	-rw-r--r--
heapq.html	42.43 KB	-rw-r--r--
hmac.html	24.74 KB	-rw-r--r--
html.entities.html	14.91 KB	-rw-r--r--
html.html	14.81 KB	-rw-r--r--
html.parser.html	47.7 KB	-rw-r--r--
http.client.html	85.63 KB	-rw-r--r--
http.cookiejar.html	113.94 KB	-rw-r--r--
http.cookies.html	47.64 KB	-rw-r--r--
http.html	45.52 KB	-rw-r--r--
http.server.html	73.05 KB	-rw-r--r--
i18n.html	13.44 KB	-rw-r--r--
idle.html	77.18 KB	-rw-r--r--
imaplib.html	87.08 KB	-rw-r--r--
imghdr.html	17.94 KB	-rw-r--r--
imp.html	54.32 KB	-rw-r--r--
importlib.html	239.96 KB	-rw-r--r--
importlib.metadata.html	43.14 KB	-rw-r--r--
index.html	75.06 KB	-rw-r--r--
inspect.html	168.74 KB	-rw-r--r--
internet.html	29.89 KB	-rw-r--r--
intro.html	13.81 KB	-rw-r--r--
io.html	154.15 KB	-rw-r--r--
ipaddress.html	137.75 KB	-rw-r--r--
ipc.html	12.6 KB	-rw-r--r--
itertools.html	153.27 KB	-rw-r--r--
json.html	98.9 KB	-rw-r--r--
keyword.html	14.88 KB	-rw-r--r--
language.html	16.71 KB	-rw-r--r--
linecache.html	18.09 KB	-rw-r--r--
locale.html	77.35 KB	-rw-r--r--
logging.config.html	100.3 KB	-rw-r--r--
logging.handlers.html	146.28 KB	-rw-r--r--
logging.html	169.67 KB	-rw-r--r--
lzma.html	66.89 KB	-rw-r--r--
mailbox.html	176.34 KB	-rw-r--r--
mailcap.html	20.86 KB	-rw-r--r--
markup.html	22.31 KB	-rw-r--r--
marshal.html	24.43 KB	-rw-r--r--
math.html	85.82 KB	-rw-r--r--
mimetypes.html	40.27 KB	-rw-r--r--
mm.html	11.16 KB	-rw-r--r--
mmap.html	55.53 KB	-rw-r--r--
modulefinder.html	23.67 KB	-rw-r--r--
modules.html	15.88 KB	-rw-r--r--
msilib.html	78.38 KB	-rw-r--r--
msvcrt.html	29.22 KB	-rw-r--r--
multiprocessing.html	405.24 KB	-rw-r--r--
multiprocessing.shared_memory....	60 KB	-rw-r--r--
netdata.html	20.24 KB	-rw-r--r--
netrc.html	20.39 KB	-rw-r--r--
nis.html	16.76 KB	-rw-r--r--
nntplib.html	84.93 KB	-rw-r--r--
numbers.html	45.67 KB	-rw-r--r--
numeric.html	19.29 KB	-rw-r--r--
operator.html	107.32 KB	-rw-r--r--
optparse.html	256.96 KB	-rw-r--r--
os.html	594.39 KB	-rw-r--r--
os.path.html	65.54 KB	-rw-r--r--
ossaudiodev.html	56.35 KB	-rw-r--r--
pathlib.html	170.01 KB	-rw-r--r--
pdb.html	68.67 KB	-rw-r--r--
persistence.html	19.13 KB	-rw-r--r--
pickle.html	154.45 KB	-rw-r--r--
pickletools.html	22.92 KB	-rw-r--r--
pipes.html	21.7 KB	-rw-r--r--
pkgutil.html	42.76 KB	-rw-r--r--
platform.html	45.08 KB	-rw-r--r--
plistlib.html	30.06 KB	-rw-r--r--
poplib.html	41.42 KB	-rw-r--r--
posix.html	20.96 KB	-rw-r--r--
pprint.html	55.35 KB	-rw-r--r--
profile.html	84.63 KB	-rw-r--r--
pty.html	23.7 KB	-rw-r--r--
pwd.html	16.84 KB	-rw-r--r--
py_compile.html	29 KB	-rw-r--r--
pyclbr.html	24.06 KB	-rw-r--r--
pydoc.html	19.59 KB	-rw-r--r--
pyexpat.html	104.38 KB	-rw-r--r--
python.html	22.46 KB	-rw-r--r--
queue.html	43.39 KB	-rw-r--r--
quopri.html	18.64 KB	-rw-r--r--
random.html	86.31 KB	-rw-r--r--
re.html	214.24 KB	-rw-r--r--
readline.html	50.19 KB	-rw-r--r--
reprlib.html	30.85 KB	-rw-r--r--
resource.html	48.26 KB	-rw-r--r--
rlcompleter.html	18.06 KB	-rw-r--r--
runpy.html	30.99 KB	-rw-r--r--
sched.html	27.04 KB	-rw-r--r--
secrets.html	30.2 KB	-rw-r--r--
security_warnings.html	16.21 KB	-rw-r--r--
select.html	74.58 KB	-rw-r--r--
selectors.html	41.91 KB	-rw-r--r--
shelve.html	36.54 KB	-rw-r--r--
shlex.html	61.03 KB	-rw-r--r--
shutil.html	100.13 KB	-rw-r--r--
signal.html	95.39 KB	-rw-r--r--
site.html	38.16 KB	-rw-r--r--
smtpd.html	44.09 KB	-rw-r--r--
smtplib.html	81.4 KB	-rw-r--r--
sndhdr.html	16.4 KB	-rw-r--r--
socket.html	256.95 KB	-rw-r--r--
socketserver.html	91.95 KB	-rw-r--r--
spwd.html	16.71 KB	-rw-r--r--
sqlite3.html	225.51 KB	-rw-r--r--
ssl.html	328.83 KB	-rw-r--r--
stat.html	57.79 KB	-rw-r--r--
statistics.html	123.22 KB	-rw-r--r--
stdtypes.html	615.43 KB	-rw-r--r--
string.html	108.03 KB	-rw-r--r--
stringprep.html	24.94 KB	-rw-r--r--
struct.html	70.58 KB	-rw-r--r--
subprocess.html	199.03 KB	-rw-r--r--
sunau.html	39.84 KB	-rw-r--r--
superseded.html	26.21 KB	-rw-r--r--
symtable.html	33.26 KB	-rw-r--r--
sys.html	198.83 KB	-rw-r--r--
sysconfig.html	39.81 KB	-rw-r--r--
syslog.html	27.36 KB	-rw-r--r--
tabnanny.html	16.18 KB	-rw-r--r--
tarfile.html	161.92 KB	-rw-r--r--
telnetlib.html	38.21 KB	-rw-r--r--
tempfile.html	58.39 KB	-rw-r--r--
termios.html	22.86 KB	-rw-r--r--
test.html	222.85 KB	-rw-r--r--
text.html	16.8 KB	-rw-r--r--
textwrap.html	48.83 KB	-rw-r--r--
threading.html	128.33 KB	-rw-r--r--
time.html	107.46 KB	-rw-r--r--
timeit.html	52.63 KB	-rw-r--r--
tk.html	28.08 KB	-rw-r--r--
tkinter.colorchooser.html	14.49 KB	-rw-r--r--
tkinter.dnd.html	17.09 KB	-rw-r--r--
tkinter.font.html	22.21 KB	-rw-r--r--
tkinter.html	106.85 KB	-rw-r--r--
tkinter.messagebox.html	20.09 KB	-rw-r--r--
tkinter.scrolledtext.html	14.52 KB	-rw-r--r--
tkinter.tix.html	59.69 KB	-rw-r--r--
tkinter.ttk.html	138.37 KB	-rw-r--r--
token.html	45.73 KB	-rw-r--r--
tokenize.html	39.86 KB	-rw-r--r--
trace.html	38.85 KB	-rw-r--r--
traceback.html	75.61 KB	-rw-r--r--
tracemalloc.html	122.33 KB	-rw-r--r--
tty.html	14.46 KB	-rw-r--r--
turtle.html	271.71 KB	-rw-r--r--
types.html	64.85 KB	-rw-r--r--
typing.html	315.69 KB	-rw-r--r--
unicodedata.html	27.3 KB	-rw-r--r--
unittest.html	310.01 KB	-rw-r--r--
unittest.mock-examples.html	177.75 KB	-rw-r--r--
unittest.mock.html	363.51 KB	-rw-r--r--
unix.html	13.46 KB	-rw-r--r--
urllib.error.html	18.56 KB	-rw-r--r--
urllib.html	12.92 KB	-rw-r--r--
urllib.parse.html	104.65 KB	-rw-r--r--
urllib.request.html	208.87 KB	-rw-r--r--
urllib.robotparser.html	22.63 KB	-rw-r--r--
uu.html	18.2 KB	-rw-r--r--
uuid.html	42.88 KB	-rw-r--r--
venv.html	90.43 KB	-rw-r--r--
warnings.html	69.13 KB	-rw-r--r--
wave.html	36.12 KB	-rw-r--r--
weakref.html	73.36 KB	-rw-r--r--
webbrowser.html	33.98 KB	-rw-r--r--
windows.html	12.32 KB	-rw-r--r--
winreg.html	89.48 KB	-rw-r--r--
winsound.html	26.3 KB	-rw-r--r--
wsgiref.html	111.52 KB	-rw-r--r--
xdrlib.html	42.07 KB	-rw-r--r--
xml.dom.html	114.66 KB	-rw-r--r--
xml.dom.minidom.html	49.6 KB	-rw-r--r--
xml.dom.pulldom.html	30.06 KB	-rw-r--r--
xml.etree.elementtree.html	186.49 KB	-rw-r--r--
xml.html	22.34 KB	-rw-r--r--
xml.sax.handler.html	55.78 KB	-rw-r--r--
xml.sax.html	31.74 KB	-rw-r--r--
xml.sax.reader.html	56.23 KB	-rw-r--r--
xml.sax.utils.html	22.28 KB	-rw-r--r--
xmlrpc.client.html	79.73 KB	-rw-r--r--
xmlrpc.html	11.9 KB	-rw-r--r--
xmlrpc.server.html	63.56 KB	-rw-r--r--
zipapp.html	52.45 KB	-rw-r--r--
zipfile.html	116.59 KB	-rw-r--r--
zipimport.html	33.76 KB	-rw-r--r--
zlib.html	42.29 KB	-rw-r--r--
zoneinfo.html	57.25 KB	-rw-r--r--

Code Editor : xmlrpc.client.html

<!DOCTYPE html>

<title>xmlrpc.client — XML-RPC client access &#8212; Python 3.10.12 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">
 
 <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
 <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?2022.1" />
 
 <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 3.10.12 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="xmlrpc.server — Basic XML-RPC servers" href="xmlrpc.server.html" />
 <link rel="prev" title="xmlrpc — XMLRPC server and client modules" href="xmlrpc.html" />
 <link rel="canonical" href="file:///usr/share/doc/python3.10/html/library/xmlrpc.client.html" />

</head>
<body>
<div class="mobile-nav">
 <input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"
 aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu" />
 <label for="menuToggler" class="toggler__label">
 
 </label>
 <nav class="nav-content" role="navigation">
 <a href="https://www.python.org/" class="nav-logo">
 <img src="../_static/py.svg" alt="Logo"/>
 </a>
 <div class="version_switcher_placeholder"></div>
 <form role="search" class="search" action="../search.html" method="get">
 <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">
 <path fill-rule="nonzero"
 d="M15.5 14h-.79l-.28-.27a6.5 6.5 0 001.48-5.34c-.47-2.78-2.79-5-5.59-5.34a6.505 6.505 0 00-7.27 7.27c.34 2.8 2.56 5.12 5.34 5.59a6.5 6.5 0 005.34-1.48l.27.28v.79l4.25 4.25c.41.41 1.08.41 1.49 0 .41-.41.41-1.08 0-1.49L15.5 14zm-6 0C7.01 14 5 11.99 5 9.5S7.01 5 9.5 5 14 7.01 14 9.5 11.99 14 9.5 14z" fill="#444"></path>
 </svg>
 <input type="text" name="q" aria-label="Quick search"/>
 <input type="submit" value="Go"/>
 </form>
 </nav>
 <div class="menu-wrapper">
 <nav class="menu" role="navigation" aria-label="main navigation">
 <div class="language_switcher_placeholder"></div>
 <h3><a href="../contents.html">Table of Contents</a></h3>
 <ul>
<li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate">xmlrpc.client</code> — XML-RPC client access</a><ul>
<li><a class="reference internal" href="#serverproxy-objects">ServerProxy Objects</a></li>
<li><a class="reference internal" href="#datetime-objects">DateTime Objects</a></li>
<li><a class="reference internal" href="#binary-objects">Binary Objects</a></li>
<li><a class="reference internal" href="#fault-objects">Fault Objects</a></li>
<li><a class="reference internal" href="#protocolerror-objects">ProtocolError Objects</a></li>
<li><a class="reference internal" href="#multicall-objects">MultiCall Objects</a></li>
<li><a class="reference internal" href="#convenience-functions">Convenience Functions</a></li>
<li><a class="reference internal" href="#example-of-client-usage">Example of Client Usage</a></li>
<li><a class="reference internal" href="#example-of-client-and-server-usage">Example of Client and Server Usage</a></li>
</ul>
</li>
</ul>

<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="xmlrpc.server.html" title="xmlrpc.server — Basic XML-RPC servers"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="xmlrpc.html" title="xmlrpc — XMLRPC server and client modules"
 accesskey="P">previous</a> |</li>

<li><img src="../_static/py.svg" alt="python logo" style="vertical-align: middle; margin-top: -1px"/></li>
 <li><a href="https://www.python.org/">Python</a> &#187;</li>
 <li class="switchers">
 <div class="language_switcher_placeholder"></div>
 <div class="version_switcher_placeholder"></div>
 </li>
 <li>
 
 </li>
 <li id="cpython-language-and-version">
 <a href="../index.html">3.10.12 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">Internet Protocols and Support</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate">xmlrpc.client</code> — XML-RPC client access</a></li>
 <li class="right">

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body" role="main">
 
 <section id="module-xmlrpc.client">
<h1><a class="reference internal" href="#module-xmlrpc.client" title="xmlrpc.client: XML-RPC client access."><code class="xref py py-mod docutils literal notranslate">xmlrpc.client</code></a> — XML-RPC client access<a class="headerlink" href="#module-xmlrpc.client" title="Permalink to this headline">¶</a></h1>
Source code: <a class="reference external" href="https://github.com/python/cpython/tree/3.10/Lib/xmlrpc/client.py">Lib/xmlrpc/client.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-xmlrpc.client" title="xmlrpc.client: XML-RPC client access."><code class="xref py py-mod docutils literal notranslate">xmlrpc.client</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 3.5: For HTTPS URIs, <a class="reference internal" href="#module-xmlrpc.client" title="xmlrpc.client: XML-RPC client access."><code class="xref py py-mod docutils literal notranslate">xmlrpc.client</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="xmlrpc.client.ServerProxy">
class xmlrpc.client.ServerProxy(uri, transport=None, encoding=None, verbose=False, allow_none=False, use_datetime=False, use_builtin_types=False, *, headers=(), context=None)<a class="headerlink" href="#xmlrpc.client.ServerProxy" title="Permalink to this definition">¶</a></dt>
<dd>A <a class="reference internal" href="#xmlrpc.client.ServerProxy" title="xmlrpc.client.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 <a class="reference internal" href="exceptions.html#TypeError" title="TypeError"><code class="xref py py-exc docutils literal notranslate">TypeError</code></a>. 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_builtin_types 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 and binary data to be
presented as <a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate">bytes</code></a> objects; this flag 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>, <a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate">bytes</code></a> and <a class="reference internal" href="stdtypes.html#bytearray" title="bytearray"><code class="xref py py-class docutils literal notranslate">bytearray</code></a> objects
may be passed to calls.
The headers parameter is an optional sequence of HTTP headers to send with
each request, expressed as a sequence of 2-tuples representing the header
name and value. (e.g. <code class="docutils literal notranslate">[('Header-Name', 'value')]</code>).
The obsolete use_datetime flag is similar to use_builtin_types but it
applies only to date/time values.
</dd></dl>

<div class="versionchanged">
Changed in version 3.3: The use_builtin_types flag was added.
</div>
<div class="versionchanged">
Changed in version 3.8: The headers parameter was added.
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>, <code class="docutils literal notranslate">i1</code>,
<code class="docutils literal notranslate">i2</code>, <code class="docutils literal notranslate">i4</code>,
<code class="docutils literal notranslate">i8</code> or
<code class="docutils literal notranslate">biginteger</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> in range from -2147483648 to 2147483647.
Values get the <code class="docutils literal notranslate">&lt;int&gt;</code> tag.</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate">double</code> or
<code class="docutils literal notranslate">float</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>. Values get the <code class="docutils literal notranslate">&lt;double&gt;</code> tag.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate">string</code></td>
<td><a class="reference internal" href="stdtypes.html#str" title="str"><code class="xref py py-class docutils literal notranslate">str</code></a></td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate">array</code></td>
<td><a class="reference internal" href="stdtypes.html#list" title="list"><code class="xref py py-class docutils literal notranslate">list</code></a> or <a class="reference internal" href="stdtypes.html#tuple" title="tuple"><code class="xref py py-class docutils literal notranslate">tuple</code></a> containing
conformable elements. Arrays are returned as
<a class="reference internal" href="stdtypes.html#list" title="list"><code class="xref py py-class docutils literal notranslate">lists</code></a>.</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="#xmlrpc.client.DateTime" title="xmlrpc.client.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
use_builtin_types and use_datetime flags.</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate">base64</code></td>
<td><a class="reference internal" href="#xmlrpc.client.Binary" title="xmlrpc.client.Binary"><code class="xref py py-class docutils literal notranslate">Binary</code></a>, <a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate">bytes</code></a> or
<a class="reference internal" href="stdtypes.html#bytearray" title="bytearray"><code class="xref py py-class docutils literal notranslate">bytearray</code></a>. Returned type depends on the
value of the use_builtin_types flag.</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>
<tr class="row-odd"><td><code class="docutils literal notranslate">bigdecimal</code></td>
<td><a class="reference internal" href="decimal.html#decimal.Decimal" title="decimal.Decimal"><code class="xref py py-class docutils literal notranslate">decimal.Decimal</code></a>. Returned type only.</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="#xmlrpc.client.Fault" title="xmlrpc.client.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="#xmlrpc.client.ProtocolError" title="xmlrpc.client.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="#xmlrpc.client.Fault" title="xmlrpc.client.Fault"><code class="xref py py-exc docutils literal notranslate">Fault</code></a> and <a class="reference internal" href="#xmlrpc.client.ProtocolError" title="xmlrpc.client.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 the xmlrpc client module currently does not marshal
instances of subclasses of built-in types.
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 bytes
via XML-RPC, use <a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate">bytes</code></a> or <a class="reference internal" href="stdtypes.html#bytearray" title="bytearray"><code class="xref py py-class docutils literal notranslate">bytearray</code></a> classes or the
<a class="reference internal" href="#xmlrpc.client.Binary" title="xmlrpc.client.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="#xmlrpc.client.ServerProxy" title="xmlrpc.client.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="#xmlrpc.client.ServerProxy" title="xmlrpc.client.ServerProxy"><code class="xref py py-class docutils literal notranslate">ServerProxy</code></a>.
<div class="versionchanged">
Changed in version 3.5: Added the context argument.
</div>
<div class="versionchanged">
Changed in version 3.6: Added support of type tags with prefixes (e.g. <code class="docutils literal notranslate">ex:nil</code>).
Added support of unmarshalling additional types used by Apache XML-RPC
implementation for numerics: <code class="docutils literal notranslate">i1</code>, <code class="docutils literal notranslate">i2</code>, <code class="docutils literal notranslate">i8</code>, <code class="docutils literal notranslate">biginteger</code>,
<code class="docutils literal notranslate">float</code> and <code class="docutils literal notranslate">bigdecimal</code>.
See <a class="reference external" href="https://ws.apache.org/xmlrpc/types.html">https://ws.apache.org/xmlrpc/types.html</a> for a description.
</div>
</div>
<div class="admonition seealso">
See also
<dl class="simple">
<dt><a class="reference external" href="https://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="https://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://xmlrpc.scripting.com/spec.html">XML-RPC Specification</a></dt><dd>The official specification.
</dd>
</dl>
</div>
<section id="serverproxy-objects">
<h2>ServerProxy Objects<a class="headerlink" href="#serverproxy-objects" title="Permalink to this headline">¶</a></h2>
A <a class="reference internal" href="#xmlrpc.client.ServerProxy" title="xmlrpc.client.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="#xmlrpc.client.Fault" title="xmlrpc.client.Fault"><code class="xref py py-class docutils literal notranslate">Fault</code></a> or <a class="reference internal" href="#xmlrpc.client.ProtocolError" title="xmlrpc.client.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="xmlrpc.client.ServerProxy.system.listMethods">
ServerProxy.system.listMethods()<a class="headerlink" href="#xmlrpc.client.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="xmlrpc.client.ServerProxy.system.methodSignature">
ServerProxy.system.methodSignature(name)<a class="headerlink" href="#xmlrpc.client.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="xmlrpc.client.ServerProxy.system.methodHelp">
ServerProxy.system.methodHelp(name)<a class="headerlink" href="#xmlrpc.client.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>

<div class="versionchanged">
Changed in version 3.5: Instances of <a class="reference internal" href="#xmlrpc.client.ServerProxy" title="xmlrpc.client.ServerProxy"><code class="xref py py-class docutils literal notranslate">ServerProxy</code></a> support the <a class="reference internal" href="../glossary.html#term-context-manager">context manager</a> protocol
for closing the underlying transport.
</div>
A working example follows. The server code:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>from xmlrpc.server 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-python3 notranslate"><div class="highlight"><pre>import xmlrpc.client

with xmlrpc.client.ServerProxy(&quot;http://localhost:8000/&quot;) as proxy:
 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>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="xmlrpc.client.DateTime">
class xmlrpc.client.DateTime<a class="headerlink" href="#xmlrpc.client.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="xmlrpc.client.DateTime.decode">
decode(string)<a class="headerlink" href="#xmlrpc.client.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="xmlrpc.client.DateTime.encode">
encode(out)<a class="headerlink" href="#xmlrpc.client.DateTime.encode" title="Permalink to this definition">¶</a></dt>
<dd>Write the XML-RPC encoding of this <a class="reference internal" href="#xmlrpc.client.DateTime" title="xmlrpc.client.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 rich comparison
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-python3 notranslate"><div class="highlight"><pre>import datetime
from xmlrpc.server import SimpleXMLRPCServer
import xmlrpc.client

def today():
 today = datetime.datetime.today()
 return xmlrpc.client.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-python3 notranslate"><div class="highlight"><pre>import xmlrpc.client
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>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="xmlrpc.client.Binary">
class xmlrpc.client.Binary<a class="headerlink" href="#xmlrpc.client.Binary" title="Permalink to this definition">¶</a></dt>
<dd>This class may be initialized from bytes data (which may include NULs). The
primary access to the content of a <a class="reference internal" href="#xmlrpc.client.Binary" title="xmlrpc.client.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="xmlrpc.client.Binary.data">
data<a class="headerlink" href="#xmlrpc.client.Binary.data" title="Permalink to this definition">¶</a></dt>
<dd>The binary data encapsulated by the <a class="reference internal" href="#xmlrpc.client.Binary" title="xmlrpc.client.Binary"><code class="xref py py-class docutils literal notranslate">Binary</code></a> instance. The data is
provided as a <a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate">bytes</code></a> object.
</dd></dl>

<a class="reference internal" href="#xmlrpc.client.Binary" title="xmlrpc.client.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="xmlrpc.client.Binary.decode">
decode(bytes)<a class="headerlink" href="#xmlrpc.client.Binary.decode" title="Permalink to this definition">¶</a></dt>
<dd>Accept a base64 <a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate">bytes</code></a> object and decode it as the instance’s new data.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="xmlrpc.client.Binary.encode">
encode(out)<a class="headerlink" href="#xmlrpc.client.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="rfc reference external" href="https://datatracker.ietf.org/doc/html/rfc2045.html#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 <code class="xref py py-meth docutils literal notranslate">__eq__()</code>
and <code class="xref py py-meth docutils literal notranslate">__ne__()</code> methods.
</dd></dl>

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

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

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

proxy = xmlrpc.client.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>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="xmlrpc.client.Fault">
class xmlrpc.client.Fault<a class="headerlink" href="#xmlrpc.client.Fault" title="Permalink to this definition">¶</a></dt>
<dd>A <a class="reference internal" href="#xmlrpc.client.Fault" title="xmlrpc.client.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="xmlrpc.client.Fault.faultCode">
faultCode<a class="headerlink" href="#xmlrpc.client.Fault.faultCode" title="Permalink to this definition">¶</a></dt>
<dd>An int indicating the fault type.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="xmlrpc.client.Fault.faultString">
faultString<a class="headerlink" href="#xmlrpc.client.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="#xmlrpc.client.Fault" title="xmlrpc.client.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-python3 notranslate"><div class="highlight"><pre>from xmlrpc.server 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-python3 notranslate"><div class="highlight"><pre>import xmlrpc.client

proxy = xmlrpc.client.ServerProxy(&quot;http://localhost:8000/&quot;)
try:
 proxy.add(2, 5)
except xmlrpc.client.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>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="xmlrpc.client.ProtocolError">
class xmlrpc.client.ProtocolError<a class="headerlink" href="#xmlrpc.client.ProtocolError" title="Permalink to this definition">¶</a></dt>
<dd>A <a class="reference internal" href="#xmlrpc.client.ProtocolError" title="xmlrpc.client.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="xmlrpc.client.ProtocolError.url">
url<a class="headerlink" href="#xmlrpc.client.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="xmlrpc.client.ProtocolError.errcode">
errcode<a class="headerlink" href="#xmlrpc.client.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="xmlrpc.client.ProtocolError.errmsg">
errmsg<a class="headerlink" href="#xmlrpc.client.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="xmlrpc.client.ProtocolError.headers">
headers<a class="headerlink" href="#xmlrpc.client.ProtocolError.headers" title="Permalink to this definition">¶</a></dt>
<dd>A dict 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="#xmlrpc.client.ProtocolError" title="xmlrpc.client.ProtocolError"><code class="xref py py-exc docutils literal notranslate">ProtocolError</code></a>
by providing an invalid URI:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>import xmlrpc.client

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

try:
 proxy.some_method()
except xmlrpc.client.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>MultiCall Objects<a class="headerlink" href="#multicall-objects" title="Permalink to this headline">¶</a></h2>
The <a class="reference internal" href="#xmlrpc.client.MultiCall" title="xmlrpc.client.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="#id6" id="id5">1</a>.
<dl class="py class">
<dt class="sig sig-object py" id="xmlrpc.client.MultiCall">
class xmlrpc.client.MultiCall(server)<a class="headerlink" href="#xmlrpc.client.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="#xmlrpc.client.MultiCall" title="xmlrpc.client.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-python3 notranslate"><div class="highlight"><pre>from xmlrpc.server 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-python3 notranslate"><div class="highlight"><pre>import xmlrpc.client

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>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="xmlrpc.client.dumps">
xmlrpc.client.dumps(params, methodname=None, methodresponse=None, encoding=None, allow_none=False)<a class="headerlink" href="#xmlrpc.client.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="#xmlrpc.client.Fault" title="xmlrpc.client.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="xmlrpc.client.loads">
xmlrpc.client.loads(data, use_datetime=False, use_builtin_types=False)<a class="headerlink" href="#xmlrpc.client.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="#xmlrpc.client.Fault" title="xmlrpc.client.Fault"><code class="xref py py-exc docutils literal notranslate">Fault</code></a> exception.
The use_builtin_types 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 and binary data to be
presented as <a class="reference internal" href="stdtypes.html#bytes" title="bytes"><code class="xref py py-class docutils literal notranslate">bytes</code></a> objects; this flag is false by default.
The obsolete use_datetime flag is similar to use_builtin_types but it
applies only to date/time values.
<div class="versionchanged">
Changed in version 3.3: The use_builtin_types flag was added.
</div>
</dd></dl>

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

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

print(proxy)

try:
 print(proxy.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-python3 notranslate"><div class="highlight"><pre>import http.client
import xmlrpc.client

class ProxiedTransport(xmlrpc.client.Transport):

def set_proxy(self, host, port=None, headers=None):
 self.proxy = host, port
 self.proxy_headers = headers

def make_connection(self, host):
 connection = http.client.HTTPConnection(*self.proxy)
 connection.set_tunnel(host, headers=self.proxy_headers)
 self._connection = host, connection
 return connection

transport = ProxiedTransport()
transport.set_proxy(&#39;proxy-server&#39;, 8080)
server = xmlrpc.client.ServerProxy(&#39;http://betty.userland.com&#39;, transport=transport)
print(server.examples.getStateName(41))
</pre></div>
</div>
</section>
<section id="example-of-client-and-server-usage">
<h2>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="xmlrpc.server.html#simplexmlrpcserver-example">SimpleXMLRPCServer Example</a>.
Footnotes
<dl class="footnote brackets">
<dt class="label" id="id6"><a class="fn-backref" href="#id5">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="#"><code class="xref py py-mod docutils literal notranslate">xmlrpc.client</code> — XML-RPC client access</a><ul>
<li><a class="reference internal" href="#serverproxy-objects">ServerProxy Objects</a></li>
<li><a class="reference internal" href="#datetime-objects">DateTime Objects</a></li>
<li><a class="reference internal" href="#binary-objects">Binary Objects</a></li>
<li><a class="reference internal" href="#fault-objects">Fault Objects</a></li>
<li><a class="reference internal" href="#protocolerror-objects">ProtocolError Objects</a></li>
<li><a class="reference internal" href="#multicall-objects">MultiCall Objects</a></li>
<li><a class="reference internal" href="#convenience-functions">Convenience Functions</a></li>
<li><a class="reference internal" href="#example-of-client-usage">Example of Client Usage</a></li>
<li><a class="reference internal" href="#example-of-client-and-server-usage">Example of Client and Server Usage</a></li>
</ul>
</li>
</ul>

<h4>Previous topic</h4>
 <a href="xmlrpc.html"
 title="previous chapter"><code class="xref py py-mod docutils literal notranslate">xmlrpc</code> — XMLRPC server and client modules</a>
 <h4>Next topic</h4>
 <a href="xmlrpc.server.html"
 title="next chapter"><code class="xref py py-mod docutils literal notranslate">xmlrpc.server</code> — Basic XML-RPC servers</a>
 <div role="note" aria-label="source link">
 <h3>This Page</h3>
 <ul class="this-page-menu">
 <li><a href="../bugs.html">Report a Bug</a></li>
 <li>
 <a href="https://github.com/python/cpython/blob/3.10/Doc/library/xmlrpc.client.rst"
 rel="nofollow">Show Source
 </a>
 </li>
 </ul>
 </div>
 </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="xmlrpc.server.html" title="xmlrpc.server — Basic XML-RPC servers"
 >next</a> |</li>
 <li class="right" >
 <a href="xmlrpc.html" title="xmlrpc — XMLRPC server and client modules"
 >previous</a> |</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" >Internet Protocols and Support</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate">xmlrpc.client</code> — XML-RPC client access</a></li>
 <li class="right">

<div class="inline-search" role="search">
 <form class="inline-search" action="../search.html" method="get">
 <input placeholder="Quick search" aria-label="Quick search" type="text" name="q" />
 <input type="submit" value="Go" />
 <input type="hidden" name="check_keywords" value="yes" />
 <input type="hidden" name="area" value="default" />
 </form>
 </div>
 |
 </li>
 
 </ul>
 </div> 
 <div class="footer">
 &copy; <a href="../copyright.html">Copyright</a> 2001-2026, Python Software Foundation.
 
 This page is licensed under the Python Software Foundation License Version 2.
 
 Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.
 
 See <a href="/license.html">History and License</a> for more information.

The Python Software Foundation is a non-profit corporation.
<a href="https://www.python.org/psf/donations/">Please donate.</a>

Last updated on January 26, 2026.
 <a href="/bugs.html">Found a bug</a>?

Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.3.2.
 </div>

</body>
</html>

${this.title}

Code Editor : xmlrpc.client.html