`docxmlrpcserver.md`

60 строк · 6.9 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/2.7/library/docxmlrpcserver.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# 20.25. [`DocXMLRPCServer`](https://python-all.ru/2.7/library/docxmlrpcserver.html#module-DocXMLRPCServer) – Самодокументирующийся XML-RPC сервер89> **Примечание**10>11> Модуль [`DocXMLRPCServer`](https://python-all.ru/2.7/library/docxmlrpcserver.html#module-DocXMLRPCServer) объединён с модулем `xmlrpc.server` в Python 3. Инструмент [2to3](https://python-all.ru/2.7/glossary.html#term-2to3) автоматически адаптирует импорты при преобразовании исходного кода в Python 3.1213Новое в версии 2.3.1415Модуль [`DocXMLRPCServer`](https://python-all.ru/2.7/library/docxmlrpcserver.html#module-DocXMLRPCServer) расширяет классы из [`SimpleXMLRPCServer`](https://python-all.ru/2.7/library/simplexmlrpcserver.html#module-SimpleXMLRPCServer) для обслуживания HTML-документации в ответ на HTTP GET-запросы. Серверы могут быть либо автономными (с использованием [`DocXMLRPCServer`](https://python-all.ru/2.7/library/docxmlrpcserver.html#DocXMLRPCServer.DocXMLRPCServer)), либо встроенными в CGI-среду (с использованием [`DocCGIXMLRPCRequestHandler`](https://python-all.ru/2.7/library/docxmlrpcserver.html#DocXMLRPCServer.DocCGIXMLRPCRequestHandler)).1617#### `class DocXMLRPCServer.DocXMLRPCServer(addr[, requestHandler[, logRequests[, allow_none[, encoding[, bind_and_activate]]]]])`1819Создаёт новый экземпляр сервера. Все параметры имеют то же значение, что и для [`SimpleXMLRPCServer.SimpleXMLRPCServer`](https://python-all.ru/2.7/library/simplexmlrpcserver.html#SimpleXMLRPCServer.SimpleXMLRPCServer); *requestHandler* по умолчанию равен [`DocXMLRPCRequestHandler`](https://python-all.ru/2.7/library/docxmlrpcserver.html#DocXMLRPCServer.DocXMLRPCRequestHandler).2021#### `class DocXMLRPCServer.DocCGIXMLRPCRequestHandler`2223Создаёт новый экземпляр для обработки XML-RPC запросов в CGI-среде.2425#### `class DocXMLRPCServer.DocXMLRPCRequestHandler`2627Создаёт новый экземпляр обработчика запросов. Этот обработчик запросов поддерживает XML-RPC POST-запросы, GET-запросы документации и изменяет протоколирование так, чтобы параметр *logRequests* конструктора [`DocXMLRPCServer`](https://python-all.ru/2.7/library/docxmlrpcserver.html#DocXMLRPCServer.DocXMLRPCServer) соблюдался.2829## 20.25.1. Объекты DocXMLRPCServer3031Класс [`DocXMLRPCServer`](https://python-all.ru/2.7/library/docxmlrpcserver.html#DocXMLRPCServer.DocXMLRPCServer) наследуется от [`SimpleXMLRPCServer.SimpleXMLRPCServer`](https://python-all.ru/2.7/library/simplexmlrpcserver.html#SimpleXMLRPCServer.SimpleXMLRPCServer) и предоставляет способ создания самодокументирующихся автономных XML-RPC серверов. HTTP POST-запросы обрабатываются как вызовы методов XML-RPC. HTTP GET-запросы обрабатываются путём генерации HTML-документации в стиле pydoc. Это позволяет серверу предоставлять собственную веб-документацию.3233#### `DocXMLRPCServer.set_server_title(server_title)`3435Устанавливает заголовок, используемый в сгенерированной HTML-документации. Этот заголовок будет использоваться внутри элемента HTML «title».3637#### `DocXMLRPCServer.set_server_name(server_name)`3839Устанавливает имя, используемое в сгенерированной HTML-документации. Это имя будет отображаться в верхней части сгенерированной документации внутри элемента «h1».4041#### `DocXMLRPCServer.set_server_documentation(server_documentation)`4243Устанавливает описание, используемое в сгенерированной HTML-документации. Это описание будет отображаться в виде абзаца, под именем сервера, в документации.4445## 20.25.2. DocCGIXMLRPCRequestHandler4647Класс [`DocCGIXMLRPCRequestHandler`](https://python-all.ru/2.7/library/docxmlrpcserver.html#DocXMLRPCServer.DocCGIXMLRPCRequestHandler) наследуется от [`SimpleXMLRPCServer.CGIXMLRPCRequestHandler`](https://python-all.ru/2.7/library/simplexmlrpcserver.html#SimpleXMLRPCServer.CGIXMLRPCRequestHandler) и предоставляет способ создания самодокументирующихся XML-RPC CGI-скриптов. HTTP POST-запросы обрабатываются как вызовы методов XML-RPC. HTTP GET-запросы обрабатываются путём генерации HTML-документации в стиле pydoc. Это позволяет серверу предоставлять собственную веб-документацию.4849#### `DocCGIXMLRPCRequestHandler.set_server_title(server_title)`5051Устанавливает заголовок, используемый в сгенерированной HTML-документации. Этот заголовок будет использоваться внутри элемента HTML «title».5253#### `DocCGIXMLRPCRequestHandler.set_server_name(server_name)`5455Устанавливает имя, используемое в сгенерированной HTML-документации. Это имя будет отображаться в верхней части сгенерированной документации внутри элемента «h1».5657#### `DocCGIXMLRPCRequestHandler.set_server_documentation(server_documentation)`5859Устанавливает описание, используемое в сгенерированной HTML-документации. Это описание будет отображаться в виде абзаца, под именем сервера, в документации.60