This document is for an old version of Python that is no longer supported. You should upgrade and read the Python documentation for the current stable release.

# 20.25. `DocXMLRPCServer` --- セルフ-ドキュメンティング XML-RPC サーバ

注釈

`DocXMLRPCServer` モジュールは、Python 3では `xmlrpc.server` モジュールに統合されました。 2to3 ツールは、ソースコード内のimportを自動的にPython 3用に修正します。

バージョン 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]]]]])

  当たなサーバ・インスタンスを生成します。各パラメータの内容は `SimpleXMLRPCServer.SimpleXMLRPCServer` のものと同じですが、 requestHandler のデフォルトは `DocXMLRPCRequestHandler` になっています。

class `DocXMLRPCServer.``DocCGIXMLRPCRequestHandler`

  CGI環境に XMR-RPC リクエスト・ハンドラの新たなインスタンスを生成します。

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 `DocXMLRPCServer` constructor parameter is honored.

## 20.25.1. 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)

  生成する HTML ドキュメントのタイトルをセットします。このタイトルは HTML の title 要素として使われます。

`DocXMLRPCServer.``set_server_name`(server_name)

  生成する HTML ドキュメントの名前をセットします。この名前は HTML 冒頭の h1 要素に使われます。

`DocXMLRPCServer.``set_server_documentation`(server_documentation)

  生成する HTML ドキュメントの本文をセットします。この本文はドキュメント中の名前の下にパラグラフとして出力されます。

## 20.25.2. DocCGIXMLRPCRequestHandler

`DocCGIXMLRPCRequestHandler` は `SimpleXMLRPCServer.CGIXMLRPCRequestHandler` の派生クラスで、セルフ- ドキュメンティングの手段と XML-RPC CGI スクリプト機能を提供します。HTTP POST リクエストは XML-RCP メソッドの呼び出しとして扱われます。 HTTP GET リクエストは pydoc スタイルの HTML ドキュメント生成のリクエストとして扱われます。これはサーバが自分自身のドキュメントを Web ベースで提供可能であることを意味します。

`DocCGIXMLRPCRequestHandler.``set_server_title`(server_title)

  生成する HTML ドキュメントのタイトルをセットします。このタイトルは HTML の title 要素として使われます。

`DocCGIXMLRPCRequestHandler.``set_server_name`(server_name)

  生成する HTML ドキュメントの名前をセットします。この名前は HTML 冒頭の h1 要素に使われます。

`DocCGIXMLRPCRequestHandler.``set_server_documentation`(server_documentation)

  生成する HTML ドキュメントの本文をセットします。この本文はドキュメント中の名前の下にパラグラフとして出力されます。