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.server.html

<!DOCTYPE html>

<title>xmlrpc.server — Basic XML-RPC servers &#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="ipaddress — IPv4/IPv6 manipulation library" href="ipaddress.html" />
 <link rel="prev" title="xmlrpc.client — XML-RPC client access" href="xmlrpc.client.html" />
 <link rel="canonical" href="file:///usr/share/doc/python3.10/html/library/xmlrpc.server.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.server</code> — Basic XML-RPC servers</a><ul>
<li><a class="reference internal" href="#simplexmlrpcserver-objects">SimpleXMLRPCServer Objects</a><ul>
<li><a class="reference internal" href="#simplexmlrpcserver-example">SimpleXMLRPCServer Example</a></li>
</ul>
</li>
<li><a class="reference internal" href="#cgixmlrpcrequesthandler">CGIXMLRPCRequestHandler</a></li>
<li><a class="reference internal" href="#documenting-xmlrpc-server">Documenting XMLRPC server</a></li>
<li><a class="reference internal" href="#docxmlrpcserver-objects">DocXMLRPCServer Objects</a></li>
<li><a class="reference internal" href="#doccgixmlrpcrequesthandler">DocCGIXMLRPCRequestHandler</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="ipaddress.html" title="ipaddress — IPv4/IPv6 manipulation library"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="xmlrpc.client.html" title="xmlrpc.client — XML-RPC client access"
 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.server</code> — Basic XML-RPC servers</a></li>
 <li class="right">

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body" role="main">
 
 <section id="module-xmlrpc.server">
