0 0 + ˆl–Ým_JJh¥² ¸È®41hßÀ ƒ}öZ_‡I|¥ŠèªÄÃ&Î :mod:`SimpleXMLRPCServer` --- Basic XML-RPC server ================================================== .. module:: SimpleXMLRPCServer :synopsis: Basic XML-RPC server implementation. .. moduleauthor:: Brian Quinlan .. sectionauthor:: Fred L. Drake, Jr. .. note:: The :mod:`SimpleXMLRPCServer` module has been merged into :mod:`xmlrpc.server` in Python 3. The :term:`2to3` tool will automatically adapt imports when converting your sources to Python 3. .. versionadded:: 2.2 **Source code:** :source:`Lib/SimpleXMLRPCServer.py` -------------- The :mod:`SimpleXMLRPCServer` module provides a basic server framework for XML-RPC servers written in Python. Servers can either be free standing, using :class:`SimpleXMLRPCServer`, or embedded in a CGI environment, using :class:`CGIXMLRPCRequestHandler`. .. class:: SimpleXMLRPCServer(addr[, requestHandler[, logRequests[, allow_none[, encoding[, bind_and_activate]]]]) Create a new server instance. This class provides methods for registration of functions that can be called by the XML-RPC protocol. The *requestHandler* parameter should be a factory for request handler instances; it defaults to :class:`SimpleXMLRPCRequestHandler`. The *addr* and *requestHandler* parameters are passed to the :class:`SocketServer.TCPServer` constructor. If *logRequests* is true (the default), requests will be logged; setting this parameter to false will turn off logging. The *allow_none* and *encoding* parameters are passed on to :mod:`xmlrpclib` and control the XML-RPC responses that will be returned from the server. The *bind_and_activate* parameter controls whether :meth:`server_bind` and :meth:`server_activate` are called immediately by the constructor; it defaults to true. Setting it to false allows code to manipulate the *allow_reuse_address* class variable before the address is bound. .. versionchanged:: 2.5 The *allow_none* and *encoding* parameters were added. .. versionchanged:: 2.6 The *bind_and_activate* parameter was added. .. class:: CGIXMLRPCRequestHandler([allow_none[, encoding]]) Create a new instance to handle XML-RPC requests in a CGI environment. The *allow_none* and *encoding* parameters are passed on to :mod:`xmlrpclib` and control the XML-RPC responses that will be returned from the server. .. versionadded:: 2.3 .. versionchanged:: 2.5 The *allow_none* and *encoding* parameters were added. .. class:: SimpleXMLRPCRequestHandler() Create a new request handler instance. This request handler supports ``POST`` requests and modifies logging so that the *logRequests* parameter to the :class:`SimpleXMLRPCServer` constructor parameter is honored. .. _simple-xmlrpc-servers: SimpleXMLRPCServer Objects -------------------------- The :class:`SimpleXMLRPCServer` class is based on :class:`SocketServer.TCPServer` and provides a means of creating simple, stand alone XML-RPC servers. .. method:: SimpleXMLRPCServer.register_function(function[, name]) Register a function that can respond to XML-RPC requests. If *name* is given, it will be the method name associated with *function*, otherwise ``function.__name__`` will be used. *name* can be either a normal or Unicode string, and may contain characters not legal in Python identifiers, including the period character. .. method:: SimpleXMLRPCServer.register_instance(instance[, allow_dotted_names]) Register an object which is used to expose method names which have not been registered using :meth:`register_function`. If *instance* contains a :meth:`_dispatch` method, it is called with the requested method name and the parameters from the request. Its API is ``def _dispatch(self, method, params)`` (note that *params* does not represent a variable argument list). If it calls an underlying function to perform its task, that function is called as ``func(*params)``, expanding th