目次

前のトピックへ

21.24. SimpleXMLRPCServer — 基本的なXML-RPCサーバー

次のトピックへ

22. マルチメディアサービス

このページ

21.25. DocXMLRPCServer — セルフ-ドキュメンティング XML-RPC サーバ

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

バージョン 2.3 で追加.

DocXMLRPCServer モジュールは SimpleXMLRPCServer クラスを拡張し、HTTP GET リクエストに対し HTML ドキュメントを返します。サーバは DocXMLRPCServer を使ったスタンドアロン環境、 DocCGIXMLRPCRequestHandler を使った CGI 環境の2つがあります。

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

リクエスト・ハンドラの新たなインスタンスを生成します。このリクエスト・ハンドラは XML-RPC POST リクエスト、ドキュメントの GET、そして DocXMLRPCServer コンストラクタに与えられた logRequests パラメータ設定を優先するため、ロギングの変更をサポートします。

21.25.1. DocXMLRPCServer オブジェクト

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

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 ドキュメントの本文をセットします。この本文はドキュメント中の名前の下にパラグラフとして出力されます。

21.25.2. DocCGIXMLRPCRequestHandler

DocCGIXMLRPCRequestHandlerSimpleXMLRPCServer.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 ドキュメントの本文をセットします。この本文はドキュメント中の名前の下にパラグラフとして出力されます。