Python パッケージとしての RaptorXML Server

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

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

Python パッケージとしての RaptorXML Server

RaptorXML Server 2017 から、Python API がネイティブの Python ホイール パッケージ Python 3.5 として使用できるようになりました。 Python ホイール パッケージは、(例えば、 python.org からの)優先する Python 3.5 に拡張モジュールとしてインストールできます。(例えば、 from jupyter.organaconda.orgSciPy.org) Python 3 配布の一部は、大きなデータ、数学、科学、工学、グラフィックなどのための広範囲におよぶ拡張モジュールを含んでいます。  RaptorXML Server のために特別にこれらのモジュールを構築することなく、これらの モジュールを、 RaptorXML Server で使用することができるようになりました。これは、ホイール パッケージが RaptorXML Server 内に含まれる RaptorXMLXBRL-python.exe アプリケーションと同じ方法で作動するからです

 

メモ:Python ホイール パッケージは、ネイティブの Python 3.5 拡張モジュールと Python バージョン 3.5 との互換性が必要です。

 

メモ:Python ホイールパッケージは Python API v1 を含んでいません。

 

メモ:RaptorXML Server のバージョンを更新する場合、Python 環境内の Python ホイールパッケージが更新されていることを確認してください。

 

RaptorXML Server パッケージの正しいインストールの必要条件は、下のセクションで説明されています:

 

ホイール ファイルの名前
ホイール ファイルのロケーション
pip を使用してホイールをインストールする
ルート カタログ ファイル
JSON 構成ファイル

 

RaptorXML Server の Python API の使用方法に関しての詳細は、Python API レファレンスとサンプルを参照してください。 https://github.com/altova で Raptor の Python API を使用するスクリプトのサンプルも参照してください。

 

ホイール ファイルの名前

ホイール ファイルは、次のパターンに従い名前が付けられます:

 

raptorxmlserver-{version}(-{build tag})?-{python tag}-{abi tag}-{platform tag}.whl

 

サンプル:

raptorxmlserver-2.6.0-cp35-cp35m-win_amd64.whl

raptorxmlserver-2.6.0-cp35-cp35m-win_amd64.whl

 

ホイール ファイルのロケーション

ホイール ファイルは、 RaptorXML Server のインストールにパッケージされています。アプリケーションの bin フォルダー内にあります:

 

Windows

Program Files\Altova\RaptorXMLServer2019\bin

Linux

/opt/Altova/RaptorXMLServer2019/bin

Mac

/usr/local/Altova/RaptorXMLServer2019/bin

 

pip を使用してホイールをインストールする

RaptorXML Server パッケージを Python のモジュールとしてインストールするには、 pip コマンドを使用します:

 

pip install <wheel-file>.whl

python -m pip install <wheel-file>.whl  

 

python.org の Python 3.5 または以降がインストールされている場合、 pip は、既にインストールされています。それ以外の場合、 pip を最初にインストールする必要があります。 詳細に関しては、 https://docs.python.org/3/installing/ を参照してください。

 

ルート カタログ ファイル

Python のための RaptorXML モジュールは、 RaptorXML Server インストールフォルダー内に保管されている RootCatalog.xml、ルート カタログ ファイル 、をロケートすることができなければなりません。これは、 RaptorXML モジュールがカタログを使用して、スキーマや他の仕様などの様々なリソースを正確にロケートし、検証や変換などの関数を実行するために参照するためです。 RaptorXML モジュールは、 RaptorXML Server のインストールのあとにカタログの場所が変更されていない場合、自動的に RootCatalog.xml をロケートします。

 

RaptorXML Server 環境を移動、または、変更する場合、または、 RootCatalog.xml をインストールされている元の場所から移動すると、カタログの場所を環境変数と RaptorXML モジュールの JSON 構成ファイルを用いて指定することができます。これをおこなうための様々な方法が下にリストされています。  RaptorXML モジュールは、与えられた順番に次のリソースを探し、RootCatalog.xml の場所を決定します。

 

 

1

環境変数 ALTOVA_RAPTORXML_PYTHON_CONFIG

RootCatalog.xml へのパスである値と共に作成します。

2

HKLM レジストリ: SOFTWARE\Altova\RaptorXMLServer\Installation_v2019_x64\Setup\CatalogPath

レジストリキーは、 RaptorXML Server インストーラーにより追加されます。値は RootCatalog.xml へのパスです。Windows のみ

3

ロケーション: /opt/Altova/RaptorXMLServer2019/etc/RootCatalog.xml

Linux のみ

4

ロケーション: /usr/local/Altova/RaptorXMLServer2019/etc/RootCatalog.xml

Mac のみ

5

環境変数 ALTOVA_RAPTORXML_PYTHON_CONFIG

JSON 構成ファイルへのパスである値と共に作成します。

6

ロケーション: .altova/raptorxml-python.config

現在作業中のディレクトリ内の JSON 構成ファイル

7

ロケーション: ~/.config/altova/raptorxml-python.config

ユーザーのホームディレクトリ内の JSON 構成ファイル

8

ロケーション: /etc/altova/altova/raptorxml-python.config

JSON 構成ファイルLinux と Mac のみ

 

JSON 構成ファイル

RaptorXMLServer モジュールのために JSON 構成ファイルを作成することができます。このファイルは、上のテーブル内のオプション 5 から 8 へルート カタログ ファイルを検索するために、使用することができます。 JSON 構成ファイルは、ルート カタログ ファイル へのパスである値を持つ「CatalogPath」 キーを持つマップを含んでいる必要があります。

 

JSON 構成ファイルのリスティング

 

{

    "CatalogPath": "/path/to/RootCatalog.xml"

}

 


(C) 2019 Altova GmbH