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

源代码: Lib/xmlrpc/server.py


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

警告

这个 xmlrpc.server 模块对恶意构造的数据不安全。如果需要分析不可信或未经身份验证的数据,请参阅 XML漏洞 .

class xmlrpc.server.SimpleXMLRPCServer(addr, requestHandler=SimpleXMLRPCRequestHandler, logRequests=True, allow_none=False, encoding=None, bind_and_activate=True, use_builtin_types=False)

创建新的服务器实例。此类提供了注册可由XML-RPC协议调用的函数的方法。这个 雷克斯丹德勒 参数应该是请求处理程序实例的工厂;它默认为 SimpleXMLRPCRequestHandler . 这个 addr雷克斯丹德勒 参数传递到 socketserver.TCPServer 构造函数。如果 逻各斯 为true(默认值),将记录请求;将此参数设置为false将关闭日志记录。这个 allow_noneencoding 参数传递到 xmlrpc.client 并控制将从服务器返回的XML-RPC响应。这个 bind_and_activate 参数控制是否 server_bind()server_activate() 由构造函数立即调用;它默认为true。将其设置为false允许代码操作 allow_reuse_address 绑定地址前的类变量。这个 use_builtin_types 参数传递到 loads() 函数和控制在接收日期/时间值或二进制数据时处理哪些类型;它默认为false。

在 3.3 版更改: 这个 use_builtin_types 增加了标志。

class xmlrpc.server.CGIXMLRPCRequestHandler(allow_none=False, encoding=None, use_builtin_types=False)

创建一个新实例来处理CGI环境中的XML-RPC请求。这个 allow_noneencoding 参数传递到 xmlrpc.client 并控制将从服务器返回的XML-RPC响应。这个 use_builtin_types 参数传递到 loads() 函数和控制在接收日期/时间值或二进制数据时处理哪些类型;它默认为false。

在 3.3 版更改: 这个 use_builtin_types 增加了标志。

class xmlrpc.server.SimpleXMLRPCRequestHandler

创建新的请求处理程序实例。此请求处理程序支持 POST 请求并修改日志记录,以便 逻各斯 参数 SimpleXMLRPCServer 构造函数参数是可接受的。

SimpleXmlRpcServer对象

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

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

注册一个可以响应XML-RPC请求的函数。如果 name 它将是与 function ,否则 function.__name__ 将被使用。 name 是一个字符串,可以包含在Python标识符中非法的字符,包括句点字符。

这个方法也可以用作修饰器。当用作装饰时, name 只能作为要注册的关键字参数提供 function 在下面 name . 如果没有 name 给出, function.__name__ 将被使用。

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

SimpleXMLRPCServer.register_instance(instance, allow_dotted_names=False)

注册一个用于公开尚未使用注册的方法名的对象 register_function() . 如果 实例 包含一个 _dispatch() 方法,使用请求的方法名和请求中的参数调用它。它的API是 def _dispatch(self, method, params) (注意 帕拉姆 不表示变量参数列表)。如果它调用一个底层函数来执行它的任务,那么该函数被调用为 func(*params) ,展开参数列表。返回值来自 _dispatch() 结果返回到客户端。如果 实例 没有一个 _dispatch() 方法,将搜索与请求方法的名称匹配的属性。

如果可选 allow_dotted_names 参数为true,实例没有 _dispatch() 方法,然后,如果请求的方法名包含句点,则将单独搜索方法名的每个组件,从而执行简单的分层搜索。然后使用请求中的参数调用从该搜索中找到的值,并将返回值传递回客户机。

警告

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

SimpleXMLRPCServer.register_introspection_functions()

注册xml-rpc自省函数 system.listMethodssystem.methodHelpsystem.methodSignature .

SimpleXMLRPCServer.register_multicall_functions()

注册xml-rpc multicall函数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() 也可用作装饰。上一个服务器示例可以用decorator方式注册函数:

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)

可以从命令行调用此示例服务演示:

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 只能作为要注册的关键字参数提供 function 在下面 name . 如果没有 name 给出, function.__name__ 将被使用。

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

CGIXMLRPCRequestHandler.register_instance(instance)

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

CGIXMLRPCRequestHandler.register_introspection_functions()

注册xml-rpc自省函数 system.listMethodssystem.methodHelpsystem.methodSignature .

CGIXMLRPCRequestHandler.register_multicall_functions()

注册xml-rpc multicall函数 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 或嵌入到CGI环境中,使用 DocCGIXMLRPCRequestHandler .

class xmlrpc.server.DocXMLRPCServer(addr, requestHandler=DocXMLRPCRequestHandler, logRequests=True, allow_none=False, encoding=None, bind_and_activate=True, use_builtin_types=True)

创建新的服务器实例。所有参数的含义与 SimpleXMLRPCServer雷克斯丹德勒 默认为 DocXMLRPCRequestHandler .

在 3.3 版更改: 这个 use_builtin_types 增加了标志。

class xmlrpc.server.DocCGIXMLRPCRequestHandler

创建一个新实例来处理CGI环境中的XML-RPC请求。

class xmlrpc.server.DocXMLRPCRequestHandler

创建新的请求处理程序实例。此请求处理程序支持XML-RPC POST请求、文档获取请求和修改日志记录,以便 逻各斯 参数 DocXMLRPCServer 构造函数参数是可接受的。

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文档中使用的说明。此描述将作为一个段落出现在文档中服务器名称的下方。