DocXMLRPCServer — Сервер XML-RPC с самодокументированием

Модуль 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 учитывался.

1. Объекты DocXMLRPCServer

Класс 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-документации. Это описание будет отображаться как абзац, ниже имени сервера, в документации.

2. DocCGIXMLRPCRequestHandler

Класс DocCGIXMLRPCRequestHandler унаследован от SimpleXMLRPCServer.CGIXMLRPCRequestHandler и предоставляет возможность создания CGI-скриптов XML-RPC с самодокументированием. Запросы 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-документации. Это описание будет отображаться как абзац, ниже имени сервера, в документации.