Документация Python неофициальный перевод
Содержание страницы

20.25. DocXMLRPCServer – Самодокументирующийся XML-RPC серверDocXMLRPCServer – Self-documenting XML-RPC server

Примечание

Модуль DocXMLRPCServer объединён с модулем xmlrpc.server в Python 3. Инструмент 2to3 автоматически адаптирует импорты при преобразовании исходного кода в Python 3.

Новое в версии 2.3.

Модуль DocXMLRPCServer расширяет классы из SimpleXMLRPCServer для обслуживания HTML-документации в ответ на HTTP GET-запросы. Серверы могут быть либо автономными (с использованием DocXMLRPCServer), либо встроенными в CGI-среду (с использованием DocCGIXMLRPCRequestHandler).

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

Создаёт новый экземпляр сервера. Все параметры имеют то же значение, что и для SimpleXMLRPCServer.SimpleXMLRPCServer; requestHandler по умолчанию равен DocXMLRPCRequestHandler.

class DocXMLRPCServer.DocCGIXMLRPCRequestHandler

Создаёт новый экземпляр для обработки XML-RPC запросов в CGI-среде.

class DocXMLRPCServer.DocXMLRPCRequestHandler

Создаёт новый экземпляр обработчика запросов. Этот обработчик запросов поддерживает XML-RPC POST-запросы, GET-запросы документации и изменяет протоколирование так, чтобы параметр logRequests конструктора DocXMLRPCServer соблюдался.

20.25.1. Объекты DocXMLRPCServerDocXMLRPCServer Objects

Класс DocXMLRPCServer наследуется от SimpleXMLRPCServer.SimpleXMLRPCServer и предоставляет способ создания самодокументирующихся автономных XML-RPC серверов. HTTP POST-запросы обрабатываются как вызовы методов XML-RPC. HTTP GET-запросы обрабатываются путём генерации HTML-документации в стиле pydoc. Это позволяет серверу предоставлять собственную веб-документацию.

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-запросы обрабатываются путём генерации HTML-документации в стиле pydoc. Это позволяет серверу предоставлять собственную веб-документацию.

DocCGIXMLRPCRequestHandler.set_server_title(server_title)

Устанавливает заголовок, используемый в сгенерированной HTML-документации. Этот заголовок будет использоваться внутри элемента HTML «title».

DocCGIXMLRPCRequestHandler.set_server_name(server_name)

Устанавливает имя, используемое в сгенерированной HTML-документации. Это имя будет отображаться в верхней части сгенерированной документации внутри элемента «h1».

DocCGIXMLRPCRequestHandler.set_server_documentation(server_documentation)

Устанавливает описание, используемое в сгенерированной HTML-документации. Это описание будет отображаться в виде абзаца, под именем сервера, в документации.