20.25. DocXMLRPCServer —自己文書化XML-RPCサーバー—Pythonドキュメント

20.25。 DocXMLRPCServer —自己文書化XML-RPCサーバー

ノート

DocXMLRPCServer モジュールは、Python3のxmlrpc.serverにマージされました。 2to3 ツールは、ソースをPython 3に変換するときに、インポートを自動的に適応させます。

バージョン2.3の新機能。

DocXMLRPCServer モジュールは、 SimpleXMLRPCServer にあるクラスを拡張して、HTTPGET要求に応答してHTMLドキュメントを提供します。 サーバーは、 DocXMLRPCServer を使用して自立型にすることも、 DocCGIXMLRPCRequestHandler を使用してCGI環境に組み込むこともできます。

class DocXMLRPCServer.DocXMLRPCServer(addr[, requestHandler[, logRequests[, allow_none[, encoding[, bind_and_activate]]]]])

新しいサーバーインスタンスを作成します。 すべてのパラメーターは、 SimpleXMLRPCServer.SimpleXMLRPCServer の場合と同じ意味を持ちます。 requestHandler のデフォルトは DocXMLRPCRequestHandler です。

class DocXMLRPCServer.DocCGIXMLRPCRequestHandler

CGI環境でXML-RPC要求を処理するための新しいインスタンスを作成します。

class DocXMLRPCServer.DocXMLRPCRequestHandler

新しいリクエストハンドラインスタンスを作成します。 このリクエストハンドラーは、XML-RPC POSTリクエスト、ドキュメントGETリクエストをサポートし、 logRequests パラメーターから DocXMLRPCServer コンストラクターパラメーターが尊重されるようにログを変更します。

20.2.1。 DocXMLRPCServerオブジェクト

DocXMLRPCServer クラスは、 SimpleXMLRPCServer.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ドキュメントで使用される名前を設定します。 この名前は、生成されたドキュメントの上部の「h1」要素内に表示されます。

DocXMLRPCServer.set_server_documentation(server_documentation)

生成されたHTMLドキュメントで使用される説明を設定します。 この説明は、ドキュメントのサーバー名の下に段落として表示されます。

20.5.2。 DocCGIXMLRPCRequestHandler

DocCGIXMLRPCRequestHandler クラスは SimpleXMLRPCServer.CGIXMLRPCRequestHandler から派生し、自己文書化されたXML-RPCCGIスクリプトを作成する手段を提供します。 HTTP POSTリクエストは、XML-RPCメソッド呼び出しとして処理されます。 HTTP GETリクエストは、pydocスタイルのHTMLドキュメントを生成することによって処理されます。 これにより、サーバーは独自のWebベースのドキュメントを提供できます。

DocCGIXMLRPCRequestHandler.set_server_title(server_title)

生成されたHTMLドキュメントで使用されるタイトルを設定します。 このタイトルは、HTMLの「title」要素内で使用されます。

DocCGIXMLRPCRequestHandler.set_server_name(server_name)

生成されたHTMLドキュメントで使用される名前を設定します。 この名前は、生成されたドキュメントの上部の「h1」要素内に表示されます。

DocCGIXMLRPCRequestHandler.set_server_documentation(server_documentation)

生成されたHTMLドキュメントで使用される説明を設定します。 この説明は、ドキュメントのサーバー名の下に段落として表示されます。