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

源代码： Lib/xmlrpc/server.py

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

警告

xmlrpc.server 模块不能抵御恶意构造的数据。如果您需要解析不受信任或未经身份验证的数据，请参阅 XML 漏洞。

可用性：非 Emscripten，非 WASI。

此模块在 WebAssembly 平台 wasm32-emscripten 和 wasm32-wasi 上不可用或无法工作。有关更多信息，请参阅 WebAssembly 平台。

class xmlrpc.server.SimpleXMLRPCServer(addr, requestHandler=SimpleXMLRPCRequestHandler, logRequests=True, allow_none=False, encoding=None, bind_and_activate=True, use_builtin_types=False)¶: 创建一个新的服务器实例。此类提供了用于注册可由 XML-RPC 协议调用的函数的方法。requestHandler 参数应该是请求处理程序实例的工厂；它默认为 SimpleXMLRPCRequestHandler。addr 和 requestHandler 参数将传递给 socketserver.TCPServer 构造函数。如果 logRequests 为真（默认值），则会记录请求；将此参数设置为假将关闭日志记录。allow_none 和 encoding 参数将传递给 xmlrpc.client，并控制将从服务器返回的 XML-RPC 响应。bind_and_activate 参数控制构造函数是否立即调用 server_bind() 和 server_activate()；它默认为真。将其设置为假允许代码在绑定地址之前操作 allow_reuse_address 类变量。use_builtin_types 参数将传递给 loads() 函数，并控制在接收日期/时间值或二进制数据时处理哪些类型；它默认为假。

在 3.3 版更改: 添加了 use_builtin_types 标志。

class xmlrpc.server.CGIXMLRPCRequestHandler(allow_none=False, encoding=None, use_builtin_types=False)¶: 创建一个新实例来处理 CGI 环境中的 XML-RPC 请求。allow_none 和 encoding 参数将传递给 xmlrpc.client，并控制将从服务器返回的 XML-RPC 响应。use_builtin_types 参数将传递给 loads() 函数，并控制在接收日期/时间值或二进制数据时处理哪些类型；它默认为假。

在 3.3 版更改: 添加了 use_builtin_types 标志。

class xmlrpc.server.SimpleXMLRPCRequestHandler¶: 创建一个新的请求处理程序实例。此请求处理程序支持 POST 请求，并修改日志记录，以便遵循 SimpleXMLRPCServer 构造函数参数的 logRequests 参数。

SimpleXMLRPCServer 对象¶

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

SimpleXMLRPCServer.register_function(function=None, name=None)¶

注册一个可以响应 XML-RPC 请求的函数。如果给定了 *name*，它将作为与 *function* 关联的方法名，否则将使用 function.__name__。*name* 是一个字符串，可以包含 Python 标识符中不允许的字符，包括句点字符。

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

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

SimpleXMLRPCServer.register_instance(instance, allow_dotted_names=False)¶

注册一个对象，该对象用于公开尚未使用 register_function() 注册的方法名。如果 *instance* 包含 _dispatch() 方法，则会使用请求的方法名和参数调用该方法。其 API 为 def _dispatch(self, method, params)（请注意，*params* 不表示可变参数列表）。如果它调用底层函数来执行其任务，则该函数将作为 func(*params) 调用，展开参数列表。来自 _dispatch() 的返回值将作为结果返回给客户端。如果 *instance* 没有 _dispatch() 方法，则会搜索与其匹配请求方法名称的属性。

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

警告

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

SimpleXMLRPCServer.register_introspection_functions()¶: 注册 XML-RPC 内省函数 system.listMethods、system.methodHelp 和 system.methodSignature。

SimpleXMLRPCServer.register_multicall_functions()¶: 注册 XML-RPC 多调用函数 system.multicall。

SimpleXMLRPCRequestHandler.rpc_paths¶: 一个属性值，它必须是一个元组，其中列出了用于接收 XML-RPC 请求的 URL 的有效路径部分。发布到其他路径的请求将导致 404“找不到页面”HTTP 错误。如果此元组为空，则所有路径都将被视为有效。默认值为 ('/', '/RPC2')。

SimpleXMLRPCServer 示例¶

服务器代码

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()

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

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() 也可以用作装饰器。前面的服务器示例可以装饰器方式注册函数

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 模块中，展示了一个允许使用点分名称并注册多调用函数的服务器。

警告

启用 *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

与上述服务器交互的客户端包含在 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 服务器交互的客户端

python -m xmlrpc.client

CGIXMLRPCRequestHandler¶

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

