Valider XBRL en Python

XBRL signifie XML Based Business Reporting Language. Il s’agit simplement d’un schéma qui aide les entreprises à organiser leurs données afin qu’elles puissent partager des informations entre différents services au sein de leur entreprise. Les documents XBRL et Inline XBRL (iXBRL) sont des rapports commerciaux électroniques structurés pour répondre à différentes exigences commerciales. Ce n’est pas simplement un autre type de document commercial ennuyeux - les documents XBRL contiennent une certaine structure, un format et des caractéristiques qui peuvent être utilisés pour valider les documents financiers. Nous pouvons facilement valider un document d’instance XBRL ou iXBRL par programmation. Dans cet article, nous allons apprendre à valider un document XBRL en Python.

Les sujets suivants seront traités dans cet article :

  1. API Python XBRL Validator pour valider le document XBRL
  2. Valider le fichier XBRL
  3. Valider le fichier XBRL en ligne

API Python XBRL Validator pour valider le document XBRL

Pour valider un fichier XBRL ou un document d’instance, nous utiliserons l’API Aspose.Finance for Python. Il permet de créer des instances XBRL, d’analyser et de valider les fichiers XBRL ou iXBRL.

L’API fournit la classe XbrlDocument qui représente un document XBRL contenant une ou plusieurs instances XBRL. Une instance XBRL est un fragment XML, l’élément racine ayant une balise XBRL. La classe XbrlInstance fournit diverses méthodes et propriétés pour travailler avec les instances XBRL. La méthode validate() de cette classe valide l’instance XBRL sélectionnée. Nous avons la classe InlineXbrlDocument de l’API qui représente un document XBRL en ligne. De plus, l’énumération ValidationErrorCode de l’API définit tous les codes d’erreur de validation et le message d’erreur correspondant.

Veuillez soit télécharger le package ou installer l’API à partir de PyPI en utilisant la commande pip suivante dans la console :

pip install aspose-finance

Valider un document XBRL en Python

Nous pouvons facilement charger et valider un document d’instance XBRL en suivant les étapes ci-dessous :

  1. Tout d’abord, chargez un fichier XBRL à l’aide de la classe XbrlDocument.
  2. Ensuite, récupérez toutes les instances à l’aide de xbrlinstances.
  3. Ensuite, accédez à l’instance XBRL souhaitée à partir de la collection.
  4. Après cela, appelez la méthode validate() pour valider l’instance XBRL.
  5. Enfin, affichez les erreurs éventuelles.

L’exemple de code suivant montre comment valider une instance XBRL dans Python.

# Cet exemple de code montre comment valider un document d'instance XBRL.
from aspose.finance.xbrl import XbrlDocument

# Le chemin d'accès au document d'entrée
inputFile = "C:\Files\sample.xbrl"

# Charger le fichier XBRL
document = XbrlDocument(inputFile)

# Obtenir des instances
xbrlInstances = document.xbrl_instances

# Sélectionnez une instance spécifique
xbrlInstance = xbrlInstances[0]

# Valider
xbrlInstance.validate()

# Afficher les erreurs de validation le cas échéant
if xbrlInstance.validation_errors.length > 0:
    for validationError in xbrlInstance.validation_errors:
        print(validationError.message)

Valider un document XBRL en ligne en Python

Nous pouvons également valider un document iXBRL en suivant les étapes ci-dessous :

  1. Tout d’abord, chargez un fichier iXBRL à l’aide de la classe InlineXbrlDocument.
  2. Après cela, appelez la méthode validate() pour valider l’instance XBRL.
  3. Enfin, affichez les erreurs éventuelles.

L’exemple de code suivant montre comment valider un document XBRL ou iXBRL en ligne dans Python.

# Cet exemple de code montre comment valider un document Inline XBRL.
from aspose.finance.xbrl.inline import InlineXbrlDocument

# Le chemin d'accès au document d'entrée
inputFile = "C:\Files\sample.html"

# Charger le fichier XBRL
document = InlineXbrlDocument(inputFile)

# Valider
document.validate();

# Afficher les erreurs de validation le cas échéant
if document.validation_errors.length > 0:
    for validationError in document.validation_errors:
        print(validationError.message)

Obtenez une licence gratuite

Vous pouvez obtenir une licence temporaire gratuite pour essayer la bibliothèque sans limitation d’évaluation.

Conclusion

Dans cet article, nous avons appris à valider un document XBRL en Python. Nous avons également vu comment valider un document XBRL en ligne par programmation. En outre, vous pouvez en savoir plus sur l’API Aspose.Finance pour Python en utilisant documentation. En cas d’ambiguïté, n’hésitez pas à nous contacter sur notre forum d’assistance gratuit.

Voir également