Baoding-FenShuaJiang
/
Green_GoodERP18_FSJ_Standard
關註 1
收藏 0
Wiki 捐赠
gooderp18绿色标准版
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
目錄樹: 0f75e31513
分支列表 標籤列表
${ item.name }
Create branch ${ searchTerm }
from '0f75e31513'
${ noResults }
Green_GoodERP18_FSJ_Standard/python/Doc/html/library/xmlrpc.server.html

778 line
67KB
原始文件 Blame 文件歷史 

  1. <!DOCTYPE html>

  2. 

  3. <html lang="en" data-content_root="../">

  4.   <head>

  5.     <meta charset="utf-8" />

  6.     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

  7. <meta property="og:title" content="xmlrpc.server — Basic XML-RPC servers" />

  8. <meta property="og:type" content="website" />

  9. <meta property="og:url" content="https://docs.python.org/3/library/xmlrpc.server.html" />

  10. <meta property="og:site_name" content="Python documentation" />

  11. <meta property="og:description" content="Source code: Lib/xmlrpc/server.py The xmlrpc.server module provides a basic server framework for XML-RPC servers written in Python. Servers can either be free standing, using SimpleXMLRPCServer, or..." />

  12. <meta property="og:image" content="https://docs.python.org/3/_static/og-image.png" />

  13. <meta property="og:image:alt" content="Python documentation" />

  14. <meta name="description" content="Source code: Lib/xmlrpc/server.py The xmlrpc.server module provides a basic server framework for XML-RPC servers written in Python. Servers can either be free standing, using SimpleXMLRPCServer, or..." />

  15. <meta property="og:image:width" content="200" />

  16. <meta property="og:image:height" content="200" />

  17. <meta name="theme-color" content="#3776ab" />

  18. 

  19.     <title>xmlrpc.server — Basic XML-RPC servers &#8212; Python 3.12.3 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">

  20.     

  21.     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />

  22.     <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?v=bb723527" />

  23.     <link id="pygments_dark_css" media="(prefers-color-scheme: dark)" rel="stylesheet" type="text/css" href="../_static/pygments_dark.css?v=b20cc3f5" />

  24.     

  25.     <script src="../_static/documentation_options.js?v=2c828074"></script>

  26.     <script src="../_static/doctools.js?v=888ff710"></script>

  27.     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>

  28.     

  29.     <script src="../_static/sidebar.js"></script>

  30.     

  31.     <link rel="search" type="application/opensearchdescription+xml"

  32.           title="Search within Python 3.12.3 documentation"

  33.           href="../_static/opensearch.xml"/>

  34.     <link rel="author" title="About these documents" href="../about.html" />

  35.     <link rel="index" title="Index" href="../genindex.html" />

  36.     <link rel="search" title="Search" href="../search.html" />

  37.     <link rel="copyright" title="Copyright" href="../copyright.html" />

  38.     <link rel="next" title="ipaddress — IPv4/IPv6 manipulation library" href="ipaddress.html" />

  39.     <link rel="prev" title="xmlrpc.client — XML-RPC client access" href="xmlrpc.client.html" />

  40.     <link rel="canonical" href="https://docs.python.org/3/library/xmlrpc.server.html" />

  41.     

  42.       

  43.     

  44. 

  45.     

  46.     <style>

  47.       @media only screen {

  48.         table.full-width-table {

  49.             width: 100%;

  50.         }

  51.       }

  52.     </style>

  53. <link rel="stylesheet" href="../_static/pydoctheme_dark.css" media="(prefers-color-scheme: dark)" id="pydoctheme_dark_css">

  54.     <link rel="shortcut icon" type="image/png" href="../_static/py.svg" />

  55.             <script type="text/javascript" src="../_static/copybutton.js"></script>

  56.             <script type="text/javascript" src="../_static/menu.js"></script>

  57.             <script type="text/javascript" src="../_static/search-focus.js"></script>

  58.             <script type="text/javascript" src="../_static/themetoggle.js"></script> 

  59. 

  60.   </head>

  61. <body>

  62. <div class="mobile-nav">

  63.     <input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"

  64.            aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu" />

  65.     <nav class="nav-content" role="navigation">

  66.         <label for="menuToggler" class="toggler__label">

  67.             <span></span>

  68.         </label>

  69.         <span class="nav-items-wrapper">

  70.             <a href="https://www.python.org/" class="nav-logo">

  71.                 <img src="../_static/py.svg" alt="Python logo"/>

  72.             </a>

  73.             <span class="version_switcher_placeholder"></span>

  74.             <form role="search" class="search" action="../search.html" method="get">

  75.                 <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24" class="search-icon">

  76.                     <path fill-rule="nonzero" fill="currentColor" 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"></path>

  77.                 </svg>

  78.                 <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" />

  79.                 <input type="submit" value="Go"/>

  80.             </form>

  81.         </span>

  82.     </nav>

  83.     <div class="menu-wrapper">

  84.         <nav class="menu" role="navigation" aria-label="main navigation">

  85.             <div class="language_switcher_placeholder"></div>

  86.             

  87. <label class="theme-selector-label">

  88.     Theme

  89.     <select class="theme-selector" oninput="activateTheme(this.value)">

  90.         <option value="auto" selected>Auto</option>

  91.         <option value="light">Light</option>

  92.         <option value="dark">Dark</option>

  93.     </select>

  94. </label>

  95.   <div>

  96.     <h3><a href="../contents.html">Table of Contents</a></h3>

  97.     <ul>

  98. <li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">xmlrpc.server</span></code> — Basic XML-RPC servers</a><ul>

  99. <li><a class="reference internal" href="#simplexmlrpcserver-objects">SimpleXMLRPCServer Objects</a><ul>

  100. <li><a class="reference internal" href="#simplexmlrpcserver-example">SimpleXMLRPCServer Example</a></li>

  101. </ul>

  102. </li>

  103. <li><a class="reference internal" href="#cgixmlrpcrequesthandler">CGIXMLRPCRequestHandler</a></li>

  104. <li><a class="reference internal" href="#documenting-xmlrpc-server">Documenting XMLRPC server</a></li>

  105. <li><a class="reference internal" href="#docxmlrpcserver-objects">DocXMLRPCServer Objects</a></li>

  106. <li><a class="reference internal" href="#doccgixmlrpcrequesthandler">DocCGIXMLRPCRequestHandler</a></li>

  107. </ul>

  108. </li>

  109. </ul>

  110. 

  111.   </div>

  112.   <div>

  113.     <h4>Previous topic</h4>

  114.     <p class="topless"><a href="xmlrpc.client.html"

  115.                           title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">xmlrpc.client</span></code> — XML-RPC client access</a></p>

  116.   </div>

  117.   <div>

  118.     <h4>Next topic</h4>

  119.     <p class="topless"><a href="ipaddress.html"

  120.                           title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">ipaddress</span></code> — IPv4/IPv6 manipulation library</a></p>

  121.   </div>

  122.   <div role="note" aria-label="source link">

  123.     <h3>This Page</h3>

  124.     <ul class="this-page-menu">

  125.       <li><a href="../bugs.html">Report a Bug</a></li>

  126.       <li>

  127.         <a href="https://github.com/python/cpython/blob/main/Doc/library/xmlrpc.server.rst"

  128.             rel="nofollow">Show Source

  129.         </a>

  130.       </li>

  131.     </ul>

  132.   </div>

  133.         </nav>

  134.     </div>

  135. </div>

  136. 

  137.   

  138.     <div class="related" role="navigation" aria-label="related navigation">

  139.       <h3>Navigation</h3>

  140.       <ul>

  141.         <li class="right" style="margin-right: 10px">

  142.           <a href="../genindex.html" title="General Index"

  143.              accesskey="I">index</a></li>

  144.         <li class="right" >

  145.           <a href="../py-modindex.html" title="Python Module Index"

  146.              >modules</a> |</li>

  147.         <li class="right" >

  148.           <a href="ipaddress.html" title="ipaddress — IPv4/IPv6 manipulation library"

  149.              accesskey="N">next</a> |</li>

  150.         <li class="right" >

  151.           <a href="xmlrpc.client.html" title="xmlrpc.client — XML-RPC client access"

  152.              accesskey="P">previous</a> |</li>

  153. 

  154.           <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"/></li>

  155.           <li><a href="https://www.python.org/">Python</a> &#187;</li>

  156.           <li class="switchers">

  157.             <div class="language_switcher_placeholder"></div>

  158.             <div class="version_switcher_placeholder"></div>

  159.           </li>

  160.           <li>

  161.               

  162.           </li>

  163.     <li id="cpython-language-and-version">

  164.       <a href="../index.html">3.12.3 Documentation</a> &#187;

  165.     </li>

  166. 

  167.           <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>

  168.           <li class="nav-item nav-item-2"><a href="internet.html" accesskey="U">Internet Protocols and Support</a> &#187;</li>

  169.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">xmlrpc.server</span></code> — Basic XML-RPC servers</a></li>

  170.                 <li class="right">

  171.                     

  172. 

  173.     <div class="inline-search" role="search">

  174.         <form class="inline-search" action="../search.html" method="get">

  175.           <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box" />

  176.           <input type="submit" value="Go" />

  177.         </form>

  178.     </div>

  179.                      |

  180.                 </li>

  181.             <li class="right">

  182. <label class="theme-selector-label">

  183.     Theme

  184.     <select class="theme-selector" oninput="activateTheme(this.value)">

  185.         <option value="auto" selected>Auto</option>

  186.         <option value="light">Light</option>

  187.         <option value="dark">Dark</option>

  188.     </select>

  189. </label> |</li>

  190.             

  191.       </ul>

  192.     </div>    

  193. 

  194.     <div class="document">

  195.       <div class="documentwrapper">

  196.         <div class="bodywrapper">

  197.           <div class="body" role="main">

  198.             

  199.   <section id="module-xmlrpc.server">

  200. <span id="xmlrpc-server-basic-xml-rpc-servers"></span><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"><span class="pre">xmlrpc.server</span></code></a> — Basic XML-RPC servers<a class="headerlink" href="#module-xmlrpc.server" title="Link to this heading">¶</a></h1>

  201. <p><strong>Source code:</strong> <a class="reference external" href="https://github.com/python/cpython/tree/3.12/Lib/xmlrpc/server.py">Lib/xmlrpc/server.py</a></p>

  202. <hr class="docutils" />

  203. <p>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"><span class="pre">xmlrpc.server</span></code></a> module provides a basic server framework for XML-RPC

  204. servers written in Python.  Servers can either be free standing, using

  205. <a class="reference internal" href="#xmlrpc.server.SimpleXMLRPCServer" title="xmlrpc.server.SimpleXMLRPCServer"><code class="xref py py-class docutils literal notranslate"><span class="pre">SimpleXMLRPCServer</span></code></a>, or embedded in a CGI environment, using

  206. <a class="reference internal" href="#xmlrpc.server.CGIXMLRPCRequestHandler" title="xmlrpc.server.CGIXMLRPCRequestHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">CGIXMLRPCRequestHandler</span></code></a>.</p>

  207. <div class="admonition warning">

  208. <p class="admonition-title">Warning</p>

  209. <p>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"><span class="pre">xmlrpc.server</span></code></a> module is not secure against maliciously

  210. constructed data.  If you need to parse untrusted or unauthenticated data see

  211. <a class="reference internal" href="xml.html#xml-vulnerabilities"><span class="std std-ref">XML vulnerabilities</span></a>.</p>

  212. </div>

  213. <div class="availability docutils container">

  214. <p><a class="reference internal" href="intro.html#availability"><span class="std std-ref">Availability</span></a>: not Emscripten, not WASI.</p>

  215. <p>This module does not work or is not available on WebAssembly platforms

  216. <code class="docutils literal notranslate"><span class="pre">wasm32-emscripten</span></code> and <code class="docutils literal notranslate"><span class="pre">wasm32-wasi</span></code>. See

  217. <a class="reference internal" href="intro.html#wasm-availability"><span class="std std-ref">WebAssembly platforms</span></a> for more information.</p>

  218. </div>

  219. <dl class="py class">

  220. <dt class="sig sig-object py" id="xmlrpc.server.SimpleXMLRPCServer">

  221. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">xmlrpc.server.</span></span><span class="sig-name descname"><span class="pre">SimpleXMLRPCServer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">addr</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">requestHandler</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">SimpleXMLRPCRequestHandler</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">logRequests</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allow_none</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">encoding</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bind_and_activate</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_builtin_types</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#xmlrpc.server.SimpleXMLRPCServer" title="Link to this definition">¶</a></dt>

  222. <dd><p>Create a new server instance.  This class provides methods for registration of

  223. functions that can be called by the XML-RPC protocol.  The <em>requestHandler</em>

  224. parameter should be a factory for request handler instances; it defaults to

  225. <a class="reference internal" href="#xmlrpc.server.SimpleXMLRPCRequestHandler" title="xmlrpc.server.SimpleXMLRPCRequestHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">SimpleXMLRPCRequestHandler</span></code></a>.  The <em>addr</em> and <em>requestHandler</em> parameters

  226. 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"><span class="pre">socketserver.TCPServer</span></code></a> constructor.  If <em>logRequests</em>

  227. is true (the default), requests will be logged; setting this parameter to false

  228. will turn off logging.   The <em>allow_none</em> and <em>encoding</em> parameters are passed

  229. 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"><span class="pre">xmlrpc.client</span></code></a> and control the XML-RPC responses that will be returned

  230. from the server. The <em>bind_and_activate</em> parameter controls whether

  231. <code class="xref py py-meth docutils literal notranslate"><span class="pre">server_bind()</span></code> and <code class="xref py py-meth docutils literal notranslate"><span class="pre">server_activate()</span></code> are called immediately by the

  232. constructor; it defaults to true. Setting it to false allows code to manipulate

  233. the <em>allow_reuse_address</em> class variable before the address is bound.

  234. The <em>use_builtin_types</em> parameter is passed to the

  235. <a class="reference internal" href="xmlrpc.client.html#xmlrpc.client.loads" title="xmlrpc.client.loads"><code class="xref py py-func docutils literal notranslate"><span class="pre">loads()</span></code></a> function and controls which types are processed

  236. when date/times values or binary data are received; it defaults to false.</p>

  237. <div class="versionchanged">

  238. <p><span class="versionmodified changed">Changed in version 3.3: </span>The <em>use_builtin_types</em> flag was added.</p>

  239. </div>

  240. </dd></dl>

  241. 

  242. <dl class="py class">

  243. <dt class="sig sig-object py" id="xmlrpc.server.CGIXMLRPCRequestHandler">

  244. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">xmlrpc.server.</span></span><span class="sig-name descname"><span class="pre">CGIXMLRPCRequestHandler</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">allow_none</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">encoding</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_builtin_types</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#xmlrpc.server.CGIXMLRPCRequestHandler" title="Link to this definition">¶</a></dt>

  245. <dd><p>Create a new instance to handle XML-RPC requests in a CGI environment.  The

  246. <em>allow_none</em> and <em>encoding</em> 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"><span class="pre">xmlrpc.client</span></code></a>

  247. and control the XML-RPC responses that will be returned from the server.

  248. The <em>use_builtin_types</em> parameter is passed to the

  249. <a class="reference internal" href="xmlrpc.client.html#xmlrpc.client.loads" title="xmlrpc.client.loads"><code class="xref py py-func docutils literal notranslate"><span class="pre">loads()</span></code></a> function and controls which types are processed

  250. when date/times values or binary data are received; it defaults to false.</p>

  251. <div class="versionchanged">

  252. <p><span class="versionmodified changed">Changed in version 3.3: </span>The <em>use_builtin_types</em> flag was added.</p>

  253. </div>

  254. </dd></dl>

  255. 

  256. <dl class="py class">

  257. <dt class="sig sig-object py" id="xmlrpc.server.SimpleXMLRPCRequestHandler">

  258. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">xmlrpc.server.</span></span><span class="sig-name descname"><span class="pre">SimpleXMLRPCRequestHandler</span></span><a class="headerlink" href="#xmlrpc.server.SimpleXMLRPCRequestHandler" title="Link to this definition">¶</a></dt>

  259. <dd><p>Create a new request handler instance.  This request handler supports <code class="docutils literal notranslate"><span class="pre">POST</span></code>

  260. requests and modifies logging so that the <em>logRequests</em> parameter to the

  261. <a class="reference internal" href="#xmlrpc.server.SimpleXMLRPCServer" title="xmlrpc.server.SimpleXMLRPCServer"><code class="xref py py-class docutils literal notranslate"><span class="pre">SimpleXMLRPCServer</span></code></a> constructor parameter is honored.</p>

  262. </dd></dl>

  263. 

  264. <section id="simplexmlrpcserver-objects">

  265. <span id="simple-xmlrpc-servers"></span><h2>SimpleXMLRPCServer Objects<a class="headerlink" href="#simplexmlrpcserver-objects" title="Link to this heading">¶</a></h2>

  266. <p>The <a class="reference internal" href="#xmlrpc.server.SimpleXMLRPCServer" title="xmlrpc.server.SimpleXMLRPCServer"><code class="xref py py-class docutils literal notranslate"><span class="pre">SimpleXMLRPCServer</span></code></a> class is based on

  267. <a class="reference internal" href="socketserver.html#socketserver.TCPServer" title="socketserver.TCPServer"><code class="xref py py-class docutils literal notranslate"><span class="pre">socketserver.TCPServer</span></code></a> and provides a means of creating simple, stand

  268. alone XML-RPC servers.</p>

  269. <dl class="py method">

  270. <dt class="sig sig-object py" id="xmlrpc.server.SimpleXMLRPCServer.register_function">

  271. <span class="sig-prename descclassname"><span class="pre">SimpleXMLRPCServer.</span></span><span class="sig-name descname"><span class="pre">register_function</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">function</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#xmlrpc.server.SimpleXMLRPCServer.register_function" title="Link to this definition">¶</a></dt>

  272. <dd><p>Register a function that can respond to XML-RPC requests.  If <em>name</em> is given,

  273. it will be the method name associated with <em>function</em>, otherwise

  274. <a class="reference internal" href="../reference/datamodel.html#function.__name__" title="function.__name__"><code class="xref py py-attr docutils literal notranslate"><span class="pre">function.__name__</span></code></a> will be used.  <em>name</em> is a string, and may contain

  275. characters not legal in Python identifiers, including the period character.</p>

  276. <p>This method can also be used as a decorator.  When used as a decorator,

  277. <em>name</em> can only be given as a keyword argument to register <em>function</em> under

  278. <em>name</em>.  If no <em>name</em> is given, <a class="reference internal" href="../reference/datamodel.html#function.__name__" title="function.__name__"><code class="xref py py-attr docutils literal notranslate"><span class="pre">function.__name__</span></code></a> will be used.</p>

  279. <div class="versionchanged">

  280. <p><span class="versionmodified changed">Changed in version 3.7: </span><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"><span class="pre">register_function()</span></code></a> can be used as a decorator.</p>

  281. </div>

  282. </dd></dl>

  283. 

  284. <dl class="py method">

  285. <dt class="sig sig-object py" id="xmlrpc.server.SimpleXMLRPCServer.register_instance">

  286. <span class="sig-prename descclassname"><span class="pre">SimpleXMLRPCServer.</span></span><span class="sig-name descname"><span class="pre">register_instance</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">instance</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allow_dotted_names</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#xmlrpc.server.SimpleXMLRPCServer.register_instance" title="Link to this definition">¶</a></dt>

  287. <dd><p>Register an object which is used to expose method names which have not been

  288. 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"><span class="pre">register_function()</span></code></a>.  If <em>instance</em> contains a

  289. <code class="xref py py-meth docutils literal notranslate"><span class="pre">_dispatch()</span></code> method, it is called with the requested method name and the

  290. parameters from the request.  Its API is <code class="docutils literal notranslate"><span class="pre">def</span> <span class="pre">_dispatch(self,</span> <span class="pre">method,</span> <span class="pre">params)</span></code>

  291. (note that <em>params</em> does not represent a variable argument list).  If it calls

  292. an underlying function to perform its task, that function is called as

  293. <code class="docutils literal notranslate"><span class="pre">func(*params)</span></code>, expanding the parameter list. The return value from

  294. <code class="xref py py-meth docutils literal notranslate"><span class="pre">_dispatch()</span></code> is returned to the client as the result.  If <em>instance</em> does

  295. not have a <code class="xref py py-meth docutils literal notranslate"><span class="pre">_dispatch()</span></code> method, it is searched for an attribute matching

  296. the name of the requested method.</p>

  297. <p>If the optional <em>allow_dotted_names</em> argument is true and the instance does not

  298. have a <code class="xref py py-meth docutils literal notranslate"><span class="pre">_dispatch()</span></code> method, then if the requested method name contains

  299. periods, each component of the method name is searched for individually, with

  300. the effect that a simple hierarchical search is performed.  The value found from

  301. this search is then called with the parameters from the request, and the return

  302. value is passed back to the client.</p>

  303. <div class="admonition warning">

  304. <p class="admonition-title">Warning</p>

  305. <p>Enabling the <em>allow_dotted_names</em> option allows intruders to access your

  306. module’s global variables and may allow intruders to execute arbitrary code on

  307. your machine.  Only use this option on a secure, closed network.</p>

  308. </div>

  309. </dd></dl>

  310. 

  311. <dl class="py method">

  312. <dt class="sig sig-object py" id="xmlrpc.server.SimpleXMLRPCServer.register_introspection_functions">

  313. <span class="sig-prename descclassname"><span class="pre">SimpleXMLRPCServer.</span></span><span class="sig-name descname"><span class="pre">register_introspection_functions</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#xmlrpc.server.SimpleXMLRPCServer.register_introspection_functions" title="Link to this definition">¶</a></dt>

  314. <dd><p>Registers the XML-RPC introspection functions <code class="docutils literal notranslate"><span class="pre">system.listMethods</span></code>,

  315. <code class="docutils literal notranslate"><span class="pre">system.methodHelp</span></code> and <code class="docutils literal notranslate"><span class="pre">system.methodSignature</span></code>.</p>

  316. </dd></dl>

  317. 

  318. <dl class="py method">

  319. <dt class="sig sig-object py" id="xmlrpc.server.SimpleXMLRPCServer.register_multicall_functions">

  320. <span class="sig-prename descclassname"><span class="pre">SimpleXMLRPCServer.</span></span><span class="sig-name descname"><span class="pre">register_multicall_functions</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#xmlrpc.server.SimpleXMLRPCServer.register_multicall_functions" title="Link to this definition">¶</a></dt>

  321. <dd><p>Registers the XML-RPC multicall function system.multicall.</p>

  322. </dd></dl>

  323. 

  324. <dl class="py attribute">

  325. <dt class="sig sig-object py" id="xmlrpc.server.SimpleXMLRPCRequestHandler.rpc_paths">

  326. <span class="sig-prename descclassname"><span class="pre">SimpleXMLRPCRequestHandler.</span></span><span class="sig-name descname"><span class="pre">rpc_paths</span></span><a class="headerlink" href="#xmlrpc.server.SimpleXMLRPCRequestHandler.rpc_paths" title="Link to this definition">¶</a></dt>

  327. <dd><p>An attribute value that must be a tuple listing valid path portions of the URL

  328. for receiving XML-RPC requests.  Requests posted to other paths will result in a

  329. 404 “no such page” HTTP error.  If this tuple is empty, all paths will be

  330. considered valid. The default value is <code class="docutils literal notranslate"><span class="pre">('/',</span> <span class="pre">'/RPC2')</span></code>.</p>

  331. </dd></dl>

  332. 

  333. <section id="simplexmlrpcserver-example">

  334. <span id="id1"></span><h3>SimpleXMLRPCServer Example<a class="headerlink" href="#simplexmlrpcserver-example" title="Link to this heading">¶</a></h3>

  335. <p>Server code:</p>

  336. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">xmlrpc.server</span> <span class="kn">import</span> <span class="n">SimpleXMLRPCServer</span>

  337. <span class="kn">from</span> <span class="nn">xmlrpc.server</span> <span class="kn">import</span> <span class="n">SimpleXMLRPCRequestHandler</span>

  338. 

  339. <span class="c1"># Restrict to a particular path.</span>

  340. <span class="k">class</span> <span class="nc">RequestHandler</span><span class="p">(</span><span class="n">SimpleXMLRPCRequestHandler</span><span class="p">):</span>

  341.     <span class="n">rpc_paths</span> <span class="o">=</span> <span class="p">(</span><span class="s1">&#39;/RPC2&#39;</span><span class="p">,)</span>

  342. 

  343. <span class="c1"># Create server</span>

  344. <span class="k">with</span> <span class="n">SimpleXMLRPCServer</span><span class="p">((</span><span class="s1">&#39;localhost&#39;</span><span class="p">,</span> <span class="mi">8000</span><span class="p">),</span>

  345.                         <span class="n">requestHandler</span><span class="o">=</span><span class="n">RequestHandler</span><span class="p">)</span> <span class="k">as</span> <span class="n">server</span><span class="p">:</span>

  346.     <span class="n">server</span><span class="o">.</span><span class="n">register_introspection_functions</span><span class="p">()</span>

  347. 

  348.     <span class="c1"># Register pow() function; this will use the value of</span>

  349.     <span class="c1"># pow.__name__ as the name, which is just &#39;pow&#39;.</span>

  350.     <span class="n">server</span><span class="o">.</span><span class="n">register_function</span><span class="p">(</span><span class="nb">pow</span><span class="p">)</span>

  351. 

  352.     <span class="c1"># Register a function under a different name</span>

  353.     <span class="k">def</span> <span class="nf">adder_function</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">):</span>

  354.         <span class="k">return</span> <span class="n">x</span> <span class="o">+</span> <span class="n">y</span>

  355.     <span class="n">server</span><span class="o">.</span><span class="n">register_function</span><span class="p">(</span><span class="n">adder_function</span><span class="p">,</span> <span class="s1">&#39;add&#39;</span><span class="p">)</span>

  356. 

  357.     <span class="c1"># Register an instance; all the methods of the instance are</span>

  358.     <span class="c1"># published as XML-RPC methods (in this case, just &#39;mul&#39;).</span>

  359.     <span class="k">class</span> <span class="nc">MyFuncs</span><span class="p">:</span>

  360.         <span class="k">def</span> <span class="nf">mul</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">):</span>

  361.             <span class="k">return</span> <span class="n">x</span> <span class="o">*</span> <span class="n">y</span>

  362. 

  363.     <span class="n">server</span><span class="o">.</span><span class="n">register_instance</span><span class="p">(</span><span class="n">MyFuncs</span><span class="p">())</span>

  364. 

  365.     <span class="c1"># Run the server&#39;s main loop</span>

  366.     <span class="n">server</span><span class="o">.</span><span class="n">serve_forever</span><span class="p">()</span>

  367. </pre></div>

  368. </div>

  369. <p>The following client code will call the methods made available by the preceding

  370. server:</p>

  371. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">xmlrpc.client</span>

  372. 

  373. <span class="n">s</span> <span class="o">=</span> <span class="n">xmlrpc</span><span class="o">.</span><span class="n">client</span><span class="o">.</span><span class="n">ServerProxy</span><span class="p">(</span><span class="s1">&#39;http://localhost:8000&#39;</span><span class="p">)</span>

  374. <span class="nb">print</span><span class="p">(</span><span class="n">s</span><span class="o">.</span><span class="n">pow</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">))</span>  <span class="c1"># Returns 2**3 = 8</span>

  375. <span class="nb">print</span><span class="p">(</span><span class="n">s</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span><span class="mi">3</span><span class="p">))</span>  <span class="c1"># Returns 5</span>

  376. <span class="nb">print</span><span class="p">(</span><span class="n">s</span><span class="o">.</span><span class="n">mul</span><span class="p">(</span><span class="mi">5</span><span class="p">,</span><span class="mi">2</span><span class="p">))</span>  <span class="c1"># Returns 5*2 = 10</span>

  377. 

  378. <span class="c1"># Print list of available methods</span>

  379. <span class="nb">print</span><span class="p">(</span><span class="n">s</span><span class="o">.</span><span class="n">system</span><span class="o">.</span><span class="n">listMethods</span><span class="p">())</span>

  380. </pre></div>

  381. </div>

  382. <p><code class="xref py py-meth docutils literal notranslate"><span class="pre">register_function()</span></code> can also be used as a decorator. The previous server

  383. example can register functions in a decorator way:</p>

  384. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">xmlrpc.server</span> <span class="kn">import</span> <span class="n">SimpleXMLRPCServer</span>

  385. <span class="kn">from</span> <span class="nn">xmlrpc.server</span> <span class="kn">import</span> <span class="n">SimpleXMLRPCRequestHandler</span>

  386. 

  387. <span class="k">class</span> <span class="nc">RequestHandler</span><span class="p">(</span><span class="n">SimpleXMLRPCRequestHandler</span><span class="p">):</span>

  388.     <span class="n">rpc_paths</span> <span class="o">=</span> <span class="p">(</span><span class="s1">&#39;/RPC2&#39;</span><span class="p">,)</span>

  389. 

  390. <span class="k">with</span> <span class="n">SimpleXMLRPCServer</span><span class="p">((</span><span class="s1">&#39;localhost&#39;</span><span class="p">,</span> <span class="mi">8000</span><span class="p">),</span>

  391.                         <span class="n">requestHandler</span><span class="o">=</span><span class="n">RequestHandler</span><span class="p">)</span> <span class="k">as</span> <span class="n">server</span><span class="p">:</span>

  392.     <span class="n">server</span><span class="o">.</span><span class="n">register_introspection_functions</span><span class="p">()</span>

  393. 

  394.     <span class="c1"># Register pow() function; this will use the value of</span>

  395.     <span class="c1"># pow.__name__ as the name, which is just &#39;pow&#39;.</span>

  396.     <span class="n">server</span><span class="o">.</span><span class="n">register_function</span><span class="p">(</span><span class="nb">pow</span><span class="p">)</span>

  397. 

  398.     <span class="c1"># Register a function under a different name, using</span>

  399.     <span class="c1"># register_function as a decorator. *name* can only be given</span>

  400.     <span class="c1"># as a keyword argument.</span>

  401.     <span class="nd">@server</span><span class="o">.</span><span class="n">register_function</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">&#39;add&#39;</span><span class="p">)</span>

  402.     <span class="k">def</span> <span class="nf">adder_function</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">):</span>

  403.         <span class="k">return</span> <span class="n">x</span> <span class="o">+</span> <span class="n">y</span>

  404. 

  405.     <span class="c1"># Register a function under function.__name__.</span>

  406.     <span class="nd">@server</span><span class="o">.</span><span class="n">register_function</span>

  407.     <span class="k">def</span> <span class="nf">mul</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">):</span>

  408.         <span class="k">return</span> <span class="n">x</span> <span class="o">*</span> <span class="n">y</span>

  409. 

  410.     <span class="n">server</span><span class="o">.</span><span class="n">serve_forever</span><span class="p">()</span>

  411. </pre></div>

  412. </div>

  413. <p>The following example included in the <code class="file docutils literal notranslate"><span class="pre">Lib/xmlrpc/server.py</span></code> module shows

  414. a server allowing dotted names and registering a multicall function.</p>

  415. <div class="admonition warning">

  416. <p class="admonition-title">Warning</p>

  417. <p>Enabling the <em>allow_dotted_names</em> option allows intruders to access your

  418. module’s global variables and may allow intruders to execute arbitrary code on

  419. your machine.  Only use this example only within a secure, closed network.</p>

  420. </div>

  421. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">datetime</span>

  422. 

  423. <span class="k">class</span> <span class="nc">ExampleService</span><span class="p">:</span>

  424.     <span class="k">def</span> <span class="nf">getData</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>

  425.         <span class="k">return</span> <span class="s1">&#39;42&#39;</span>

  426. 

  427.     <span class="k">class</span> <span class="nc">currentTime</span><span class="p">:</span>

  428.         <span class="nd">@staticmethod</span>

  429.         <span class="k">def</span> <span class="nf">getCurrentTime</span><span class="p">():</span>

  430.             <span class="k">return</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">now</span><span class="p">()</span>

  431. 

  432. <span class="k">with</span> <span class="n">SimpleXMLRPCServer</span><span class="p">((</span><span class="s2">&quot;localhost&quot;</span><span class="p">,</span> <span class="mi">8000</span><span class="p">))</span> <span class="k">as</span> <span class="n">server</span><span class="p">:</span>

  433.     <span class="n">server</span><span class="o">.</span><span class="n">register_function</span><span class="p">(</span><span class="nb">pow</span><span class="p">)</span>

  434.     <span class="n">server</span><span class="o">.</span><span class="n">register_function</span><span class="p">(</span><span class="k">lambda</span> <span class="n">x</span><span class="p">,</span><span class="n">y</span><span class="p">:</span> <span class="n">x</span><span class="o">+</span><span class="n">y</span><span class="p">,</span> <span class="s1">&#39;add&#39;</span><span class="p">)</span>

  435.     <span class="n">server</span><span class="o">.</span><span class="n">register_instance</span><span class="p">(</span><span class="n">ExampleService</span><span class="p">(),</span> <span class="n">allow_dotted_names</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>

  436.     <span class="n">server</span><span class="o">.</span><span class="n">register_multicall_functions</span><span class="p">()</span>

  437.     <span class="nb">print</span><span class="p">(</span><span class="s1">&#39;Serving XML-RPC on localhost port 8000&#39;</span><span class="p">)</span>

  438.     <span class="k">try</span><span class="p">:</span>

  439.         <span class="n">server</span><span class="o">.</span><span class="n">serve_forever</span><span class="p">()</span>

  440.     <span class="k">except</span> <span class="ne">KeyboardInterrupt</span><span class="p">:</span>

  441.         <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;</span><span class="se">\n</span><span class="s2">Keyboard interrupt received, exiting.&quot;</span><span class="p">)</span>

  442.         <span class="n">sys</span><span class="o">.</span><span class="n">exit</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>

  443. </pre></div>

  444. </div>

  445. <p>This ExampleService demo can be invoked from the command line:</p>

  446. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="o">-</span><span class="n">m</span> <span class="n">xmlrpc</span><span class="o">.</span><span class="n">server</span>

  447. </pre></div>

  448. </div>

  449. <p>The client that interacts with the above server is included in

  450. <code class="docutils literal notranslate"><span class="pre">Lib/xmlrpc/client.py</span></code>:</p>

  451. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="n">server</span> <span class="o">=</span> <span class="n">ServerProxy</span><span class="p">(</span><span class="s2">&quot;http://localhost:8000&quot;</span><span class="p">)</span>

  452. 

  453. <span class="k">try</span><span class="p">:</span>

  454.     <span class="nb">print</span><span class="p">(</span><span class="n">server</span><span class="o">.</span><span class="n">currentTime</span><span class="o">.</span><span class="n">getCurrentTime</span><span class="p">())</span>

  455. <span class="k">except</span> <span class="n">Error</span> <span class="k">as</span> <span class="n">v</span><span class="p">:</span>

  456.     <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;ERROR&quot;</span><span class="p">,</span> <span class="n">v</span><span class="p">)</span>

  457. 

  458. <span class="n">multi</span> <span class="o">=</span> <span class="n">MultiCall</span><span class="p">(</span><span class="n">server</span><span class="p">)</span>

  459. <span class="n">multi</span><span class="o">.</span><span class="n">getData</span><span class="p">()</span>

  460. <span class="n">multi</span><span class="o">.</span><span class="n">pow</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span><span class="mi">9</span><span class="p">)</span>

  461. <span class="n">multi</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span><span class="mi">2</span><span class="p">)</span>

  462. <span class="k">try</span><span class="p">:</span>

  463.     <span class="k">for</span> <span class="n">response</span> <span class="ow">in</span> <span class="n">multi</span><span class="p">():</span>

  464.         <span class="nb">print</span><span class="p">(</span><span class="n">response</span><span class="p">)</span>

  465. <span class="k">except</span> <span class="n">Error</span> <span class="k">as</span> <span class="n">v</span><span class="p">:</span>

  466.     <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;ERROR&quot;</span><span class="p">,</span> <span class="n">v</span><span class="p">)</span>

  467. </pre></div>

  468. </div>

  469. <p>This client which interacts with the demo XMLRPC server can be invoked as:</p>

  470. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="n">python</span> <span class="o">-</span><span class="n">m</span> <span class="n">xmlrpc</span><span class="o">.</span><span class="n">client</span>

  471. </pre></div>

  472. </div>

  473. </section>

  474. </section>

  475. <section id="cgixmlrpcrequesthandler">

  476. <h2>CGIXMLRPCRequestHandler<a class="headerlink" href="#cgixmlrpcrequesthandler" title="Link to this heading">¶</a></h2>

  477. <p>The <a class="reference internal" href="#xmlrpc.server.CGIXMLRPCRequestHandler" title="xmlrpc.server.CGIXMLRPCRequestHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">CGIXMLRPCRequestHandler</span></code></a> class can be used to handle XML-RPC

  478. requests sent to Python CGI scripts.</p>

  479. <dl class="py method">

  480. <dt class="sig sig-object py" id="xmlrpc.server.CGIXMLRPCRequestHandler.register_function">

  481. <span class="sig-prename descclassname"><span class="pre">CGIXMLRPCRequestHandler.</span></span><span class="sig-name descname"><span class="pre">register_function</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">function</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#xmlrpc.server.CGIXMLRPCRequestHandler.register_function" title="Link to this definition">¶</a></dt>

  482. <dd><p>Register a function that can respond to XML-RPC requests.  If <em>name</em> is given,

  483. it will be the method name associated with <em>function</em>, otherwise

  484. <a class="reference internal" href="../reference/datamodel.html#function.__name__" title="function.__name__"><code class="xref py py-attr docutils literal notranslate"><span class="pre">function.__name__</span></code></a> will be used.  <em>name</em> is a string, and may contain

  485. characters not legal in Python identifiers, including the period character.</p>

  486. <p>This method can also be used as a decorator.  When used as a decorator,

  487. <em>name</em> can only be given as a keyword argument to register <em>function</em> under

  488. <em>name</em>.  If no <em>name</em> is given, <a class="reference internal" href="../reference/datamodel.html#function.__name__" title="function.__name__"><code class="xref py py-attr docutils literal notranslate"><span class="pre">function.__name__</span></code></a> will be used.</p>

  489. <div class="versionchanged">

  490. <p><span class="versionmodified changed">Changed in version 3.7: </span><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"><span class="pre">register_function()</span></code></a> can be used as a decorator.</p>

  491. </div>

  492. </dd></dl>

  493. 

  494. <dl class="py method">

  495. <dt class="sig sig-object py" id="xmlrpc.server.CGIXMLRPCRequestHandler.register_instance">

  496. <span class="sig-prename descclassname"><span class="pre">CGIXMLRPCRequestHandler.</span></span><span class="sig-name descname"><span class="pre">register_instance</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">instance</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#xmlrpc.server.CGIXMLRPCRequestHandler.register_instance" title="Link to this definition">¶</a></dt>

  497. <dd><p>Register an object which is used to expose method names  which have not been

  498. 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"><span class="pre">register_function()</span></code></a>. If  instance contains a

  499. <code class="xref py py-meth docutils literal notranslate"><span class="pre">_dispatch()</span></code> method, it is called with the  requested method name and the

  500. parameters from the  request; the return value is returned to the client as the

  501. result. If instance does not have a <code class="xref py py-meth docutils literal notranslate"><span class="pre">_dispatch()</span></code> method, it is searched

  502. for an attribute matching the name of the requested method; if  the requested

  503. method name contains periods, each  component of the method name is searched for

  504. individually,  with the effect that a simple hierarchical search is performed.

  505. The value found from this search is then called with the  parameters from the

  506. request, and the return value is passed  back to the client.</p>

  507. </dd></dl>

  508. 

  509. <dl class="py method">

  510. <dt class="sig sig-object py" id="xmlrpc.server.CGIXMLRPCRequestHandler.register_introspection_functions">

  511. <span class="sig-prename descclassname"><span class="pre">CGIXMLRPCRequestHandler.</span></span><span class="sig-name descname"><span class="pre">register_introspection_functions</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#xmlrpc.server.CGIXMLRPCRequestHandler.register_introspection_functions" title="Link to this definition">¶</a></dt>

  512. <dd><p>Register the XML-RPC introspection functions  <code class="docutils literal notranslate"><span class="pre">system.listMethods</span></code>,

  513. <code class="docutils literal notranslate"><span class="pre">system.methodHelp</span></code> and  <code class="docutils literal notranslate"><span class="pre">system.methodSignature</span></code>.</p>

  514. </dd></dl>

  515. 

  516. <dl class="py method">

  517. <dt class="sig sig-object py" id="xmlrpc.server.CGIXMLRPCRequestHandler.register_multicall_functions">

  518. <span class="sig-prename descclassname"><span class="pre">CGIXMLRPCRequestHandler.</span></span><span class="sig-name descname"><span class="pre">register_multicall_functions</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#xmlrpc.server.CGIXMLRPCRequestHandler.register_multicall_functions" title="Link to this definition">¶</a></dt>

  519. <dd><p>Register the XML-RPC multicall function <code class="docutils literal notranslate"><span class="pre">system.multicall</span></code>.</p>

  520. </dd></dl>

  521. 

  522. <dl class="py method">

  523. <dt class="sig sig-object py" id="xmlrpc.server.CGIXMLRPCRequestHandler.handle_request">

  524. <span class="sig-prename descclassname"><span class="pre">CGIXMLRPCRequestHandler.</span></span><span class="sig-name descname"><span class="pre">handle_request</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request_text</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#xmlrpc.server.CGIXMLRPCRequestHandler.handle_request" title="Link to this definition">¶</a></dt>

  525. <dd><p>Handle an XML-RPC request. If <em>request_text</em> is given, it should be the POST

  526. data provided by the HTTP server,  otherwise the contents of stdin will be used.</p>

  527. </dd></dl>

  528. 

  529. <p>Example:</p>

  530. <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">MyFuncs</span><span class="p">:</span>

  531.     <span class="k">def</span> <span class="nf">mul</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">):</span>

  532.         <span class="k">return</span> <span class="n">x</span> <span class="o">*</span> <span class="n">y</span>

  533. 

  534. 

  535. <span class="n">handler</span> <span class="o">=</span> <span class="n">CGIXMLRPCRequestHandler</span><span class="p">()</span>

  536. <span class="n">handler</span><span class="o">.</span><span class="n">register_function</span><span class="p">(</span><span class="nb">pow</span><span class="p">)</span>

  537. <span class="n">handler</span><span class="o">.</span><span class="n">register_function</span><span class="p">(</span><span class="k">lambda</span> <span class="n">x</span><span class="p">,</span><span class="n">y</span><span class="p">:</span> <span class="n">x</span><span class="o">+</span><span class="n">y</span><span class="p">,</span> <span class="s1">&#39;add&#39;</span><span class="p">)</span>

  538. <span class="n">handler</span><span class="o">.</span><span class="n">register_introspection_functions</span><span class="p">()</span>

  539. <span class="n">handler</span><span class="o">.</span><span class="n">register_instance</span><span class="p">(</span><span class="n">MyFuncs</span><span class="p">())</span>

  540. <span class="n">handler</span><span class="o">.</span><span class="n">handle_request</span><span class="p">()</span>

  541. </pre></div>

  542. </div>

  543. </section>

  544. <section id="documenting-xmlrpc-server">

  545. <h2>Documenting XMLRPC server<a class="headerlink" href="#documenting-xmlrpc-server" title="Link to this heading">¶</a></h2>

  546. <p>These classes extend the above classes to serve HTML documentation in response

  547. to HTTP GET requests.  Servers can either be free standing, using

  548. <a class="reference internal" href="#xmlrpc.server.DocXMLRPCServer" title="xmlrpc.server.DocXMLRPCServer"><code class="xref py py-class docutils literal notranslate"><span class="pre">DocXMLRPCServer</span></code></a>, or embedded in a CGI environment, using

  549. <a class="reference internal" href="#xmlrpc.server.DocCGIXMLRPCRequestHandler" title="xmlrpc.server.DocCGIXMLRPCRequestHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">DocCGIXMLRPCRequestHandler</span></code></a>.</p>

  550. <dl class="py class">

  551. <dt class="sig sig-object py" id="xmlrpc.server.DocXMLRPCServer">

  552. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">xmlrpc.server.</span></span><span class="sig-name descname"><span class="pre">DocXMLRPCServer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">addr</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">requestHandler</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">DocXMLRPCRequestHandler</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">logRequests</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allow_none</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">encoding</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bind_and_activate</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_builtin_types</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#xmlrpc.server.DocXMLRPCServer" title="Link to this definition">¶</a></dt>

  553. <dd><p>Create a new server instance. All parameters have the same meaning as for

  554. <a class="reference internal" href="#xmlrpc.server.SimpleXMLRPCServer" title="xmlrpc.server.SimpleXMLRPCServer"><code class="xref py py-class docutils literal notranslate"><span class="pre">SimpleXMLRPCServer</span></code></a>; <em>requestHandler</em> defaults to

  555. <a class="reference internal" href="#xmlrpc.server.DocXMLRPCRequestHandler" title="xmlrpc.server.DocXMLRPCRequestHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">DocXMLRPCRequestHandler</span></code></a>.</p>

  556. <div class="versionchanged">

  557. <p><span class="versionmodified changed">Changed in version 3.3: </span>The <em>use_builtin_types</em> flag was added.</p>

  558. </div>

  559. </dd></dl>

  560. 

  561. <dl class="py class">

  562. <dt class="sig sig-object py" id="xmlrpc.server.DocCGIXMLRPCRequestHandler">

  563. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">xmlrpc.server.</span></span><span class="sig-name descname"><span class="pre">DocCGIXMLRPCRequestHandler</span></span><a class="headerlink" href="#xmlrpc.server.DocCGIXMLRPCRequestHandler" title="Link to this definition">¶</a></dt>

  564. <dd><p>Create a new instance to handle XML-RPC requests in a CGI environment.</p>

  565. </dd></dl>

  566. 

  567. <dl class="py class">

  568. <dt class="sig sig-object py" id="xmlrpc.server.DocXMLRPCRequestHandler">

  569. <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">xmlrpc.server.</span></span><span class="sig-name descname"><span class="pre">DocXMLRPCRequestHandler</span></span><a class="headerlink" href="#xmlrpc.server.DocXMLRPCRequestHandler" title="Link to this definition">¶</a></dt>

  570. <dd><p>Create a new request handler instance. This request handler supports XML-RPC

  571. POST requests, documentation GET requests, and modifies logging so that the

  572. <em>logRequests</em> parameter to the <a class="reference internal" href="#xmlrpc.server.DocXMLRPCServer" title="xmlrpc.server.DocXMLRPCServer"><code class="xref py py-class docutils literal notranslate"><span class="pre">DocXMLRPCServer</span></code></a> constructor parameter is

  573. honored.</p>

  574. </dd></dl>

  575. 

  576. </section>

  577. <section id="docxmlrpcserver-objects">

  578. <span id="doc-xmlrpc-servers"></span><h2>DocXMLRPCServer Objects<a class="headerlink" href="#docxmlrpcserver-objects" title="Link to this heading">¶</a></h2>

  579. <p>The <a class="reference internal" href="#xmlrpc.server.DocXMLRPCServer" title="xmlrpc.server.DocXMLRPCServer"><code class="xref py py-class docutils literal notranslate"><span class="pre">DocXMLRPCServer</span></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"><span class="pre">SimpleXMLRPCServer</span></code></a>

  580. and provides a means of creating self-documenting, stand alone XML-RPC

  581. servers. HTTP POST requests are handled as XML-RPC method calls. HTTP GET

  582. requests are handled by generating pydoc-style HTML documentation. This allows a

  583. server to provide its own web-based documentation.</p>

  584. <dl class="py method">

  585. <dt class="sig sig-object py" id="xmlrpc.server.DocXMLRPCServer.set_server_title">

  586. <span class="sig-prename descclassname"><span class="pre">DocXMLRPCServer.</span></span><span class="sig-name descname"><span class="pre">set_server_title</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">server_title</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#xmlrpc.server.DocXMLRPCServer.set_server_title" title="Link to this definition">¶</a></dt>

  587. <dd><p>Set the title used in the generated HTML documentation. This title will be used

  588. inside the HTML “title” element.</p>

  589. </dd></dl>

  590. 

  591. <dl class="py method">

  592. <dt class="sig sig-object py" id="xmlrpc.server.DocXMLRPCServer.set_server_name">

  593. <span class="sig-prename descclassname"><span class="pre">DocXMLRPCServer.</span></span><span class="sig-name descname"><span class="pre">set_server_name</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">server_name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#xmlrpc.server.DocXMLRPCServer.set_server_name" title="Link to this definition">¶</a></dt>

  594. <dd><p>Set the name used in the generated HTML documentation. This name will appear at

  595. the top of the generated documentation inside a “h1” element.</p>

  596. </dd></dl>

  597. 

  598. <dl class="py method">

  599. <dt class="sig sig-object py" id="xmlrpc.server.DocXMLRPCServer.set_server_documentation">

  600. <span class="sig-prename descclassname"><span class="pre">DocXMLRPCServer.</span></span><span class="sig-name descname"><span class="pre">set_server_documentation</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">server_documentation</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#xmlrpc.server.DocXMLRPCServer.set_server_documentation" title="Link to this definition">¶</a></dt>

  601. <dd><p>Set the description used in the generated HTML documentation. This description

  602. will appear as a paragraph, below the server name, in the documentation.</p>

  603. </dd></dl>

  604. 

  605. </section>

  606. <section id="doccgixmlrpcrequesthandler">

  607. <h2>DocCGIXMLRPCRequestHandler<a class="headerlink" href="#doccgixmlrpcrequesthandler" title="Link to this heading">¶</a></h2>

  608. <p>The <a class="reference internal" href="#xmlrpc.server.DocCGIXMLRPCRequestHandler" title="xmlrpc.server.DocCGIXMLRPCRequestHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">DocCGIXMLRPCRequestHandler</span></code></a> class is derived from

  609. <a class="reference internal" href="#xmlrpc.server.CGIXMLRPCRequestHandler" title="xmlrpc.server.CGIXMLRPCRequestHandler"><code class="xref py py-class docutils literal notranslate"><span class="pre">CGIXMLRPCRequestHandler</span></code></a> and provides a means of creating

  610. self-documenting, XML-RPC CGI scripts. HTTP POST requests are handled as XML-RPC

  611. method calls. HTTP GET requests are handled by generating pydoc-style HTML

  612. documentation. This allows a server to provide its own web-based documentation.</p>

  613. <dl class="py method">

  614. <dt class="sig sig-object py" id="xmlrpc.server.DocCGIXMLRPCRequestHandler.set_server_title">

  615. <span class="sig-prename descclassname"><span class="pre">DocCGIXMLRPCRequestHandler.</span></span><span class="sig-name descname"><span class="pre">set_server_title</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">server_title</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#xmlrpc.server.DocCGIXMLRPCRequestHandler.set_server_title" title="Link to this definition">¶</a></dt>

  616. <dd><p>Set the title used in the generated HTML documentation. This title will be used

  617. inside the HTML “title” element.</p>

  618. </dd></dl>

  619. 

  620. <dl class="py method">

  621. <dt class="sig sig-object py" id="xmlrpc.server.DocCGIXMLRPCRequestHandler.set_server_name">

  622. <span class="sig-prename descclassname"><span class="pre">DocCGIXMLRPCRequestHandler.</span></span><span class="sig-name descname"><span class="pre">set_server_name</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">server_name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#xmlrpc.server.DocCGIXMLRPCRequestHandler.set_server_name" title="Link to this definition">¶</a></dt>

  623. <dd><p>Set the name used in the generated HTML documentation. This name will appear at

  624. the top of the generated documentation inside a “h1” element.</p>

  625. </dd></dl>

  626. 

  627. <dl class="py method">

  628. <dt class="sig sig-object py" id="xmlrpc.server.DocCGIXMLRPCRequestHandler.set_server_documentation">

  629. <span class="sig-prename descclassname"><span class="pre">DocCGIXMLRPCRequestHandler.</span></span><span class="sig-name descname"><span class="pre">set_server_documentation</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">server_documentation</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#xmlrpc.server.DocCGIXMLRPCRequestHandler.set_server_documentation" title="Link to this definition">¶</a></dt>

  630. <dd><p>Set the description used in the generated HTML documentation. This description

  631. will appear as a paragraph, below the server name, in the documentation.</p>

  632. </dd></dl>

  633. 

  634. </section>

  635. </section>

  636. 

  637. 

  638.             <div class="clearer"></div>

  639.           </div>

  640.         </div>

  641.       </div>

  642.       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">

  643.         <div class="sphinxsidebarwrapper">

  644.   <div>

  645.     <h3><a href="../contents.html">Table of Contents</a></h3>

  646.     <ul>

  647. <li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate"><span class="pre">xmlrpc.server</span></code> — Basic XML-RPC servers</a><ul>

  648. <li><a class="reference internal" href="#simplexmlrpcserver-objects">SimpleXMLRPCServer Objects</a><ul>

  649. <li><a class="reference internal" href="#simplexmlrpcserver-example">SimpleXMLRPCServer Example</a></li>

  650. </ul>

  651. </li>

  652. <li><a class="reference internal" href="#cgixmlrpcrequesthandler">CGIXMLRPCRequestHandler</a></li>

  653. <li><a class="reference internal" href="#documenting-xmlrpc-server">Documenting XMLRPC server</a></li>

  654. <li><a class="reference internal" href="#docxmlrpcserver-objects">DocXMLRPCServer Objects</a></li>

  655. <li><a class="reference internal" href="#doccgixmlrpcrequesthandler">DocCGIXMLRPCRequestHandler</a></li>

  656. </ul>

  657. </li>

  658. </ul>

  659. 

  660.   </div>

  661.   <div>

  662.     <h4>Previous topic</h4>

  663.     <p class="topless"><a href="xmlrpc.client.html"

  664.                           title="previous chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">xmlrpc.client</span></code> — XML-RPC client access</a></p>

  665.   </div>

  666.   <div>

  667.     <h4>Next topic</h4>

  668.     <p class="topless"><a href="ipaddress.html"

  669.                           title="next chapter"><code class="xref py py-mod docutils literal notranslate"><span class="pre">ipaddress</span></code> — IPv4/IPv6 manipulation library</a></p>

  670.   </div>

  671.   <div role="note" aria-label="source link">

  672.     <h3>This Page</h3>

  673.     <ul class="this-page-menu">

  674.       <li><a href="../bugs.html">Report a Bug</a></li>

  675.       <li>

  676.         <a href="https://github.com/python/cpython/blob/main/Doc/library/xmlrpc.server.rst"

  677.             rel="nofollow">Show Source

  678.         </a>

  679.       </li>

  680.     </ul>

  681.   </div>

  682.         </div>

  683. <div id="sidebarbutton" title="Collapse sidebar">

  684. <span>«</span>

  685. </div>

  686. 

  687.       </div>

  688.       <div class="clearer"></div>

  689.     </div>  

  690.     <div class="related" role="navigation" aria-label="related navigation">

  691.       <h3>Navigation</h3>

  692.       <ul>

  693.         <li class="right" style="margin-right: 10px">

  694.           <a href="../genindex.html" title="General Index"

  695.              >index</a></li>

  696.         <li class="right" >

  697.           <a href="../py-modindex.html" title="Python Module Index"

  698.              >modules</a> |</li>

  699.         <li class="right" >

  700.           <a href="ipaddress.html" title="ipaddress — IPv4/IPv6 manipulation library"

  701.              >next</a> |</li>

  702.         <li class="right" >

  703.           <a href="xmlrpc.client.html" title="xmlrpc.client — XML-RPC client access"

  704.              >previous</a> |</li>

  705. 

  706.           <li><img src="../_static/py.svg" alt="Python logo" style="vertical-align: middle; margin-top: -1px"/></li>

  707.           <li><a href="https://www.python.org/">Python</a> &#187;</li>

  708.           <li class="switchers">

  709.             <div class="language_switcher_placeholder"></div>

  710.             <div class="version_switcher_placeholder"></div>

  711.           </li>

  712.           <li>

  713.               

  714.           </li>

  715.     <li id="cpython-language-and-version">

  716.       <a href="../index.html">3.12.3 Documentation</a> &#187;

  717.     </li>

  718. 

  719.           <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> &#187;</li>

  720.           <li class="nav-item nav-item-2"><a href="internet.html" >Internet Protocols and Support</a> &#187;</li>

  721.         <li class="nav-item nav-item-this"><a href=""><code class="xref py py-mod docutils literal notranslate"><span class="pre">xmlrpc.server</span></code> — Basic XML-RPC servers</a></li>

  722.                 <li class="right">

  723.                     

  724. 

  725.     <div class="inline-search" role="search">

  726.         <form class="inline-search" action="../search.html" method="get">

  727.           <input placeholder="Quick search" aria-label="Quick search" type="search" name="q" id="search-box" />

  728.           <input type="submit" value="Go" />

  729.         </form>

  730.     </div>

  731.                      |

  732.                 </li>

  733.             <li class="right">

  734. <label class="theme-selector-label">

  735.     Theme

  736.     <select class="theme-selector" oninput="activateTheme(this.value)">

  737.         <option value="auto" selected>Auto</option>

  738.         <option value="light">Light</option>

  739.         <option value="dark">Dark</option>

  740.     </select>

  741. </label> |</li>

  742.             

  743.       </ul>

  744.     </div>  

  745.     <div class="footer">

  746.     &copy; 

  747.       <a href="../copyright.html">

  748.     

  749.     Copyright

  750.     

  751.       </a>

  752.      2001-2024, Python Software Foundation.

  753.     <br />

  754.     This page is licensed under the Python Software Foundation License Version 2.

  755.     <br />

  756.     Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.

  757.     <br />

  758.     

  759.       See <a href="/license.html">History and License</a> for more information.<br />

  760.     

  761.     

  762.     <br />

  763. 

  764.     The Python Software Foundation is a non-profit corporation.

  765. <a href="https://www.python.org/psf/donations/">Please donate.</a>

  766. <br />

  767.     <br />

  768.       Last updated on Apr 09, 2024 (13:47 UTC).

  769.     

  770.       <a href="/bugs.html">Found a bug</a>?

  771.     

  772.     <br />

  773. 

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

  775.     </div>

  776. 

  777.   </body>

  778. </html>
上海开阖软件有限公司 沪ICP备12045867号-1