CGIXMLRPCRequestHandler.register_function(function=None, name=None)¶

注册一个可以响应 XML-RPC 请求的函数。如果给定了 *name*，它将作为与 *function* 关联的方法名，否则将使用 function.__name__。*name* 是一个字符串，可以包含 Python 标识符中不允许的字符，包括句点字符。

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

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

CGIXMLRPCRequestHandler.register_instance(instance)¶: 注册一个对象，该对象用于公开尚未使用 register_function() 注册的方法名。如果实例包含 _dispatch() 方法，则会使用请求的方法名和参数调用该方法；返回值将作为结果返回给客户端。如果实例没有 _dispatch() 方法，则会搜索与其匹配请求方法名称的属性；如果请求的方法名包含句点，则会分别搜索方法名的每个组成部分，从而执行简单的分层搜索。然后，使用请求中的参数调用从此搜索中找到的值，并将返回值传递回客户端。

CGIXMLRPCRequestHandler.register_introspection_functions()¶: 注册 XML-RPC 内省函数 system.listMethods、system.methodHelp 和 system.methodSignature。

CGIXMLRPCRequestHandler.register_multicall_functions()¶: 注册 XML-RPC 多调用函数 system.multicall。

CGIXMLRPCRequestHandler.handle_request(request_text=None)¶: 处理 XML-RPC 请求。如果给定了 *request_text*，则它应该是 HTTP 服务器提供的 POST 数据，否则将使用 stdin 的内容。

示例

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 环境中。

class xmlrpc.server.DocXMLRPCServer(addr, requestHandler=DocXMLRPCRequestHandler, logRequests=True, allow_none=False, encoding=None, bind_and_activate=True, use_builtin_types=True)¶: 创建一个新的服务器实例。所有参数的含义与 SimpleXMLRPCServer 相同；*requestHandler* 默认为 DocXMLRPCRequestHandler。

在 3.3 版更改: 添加了 use_builtin_types 标志。

class xmlrpc.server.DocCGIXMLRPCRequestHandler¶: 创建一个新实例来处理 CGI 环境中的 XML-RPC 请求。

class xmlrpc.server.DocXMLRPCRequestHandler¶: 创建一个新的请求处理程序实例。此请求处理程序支持 XML-RPC POST 请求、文档 GET 请求，并修改日志记录，以便遵循 DocXMLRPCServer 构造函数参数的 *logRequests* 参数。

DocXMLRPCServer 对象¶

DocXMLRPCServer 类派生自 SimpleXMLRPCServer，并提供了一种创建自文档化、独立的 XML-RPC 服务器的方法。HTTP POST 请求作为 XML-RPC 方法调用处理。HTTP GET 请求通过生成 pydoc 风格的 HTML 文档来处理。这允许服务器提供自己的基于 Web 的文档。

DocXMLRPCServer.set_server_title(server_title)¶: 设置生成的 HTML 文档中使用的标题。此标题将用于 HTML“title”元素内。

DocXMLRPCServer.set_server_name(server_name)¶: 设置生成的 HTML 文档中使用的名称。此名称将出现在生成的文档顶部的“h1”元素内。

DocXMLRPCServer.set_server_documentation(server_documentation)¶: 设置生成的 HTML 文档中使用的描述。此描述将作为段落出现在文档中服务器名称的下方。

DocCGIXMLRPCRequestHandler¶

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

DocCGIXMLRPCRequestHandler.set_server_title(server_title)¶: 设置生成的 HTML 文档中使用的标题。此标题将用于 HTML“title”元素内。

DocCGIXMLRPCRequestHandler.set_server_name(server_name)¶: 设置生成的 HTML 文档中使用的名称。此名称将出现在生成的文档顶部的“h1”元素内。

DocCGIXMLRPCRequestHandler.set_server_documentation(server_documentation)¶: 设置生成的 HTML 文档中使用的描述。此描述将作为段落出现在文档中服务器名称的下方。

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

SimpleXMLRPCServer 对象¶

SimpleXMLRPCServer 示例¶

CGIXMLRPCRequestHandler¶

记录 XMLRPC 服务器¶

DocXMLRPCServer 对象¶

DocCGIXMLRPCRequestHandler¶

目录

上一主题

下一主题

本页

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

SimpleXMLRPCServer 对象¶

SimpleXMLRPCServer 示例¶

CGIXMLRPCRequestHandler¶

记录 XMLRPC 服务器¶

DocXMLRPCServer 对象¶

DocCGIXMLRPCRequestHandler¶

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