<h1><a class="reference internal" href="#module-xmlrpc.server" title="xmlrpc.server: Basic XML-RPC server implementations."><code class="xref py py-mod docutils literal notranslate">xmlrpc.server</code></a> — Basic XML-RPC servers<a class="headerlink" href="#module-xmlrpc.server" title="Permalink to this headline">¶</a></h1>
Source code: <a class="reference external" href="https://github.com/python/cpython/tree/3.10/Lib/xmlrpc/server.py">Lib/xmlrpc/server.py</a>
<hr class="docutils" />
The <a class="reference internal" href="#module-xmlrpc.server" title="xmlrpc.server: Basic XML-RPC server implementations."><code class="xref py py-mod docutils literal notranslate">xmlrpc.server</code></a> module provides a basic server framework for XML-RPC
servers written in Python. Servers can either be free standing, using
<a class="reference internal" href="#xmlrpc.server.SimpleXMLRPCServer" title="xmlrpc.server.SimpleXMLRPCServer"><code class="xref py py-class docutils literal notranslate">SimpleXMLRPCServer</code></a>, or embedded in a CGI environment, using
<a class="reference internal" href="#xmlrpc.server.CGIXMLRPCRequestHandler" title="xmlrpc.server.CGIXMLRPCRequestHandler"><code class="xref py py-class docutils literal notranslate">CGIXMLRPCRequestHandler</code></a>.
<div class="admonition warning">
Warning
The <a class="reference internal" href="#module-xmlrpc.server" title="xmlrpc.server: Basic XML-RPC server implementations."><code class="xref py py-mod docutils literal notranslate">xmlrpc.server</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>
<dl class="py class">
<dt class="sig sig-object py" id="xmlrpc.server.SimpleXMLRPCServer">
class xmlrpc.server.SimpleXMLRPCServer(addr, requestHandler=SimpleXMLRPCRequestHandler, logRequests=True, allow_none=False, encoding=None, bind_and_activate=True, use_builtin_types=False)<a class="headerlink" href="#xmlrpc.server.SimpleXMLRPCServer" title="Permalink to this definition">¶</a></dt>
<dd>Create a new server instance. This class provides methods for registration of
functions that can be called by the XML-RPC protocol. The requestHandler
parameter should be a factory for request handler instances; it defaults to
<a class="reference internal" href="#xmlrpc.server.SimpleXMLRPCRequestHandler" title="xmlrpc.server.SimpleXMLRPCRequestHandler"><code class="xref py py-class docutils literal notranslate">SimpleXMLRPCRequestHandler</code></a>. The addr and requestHandler parameters
are passed to the <a class="reference internal" href="socketserver.html#socketserver.TCPServer" title="socketserver.TCPServer"><code class="xref py py-class docutils literal notranslate">socketserver.TCPServer</code></a> constructor. If logRequests
is true (the default), requests will be logged; setting this parameter to false
will turn off logging. The allow_none and encoding parameters are passed
on to <a class="reference internal" href="xmlrpc.client.html#module-xmlrpc.client" title="xmlrpc.client: XML-RPC client access."><code class="xref py py-mod docutils literal notranslate">xmlrpc.client</code></a> and control the XML-RPC responses that will be returned
from the server. The bind_and_activate parameter controls whether
<code class="xref py py-meth docutils literal notranslate">server_bind()</code> and <code class="xref py py-meth docutils literal notranslate">server_activate()</code> are called immediately by the
constructor; it defaults to true. Setting it to false allows code to manipulate
the allow_reuse_address class variable before the address is bound.
The use_builtin_types parameter is passed to the
<a class="reference internal" href="xmlrpc.client.html#xmlrpc.client.loads" title="xmlrpc.client.loads"><code class="xref py py-func docutils literal notranslate">loads()</code></a> function and controls which types are processed
when date/times values or binary data are received; it defaults to false.
<div class="versionchanged">
Changed in version 3.3: The use_builtin_types flag was added.
</div>
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="xmlrpc.server.CGIXMLRPCRequestHandler">
class xmlrpc.server.CGIXMLRPCRequestHandler(allow_none=False, encoding=None, use_builtin_types=False)<a class="headerlink" href="#xmlrpc.server.CGIXMLRPCRequestHandler" title="Permalink to this definition">¶</a></dt>
<dd>Create a new instance to handle XML-RPC requests in a CGI environment. The
allow_none and encoding parameters are passed on to <a class="reference internal" href="xmlrpc.client.html#module-xmlrpc.client" title="xmlrpc.client: XML-RPC client access."><code class="xref py py-mod docutils literal notranslate">xmlrpc.client</code></a>
and control the XML-RPC responses that will be returned from the server.
The use_builtin_types parameter is passed to the
<a class="reference internal" href="xmlrpc.client.html#xmlrpc.client.loads" title="xmlrpc.client.loads"><code class="xref py py-func docutils literal notranslate">loads()</code></a> function and controls which types are processed
when date/times values or binary data are received; it defaults to false.
<div class="versionchanged">
Changed in version 3.3: The use_builtin_types flag was added.
</div>
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="xmlrpc.server.SimpleXMLRPCRequestHandler">
class xmlrpc.server.SimpleXMLRPCRequestHandler<a class="headerlink" href="#xmlrpc.server.SimpleXMLRPCRequestHandler" title="Permalink to this definition">¶</a></dt>
<dd>Create a new request handler instance. This request handler supports <code class="docutils literal notranslate">POST</code>
requests and modifies logging so that the logRequests parameter to the
<a class="reference internal" href="#xmlrpc.server.SimpleXMLRPCServer" title="xmlrpc.server.SimpleXMLRPCServer"><code class="xref py py-class docutils literal notranslate">SimpleXMLRPCServer</code></a> constructor parameter is honored.
</dd></dl>

