Python API

www.altova.com このトピックを印刷 前のページ 1つ上のレベル 次のページ

ホーム >  エンジン API: Python と .NET >

Python API

RaptorXML Python API により XML ドキュメントと XML スキーマドキュメント内でのデータへのアクセス、および、 Python スクリプト内での操作を有効化することができます。 Python API の一般的な使用ケースは以下の通りです:

 

カスタムの検証ルールとエラーメッセージの実装
XML ドキュメントからコンテンツをデータベースにエクスポート
XML ドキュメントからコンテンツをカスタムデータ書式にエクスポート
Python シェル、または、 Jupyter ノートブック (http://jupyter.org/) 内で XML ドキュメントのデータモデルをインタラクティブにナビゲートしクエリ

RaptorXML Server の Python インターフェイスは、 Python API を介して、 XML および XSD のための XML ドキュメント および XML スキーマ ドキュメント 内のデータへのアクセスおよび取得を可能にします。 ソースドキュメント内のどのデータが処理され、どのように処理されるかは、 RaptorXML Server へパスされた Python スクリプト内で指定されています。

 

Python API

( XML および XSDのための) Python API は、 XML および XSD ドキュメント内に含まれるメタ情報、構造情報、データへのアクセスを提供します。 この結果、API を使用してドキュメント情報にアクセスし処理する Python スクリプトが作成されることができます。 例えば、XML ドキュメント からデータベースまたは CSV ファイルへデータを書き込む Python スクリプトが RaptorXML Server へパスされることができます。

 

Raptor の Python API のためのサンプルスクリプトは以下で使用することが可能です: https://github.com/altova

 

Python API は API レファレンスで説明されています:

 

Python API v1 レファレンス
Python API v2 レファレンス

 

メモ:Raptor の Python API v1 を使用することはできません。 Python API v2 を使用してください。

 

Python のための RaptorXML Server パッケージ

RaptorXML Server のインストール内で、ホイールフォーマットの Python パッケージを検索することができます。 Python の pip コマンドを使用して、このパッケージをインストールのモジュールとしてインストールします。RaptorXML モジュールがインストールされると、モジュールの関数をコード内で使用することができます。この方法で、 RaptorXML の機能は、作成する Python プログラム内で、グラフィックライブラリなどの他のサード パーティライブラリと簡単に使用することができます。

 

RaptorXML Server の Python パッケージの使用方法に関する詳細は、Python パッケージとしての RaptorXML Server を参照してください。

 

Python スクリプト

ユーザーにより作成された Python スクリプトは以下のコマンドの --script パラメータと共に送信されます。

 

valxml-withxsd (xsi)
valxsd (xsd)

 

Python スクリプトを呼び出すこれらのコマンドは、コマンドライン インターフェイス (CLI) および HTTP インターフェイスを介して使用することができます。 RaptorXML Server ので Python API の Python スクリプトの使用方法は、 https://github.com/altova で説明されています。

 

Python スクリプトを安全にする

HTTP を介して RaptorXML Server に対して、Python スクリプが コマンド内で指定されている場合、スクリプトは信頼できるディレクトリにある場合のみ作動します。 スクリプトは信頼できるディレクトリから実行されます。 Python スクリプトをこれ以外のディレクトリから指定するとエラーが生じます。 信頼できるディレクトリは サーバー構成ファイルserver.script-root-dir 設定で指定されており、信頼できるディレクトリは Python スクリプトを使用する場合指定されていなければなりません。 使用されるすべての Python スクリプトがこのディレクトリに保存されていることを確認してください。

 

HTTP ジョブリクエストのためにサーバーにより生成される出力は、(output-root-directory のサブディレクトリである) ジョブ出力ディレクトリ に書き込まれますが、この制限はあらゆる箇所に書き込むことのできる Python スクリプトに対しては適用されません。サーバー管理者は、信頼できるディレクトリ内のスクリプトを脆弱性に関する問題の可能性の点からレビューする必要があります。

 


(C) 2019 Altova GmbH