xmlrpc.server —基本的 XML-RPC 服务器

源代码： Lib/xmlrpc/server.py

xmlrpc.server模块为使用 Python 编写的 XML-RPC 服务器提供了基本的服务器框架。服务器可以使用SimpleXMLRPCServer独立安装，也可以使用CGIXMLRPCRequestHandler嵌入 CGI 环境中。

Warning

xmlrpc.server模块不能安全防范恶意构建的数据。如果您需要解析不可信或未经身份验证的数据，请参见XML vulnerabilities。

在版本 3.3 中更改：添加了* use_builtin_types *标志。

在版本 3.3 中更改：添加了* use_builtin_types *标志。

SimpleXMLRPCServer Objects

SimpleXMLRPCServer类基于socketserver.TCPServer，并提供了一种创建简单的独立 XML-RPC 服务器的方法。

此方法也可以用作装饰器。当用作装饰器时，只能将* name 用作关键字参数，以将 function 注册在 name 下。如果没有给出名称*，将使用function.__name__。

在版本 3.7 中更改：register_function()可以用作装饰器。

如果可选的* allow_dotted_names *参数为 true，并且实例没有_dispatch()方法，则如果请求的方法名称包含句点，则将分别搜索方法名称的每个组成部分，从而执行简单的分层搜索。然后使用请求中的参数调用从此搜索中找到的值，并将返回值传递回 Client 端。

Warning

启用* allow_dotted_names *选项允许入侵者访问模块的全局变量，并且可以允许入侵者在计算机上执行任意代码。仅在安全，封闭的网络上使用此选项。

SimpleXMLRPCServer Example

Server code:

from xmlrpc.server import SimpleXMLRPCServer
from xmlrpc.server import SimpleXMLRPCRequestHandler

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

# Create server
with SimpleXMLRPCServer(('localhost', 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 'pow'.
    server.register_function(pow)

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

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

    server.register_instance(MyFuncs())

    # Run the server's main loop
    server.serve_forever()

以下 Client 端代码将调用前面的服务器提供的方法：

import xmlrpc.client

s = xmlrpc.client.ServerProxy('http://localhost:8000')
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())

register_function()也可以用作装饰器。前面的服务器示例可以用修饰器方式注册Function：

from xmlrpc.server import SimpleXMLRPCServer
from xmlrpc.server import SimpleXMLRPCRequestHandler

class RequestHandler(SimpleXMLRPCRequestHandler):
    rpc_paths = ('/RPC2',)

with SimpleXMLRPCServer(('localhost', 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 'pow'.
    server.register_function(pow)

    # 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='add')
    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()

Lib/xmlrpc/server.py模块中包含的以下示例显示了一个服务器，该服务器允许使用点号命名并注册一个多重调用Function。

Warning

启用* allow_dotted_names *选项允许入侵者访问模块的全局变量，并且可以允许入侵者在计算机上执行任意代码。仅在安全，封闭的网络中使用此示例。

import datetime

class ExampleService:
    def getData(self):
        return '42'

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

with SimpleXMLRPCServer(("localhost", 8000)) as server:
    server.register_function(pow)
    server.register_function(lambda x,y: x+y, 'add')
    server.register_instance(ExampleService(), allow_dotted_names=True)
    server.register_multicall_functions()
    print('Serving XML-RPC on localhost port 8000')
    try:
        server.serve_forever()
    except KeyboardInterrupt:
        print("\nKeyboard interrupt received, exiting.")
        sys.exit(0)

可以从命令行调用此 ExampleService 演示：

python -m xmlrpc.server

与上述服务器进行交互的 Client 端包含在 Lib/xmlrpc/client.py 中：

server = ServerProxy("http://localhost:8000")

try:
    print(server.currentTime.getCurrentTime())
except Error as v:
    print("ERROR", 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("ERROR", v)

与演示 XMLRPC 服务器交互的此 Client 端可以pass以下方式调用：

python -m xmlrpc.client

CGIXMLRPCRequestHandler

CGIXMLRPCRequestHandler类可用于处理发送到 Python CGI 脚本的 XML-RPC 请求。

此方法也可以用作装饰器。当用作装饰器时，只能将* name 用作关键字参数，以将 function 注册在 name 下。如果没有给出名称*，将使用function.__name__。

在版本 3.7 中更改：register_function()可以用作装饰器。

Example:

class MyFuncs:
    def mul(self, x, y):
        return x * y

handler = CGIXMLRPCRequestHandler()
handler.register_function(pow)
handler.register_function(lambda x,y: x+y, 'add')
handler.register_introspection_functions()
handler.register_instance(MyFuncs())
handler.handle_request()

记录 XMLRPC 服务器

这些类扩展了上述类，以响应 HTTP GET 请求而提供 HTML 文档。服务器可以使用DocXMLRPCServer独立安装，也可以使用DocCGIXMLRPCRequestHandler嵌入 CGI 环境中。

在版本 3.3 中更改：添加了* use_builtin_types *标志。

DocXMLRPCServer Objects

DocXMLRPCServer类是从SimpleXMLRPCServer派生的，它提供了一种创建自文档的独立 XML-RPC 服务器的方法。 HTTP POST 请求作为 XML-RPC 方法调用处理。pass生成 pydoc 样式的 HTML 文档来处理 HTTP GET 请求。这允许服务器提供其自己的基于 Web 的文档。

DocCGIXMLRPCRequestHandler

DocCGIXMLRPCRequestHandler类是从CGIXMLRPCRequestHandler派生的，并提供了一种创建自文档化 XML-RPC CGI 脚本的方法。 HTTP POST 请求作为 XML-RPC 方法调用处理。pass生成 pydoc 样式的 HTML 文档来处理 HTTP GET 请求。这允许服务器提供其自己的基于 Web 的文档。

首页