20.25. DocXMLRPCServer — 自文档化 XML-RPC 服务器 — Python 文档

20.25。 DocXMLRPC服务器 — 自记录 XML-RPC 服务器

笔记

DocXMLRPCServer 模块已合并到 Python 3 中的 xmlrpc.server。 2to3 工具将在将您的源代码转换为 Python 3 时自动调整导入。

2.3 版中的新功能。

DocXMLRPCServer 模块扩展了 SimpleXMLRPCServer 中的类，以响应 HTTP GET 请求提供 HTML 文档。 服务器可以是独立的，使用 DocXMLRPCServer，或者嵌入在 CGI 环境中，使用 DocCGIXMLRPCRequestHandler。

class DocXMLRPCServer.DocXMLRPCServer(addr[, requestHandler[, logRequests[, allow_none[, encoding[, bind_and_activate]]]]])

创建一个新的服务器实例。 所有参数与 SimpleXMLRPCServer.SimpleXMLRPCServer 的含义相同； requestHandler 默认为 DocXMLRPCRequestHandler。

class DocXMLRPCServer.DocCGIXMLRPCRequestHandler

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

class DocXMLRPCServer.DocXMLRPCRequestHandler

创建一个新的请求处理程序实例。 此请求处理程序支持 XML-RPC POST 请求、文档 GET 请求并修改日志记录，以便 DocXMLRPCServer 构造函数参数的 logRequests 参数得到遵守。

20.25.1。 DocXMLRPCServer 对象

DocXMLRPCServer 类是从 SimpleXMLRPCServer.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 文档中使用的描述。 此描述将在文档中显示为位于服务器名称下方的段落。

20.25.2. DocCGIXMLRPCRequestHandler

DocCGIXMLRPCRequestHandler 类派生自 SimpleXMLRPCServer.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 文档中使用的描述。 此描述将在文档中显示为位于服务器名称下方的段落。