<section id="simplexmlrpcserver-objects">
<h2>SimpleXMLRPCServer Objects<a class="headerlink" href="#simplexmlrpcserver-objects" title="Permalink to this headline">¶</a></h2>
The <a class="reference internal" href="#xmlrpc.server.SimpleXMLRPCServer" title="xmlrpc.server.SimpleXMLRPCServer"><code class="xref py py-class docutils literal notranslate">SimpleXMLRPCServer</code></a> class is based on
<a class="reference internal" href="socketserver.html#socketserver.TCPServer" title="socketserver.TCPServer"><code class="xref py py-class docutils literal notranslate">socketserver.TCPServer</code></a> and provides a means of creating simple, stand
alone XML-RPC servers.
<dl class="py method">
<dt class="sig sig-object py" id="xmlrpc.server.SimpleXMLRPCServer.register_function">
SimpleXMLRPCServer.register_function(function=None, name=None)<a class="headerlink" href="#xmlrpc.server.SimpleXMLRPCServer.register_function" title="Permalink to this definition">¶</a></dt>
<dd>Register a function that can respond to XML-RPC requests. If name is given,
it will be the method name associated with function, otherwise
<code class="docutils literal notranslate">function.__name__</code> will be used. name is a string, and may contain
characters not legal in Python identifiers, including the period character.
This method can also be used as a decorator. When used as a decorator,
name can only be given as a keyword argument to register function under
name. If no name is given, <code class="docutils literal notranslate">function.__name__</code> will be used.
<div class="versionchanged">
Changed in version 3.7: <a class="reference internal" href="#xmlrpc.server.SimpleXMLRPCServer.register_function" title="xmlrpc.server.SimpleXMLRPCServer.register_function"><code class="xref py py-meth docutils literal notranslate">register_function()</code></a> can be used as a decorator.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="xmlrpc.server.SimpleXMLRPCServer.register_instance">
SimpleXMLRPCServer.register_instance(instance, allow_dotted_names=False)<a class="headerlink" href="#xmlrpc.server.SimpleXMLRPCServer.register_instance" title="Permalink to this definition">¶</a></dt>
<dd>Register an object which is used to expose method names which have not been
registered using <a class="reference internal" href="#xmlrpc.server.SimpleXMLRPCServer.register_function" title="xmlrpc.server.SimpleXMLRPCServer.register_function"><code class="xref py py-meth docutils literal notranslate">register_function()</code></a>. If instance contains a
<code class="xref py py-meth docutils literal notranslate">_dispatch()</code> method, it is called with the requested method name and the
parameters from the request. Its API is <code class="docutils literal notranslate">def _dispatch(self, method, params)</code>
(note that params does not represent a variable argument list). If it calls
an underlying function to perform its task, that function is called as
<code class="docutils literal notranslate">func(*params)</code>, expanding the parameter list. The return value from
<code class="xref py py-meth docutils literal notranslate">_dispatch()</code> is returned to the client as the result. If instance does
not have a <code class="xref py py-meth docutils literal notranslate">_dispatch()</code> method, it is searched for an attribute matching
the name of the requested method.
If the optional allow_dotted_names argument is true and the instance does not
have a <code class="xref py py-meth docutils literal notranslate">_dispatch()</code> method, then if the requested method name contains
periods, each component of the method name is searched for individually, with
the effect that a simple hierarchical search is performed. The value found from
this search is then called with the parameters from the request, and the return
value is passed back to the client.
<div class="admonition warning">
Warning
Enabling the allow_dotted_names option allows intruders to access your
module’s global variables and may allow intruders to execute arbitrary code on
your machine. Only use this option on a secure, closed network.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="xmlrpc.server.SimpleXMLRPCServer.register_introspection_functions">
SimpleXMLRPCServer.register_introspection_functions()<a class="headerlink" href="#xmlrpc.server.SimpleXMLRPCServer.register_introspection_functions" title="Permalink to this definition">¶</a></dt>
<dd>Registers the XML-RPC introspection functions <code class="docutils literal notranslate">system.listMethods</code>,
<code class="docutils literal notranslate">system.methodHelp</code> and <code class="docutils literal notranslate">system.methodSignature</code>.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="xmlrpc.server.SimpleXMLRPCServer.register_multicall_functions">
SimpleXMLRPCServer.register_multicall_functions()<a class="headerlink" href="#xmlrpc.server.SimpleXMLRPCServer.register_multicall_functions" title="Permalink to this definition">¶</a></dt>
<dd>Registers the XML-RPC multicall function system.multicall.
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="xmlrpc.server.SimpleXMLRPCRequestHandler.rpc_paths">
SimpleXMLRPCRequestHandler.rpc_paths<a class="headerlink" href="#xmlrpc.server.SimpleXMLRPCRequestHandler.rpc_paths" title="Permalink to this definition">¶</a></dt>
<dd>An attribute value that must be a tuple listing valid path portions of the URL
for receiving XML-RPC requests. Requests posted to other paths will result in a
404 “no such page” HTTP error. If this tuple is empty, all paths will be
considered valid. The default value is <code class="docutils literal notranslate">('/', '/RPC2')</code>.
</dd></dl>

