在 Python 中驗證 XBRL

XBRL 代表基於 XML 的商業報告語言。它只是一個幫助公司組織數據的模式,以便他們可以在公司內的各個部門之間共享信息。 XBRL 和 Inline XBRL (iXBRL) 文檔是結構化的電子業務報告,以滿足不同的業務需求。它不僅僅是另一種乏味的商業文件——XBRL 文件包含可用於驗證財務文件的特定結構、格式和特徵。我們可以輕鬆地以編程方式驗證 XBRL 或 iXBRL 實例文檔。在本文中,我們將學習如何使用 Python 驗證 XBRL 文檔。

本文應涵蓋以下主題:

  1. 用於驗證 XBRL 文檔的 Python XBRL 驗證器 API
  2. 驗證 XBRL 文件
  3. 驗證內聯 XBRL 文件

用於驗證 XBRL 文檔的 Python XBRL Validator API

為了驗證 XBRL 文件或實例文檔,我們將使用 Aspose.Finance for Python API。它允許創建 XBRL 實例、解析和驗證 XBRL 或 iXBRL 文件。

API 提供了 XbrlDocument 類,代表包含一個或多個 XBRL 實例的 XBRL 文檔。 XBRL 實例是一個 XML 片段,根元素具有 XBRL 標記。 XbrlInstance 類提供各種方法和屬性來處理 XBRL 實例。此類的 validate() 方法驗證選定的 XBRL 實例。我們有代表內聯 XBRL 文檔的 API 的 InlineXbrlDocument 類。此外,API 的 ValidationErrorCode 枚舉定義了所有驗證錯誤代碼和相應的錯誤消息。

下載軟件包 或在控制台中使用以下 pip 命令從 PyPI 安裝 API:

pip install aspose-finance

在 Python 中驗證 XBRL 文檔

我們可以按照以下步驟輕鬆加載和驗證 XBRL 實例文檔:

  1. 首先,使用 XbrlDocument 類加載 XBRL 文件。
  2. 接下來,使用 xbrlinstances 獲取所有實例。
  3. 然後,從集合中訪問所需的 XBRL 實例。
  4. 之後,調用 validate() 方法來驗證 XBRL 實例。
  5. 最後,顯示錯誤(如果有)。

以下代碼示例顯示瞭如何在 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 文檔:

  1. 首先,使用 InlineXbrlDocument 類加載 iXBRL 文件。
  2. 之後,調用 validate() 方法來驗證 XBRL 實例。
  3. 最後,顯示錯誤(如果有)。

以下代碼示例顯示瞭如何在 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 的信息。如有任何疑問,請隨時通過我們的 免費支持論壇 與我們聯繫。

也可以看看