Python API バージョン

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

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

Python API バージョン

RaptorXML+XBRL Server は、Python API バージョン 複数のをサポートします。Python API の以前のバージョンは、 RaptorXML+XBRL Server の現在のバージョンでもサポートされています。 Python API バージョンは、 --script-api-version=MAJOR_VERSION コマンドラインフラグによりサポートされています。 MAJOR_VERSION のデフォルトの引数は、常に最新のバージョンです。新しい RaptorXML+XBRL Server Python API MAJOR_VERSION は、互換性に関する変更または大幅な機能の向上が追加されると紹介されます。 API のユーザーは、新しいバージョンがリリースされても、既存のスクリプトをアップデートする必要はありません。

 

以下が奨励されます:

 

--script-api-version=MAJOR_VERSION フラグを使用して、RaptorXML+XBRL Server コマンドライン (または Web-API) からユーティリティスクリプトを呼び出します。新しい API MAJOR_VERSION がリリースされても、 RaptorXML+XBRL Server アップデートの後、スクリプトが作動することを保証することができます。
今後の RaptorXML+XBRL Server のリリースで以前のバージョンはサポートされますが、新規プロジェクトのために API  の最新バージョンを使用してください。

 

下にリストされる Python API バージョンを使用することができます。 異なる API のドキュメントは、下にリストされるオンライン上のロケーションで使用することができます。

 

サンプルファイル

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

 

Python API バージョン 1

RaptorXML+XBRL Server v2014 で紹介されました。

 

 

コマンドラインフラグ:

--script-api-version=1

ドキュメント:

Python API バージョン 1 レファレンス

 

 

これは、オリジナルの RaptorXML+XBRL Server Python API です。以下の RaptorXML+XBRL Server の内部モデルへのアクセスへのサポートをカバーします:

 

XML 1.0 and XML 1.1 (API モジュール xml)
XMLSchema 1.0 and XMLSchema 1.1 (API モジュール xsd)
XBRL 2.1 (API モジュール xbrl)

 

API は、 Python スクリプトファイル内で実装されるコールバック関数を介して使用することができます。on_xsi_valid

 

on_xsd_valid
on_dts_valid
on_xbrl_valid

 

スクリプトは、 コマンドライン上の --script オプションで指定されています。コールバック関数は検証に成功した場合のみ呼び出されます。コールバック関数と API の詳細については、 RaptorXML+XBRL Server Python API バージョン 1 レファレンス内で説明されています。

 

メモ:Raptor の Python API v1 は非奨励されています。 Python API v2 を使用してください。

 

Python API バージョン 2

RaptorXML+XBRL Server v2015r3 で紹介されました。 最新の API バージョンは 2.7.0 です。

 

コマンドライン フラグ:

--script-api-version=2
--script-api-version=2.1
--script-api-version=2.2
--script-api-version=2.3

--script-api-version=2.4
--script-api-version=2.4.1

--script-api-version=2.5.0

--script-api-version=2.6.0

--script-api-version=2.7.0

v 2015r3

v 2015r4

v 2016

v 2016r2

v 2017
v 2018

v 2018r2

v 2019

v2019r3

ドキュメント:

Python API バージョン 2 レファレンス

 

 

API バージョンは、  300 個の新しいクラスを紹介し、頻繁に使用される情報 (例えば、 PSVI データ) が更に簡単にアクセスすることができ、関連した API が論理的にグループ化 (例えば、 xbrl.taxonomy、xbrl.formula、 xbrl.table) できるよう RaptorXML+XBRL Server Python API バージョン 1 からのモジュールを再構成します。このバージョンでは、コールバック機能は検証が成功した場合だけではなく、検証が失敗した場合にも呼び出されます。 この振る舞いを反映するため、コールバック機能の名前は以下のように変更されます:

 

on_xsi_finished
on_xsd_finished
on_dts_finished
on_xbrl_finished

 

モジュール化を有効化するために、 RaptorXML+XBRL Server は複数の --script オプションをサポートします。Python スクリプトファイル内で実装されるコールバックは、コマンドライン上で指定された順番で実行されます。

 


(C) 2019 Altova GmbH