xmlrpc.server — Базовые серверы XML-RPC

Исходный код: Lib/xmlrpc/server.py

Модуль xmlrpc.server предоставляет базовый серверный фреймворк для серверов XML-RPC, написанных на языке Python. Серверы могут быть автономными, используя SimpleXMLRPCServer, или встроенными в среду CGI, используя CGIXMLRPCRequestHandler.

class xmlrpc.server.SimpleXMLRPCServer(addr, requestHandler=SimpleXMLRPCRequestHandler, logRequests=True, allow_none=False, encoding=None, bind_and_activate=True, use_builtin_types=False)

Создаёт новый экземпляр сервера. Этот класс предоставляет методы для регистрации функций, которые могут быть вызваны протоколом XML-RPC. Параметр requestHandler должен быть фабрикой для экземпляров обработчиков запросов; по умолчанию он равен SimpleXMLRPCRequestHandler. Параметры addr и requestHandler передаются конструктору socketserver.TCPServer. Если logRequests имеет значение true (по умолчанию), запросы будут регистрироваться; установка этого параметра в false отключит регистрацию. Параметры allow_none и encoding передаются в xmlrpc.client и управляют ответами XML-RPC, которые будут возвращены сервером. Параметр bind_and_activate управляет тем, вызываются ли server_bind() и server_activate() непосредственно конструктором; по умолчанию он равен true. Установка его в false позволяет коду манипулировать переменной класса allow_reuse_address перед привязкой адреса. Параметр use_builtin_types передается функции loads() и управляет типами, которые обрабатываются при получении значений дат/времени или двоичных данных; по умолчанию он равен false.

Изменено в версии 3.3: Добавлен флаг use_builtin_types.

class xmlrpc.server.CGIXMLRPCRequestHandler(allow_none=False, encoding=None, use_builtin_types=False)

Создаёт новый экземпляр для обработки запросов XML-RPC в среде CGI. Параметры allow_none и encoding передаются в xmlrpc.client и управляют ответами XML-RPC, которые будут возвращены сервером. Параметр use_builtin_types передается функции loads() и управляет типами, которые обрабатываются при получении значений дат/времени или двоичных данных; по умолчанию он равен false.

Изменено в версии 3.3: Добавлен флаг use_builtin_types.

class xmlrpc.server.SimpleXMLRPCRequestHandler

Создаёт новый экземпляр обработчика запросов. Этот обработчик запросов поддерживает POST запросы и изменяет логирование таким образом, чтобы параметр logRequests конструктора SimpleXMLRPCServer соблюдался.

21.27.1. Объекты SimpleXMLRPCServer

Класс SimpleXMLRPCServer основан на socketserver.TCPServer и предоставляет средства для создания простых автономных серверов XML-RPC.

SimpleXMLRPCServer.register_function(function, name=None)

Регистрирует функцию, которая может отвечать на запросы XML-RPC. Если задан name, он будет именем метода, связанным с function, в противном случае используется function.__name__. name может быть обычной или строкой Unicode и может содержать символы, не являющиеся допустимыми в идентификаторах Python, включая символ точки.

SimpleXMLRPCServer.register_instance(instance, allow_dotted_names=False)

Регистрирует объект, который используется для экспонирования имён методов, которые не были зарегистрированы с помощью register_function(). Если instance содержит метод _dispatch(), он вызывается с именем запрошенного метода и параметрами из запроса. Его API — def _dispatch(self, method, params) (обратите внимание, что params не представляет собой список переменных аргументов). Если он вызывает базовую функцию для выполнения своей задачи, эта функция вызывается как func(*params), расширяя список параметров. Значение, возвращённое из _dispatch(), возвращается клиенту в качестве результата. Если у instance нет метода _dispatch(), он ищется по атрибуту, соответствующему имени запрошенного метода.

Если необязательный аргумент allow_dotted_names имеет значение true и у экземпляра нет метода _dispatch(), а имя запрошенного метода содержит точки, каждый компонент имени метода ищется индивидуально, что приводит к выполнению простого иерархического поиска. Найденное значение затем вызывается с параметрами из запроса, а возвращаемое значение передаётся обратно клиенту.

Предупреждение

Включение параметра allow_dotted_names позволяет злоумышленникам получить доступ к глобальным переменным вашего модуля и может позволить им выполнить произвольный код на вашей машине. Используйте этот параметр только в защищенной закрытой сети.

SimpleXMLRPCServer.register_introspection_functions()

Регистрирует функции интроспекции XML-RPC system.listMethods, system.methodHelp и system.methodSignature.

SimpleXMLRPCServer.register_multicall_functions()

Регистрирует систему мультивызовов XML-RPC system.multicall.

SimpleXMLRPCRequestHandler.rpc_paths

Значение атрибута, которое должно быть кортежем, перечисляющим допустимые части пути URL для получения запросов XML-RPC. Запросы, отправленные в другие пути, приведут к ошибке HTTP 404 «такой страницы нет». Если этот кортеж пуст, все пути будут считаться допустимыми. Значение по умолчанию — ('/', '/RPC2').

21.27.1.1. Пример SimpleXMLRPCServer

Код сервера:

from xmlrpc.server import SimpleXMLRPCServer
from xmlrpc.server import SimpleXMLRPCRequestHandler

