20.25. DocXMLRPCServer — Self-documenting XML-RPC server¶
Nota
The DocXMLRPCServer module has been merged into xmlrpc.server
in Python 3. The 2to3 tool will automatically adapt imports when
converting your sources to Python 3.
Novo na versão 2.3.
The DocXMLRPCServer module extends the classes found in
SimpleXMLRPCServer to serve HTML documentation in response to HTTP GET
requests. Servers can either be free standing, using DocXMLRPCServer,
or embedded in a CGI environment, using DocCGIXMLRPCRequestHandler.
-
class
DocXMLRPCServer.DocXMLRPCServer(addr[, requestHandler[, logRequests[, allow_none[, encoding[, bind_and_activate]]]]])¶ Create a new server instance. All parameters have the same meaning as for
SimpleXMLRPCServer.SimpleXMLRPCServer; requestHandler defaults toDocXMLRPCRequestHandler.
-
class
DocXMLRPCServer.DocCGIXMLRPCRequestHandler¶ Cria uma nova instância para manipular solicitações XML-RPC em um ambiente CGI.
-
class
DocXMLRPCServer.DocXMLRPCRequestHandler¶ Create a new request handler instance. This request handler supports XML-RPC POST requests, documentation GET requests, and modifies logging so that the logRequests parameter to the
DocXMLRPCServerconstructor parameter is honored.
20.25.1. Objetos de DocXMLRPCServer¶
The DocXMLRPCServer class is derived from
SimpleXMLRPCServer.SimpleXMLRPCServer and provides a means of creating
self-documenting, stand alone XML-RPC servers. HTTP POST requests are handled as
XML-RPC method calls. HTTP GET requests are handled by generating pydoc-style
HTML documentation. This allows a server to provide its own web-based
documentation.
-
DocXMLRPCServer.set_server_title(server_title)¶ Define o título usado na documentação HTML gerada. Este título será usado dentro do elemento “title” do HTML.
-
DocXMLRPCServer.set_server_name(server_name)¶ Define o nome usado na documentação HTML gerada. Este nome aparecerá na parte superior da documentação gerada dentro de um elemento “h1”.
-
DocXMLRPCServer.set_server_documentation(server_documentation)¶ Define a descrição usada na documentação HTML gerada. Esta descrição aparecerá como um parágrafo, abaixo do nome do servidor, na documentação.
20.25.2. DocCGIXMLRPCRequestHandler¶
The DocCGIXMLRPCRequestHandler class is derived from
SimpleXMLRPCServer.CGIXMLRPCRequestHandler and provides a means of
creating self-documenting, XML-RPC CGI scripts. HTTP POST requests are handled
as XML-RPC method calls. HTTP GET requests are handled by generating pydoc-style
HTML documentation. This allows a server to provide its own web-based
documentation.
-
DocCGIXMLRPCRequestHandler.set_server_title(server_title)¶ Define o título usado na documentação HTML gerada. Este título será usado dentro do elemento “title” do HTML.
-
DocCGIXMLRPCRequestHandler.set_server_name(server_name)¶ Define o nome usado na documentação HTML gerada. Este nome aparecerá na parte superior da documentação gerada dentro de um elemento “h1”.
-
DocCGIXMLRPCRequestHandler.set_server_documentation(server_documentation)¶ Define a descrição usada na documentação HTML gerada. Esta descrição aparecerá como um parágrafo, abaixo do nome do servidor, na documentação.