`xmlrpc.server.md`

309 строк · 25.1 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.9/library/xmlrpc.server.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# [`xmlrpc.server`](https://python-all.ru/3.9/library/xmlrpc.server.html#module-xmlrpc.server) – базовые XML-RPC серверы89**Исходный код:** [Lib/xmlrpc/server.py](https://python-all.ru/src/3.9/Lib/xmlrpc/server.py)1011---1213Модуль [`xmlrpc.server`](https://python-all.ru/3.9/library/xmlrpc.server.html#module-xmlrpc.server) предоставляет базовый каркас сервера для XML-RPC серверов, написанных на Python. Серверы могут быть как автономными, с использованием [`SimpleXMLRPCServer`](https://python-all.ru/3.9/library/xmlrpc.server.html#xmlrpc.server.SimpleXMLRPCServer), так и встроенными в CGI-среду, с использованием [`CGIXMLRPCRequestHandler`](https://python-all.ru/3.9/library/xmlrpc.server.html#xmlrpc.server.CGIXMLRPCRequestHandler).1415> **Предупреждение**16>17> Модуль [`xmlrpc.server`](https://python-all.ru/3.9/library/xmlrpc.server.html#module-xmlrpc.server) не защищён от вредоносных данных. Если требуется разбирать непроверенные или неаутентифицированные данные, см. [уязвимости XML](https://python-all.ru/3.9/library/xml.html#xml-vulnerabilities).1819#### `class xmlrpc.server.SimpleXMLRPCServer(addr, requestHandler=SimpleXMLRPCRequestHandler, logRequests=True, allow_none=False, encoding=None, bind_and_activate=True, use_builtin_types=False)`2021Создаёт новый экземпляр сервера. Этот класс предоставляет методы для регистрации функций, которые могут быть вызваны через протокол XML-RPC. Параметр *requestHandler* должен быть фабрикой экземпляров обработчиков запросов; по умолчанию используется [`SimpleXMLRPCRequestHandler`](https://python-all.ru/3.9/library/xmlrpc.server.html#xmlrpc.server.SimpleXMLRPCRequestHandler). Параметры *addr* и *requestHandler* передаются конструктору [`socketserver.TCPServer`](https://python-all.ru/3.9/library/socketserver.html#socketserver.TCPServer). Если *logRequests* равен true (по умолчанию), запросы будут логироваться; установка этого параметра в false отключает логирование. Параметры *allow\_none* и *encoding* передаются в [`xmlrpc.client`](https://python-all.ru/3.9/library/xmlrpc.client.html#module-xmlrpc.client) и управляют XML-RPC ответами, которые будут возвращаться сервером. Параметр *bind\_and\_activate* управляет тем, будут ли `server_bind()` и `server_activate()` вызваны сразу конструктором; по умолчанию true. Установка false позволяет коду изменить переменную класса *allow\_reuse\_address* до привязки адреса. Параметр *use\_builtin\_types* передаётся функции [`loads()`](https://python-all.ru/3.9/library/xmlrpc.client.html#xmlrpc.client.loads) и управляет тем, какие типы обрабатываются при получении значений даты/времени или двоичных данных; по умолчанию false.2223Изменено в версии 3.3: Добавлен флаг *use\_builtin\_types*.2425#### `class xmlrpc.server.CGIXMLRPCRequestHandler(allow_none=False, encoding=None, use_builtin_types=False)`2627Создаёт новый экземпляр для обработки XML-RPC запросов в CGI-среде. Параметры *allow\_none* и *encoding* передаются в [`xmlrpc.client`](https://python-all.ru/3.9/library/xmlrpc.client.html#module-xmlrpc.client) и управляют XML-RPC ответами, возвращаемыми сервером. Параметр *use\_builtin\_types* передаётся функции [`loads()`](https://python-all.ru/3.9/library/xmlrpc.client.html#xmlrpc.client.loads) и управляет тем, какие типы обрабатываются при получении значений даты/времени или двоичных данных; по умолчанию false.2829Изменено в версии 3.3: Добавлен флаг *use\_builtin\_types*.3031#### `class xmlrpc.server.SimpleXMLRPCRequestHandler`3233Создаёт новый экземпляр обработчика запросов. Этот обработчик поддерживает запросы `POST` и изменяет логирование так, чтобы параметр *logRequests* конструктора [`SimpleXMLRPCServer`](https://python-all.ru/3.9/library/xmlrpc.server.html#xmlrpc.server.SimpleXMLRPCServer) учитывался.3435## Объекты SimpleXMLRPCServer3637Класс [`SimpleXMLRPCServer`](https://python-all.ru/3.9/library/xmlrpc.server.html#xmlrpc.server.SimpleXMLRPCServer) основан на [`socketserver.TCPServer`](https://python-all.ru/3.9/library/socketserver.html#socketserver.TCPServer) и предоставляет средства для создания простых автономных XML-RPC серверов.3839#### `SimpleXMLRPCServer.register_function(function=None, name=None)`4041Регистрирует функцию, которая может отвечать на XML-RPC запросы. Если задано *name*, оно будет именем метода, связанным с *function*, в противном случае будет использовано `function.__name__`. *name* – строка, и может содержать символы, недопустимые в идентификаторах Python, включая точку.4243Этот метод также можно использовать как декоратор. При использовании в качестве декоратора *name* может быть передан только как именованный аргумент для регистрации *function* под именем *name*. Если *name* не указано, будет использовано `function.__name__`.4445Изменено в версии 3.7: [`register_function()`](https://python-all.ru/3.9/library/xmlrpc.server.html#xmlrpc.server.SimpleXMLRPCServer.register_function) можно использовать как декоратор.4647#### `SimpleXMLRPCServer.register_instance(instance, allow_dotted_names=False)`4849Регистрирует объект, который используется для предоставления доступа к именам методов, не зарегистрированных с помощью [`register_function()`](https://python-all.ru/3.9/library/xmlrpc.server.html#xmlrpc.server.SimpleXMLRPCServer.register_function). Если *instance* содержит метод `_dispatch()`, он вызывается с именем запрошенного метода и параметрами из запроса. Его API: `def _dispatch(self, method, params)` (обратите внимание, что *params* не представляет собой список переменных аргументов). Если для выполнения задачи вызывается нижележащая функция, она вызывается как `func(*params)`, с развёртыванием списка параметров. Возвращаемое значение `_dispatch()` возвращается клиенту как результат. Если *instance* не имеет метода `_dispatch()`, в нём ищется атрибут, соответствующий имени запрошенного метода.5051Если необязательный аргумент *allow\_dotted\_names* равен true и экземпляр не имеет метода `_dispatch()`, то если имя запрошенного метода содержит точки, каждый компонент имени метода ищется отдельно, в результате чего выполняется простой иерархический поиск. Найденное значение затем вызывается с параметрами из запроса, а возвращаемое значение передаётся обратно клиенту.5253> **Предупреждение**54>55> Включение опции *allow\_dotted\_names* позволяет злоумышленникам получить доступ к глобальным переменным вашего модуля и может позволить им выполнить произвольный код на вашей машине. Используйте эту опцию только в безопасной закрытой сети.5657#### `SimpleXMLRPCServer.register_introspection_functions()`5859Регистрирует функции интроспекции XML-RPC: `system.listMethods`, `system.methodHelp` и `system.methodSignature`.6061#### `SimpleXMLRPCServer.register_multicall_functions()`6263Регистрирует функцию мультивызова XML-RPC system.multicall.6465#### `SimpleXMLRPCRequestHandler.rpc_paths`6667Значение атрибута, которое должно быть кортежем, перечисляющим допустимые части пути URL для приёма XML-RPC запросов. Запросы, отправленные на другие пути, приведут к HTTP-ошибке 404 «страница не найдена». Если кортеж пуст, все пути считаются допустимыми. Значение по умолчанию – `('/', '/RPC2')`.6869### Пример SimpleXMLRPCServer7071Код сервера:7273```python74from xmlrpc.server import SimpleXMLRPCServer75from xmlrpc.server import SimpleXMLRPCRequestHandler7677# Ограничить конкретным путём.78class RequestHandler(SimpleXMLRPCRequestHandler):79    rpc_paths = ('/RPC2',)8081# Создать сервер82with SimpleXMLRPCServer(('localhost', 8000),83                        requestHandler=RequestHandler) as server:84    server.register_introspection_functions()8586    # Зарегистрировать функцию pow(); будет использовано значение87    # pow.__name__ как имя, то есть просто 'pow'.88    server.register_function(pow)8990    # Зарегистрировать функцию под другим именем91    def adder_function(x, y):92        return x + y93    server.register_function(adder_function, 'add')9495    # Зарегистрировать экземпляр; все методы экземпляра96    # публикуются как XML-RPC-методы (в данном случае только 'mul').97    class MyFuncs:98        def mul(self, x, y):99            return x * y100101    server.register_instance(MyFuncs())102103    # Запустить главный цикл сервера104    server.serve_forever()105```106107Следующий клиентский код будет вызывать методы, предоставленные предыдущим сервером:108109```python110import xmlrpc.client111112s = xmlrpc.client.ServerProxy('http://localhost:8000')113print(s.pow(2,3))  # Возвращает 2**3 = 8114print(s.add(2,3))  # Возвращает 5115print(s.mul(5,2))  # Возвращает 5*2 = 10116117# Вывести список доступных методов118print(s.system.listMethods())119```120121`register_function()` также можно использовать как декоратор. Предыдущий пример сервера может регистрировать функции с помощью декоратора:122123```python124from xmlrpc.server import SimpleXMLRPCServer125from xmlrpc.server import SimpleXMLRPCRequestHandler126127class RequestHandler(SimpleXMLRPCRequestHandler):128    rpc_paths = ('/RPC2',)129130with SimpleXMLRPCServer(('localhost', 8000),131                        requestHandler=RequestHandler) as server:132    server.register_introspection_functions()133134    # Зарегистрировать функцию pow(); будет использовано значение135    # pow.__name__ как имя, то есть просто 'pow'.136    server.register_function(pow)137138    # Зарегистрировать функцию под другим именем, используя139    # register_function как декоратор. *name* можно указать только140    # как именованный аргумент.141    @server.register_function(name='add')142    def adder_function(x, y):143        return x + y144145    # Регистрирует функцию под именем function.__name__.146    @server.register_function147    def mul(x, y):148        return x * y149150    server.serve_forever()151```152153Следующий пример из модуля `Lib/xmlrpc/server.py` показывает сервер, поддерживающий составные имена и регистрирующий функцию multicall.154155> **Предупреждение**156>157> Включение опции *allow\_dotted\_names* позволяет злоумышленникам получить доступ к глобальным переменным вашего модуля и может позволить им выполнить произвольный код на вашей машине. Используйте этот пример только в защищённой закрытой сети.158159```python160import datetime161162class ExampleService:163    def getData(self):164        return '42'165166    class currentTime:167        @staticmethod168        def getCurrentTime():169            return datetime.datetime.now()170171with SimpleXMLRPCServer(("localhost", 8000)) as server:172    server.register_function(pow)173    server.register_function(lambda x,y: x+y, 'add')174    server.register_instance(ExampleService(), allow_dotted_names=True)175    server.register_multicall_functions()176    print('Serving XML-RPC on localhost port 8000')177    try:178        server.serve_forever()179    except KeyboardInterrupt:180        print("\nKeyboard interrupt received, exiting.")181        sys.exit(0)182```183184Демо-сервис ExampleService можно запустить из командной строки:185186```python187python -m xmlrpc.server188```189190Клиент, который взаимодействует с указанным выше сервером, находится в *Lib/xmlrpc/client.py*:191192```python193server = ServerProxy("http://localhost:8000")194195try:196    print(server.currentTime.getCurrentTime())197except Error as v:198    print("ERROR", v)199200multi = MultiCall(server)201multi.getData()202multi.pow(2,9)203multi.add(1,2)204try:205    for response in multi():206        print(response)207except Error as v:208    print("ERROR", v)209```210211Этот клиент, взаимодействующий с демо-сервером XMLRPC, может быть вызван как:212213```python214python -m xmlrpc.client215```216217## CGIXMLRPCRequestHandler218219Класс [`CGIXMLRPCRequestHandler`](https://python-all.ru/3.9/library/xmlrpc.server.html#xmlrpc.server.CGIXMLRPCRequestHandler) можно использовать для обработки XML-RPC-запросов, отправленных в скрипты Python CGI.220221#### `CGIXMLRPCRequestHandler.register_function(function=None, name=None)`222223Регистрирует функцию, которая может отвечать на XML-RPC запросы. Если задано *name*, оно будет именем метода, связанным с *function*, в противном случае будет использовано `function.__name__`. *name* – строка, и может содержать символы, недопустимые в идентификаторах Python, включая точку.224225Этот метод также можно использовать как декоратор. При использовании в качестве декоратора *name* может быть передан только как именованный аргумент для регистрации *function* под именем *name*. Если *name* не указано, будет использовано `function.__name__`.226227Изменено в версии 3.7: [`register_function()`](https://python-all.ru/3.9/library/xmlrpc.server.html#xmlrpc.server.CGIXMLRPCRequestHandler.register_function) можно использовать как декоратор.228229#### `CGIXMLRPCRequestHandler.register_instance(instance)`230231Регистрирует объект, который используется для предоставления имён методов, не зарегистрированных с помощью [`register_function()`](https://python-all.ru/3.9/library/xmlrpc.server.html#xmlrpc.server.CGIXMLRPCRequestHandler.register_function). Если экземпляр содержит метод `_dispatch()`, он вызывается с запрошенным именем метода и параметрами из запроса; возвращаемое значение передаётся клиенту как результат. Если экземпляр не имеет метода `_dispatch()`, выполняется поиск атрибута, соответствующего имени запрошенного метода; если имя запрошенного метода содержит точки, каждый компонент имени метода ищется отдельно, в результате чего выполняется простая иерархическая проверка. Найденное значение затем вызывается с параметрами из запроса, а возвращаемое значение передаётся обратно клиенту.232233#### `CGIXMLRPCRequestHandler.register_introspection_functions()`234235Регистрирует функции интроспекции XML-RPC `system.listMethods`, `system.methodHelp` и `system.methodSignature`.236237#### `CGIXMLRPCRequestHandler.register_multicall_functions()`238239Регистрирует функцию мультивызова XML-RPC `system.multicall`.240241#### `CGIXMLRPCRequestHandler.handle_request(request_text=None)`242243Обрабатывает XML-RPC запрос. Если задан *request\_text*, он должен содержать POST-данные, предоставленные HTTP-сервером, в противном случае будет использовано содержимое stdin.244245Пример:246247```python248class MyFuncs:249    def mul(self, x, y):250        return x * y251252handler = CGIXMLRPCRequestHandler()253handler.register_function(pow)254handler.register_function(lambda x,y: x+y, 'add')255handler.register_introspection_functions()256handler.register_instance(MyFuncs())257handler.handle_request()258```259260## Документирование сервера XMLRPC261262Эти классы расширяют указанные выше классы, чтобы предоставлять HTML-документацию в ответ на HTTP GET запросы. Серверы могут быть автономными, с использованием [`DocXMLRPCServer`](https://python-all.ru/3.9/library/xmlrpc.server.html#xmlrpc.server.DocXMLRPCServer), или встроенными в CGI-среду, с использованием [`DocCGIXMLRPCRequestHandler`](https://python-all.ru/3.9/library/xmlrpc.server.html#xmlrpc.server.DocCGIXMLRPCRequestHandler).263264#### `class xmlrpc.server.DocXMLRPCServer(addr, requestHandler=DocXMLRPCRequestHandler, logRequests=True, allow_none=False, encoding=None, bind_and_activate=True, use_builtin_types=True)`265266Создаёт новый экземпляр сервера. Все параметры имеют то же значение, что и для [`SimpleXMLRPCServer`](https://python-all.ru/3.9/library/xmlrpc.server.html#xmlrpc.server.SimpleXMLRPCServer); *requestHandler* по умолчанию равен [`DocXMLRPCRequestHandler`](https://python-all.ru/3.9/library/xmlrpc.server.html#xmlrpc.server.DocXMLRPCRequestHandler).267268Изменено в версии 3.3: Добавлен флаг *use\_builtin\_types*.269270#### `class xmlrpc.server.DocCGIXMLRPCRequestHandler`271272Создаёт новый экземпляр для обработки XML-RPC запросов в CGI-среде.273274#### `class xmlrpc.server.DocXMLRPCRequestHandler`275276Создаёт новый экземпляр обработчика запросов. Этот обработчик запросов поддерживает XML-RPC POST-запросы, GET-запросы документации и изменяет протоколирование так, чтобы параметр *logRequests* конструктора [`DocXMLRPCServer`](https://python-all.ru/3.9/library/xmlrpc.server.html#xmlrpc.server.DocXMLRPCServer) соблюдался.277278## Объекты DocXMLRPCServer279280Класс [`DocXMLRPCServer`](https://python-all.ru/3.9/library/xmlrpc.server.html#xmlrpc.server.DocXMLRPCServer) является производным от [`SimpleXMLRPCServer`](https://python-all.ru/3.9/library/xmlrpc.server.html#xmlrpc.server.SimpleXMLRPCServer) и предоставляет средство создания самодокументируемых автономных XML-RPC серверов. HTTP POST запросы обрабатываются как вызовы методов XML-RPC. HTTP GET запросы обрабатываются генерацией HTML-документации в стиле pydoc. Это позволяет серверу предоставлять собственную веб-документацию.281282#### `DocXMLRPCServer.set_server_title(server_title)`283284Устанавливает заголовок, используемый в сгенерированной HTML-документации. Этот заголовок будет использоваться внутри элемента HTML «title».285286#### `DocXMLRPCServer.set_server_name(server_name)`287288Устанавливает имя, используемое в сгенерированной HTML-документации. Это имя будет отображаться в верхней части сгенерированной документации внутри элемента «h1».289290#### `DocXMLRPCServer.set_server_documentation(server_documentation)`291292Устанавливает описание, используемое в сгенерированной HTML-документации. Это описание будет отображаться в виде абзаца, под именем сервера, в документации.293294## DocCGIXMLRPCRequestHandler295296Класс [`DocCGIXMLRPCRequestHandler`](https://python-all.ru/3.9/library/xmlrpc.server.html#xmlrpc.server.DocCGIXMLRPCRequestHandler) является производным от [`CGIXMLRPCRequestHandler`](https://python-all.ru/3.9/library/xmlrpc.server.html#xmlrpc.server.CGIXMLRPCRequestHandler) и предоставляет средство создания самодокументируемых XML-RPC CGI-скриптов. HTTP POST запросы обрабатываются как вызовы методов XML-RPC. HTTP GET запросы обрабатываются генерацией HTML-документации в стиле pydoc. Это позволяет серверу предоставлять собственную веб-документацию.297298#### `DocCGIXMLRPCRequestHandler.set_server_title(server_title)`299300Устанавливает заголовок, используемый в сгенерированной HTML-документации. Этот заголовок будет использоваться внутри элемента HTML «title».301302#### `DocCGIXMLRPCRequestHandler.set_server_name(server_name)`303304Устанавливает имя, используемое в сгенерированной HTML-документации. Это имя будет отображаться в верхней части сгенерированной документации внутри элемента «h1».305306#### `DocCGIXMLRPCRequestHandler.set_server_documentation(server_documentation)`307308Устанавливает описание, используемое в сгенерированной HTML-документации. Это описание будет отображаться в виде абзаца, под именем сервера, в документации.309