# Restrict to a particular path.
class RequestHandler(SimpleXMLRPCRequestHandler):
    rpc_paths = ('/RPC2',)

# Create server
with SimpleXMLRPCServer(("localhost", 8000),
                        requestHandler=RequestHandler) as server:
    server.register_introspection_functions()

    # Register pow() function; this will use the value of
    # pow.__name__ as the name, which is just 'pow'.
    server.register_function(pow)

    # Register a function under a different name
    def adder_function(x,y):
        return x + y
    server.register_function(adder_function, 'add')

    # Register an instance; all the methods of the instance are
    # published as XML-RPC methods (in this case, just 'mul').
    class MyFuncs:
        def mul(self, x, y):
            return x * y

    server.register_instance(MyFuncs())

    # Run the server's main loop
    server.serve_forever()

Следующий клиентский код вызовет методы, доступные на предшествующем сервере:

import xmlrpc.client

s = xmlrpc.client.ServerProxy('http://localhost:8000')
print(s.pow(2,3))  # Returns 2**3 = 8
print(s.add(2,3))  # Returns 5
print(s.mul(5,2))  # Returns 5*2 = 10

# Print list of available methods
print(s.system.listMethods())

Следующий пример, включенный в модуль Lib/xmlrpc/server.py, демонстрирует сервер, разрешающий имена с точками и регистрирующий функцию мультивызова.

import datetime

class ExampleService:
    def getData(self):
        return '42'

    class currentTime:
        @staticmethod
        def getCurrentTime():
            return datetime.datetime.now()

with SimpleXMLRPCServer(("localhost", 8000)) as server:
    server.register_function(pow)
    server.register_function(lambda x,y: x+y, 'add')
    server.register_instance(ExampleService(), allow_dotted_names=True)
    server.register_multicall_functions()
    print('Serving XML-RPC on localhost port 8000')
    try:
        server.serve_forever()
    except KeyboardInterrupt:
        print("\nKeyboard interrupt received, exiting.")
        sys.exit(0)

Данный демонстрационный пример ExampleService можно вызвать из командной строки:

python -m xmlrpc.server

Клиент, взаимодействующий с вышеупомянутым сервером, включен в Lib/xmlrpc/client.py:

server = ServerProxy("http://localhost:8000")

try:
    print(server.currentTime.getCurrentTime())
except Error as v:
    print("ERROR", v)

multi = MultiCall(server)
multi.getData()
multi.pow(2,9)
multi.add(1,2)
try:
    for response in multi():
        print(response)
except Error as v:
    print("ERROR", v)

Этот клиент, взаимодействующий с демонстрационным сервером XMLRPC, можно вызвать как:

python -m xmlrpc.client

21.27.2. CGIXMLRPCRequestHandler

Класс CGIXMLRPCRequestHandler может использоваться для обработки запросов XML-RPC, отправленных в скрипты Python CGI.

CGIXMLRPCRequestHandler.register_function(function, name=None)

Регистрирует функцию, которая может отвечать на запросы XML-RPC. Если задано name, оно будет именем метода, связанным с функцией, иначе используется function.__name__. name может быть обычной или строкой Unicode и может содержать символы, не являющиеся допустимыми в идентификаторах Python, включая символ точки.

CGIXMLRPCRequestHandler.register_instance(instance)

Регистрирует объект, который используется для экспонирования имён методов, которые не были зарегистрированы с помощью register_function(). Если instance содержит метод _dispatch(), он вызывается с именем запрошенного метода и параметрами из запроса; возвращаемое значение возвращается клиенту в качестве результата. Если у instance нет метода _dispatch(), он ищется по атрибуту, соответствующему имени запрошенного метода; если имя запрошенного метода содержит точки, каждый компонент имени метода ищется индивидуально, что приводит к выполнению простого иерархического поиска. Найденное значение затем вызывается с параметрами из запроса, а возвращаемое значение передаётся обратно клиенту.

CGIXMLRPCRequestHandler.register_introspection_functions()

Регистрирует функции интроспекции XML-RPC system.listMethods, system.methodHelp и system.methodSignature.

CGIXMLRPCRequestHandler.register_multicall_functions()

Регистрирует функцию мультивызова XML-RPC system.multicall.

CGIXMLRPCRequestHandler.handle_request(request_text=None)

Обработка запроса XML-RPC. Если request_text задан, он должен содержать данные POST, предоставленные HTTP-сервером; в противном случае будут использованы данные из stdin.

Пример:

class MyFuncs:
    def mul(self, x, y):
        return x * y


handler = CGIXMLRPCRequestHandler()
handler.register_function(pow)
handler.register_function(lambda x,y: x+y, 'add')
handler.register_introspection_functions()
handler.register_instance(MyFuncs())
handler.handle_request()

21.27.3. Документирование XMLRPC-сервера

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

class xmlrpc.server.DocXMLRPCServer(addr, requestHandler=DocXMLRPCRequestHandler, logRequests=True, allow_none=False, encoding=None, bind_and_activate=True, use_builtin_types=True)

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

Изменено в версии 3.3: Добавлен флаг use_builtin_types.

class xmlrpc.server.DocCGIXMLRPCRequestHandler

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

class xmlrpc.server.DocXMLRPCRequestHandler

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

21.27.4. Объекты DocXMLRPCServer

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

21.27.5. DocCGIXMLRPCRequestHandler

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