Ler arquivos XBRL em Python

Relatórios de negócios eletrônicos estruturados são compostos de documentos XBRL e documentos Inline XBRL (iXBRL). No XBRL, os relatórios de negócios são coleções de fatos. Como alternativa, um relatório iXBRL é legível por humanos e contém dados marcados. Programaticamente, podemos ler documentos de instância XBRL ou iXBRL e recuperar referências de esquema, contextos, itens etc. Neste artigo, aprenderemos como ler arquivos XBRL em Python.

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

  1. Python XBRL Reader para ler XBRL
  2. Leia o arquivo XBRL
  3. Leia o arquivo iXBRL

Python XBRL Reader para ler XBRL

Para ler arquivos XBRL ou documentos de instância, usaremos a API Aspose.Finance for Python. Permite criar documentos de instância 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. A classe XbrlInstance fornece vários métodos e propriedades para trabalhar com instâncias XBRL. Temos a classe InlineXbrlDocument que representa um documento XBRL embutido.

Por favor baixe o pacote ou instale a API de PyPI usando o seguinte comando pip no console:

pip install aspose-finance

Ler arquivos XBRL usando Python

Podemos carregar e ler 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 xbrlinstances.
  3. Em seguida, acesse a instância XBRL desejada acessando usando seu índice da coleção.
  4. Depois disso, leia o conteúdo da instância XBRL.
  5. Por fim, mostre os dados/informações necessários.

O exemplo de código a seguir mostra como ler um arquivo XBRL em Python.

# Este exemplo de código demonstra como ler um arquivo XBRL.
from aspose.finance.xbrl import XbrlDocument

# Carregar Documento XBRL
document = XbrlDocument("C:\\Files\\sample.xbrl")

# Obter instâncias
xbrlInstances = document.xbrl_instances

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

# Extrair e ler
facts = xbrlInstance.facts
schemaRefs = xbrlInstance.schema_refs
contexts = xbrlInstance.contexts
units = xbrlInstance.units

# Mostrar dados
if contexts.length > 0:
    for x in contexts:
        print("id: " + x.id)
        print("Entity Identifier : " + x.entity.identifier)

Ler arquivos iXBRL em Python

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

  1. Primeiramente, carregue um arquivo iXBRL usando a classe InlineXbrlDocument.
  2. Leia o conteúdo do documento iXBRL.

O exemplo de código a seguir mostra como ler um arquivo iXBRL em Python.

# Este exemplo de código demonstra como analisar o documento iXBRL.
from aspose.finance.xbrl.inline import InlineXbrlDocument

# O caminho para o diretório de documentos.
inputFile = "C:\\Files\\Output.html"

# Carregar arquivo de entrada
document = InlineXbrlDocument(inputFile)

# Analisar
inlineFacts = document.facts
contexts = document.contexts
units = document.units

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 ler arquivos XBRL em Python. Também vimos como extrair dados de objetos de instância XBRL programaticamente. Além disso, você pode aprender mais sobre o Aspose.Finance para 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