Перевірте XBRL у Python

XBRL означає XML Business Reporting Language. Це просто схема, яка допомагає компаніям упорядковувати свої дані, щоб вони могли обмінюватися інформацією між різними відділами компанії. Документи XBRL і Inline XBRL (iXBRL) — це структуровані електронні бізнес-звіти, які відповідають різним вимогам бізнесу. Це не просто ще один тип нудного ділового документа — документи XBRL містять певну структуру, формат і характеристики, які можна використовувати для перевірки фінансових документів. Ми можемо легко перевірити екземпляр документа XBRL або iXBRL програмним шляхом. У цій статті ми дізнаємося, як перевірити документ XBRL у Python.

У цій статті будуть розглянуті такі теми:

  1. API перевірки Python XBRL для перевірки документа XBRL
  2. Перевірити файл XBRL
  3. Перевірити вбудований файл XBRL

Python XBRL Validator API для перевірки документа XBRL

Щоб перевірити файл XBRL або екземпляр документа, ми будемо використовувати Aspose.Finance for Python API. Це дозволяє створювати екземпляри XBRL, аналізувати та перевіряти файли XBRL або iXBRL.

API надає клас XbrlDocument, який представляє документ XBRL, що містить один або більше екземплярів XBRL. Екземпляр XBRL — це фрагмент XML, кореневий елемент якого має тег XBRL. Клас XbrlInstance надає різні методи та властивості для роботи з екземплярами XBRL. Метод validate() цього класу перевіряє вибраний екземпляр XBRL. У нас є клас InlineXbrlDocument API, який представляє вбудований документ XBRL. Крім того, перелік ValidationErrorCode API визначає всі коди помилок перевірки та відповідне повідомлення про помилку.

Завантажте пакет або встановіть API з PyPI за допомогою такої команди pip у консолі:

pip install aspose-finance

Перевірте документ XBRL у Python

Ми можемо легко завантажити та перевірити екземпляр документа XBRL, виконавши наведені нижче кроки:

  1. По-перше, завантажте файл XBRL за допомогою класу XbrlDocument.
  2. Потім отримайте всі екземпляри за допомогою xbrlinstances.
  3. Потім перейдіть до потрібного екземпляра XBRL із колекції.
  4. Після цього викличте метод validate(), щоб перевірити екземпляр XBRL.
  5. Нарешті, покажіть помилки, якщо такі є.

У наступному прикладі коду показано, як перевірити екземпляр XBRL у Python.

# Цей приклад коду демонструє, як перевірити документ екземпляра XBRL.
from aspose.finance.xbrl import XbrlDocument

# Шлях до вхідного документа
inputFile = "C:\Files\sample.xbrl"

# Завантажте файл XBRL
document = XbrlDocument(inputFile)

# Отримати екземпляри
xbrlInstances = document.xbrl_instances

# Виберіть конкретний екземпляр
xbrlInstance = xbrlInstances[0]

# Перевірити
xbrlInstance.validate()

# Показати помилки перевірки, якщо такі є
if xbrlInstance.validation_errors.length > 0:
   for validationError in xbrlInstance.validation_errors:
        print(validationError.message)

Перевірте вбудований документ XBRL у Python

Ми також можемо перевірити документ iXBRL, виконавши наведені нижче дії.

  1. По-перше, завантажте файл iXBRL за допомогою класу InlineXbrlDocument.
  2. Після цього викличте метод validate(), щоб перевірити примірник XBRL.
  3. Нарешті, покажіть помилки, якщо такі є.

У наведеному нижче прикладі коду показано, як перевірити вбудований документ XBRL або iXBRL у Python.

# Цей приклад коду демонструє, як перевірити документ Inline XBRL.
from aspose.finance.xbrl.inline import InlineXbrlDocument

# Шлях до вхідного документа
inputFile = "C:\Files\sample.html"

# Завантажте файл XBRL
document = InlineXbrlDocument(inputFile)

# Перевірити
document.validate();

# Показати помилки перевірки, якщо такі є
if document.validation_errors.length > 0:
   for validationError in document.validation_errors:
        print(validationError.message)

Отримайте безкоштовну ліцензію

Ви можете отримати безкоштовну тимчасову ліцензію, щоб спробувати бібліотеку без оціночних обмежень.

Висновок

У цій статті ми дізналися, як перевірити документ XBRL у Python. Ми також бачили, як програмно перевірити вбудований документ XBRL. Крім того, ви можете дізнатися більше про API Aspose.Finance for Python за допомогою документації. У разі будь-яких неясностей зв’яжіться з нами на нашому безкоштовному форумі підтримки.

Дивись також