Validar XBRL em Python

XBRL significa XML Linguagem de Relatório de Negócios Baseada. É simplesmente um esquema que ajuda as empresas a organizar seus dados para que possam compartilhar informações entre vários departamentos de sua empresa. Os documentos XBRL e Inline XBRL (iXBRL) são relatórios de negócios eletrônicos estruturados para atender a diferentes requisitos de negócios. Não é apenas outro tipo de documento comercial chato — os documentos XBRL contêm certa estrutura, formato e características que podem ser usadas para validar os documentos financeiros. Podemos validar facilmente um documento de instância XBRL ou iXBRL programaticamente. Neste artigo, aprenderemos como validar um documento XBRL em Python.

Os seguintes tópicos serão abordados neste artigo:

  1. API do validador XBRL do Python para validar o documento XBRL
  2. Validar arquivo XBRL
  3. Validar arquivo XBRL embutido

API do Python XBRL Validator para validar o documento XBRL

Para validar um arquivo XBRL ou documento de instância, usaremos a API Aspose.Finance for Python. Ele permite criar instâncias XBRL, analisar e validar os arquivos XBRL ou iXBRL.

A API fornece a classe XbrlDocument que representa um documento XBRL contendo uma ou mais instâncias XBRL. Uma instância XBRL é um fragmento XML, com o elemento raiz tendo uma tag XBRL. A classe XbrlInstance fornece vários métodos e propriedades para trabalhar com instâncias XBRL. O método validate() desta classe valida a instância XBRL selecionada. Temos a classe InlineXbrlDocument da API que representa um documento XBRL embutido. Além disso, a enumeração ValidationErrorCode da API define todos os códigos de erro de validação e a respectiva mensagem de erro.

Por favor, faça o download do pacote ou instale a API de PyPI usando o seguinte comando pip no console:

pip install aspose-finance

Validar documento XBRL em Python

Podemos carregar e validar facilmente um documento de instância XBRL seguindo as etapas abaixo:

  1. Primeiramente, carregue um arquivo XBRL usando a classe XbrlDocument.
  2. Em seguida, obtenha todas as instâncias usando o xbrlinstances.
  3. Em seguida, acesse a instância XBRL desejada da coleção.
  4. Depois disso, chame o método validate() para validar a instância XBRL.
  5. Por fim, mostre os erros, se houver.

O exemplo de código a seguir mostra como validar uma instância XBRL em Python.

# Este exemplo de código demonstra como validar o documento de instância XBRL.
from aspose.finance.xbrl import XbrlDocument

# O caminho para o documento de entrada
inputFile = "C:\Files\sample.xbrl"

# Carregar arquivo XBRL
document = XbrlDocument(inputFile)

# Obter instâncias
xbrlInstances = document.xbrl_instances

# Selecione uma instância específica
xbrlInstance = xbrlInstances[0]

# Validar
xbrlInstance.validate()

# Mostrar erros de validação, se houver
if xbrlInstance.validation_errors.length > 0:
    for validationError in xbrlInstance.validation_errors:
        print(validationError.message)

Validar documento XBRL embutido em Python

Também podemos validar um documento iXBRL seguindo as etapas abaixo:

  1. Primeiramente, carregue um arquivo iXBRL usando a classe InlineXbrlDocument.
  2. Depois disso, chame o método validate() para validar a instância XBRL.
  3. Por fim, mostre os erros, se houver.

O exemplo de código a seguir mostra como validar um documento XBRL ou iXBRL embutido em Python.

# Este exemplo de código demonstra como validar o documento XBRL embutido.
from aspose.finance.xbrl.inline import InlineXbrlDocument

# O caminho para o documento de entrada
inputFile = "C:\Files\sample.html"

# Carregar arquivo XBRL
document = InlineXbrlDocument(inputFile)

# Validar
document.validate();

# Mostrar erros de validação, se houver
if document.validation_errors.length > 0:
    for validationError in document.validation_errors:
        print(validationError.message)

Obtenha uma licença gratuita

Você pode obter uma licença temporária gratuita para experimentar a biblioteca sem limitações de avaliação.

Conclusão

Neste artigo, aprendemos como validar um documento XBRL em Python. Também vimos como validar um documento XBRL embutido programaticamente. Além disso, você pode aprender mais sobre Aspose.Finance for Python API usando documentação. Em caso de ambiguidade, sinta-se à vontade para nos contatar em nosso fórum de suporte gratuito.

Veja também