<section id="simplexmlrpcserver-example">
<h3>SimpleXMLRPCServer Example<a class="headerlink" href="#simplexmlrpcserver-example" title="Permalink to this headline">¶</a></h3>
Server code:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>from xmlrpc.server import SimpleXMLRPCServer
from xmlrpc.server import SimpleXMLRPCRequestHandler

# Restrict to a particular path.
class RequestHandler(SimpleXMLRPCRequestHandler):
 rpc_paths = (&#39;/RPC2&#39;,)

# Create server
with SimpleXMLRPCServer((&#39;localhost&#39;, 8000),
 requestHandler=RequestHandler) as server:
 server.register_introspection_functions()

# Register pow() function; this will use the value of
 # pow.__name__ as the name, which is just &#39;pow&#39;.
 server.register_function(pow)

# Register a function under a different name
 def adder_function(x, y):
 return x + y
 server.register_function(adder_function, &#39;add&#39;)

# Register an instance; all the methods of the instance are
 # published as XML-RPC methods (in this case, just &#39;mul&#39;).
 class MyFuncs:
 def mul(self, x, y):
 return x * y

server.register_instance(MyFuncs())

# Run the server&#39;s main loop
 server.serve_forever()
</pre></div>
</div>
The following client code will call the methods made available by the preceding
server:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>import xmlrpc.client

s = xmlrpc.client.ServerProxy(&#39;http://localhost:8000&#39;)
print(s.pow(2,3)) # Returns 2**3 = 8
print(s.add(2,3)) # Returns 5
print(s.mul(5,2)) # Returns 5*2 = 10

# Print list of available methods
print(s.system.listMethods())
</pre></div>
</div>
<code class="xref py py-meth docutils literal notranslate">register_function()</code> can also be used as a decorator. The previous server
example can register functions in a decorator way:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>from xmlrpc.server import SimpleXMLRPCServer
from xmlrpc.server import SimpleXMLRPCRequestHandler

class RequestHandler(SimpleXMLRPCRequestHandler):
 rpc_paths = (&#39;/RPC2&#39;,)

with SimpleXMLRPCServer((&#39;localhost&#39;, 8000),
 requestHandler=RequestHandler) as server:
 server.register_introspection_functions()

# Register a function under a different name, using
 # register_function as a decorator. *name* can only be given
 # as a keyword argument.
 @server.register_function(name=&#39;add&#39;)
 def adder_function(x, y):
 return x + y

# Register a function under function.__name__.
 @server.register_function
 def mul(x, y):
 return x * y

server.serve_forever()
</pre></div>
</div>
The following example included in the <code class="file docutils literal notranslate">Lib/xmlrpc/server.py</code> module shows
a server allowing dotted names and registering a multicall function.
<div class="admonition warning">
Warning
Enabling the allow_dotted_names option allows intruders to access your
module’s global variables and may allow intruders to execute arbitrary code on
your machine. Only use this example only within a secure, closed network.
</div>
<div class="highlight-python3 notranslate"><div class="highlight"><pre>import datetime

class ExampleService:
 def getData(self):
 return &#39;42&#39;

class currentTime:
 @staticmethod
 def getCurrentTime():
 return datetime.datetime.now()

with SimpleXMLRPCServer((&quot;localhost&quot;, 8000)) as server:
 server.register_function(pow)
 server.register_function(lambda x,y: x+y, &#39;add&#39;)
 server.register_instance(ExampleService(), allow_dotted_names=True)
 server.register_multicall_functions()
 print(&#39;Serving XML-RPC on localhost port 8000&#39;)
 try:
 server.serve_forever()
 except KeyboardInterrupt:
 print(&quot;\nKeyboard interrupt received, exiting.&quot;)
 sys.exit(0)
</pre></div>
</div>
This ExampleService demo can be invoked from the command line:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>python -m xmlrpc.server
</pre></div>
</div>
The client that interacts with the above server is included in
<code class="docutils literal notranslate">Lib/xmlrpc/client.py</code>:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>server = ServerProxy(&quot;http://localhost:8000&quot;)

try:
 print(server.currentTime.getCurrentTime())
except Error as v:
 print(&quot;ERROR&quot;, v)

multi = MultiCall(server)
multi.getData()
multi.pow(2,9)
multi.add(1,2)
try:
 for response in multi():
 print(response)
except Error as v:
 print(&quot;ERROR&quot;, v)
</pre></div>
</div>
This client which interacts with the demo XMLRPC server can be invoked as:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>python -m xmlrpc.client
</pre></div>
</div>
</section>
</section>
<section id="cgixmlrpcrequesthandler">
<h2>CGIXMLRPCRequestHandler<a class="headerlink" href="#cgixmlrpcrequesthandler" title="Permalink to this headline">¶</a></h2>
The <a class="reference internal" href="#xmlrpc.server.CGIXMLRPCRequestHandler" title="xmlrpc.server.CGIXMLRPCRequestHandler"><code class="xref py py-class docutils literal notranslate">CGIXMLRPCRequestHandler</code></a> class can be used to handle XML-RPC
requests sent to Python CGI scripts.
<dl class="py method">
<dt class="sig sig-object py" id="xmlrpc.server.CGIXMLRPCRequestHandler.register_function">
CGIXMLRPCRequestHandler.register_function(function=None, name=None)<a class="headerlink" href="#xmlrpc.server.CGIXMLRPCRequestHandler.register_function" title="Permalink to this definition">¶</a></dt>
<dd>Register a function that can respond to XML-RPC requests. If name is given,
it will be the method name associated with function, otherwise
<code class="docutils literal notranslate">function.__name__</code> will be used. name is a string, and may contain
characters not legal in Python identifiers, including the period character.
This method can also be used as a decorator. When used as a decorator,
name can only be given as a keyword argument to register function under
name. If no name is given, <code class="docutils literal notranslate">function.__name__</code> will be used.
<div class="versionchanged">
Changed in version 3.7: <a class="reference internal" href="#xmlrpc.server.CGIXMLRPCRequestHandler.register_function" title="xmlrpc.server.CGIXMLRPCRequestHandler.register_function"><code class="xref py py-meth docutils literal notranslate">register_function()</code></a> can be used as a decorator.
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="xmlrpc.server.CGIXMLRPCRequestHandler.register_instance">
CGIXMLRPCRequestHandler.register_instance(instance)<a class="headerlink" href="#xmlrpc.server.CGIXMLRPCRequestHandler.register_instance" title="Permalink to this definition">¶</a></dt>
<dd>Register an object which is used to expose method names which have not been
registered using <a class="reference internal" href="#xmlrpc.server.CGIXMLRPCRequestHandler.register_function" title="xmlrpc.server.CGIXMLRPCRequestHandler.register_function"><code class="xref py py-meth docutils literal notranslate">register_function()</code></a>. If instance contains a
<code class="xref py py-meth docutils literal notranslate">_dispatch()</code> method, it is called with the requested method name and the
parameters from the request; the return value is returned to the client as the
result. If instance does not have a <code class="xref py py-meth docutils literal notranslate">_dispatch()</code> method, it is searched
for an attribute matching the name of the requested method; if the requested
method name contains periods, each component of the method name is searched for
individually, with the effect that a simple hierarchical search is performed.
The value found from this search is then called with the parameters from the
request, and the return value is passed back to the client.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="xmlrpc.server.CGIXMLRPCRequestHandler.register_introspection_functions">
CGIXMLRPCRequestHandler.register_introspection_functions()<a class="headerlink" href="#xmlrpc.server.CGIXMLRPCRequestHandler.register_introspection_functions" title="Permalink to this definition">¶</a></dt>
<dd>Register the XML-RPC introspection functions <code class="docutils literal notranslate">system.listMethods</code>,
<code class="docutils literal notranslate">system.methodHelp</code> and <code class="docutils literal notranslate">system.methodSignature</code>.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="xmlrpc.server.CGIXMLRPCRequestHandler.register_multicall_functions">
CGIXMLRPCRequestHandler.register_multicall_functions()<a class="headerlink" href="#xmlrpc.server.CGIXMLRPCRequestHandler.register_multicall_functions" title="Permalink to this definition">¶</a></dt>
<dd>Register the XML-RPC multicall function <code class="docutils literal notranslate">system.multicall</code>.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="xmlrpc.server.CGIXMLRPCRequestHandler.handle_request">
CGIXMLRPCRequestHandler.handle_request(request_text=None)<a class="headerlink" href="#xmlrpc.server.CGIXMLRPCRequestHandler.handle_request" title="Permalink to this definition">¶</a></dt>
<dd>Handle an XML-RPC request. If request_text is given, it should be the POST
data provided by the HTTP server, otherwise the contents of stdin will be used.
</dd></dl>

Example:
<div class="highlight-python3 notranslate"><div class="highlight"><pre>class MyFuncs:
 def mul(self, x, y):
 return x * y

handler = CGIXMLRPCRequestHandler()
handler.register_function(pow)
handler.register_function(lambda x,y: x+y, &#39;add&#39;)
handler.register_introspection_functions()
handler.register_instance(MyFuncs())
handler.handle_request()
</pre></div>
</div>
</section>
<section id="documenting-xmlrpc-server">
<h2>Documenting XMLRPC server<a class="headerlink" href="#documenting-xmlrpc-server" title="Permalink to this headline">¶</a></h2>
These classes extend the above classes to serve HTML documentation in response
to HTTP GET requests. Servers can either be free standing, using
<a class="reference internal" href="#xmlrpc.server.DocXMLRPCServer" title="xmlrpc.server.DocXMLRPCServer"><code class="xref py py-class docutils literal notranslate">DocXMLRPCServer</code></a>, or embedded in a CGI environment, using
<a class="reference internal" href="#xmlrpc.server.DocCGIXMLRPCRequestHandler" title="xmlrpc.server.DocCGIXMLRPCRequestHandler"><code class="xref py py-class docutils literal notranslate">DocCGIXMLRPCRequestHandler</code></a>.
<dl class="py class">
<dt class="sig sig-object py" id="xmlrpc.server.DocXMLRPCServer">
class xmlrpc.server.DocXMLRPCServer(addr, requestHandler=DocXMLRPCRequestHandler, logRequests=True, allow_none=False, encoding=None, bind_and_activate=True, use_builtin_types=True)<a class="headerlink" href="#xmlrpc.server.DocXMLRPCServer" title="Permalink to this definition">¶</a></dt>
<dd>Create a new server instance. All parameters have the same meaning as for
<a class="reference internal" href="#xmlrpc.server.SimpleXMLRPCServer" title="xmlrpc.server.SimpleXMLRPCServer"><code class="xref py py-class docutils literal notranslate">SimpleXMLRPCServer</code></a>; requestHandler defaults to
<a class="reference internal" href="#xmlrpc.server.DocXMLRPCRequestHandler" title="xmlrpc.server.DocXMLRPCRequestHandler"><code class="xref py py-class docutils literal notranslate">DocXMLRPCRequestHandler</code></a>.
<div class="versionchanged">
Changed in version 3.3: The use_builtin_types flag was added.
</div>
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="xmlrpc.server.DocCGIXMLRPCRequestHandler">
class xmlrpc.server.DocCGIXMLRPCRequestHandler<a class="headerlink" href="#xmlrpc.server.DocCGIXMLRPCRequestHandler" title="Permalink to this definition">¶</a></dt>
<dd>Create a new instance to handle XML-RPC requests in a CGI environment.
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="xmlrpc.server.DocXMLRPCRequestHandler">
class xmlrpc.server.DocXMLRPCRequestHandler<a class="headerlink" href="#xmlrpc.server.DocXMLRPCRequestHandler" title="Permalink to this definition">¶</a></dt>
<dd>Create a new request handler instance. This request handler supports XML-RPC
POST requests, documentation GET requests, and modifies logging so that the
logRequests parameter to the <a class="reference internal" href="#xmlrpc.server.DocXMLRPCServer" title="xmlrpc.server.DocXMLRPCServer"><code class="xref py py-class docutils literal notranslate">DocXMLRPCServer</code></a> constructor parameter is
honored.
</dd></dl>

</section>
<section id="docxmlrpcserver-objects">
<h2>DocXMLRPCServer Objects<a class="headerlink" href="#docxmlrpcserver-objects" title="Permalink to this headline">¶</a></h2>
The <a class="reference internal" href="#xmlrpc.server.DocXMLRPCServer" title="xmlrpc.server.DocXMLRPCServer"><code class="xref py py-class docutils literal notranslate">DocXMLRPCServer</code></a> class is derived from <a class="reference internal" href="#xmlrpc.server.SimpleXMLRPCServer" title="xmlrpc.server.SimpleXMLRPCServer"><code class="xref py py-class docutils literal notranslate">SimpleXMLRPCServer</code></a>
and provides a means of creating self-documenting, stand alone XML-RPC
servers. HTTP POST requests are handled as XML-RPC method calls. HTTP GET
requests are handled by generating pydoc-style HTML documentation. This allows a
server to provide its own web-based documentation.
<dl class="py method">
<dt class="sig sig-object py" id="xmlrpc.server.DocXMLRPCServer.set_server_title">
DocXMLRPCServer.set_server_title(server_title)<a class="headerlink" href="#xmlrpc.server.DocXMLRPCServer.set_server_title" title="Permalink to this definition">¶</a></dt>
<dd>Set the title used in the generated HTML documentation. This title will be used
inside the HTML “title” element.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="xmlrpc.server.DocXMLRPCServer.set_server_name">
DocXMLRPCServer.set_server_name(server_name)<a class="headerlink" href="#xmlrpc.server.DocXMLRPCServer.set_server_name" title="Permalink to this definition">¶</a></dt>
<dd>Set the name used in the generated HTML documentation. This name will appear at
the top of the generated documentation inside a “h1” element.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="xmlrpc.server.DocXMLRPCServer.set_server_documentation">
DocXMLRPCServer.set_server_documentation(server_documentation)<a class="headerlink" href="#xmlrpc.server.DocXMLRPCServer.set_server_documentation" title="Permalink to this definition">¶</a></dt>
<dd>Set the description used in the generated HTML documentation. This description
will appear as a paragraph, below the server name, in the documentation.
</dd></dl>

</section>
<section id="doccgixmlrpcrequesthandler">
<h2>DocCGIXMLRPCRequestHandler<a class="headerlink" href="#doccgixmlrpcrequesthandler" title="Permalink to this headline">¶</a></h2>
The <a class="reference internal" href="#xmlrpc.server.DocCGIXMLRPCRequestHandler" title="xmlrpc.server.DocCGIXMLRPCRequestHandler"><code class="xref py py-class docutils literal notranslate">DocCGIXMLRPCRequestHandler</code></a> class is derived from
<a class="reference internal" href="#xmlrpc.server.CGIXMLRPCRequestHandler" title="xmlrpc.server.CGIXMLRPCRequestHandler"><code class="xref py py-class docutils literal notranslate">CGIXMLRPCRequestHandler</code></a> and provides a means of creating
self-documenting, XML-RPC CGI scripts. HTTP POST requests are handled as XML-RPC
method calls. HTTP GET requests are handled by generating pydoc-style HTML
documentation. This allows a server to provide its own web-based documentation.
<dl class="py method">
<dt class="sig sig-object py" id="xmlrpc.server.DocCGIXMLRPCRequestHandler.set_server_title">
DocCGIXMLRPCRequestHandler.set_server_title(server_title)<a class="headerlink" href="#xmlrpc.server.DocCGIXMLRPCRequestHandler.set_server_title" title="Permalink to this definition">¶</a></dt>
<dd>Set the title used in the generated HTML documentation. This title will be used
inside the HTML “title” element.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="xmlrpc.server.DocCGIXMLRPCRequestHandler.set_server_name">
DocCGIXMLRPCRequestHandler.set_server_name(server_name)<a class="headerlink" href="#xmlrpc.server.DocCGIXMLRPCRequestHandler.set_server_name" title="Permalink to this definition">¶</a></dt>
<dd>Set the name used in the generated HTML documentation. This name will appear at
the top of the generated documentation inside a “h1” element.
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="xmlrpc.server.DocCGIXMLRPCRequestHandler.set_server_documentation">
DocCGIXMLRPCRequestHandler.set_server_documentation(server_documentation)<a class="headerlink" href="#xmlrpc.server.DocCGIXMLRPCRequestHandler.set_server_documentation" title="Permalink to this definition">¶</a></dt>
<dd>Set the description used in the generated HTML documentation. This description
will appear as a paragraph, below the server name, in the documentation.
</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.server</code> — Basic XML-RPC servers</a><ul>
<li><a class="reference internal" href="#simplexmlrpcserver-objects">SimpleXMLRPCServer Objects</a><ul>
<li><a class="reference internal" href="#simplexmlrpcserver-example">SimpleXMLRPCServer Example</a></li>
</ul>
</li>
<li><a class="reference internal" href="#cgixmlrpcrequesthandler">CGIXMLRPCRequestHandler</a></li>
<li><a class="reference internal" href="#documenting-xmlrpc-server">Documenting XMLRPC server</a></li>
<li><a class="reference internal" href="#docxmlrpcserver-objects">DocXMLRPCServer Objects</a></li>
<li><a class="reference internal" href="#doccgixmlrpcrequesthandler">DocCGIXMLRPCRequestHandler</a></li>
</ul>
</li>
</ul>

<h4>Previous topic</h4>
 <a href="xmlrpc.client.html"
 title="previous chapter"><code class="xref py py-mod docutils literal notranslate">xmlrpc.client</code> — XML-RPC client access</a>
 <h4>Next topic</h4>
 <a href="ipaddress.html"
 title="next chapter"><code class="xref py py-mod docutils literal notranslate">ipaddress</code> — IPv4/IPv6 manipulation library</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.server.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="ipaddress.html" title="ipaddress — IPv4/IPv6 manipulation library"
 >next</a> |</li>
 <li class="right" >
 <a href="xmlrpc.client.html" title="xmlrpc.client — XML-RPC client access"
 >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.server</code> — Basic XML-RPC servers</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.server.html