20.25. DocXMLRPCServer —自文档 XML-RPC 服务器
Note
DocXMLRPCServer模块已在 Python 3 中合并到xmlrpc.server中。2to3工具在将源转换为 Python 3 时将自动适应导入。
2.3 版的新Function。
DocXMLRPCServer模块扩展了SimpleXMLRPCServer中的类，以响应 HTTP GET 请求而提供 HTML 文档。服务器可以使用DocXMLRPCServer独立安装，也可以使用DocCGIXMLRPCRequestHandler嵌入 CGI 环境中。
-
- class *
DocXMLRPCServer.DocXMLRPCServer(* addr * [，* requestHandler * [，* logRequests * [，* allow_none * [，* encoding * [，* bind_and_activate *]]]]]]))
- 创建一个新的服务器实例。所有参数的含义与SimpleXMLRPCServer.SimpleXMLRPCServer相同； * requestHandler *默认为DocXMLRPCRequestHandler。
- class *
-
类别
DocXMLRPCServer.DocCGIXMLRPCRequestHandler- 创建一个新实例以在 CGI 环境中处理 XML-RPC 请求。
-
类别
DocXMLRPCServer.DocXMLRPCRequestHandler- 创建一个新的请求处理程序实例。该请求处理程序支持 XML-RPC POST 请求，文档 GET 请求，并修改日志记录，以便使用DocXMLRPCServer构造函数参数的* logRequests *参数。
20.25.1. DocXMLRPCServer 对象
DocXMLRPCServer类是从SimpleXMLRPCServer.SimpleXMLRPCServer派生的，它提供了一种创建自文档的独立 XML-RPC 服务器的方法。 HTTP POST 请求作为 XML-RPC 方法调用处理。pass生成 pydoc 样式的 HTML 文档来处理 HTTP GET 请求。这允许服务器提供其自己的基于 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 文档中使用的描述。该说明将在文档中的服务器名称下方以一段显示。
20.25.2. DocCGIXMLRPCRequestHandler
DocCGIXMLRPCRequestHandler类是从SimpleXMLRPCServer.CGIXMLRPCRequestHandler派生的，并提供了一种创建自文档化 XML-RPC CGI 脚本的方法。 HTTP POST 请求作为 XML-RPC 方法调用处理。pass生成 pydoc 样式的 HTML 文档来处理 HTTP GET 请求。这允许服务器提供其自己的基于 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 文档中使用的描述。该说明将在文档中的服务器名称下方以一段显示。