Sprawdź poprawność XBRL w Python

XBRL oznacza XML oparty na języku raportowania biznesowego. Jest to po prostu schemat, który pomaga firmom organizować swoje dane, aby mogły udostępniać informacje między różnymi działami w firmie. Dokumenty XBRL i Inline XBRL (iXBRL) to ustrukturyzowane elektroniczne raporty biznesowe spełniające różne wymagania biznesowe. To nie jest kolejny typ nudnego dokumentu biznesowego — dokumenty XBRL mają określoną strukturę, format i cechy, które można wykorzystać do walidacji dokumentów finansowych. Możemy łatwo programowo zweryfikować dokument instancji XBRL lub iXBRL. W tym artykule dowiemy się, jak sprawdzić poprawność dokumentu XBRL w Python.

W tym artykule zostaną omówione następujące tematy:

  1. Python XBRL Validator API do walidacji dokumentu XBRL
  2. Zweryfikuj plik XBRL
  3. Weryfikacja pliku wbudowanego XBRL

Python XBRL Validator API do sprawdzania poprawności dokumentu XBRL

Aby zweryfikować plik XBRL lub dokument instancji, użyjemy API Aspose.Finance for Python. Umożliwia tworzenie instancji XBRL, parsowanie i sprawdzanie poprawności plików XBRL lub iXBRL.

Interfejs API udostępnia klasę XbrlDocument, która reprezentuje dokument XBRL zawierający co najmniej jedną instancję XBRL. Instancja XBRL to fragment XML, w którym element główny ma znacznik XBRL. Klasa XbrlInstance udostępnia różne metody i właściwości do pracy z instancjami XBRL. Metoda validate() tej klasy sprawdza poprawność wybranej instancji XBRL. Mamy klasę InlineXbrlDocument interfejsu API, która reprezentuje wbudowany dokument XBRL. Ponadto wyliczenie ValidationErrorCode API definiuje wszystkie kody błędów walidacji i odpowiedni komunikat o błędzie.

Proszę pobierz pakiet lub zainstaluj interfejs API z PyPI, używając następującego polecenia pip w konsoli:

pip install aspose-finance

Sprawdź poprawność dokumentu XBRL w Python

Możemy łatwo załadować i zweryfikować dokument instancji XBRL, wykonując czynności podane poniżej:

  1. Najpierw załaduj plik XBRL przy użyciu klasy XbrlDocument.
  2. Następnie pobierz wszystkie instancje za pomocą xbrlinstances.
  3. Następnie uzyskaj dostęp do żądanej instancji XBRL z kolekcji.
  4. Następnie wywołaj metodę validate() w celu sprawdzenia poprawności instancji XBRL.
  5. Na koniec pokaż ewentualne błędy.

Poniższy przykładowy kod pokazuje, jak sprawdzić poprawność wystąpienia XBRL w języku Python.

# Ten przykład kodu demonstruje, jak sprawdzić poprawność dokumentu instancji XBRL.
from aspose.finance.xbrl import XbrlDocument

# Ścieżka do dokumentu wejściowego
inputFile = "C:\Files\sample.xbrl"

# Załaduj plik XBRL
document = XbrlDocument(inputFile)

# Pobierz instancje
xbrlInstances = document.xbrl_instances

# Wybierz konkretną instancję
xbrlInstance = xbrlInstances[0]

# Uprawomocnić
xbrlInstance.validate()

# Pokaż błędy sprawdzania poprawności, jeśli występują
if xbrlInstance.validation_errors.length > 0:
   for validationError in xbrlInstance.validation_errors:
        print(validationError.message)

Sprawdź poprawność dokumentu Inline XBRL w Python

Możemy również zweryfikować dokument iXBRL, wykonując poniższe czynności:

  1. Najpierw załaduj plik iXBRL przy użyciu klasy InlineXbrlDocument.
  2. Następnie wywołaj metodę validate() w celu sprawdzenia poprawności instancji XBRL.
  3. Na koniec pokaż ewentualne błędy.

Poniższy przykładowy kod pokazuje, jak sprawdzić poprawność wbudowanego dokumentu XBRL lub iXBRL w języku Python.

# Ten przykład kodu demonstruje, jak sprawdzić poprawność dokumentu Inline XBRL.
from aspose.finance.xbrl.inline import InlineXbrlDocument

# Ścieżka do dokumentu wejściowego
inputFile = "C:\Files\sample.html"

# Załaduj plik XBRL
document = InlineXbrlDocument(inputFile)

# Uprawomocnić
document.validate();

# Pokaż błędy sprawdzania poprawności, jeśli występują
if document.validation_errors.length > 0:
   for validationError in document.validation_errors:
        print(validationError.message)

Uzyskaj bezpłatną licencję

Możesz uzyskać bezpłatną tymczasową licencję, aby wypróbować bibliotekę bez ograniczeń ewaluacyjnych.

Wniosek

W tym artykule dowiedzieliśmy się, jak sprawdzić poprawność dokumentu XBRL w Python. Widzieliśmy również, jak programowo sprawdzić poprawność wbudowanego dokumentu XBRL. Poza tym możesz dowiedzieć się więcej o Aspose.Finance for Python API korzystając z documentation. W przypadku jakichkolwiek niejasności prosimy o kontakt na naszym darmowym forum pomocy technicznej.

Zobacz też