XBRL は XML ベースのビジネス レポート言語の略です。これは、企業が社内のさまざまな部門間で情報を共有できるようにデータを整理するのに役立つスキーマです。 XBRL およびインライン XBRL (iXBRL) ドキュメントは、さまざまなビジネス要件を満たす構造化された電子ビジネス レポートです。これは単なる別の種類の退屈なビジネス ドキュメントではありません。XBRL ドキュメントには、財務ドキュメントの検証に使用できる特定の構造、形式、および特性が含まれています。 XBRL または iXBRL インスタンス ドキュメントをプログラムで簡単に検証できます。この記事では、Python で XBRL ドキュメントを検証する方法を学びます。
この記事では、次のトピックについて説明します。
XBRL ドキュメントを検証する Python XBRL Validator API
XBRL ファイルまたはインスタンス ドキュメントを検証するには、Aspose.Finance for Python API を使用します。 XBRL インスタンスの作成、解析、および XBRL または iXBRL ファイルの検証を行うことができます。
API は、1 つ以上の XBRL インスタンスを含む XBRL ドキュメントを表す XbrlDocument クラスを提供します。 XBRL インスタンスは XML フラグメントであり、ルート要素には XBRL タグがあります。 XbrlInstance クラスは、XBRL インスタンスを操作するためのさまざまなメソッドとプロパティを提供します。このクラスの validate() メソッドは、選択された XBRL インスタンスを検証します。インライン XBRL ドキュメントを表す API の InlineXbrlDocument クラスがあります。さらに、API の ValidationErrorCode 列挙は、すべての検証エラー コードとそれぞれのエラー メッセージを定義します。
パッケージをダウンロードするか、コンソールで次の pip コマンドを使用して PyPI から API をインストールしてください。
pip install aspose-finance
Python で XBRL ドキュメントを検証する
以下の手順に従って、XBRL インスタンス ドキュメントを簡単にロードして検証できます。
- まず、XbrlDocument クラスを使用して XBRL ファイルをロードします。
- 次に、xbrlinstances を使用してすべてのインスタンスを取得します。
- 次に、コレクションから目的の XBRL インスタンスにアクセスします。
- その後、validate() メソッドを呼び出して XBRL インスタンスを検証します。
- 最後に、エラーがあれば表示します。
次のコード サンプルは、Python で XBRL インスタンスを検証する方法を示しています。
# このコード例は、XBRL インスタンス ドキュメントを検証する方法を示しています。
from aspose.finance.xbrl import XbrlDocument
# 入力ドキュメントへのパス
inputFile = "C:\Files\sample.xbrl"
# XBRL ファイルを読み込む
document = XbrlDocument(inputFile)
# インスタンスを取得する
xbrlInstances = document.xbrl_instances
# 特定のインスタンスを選択
xbrlInstance = xbrlInstances[0]
# 検証
xbrlInstance.validate()
# 検証エラーがあれば表示する
if xbrlInstance.validation_errors.length > 0:
for validationError in xbrlInstance.validation_errors:
print(validationError.message)
Python でインライン XBRL ドキュメントを検証する
以下の手順に従って iXBRL ドキュメントを検証することもできます。
- まず、InlineXbrlDocument クラスを使用して iXBRL ファイルをロードします。
- その後、validate() メソッドを呼び出して XBRL インスタンスを検証します。
- 最後に、エラーがあれば表示します。
次のコード サンプルは、Python でインライン XBRL または iXBRL ドキュメントを検証する方法を示しています。
# このコード例は、インライン XBRL ドキュメントを検証する方法を示しています。
from aspose.finance.xbrl.inline import InlineXbrlDocument
# 入力ドキュメントへのパス
inputFile = "C:\Files\sample.html"
# XBRL ファイルを読み込む
document = InlineXbrlDocument(inputFile)
# 検証
document.validate();
# 検証エラーがあれば表示する
if document.validation_errors.length > 0:
for validationError in document.validation_errors:
print(validationError.message)
無料ライセンスを取得する
無料の一時ライセンスを取得して、評価制限なしでライブラリを試すことができます。
結論
この記事では、Python で XBRL ドキュメントを検証する方法を学びました。また、インライン XBRL ドキュメントをプログラムで検証する方法も見てきました。さらに、ドキュメンテーション を使用して、Aspose.Finance for Python API の詳細を学ぶことができます。ご不明な点がございましたら、無料サポート フォーラム までお気軽にお問い合わせください。