Validar XBRL en Python

XBRL significa XML lenguaje de informes comerciales basados. Es simplemente un esquema que ayuda a las empresas a organizar sus datos para que puedan compartir información entre varios departamentos dentro de su empresa. Los documentos XBRL e Inline XBRL (iXBRL) son informes comerciales electrónicos estructurados para cumplir con diferentes requisitos comerciales. No es solo otro tipo de documento comercial aburrido: los documentos XBRL contienen cierta estructura, formato y características que se pueden usar para validar los documentos financieros. Podemos validar fácilmente un documento de instancia XBRL o iXBRL mediante programación. En este artículo, aprenderemos cómo validar un documento XBRL en Python.

En este artículo se tratarán los siguientes temas:

  1. API de Python XBRL Validator para validar documentos XBRL
  2. Validar archivo XBRL
  3. Validar archivo XBRL en línea

Python XBRL Validator API para validar documentos XBRL

Para validar un archivo XBRL o un documento de instancia, utilizaremos la API Aspose.Finance for Python. Permite crear instancias XBRL, analizar y validar los archivos XBRL o iXBRL.

La API proporciona la clase XbrlDocument que representa un documento XBRL que contiene una o más instancias XBRL. Una instancia XBRL es un fragmento XML, cuyo elemento raíz tiene una etiqueta XBRL. La clase XbrlInstance proporciona varios métodos y propiedades para trabajar con instancias XBRL. El método validate() de esta clase valida la instancia XBRL seleccionada. Tenemos la clase InlineXbrlDocument de la API que representa un documento XBRL en línea. Además, la enumeración ValidationErrorCode de la API define todos los códigos de error de validación y el mensaje de error respectivo.

Descargue el paquete o instale la API desde PyPI usando el siguiente comando pip en la consola:

pip install aspose-finance

Validar documento XBRL en Python

Podemos cargar y validar fácilmente un documento de instancia XBRL siguiendo los pasos que se detallan a continuación:

  1. En primer lugar, cargue un archivo XBRL utilizando la clase XbrlDocument.
  2. Luego, obtenga todas las instancias usando xbrlinstances.
  3. Luego, acceda a la instancia XBRL deseada de la colección.
  4. Después de eso, llame al método de validación () para validar la instancia de XBRL.
  5. Finalmente, muestre los errores si los hubiere.

El siguiente ejemplo de código muestra cómo validar una instancia XBRL en Python.

# Este ejemplo de código demuestra cómo validar un documento de instancia de XBRL.
from aspose.finance.xbrl import XbrlDocument

# La ruta al documento de entrada
inputFile = "C:\Files\sample.xbrl"

# Cargar archivo XBRL
document = XbrlDocument(inputFile)

# Obtener instancias
xbrlInstances = document.xbrl_instances

# Seleccionar instancia específica
xbrlInstance = xbrlInstances[0]

# Validar
xbrlInstance.validate()

# Mostrar errores de validación si los hay
if xbrlInstance.validation_errors.length > 0:
    for validationError in xbrlInstance.validation_errors:
        print(validationError.message)

Validar documento XBRL en línea en Python

También podemos validar un documento iXBRL siguiendo los pasos que se detallan a continuación:

  1. En primer lugar, cargue un archivo iXBRL utilizando la clase InlineXbrlDocument.
  2. Después de eso, llame al método de validación () para validar la instancia de XBRL.
  3. Finalmente, muestre los errores si los hubiere.

El siguiente ejemplo de código muestra cómo validar un documento XBRL o iXBRL en línea en Python.

# Este ejemplo de código demuestra cómo validar un documento XBRL en línea.
from aspose.finance.xbrl.inline import InlineXbrlDocument

# La ruta al documento de entrada
inputFile = "C:\Files\sample.html"

# Cargar archivo XBRL
document = InlineXbrlDocument(inputFile)

# Validar
document.validate();

# Mostrar errores de validación si los hay
if document.validation_errors.length > 0:
    for validationError in document.validation_errors:
        print(validationError.message)

Obtenga una licencia gratis

Puede obtener una licencia temporal gratuita para probar la biblioteca sin limitaciones de evaluación.

Conclusión

En este artículo hemos aprendido a validar un documento XBRL en Python. También hemos visto cómo validar un documento XBRL en línea mediante programación. Además, puede obtener más información sobre Aspose.Finance for Python API usando documentación. En caso de cualquier ambigüedad, no dude en contactarnos en nuestro foro de soporte gratuito.

Ver también