在 Python 中验证 XBRL

XBRL 代表基于 XML 的商业报告语言。它只是一种帮助公司组织数据的模式,以便他们可以在公司内的各个部门之间共享信息。 XBRL 和内联 XBRL (iXBRL) 文档是结构化的电子商务报告,可以满足不同的业务需求。它不仅仅是另一种无聊的商业文件——XBRL 文件包含某些结构、格式和特征,可用于验证财务文件。我们可以轻松地以编程方式验证 XBRL 或 iXBRL 实例文档。在本文中,我们将学习如何在 Python 中验证 XBRL 文档。

本文将涵盖以下主题:

  1. 用于验证 XBRL 文档的 Python XBRL 验证器 API
  2. 验证 XBRL 文件
  3. 验证内联 XBRL 文件

用于验证 XBRL 文档的 Python XBRL 验证器 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 文档。此外,您可以使用 documentation 了解更多关于 Aspose.Finance for Python API 的信息。如有任何歧义,请随时在我们的 免费支持论坛 上与我们联系。

也可以看看