Validieren Sie XBRL in Python

XBRL steht für XML Based Business Reporting Language. Es ist einfach ein Schema, das Unternehmen hilft, ihre Daten zu organisieren, damit sie Informationen zwischen verschiedenen Abteilungen innerhalb ihres Unternehmens austauschen können. XBRL- und Inline-XBRL-Dokumente (iXBRL) sind strukturierte elektronische Geschäftsberichte, um unterschiedliche Geschäftsanforderungen zu erfüllen. Es ist nicht nur eine andere Art langweiliger Geschäftsdokumente – XBRL-Dokumente enthalten bestimmte Strukturen, Formate und Merkmale, die zur Validierung der Finanzdokumente verwendet werden können. Wir können ein XBRL- oder iXBRL-Instanzdokument einfach programmgesteuert validieren. In diesem Artikel erfahren Sie, wie Sie ein XBRL-Dokument in Python validieren.

Folgende Themen sollen in diesem Artikel behandelt werden:

  1. Python XBRL Validator API zum Validieren von XBRL-Dokumenten
  2. XBRL-Datei validieren
  3. Inline-XBRL-Datei validieren

Python XBRL Validator API zum Validieren von XBRL-Dokumenten

Um eine XBRL-Datei oder ein Instanzdokument zu validieren, verwenden wir die API Aspose.Finance for Python. Es ermöglicht das Erstellen von XBRL-Instanzen, das Analysieren und Validieren der XBRL- oder iXBRL-Dateien.

Die API stellt die Klasse XbrlDocument bereit, die ein XBRL-Dokument darstellt, das eine oder mehrere XBRL-Instanzen enthält. Eine XBRL-Instanz ist ein XML-Fragment, wobei das Wurzelelement ein XBRL-Tag hat. Die Klasse XbrlInstance stellt verschiedene Methoden und Eigenschaften für die Arbeit mit XBRL-Instanzen bereit. Die Methode validate() dieser Klasse validiert die ausgewählte XBRL-Instanz. Wir haben die Klasse InlineXbrlDocument der API, die ein Inline-XBRL-Dokument darstellt. Darüber hinaus definiert die Aufzählung ValidationErrorCode der API alle Validierungsfehlercodes und die entsprechende Fehlermeldung.

Bitte laden Sie das Paket herunter oder installieren Sie die API von PyPI mit dem folgenden Pip-Befehl in der Konsole:

pip install aspose-finance

Validieren Sie das XBRL-Dokument in Python

Wir können ein XBRL-Instanzdokument einfach laden und validieren, indem wir die folgenden Schritte ausführen:

  1. Laden Sie zunächst eine XBRL-Datei mit der XbrlDocument-Klasse.
  2. Rufen Sie als Nächstes alle Instanzen mithilfe der xbrlinstances ab.
  3. Greifen Sie dann aus der Sammlung auf die gewünschte XBRL-Instanz zu.
  4. Rufen Sie danach die Methode validate() auf, um die XBRL-Instanz zu validieren.
  5. Zeigen Sie abschließend die Fehler an, falls vorhanden.

Das folgende Codebeispiel zeigt, wie eine XBRL-Instanz in Python validiert wird.

# Dieses Codebeispiel zeigt, wie ein XBRL-Instanzdokument validiert wird.
from aspose.finance.xbrl import XbrlDocument

# Der Pfad zum Eingabedokument
inputFile = "C:\Files\sample.xbrl"

# XBRL-Datei laden
document = XbrlDocument(inputFile)

# Holen Sie sich Instanzen
xbrlInstances = document.xbrl_instances

# Wählen Sie eine bestimmte Instanz aus
xbrlInstance = xbrlInstances[0]

# Bestätigen
xbrlInstance.validate()

# Validierungsfehler anzeigen, falls vorhanden
if xbrlInstance.validation_errors.length > 0:
    for validationError in xbrlInstance.validation_errors:
        print(validationError.message)

Validieren Sie das Inline-XBRL-Dokument in Python

Wir können ein iXBRL-Dokument auch validieren, indem wir die folgenden Schritte ausführen:

  1. Laden Sie zunächst eine iXBRL-Datei mit der InlineXbrlDocument-Klasse.
  2. Rufen Sie danach die Methode validate() auf, um die XBRL-Instanz zu validieren.
  3. Zeigen Sie abschließend die Fehler an, falls vorhanden.

Das folgende Codebeispiel zeigt, wie ein Inline-XBRL- oder iXBRL-Dokument in Python validiert wird.

# Dieses Codebeispiel zeigt, wie ein Inline-XBRL-Dokument validiert wird.
from aspose.finance.xbrl.inline import InlineXbrlDocument

# Der Pfad zum Eingabedokument
inputFile = "C:\Files\sample.html"

# XBRL-Datei laden
document = InlineXbrlDocument(inputFile)

# Bestätigen
document.validate();

# Validierungsfehler anzeigen, falls vorhanden
if document.validation_errors.length > 0:
    for validationError in document.validation_errors:
        print(validationError.message)

Holen Sie sich eine kostenlose Lizenz

Sie können eine kostenlose temporäre Lizenz erhalten, um die Bibliothek ohne Evaluierungseinschränkungen zu testen.

Fazit

In diesem Artikel haben wir gelernt, wie man ein XBRL-Dokument in Python validiert. Wir haben auch gesehen, wie ein Inline-XBRL-Dokument programmgesteuert validiert wird. Außerdem können Sie mehr über Aspose.Finance für die Python-API erfahren, indem Sie Dokumentation verwenden. Bei Unklarheiten können Sie sich gerne in unserem kostenlosen Support-Forum an uns wenden.

Siehe auch