Проверка XBRL в Python

XBRL означает язык бизнес-отчетности на основе XML. Это просто схема, которая помогает компаниям организовать свои данные, чтобы они могли обмениваться информацией между различными отделами своей компании. Документы XBRL и Inline XBRL (iXBRL) представляют собой структурированные электронные бизнес-отчеты, отвечающие различным бизнес-требованиям. Это не просто еще один тип скучного делового документа — документы XBRL содержат определенную структуру, формат и характеристики, которые можно использовать для проверки финансовых документов. Мы можем легко проверить экземпляр документа XBRL или iXBRL программно. В этой статье мы узнаем, как проверить документ XBRL в Python.

В этой статье должны быть раскрыты следующие темы:

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

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

Для проверки файла XBRL или экземпляра документа мы будем использовать API Aspose.Finance for Python. Он позволяет создавать экземпляры 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. Кроме того, вы можете узнать больше об Aspose.Finance for Python API, используя документацию. В случае возникновения каких-либо неясностей, пожалуйста, свяжитесь с нами на нашем бесплатном форуме поддержки.

Смотрите также