Versiones de la API de Python
RaptorXML+XBRL Server ofrece varias versiones de la API de Python. Todas las versiones antiguas de la API de Python son compatibles con la versión actual de RaptorXML+XBRL Server. La versión de la API de Python se selecciona con la marca de la línea de comandos --script-api-version=MAJOR_VERSION. El valor predeterminado del argumento MAJOR_VERSION siempre es la versión actual. Cada vez que se introduzcan mejoras o cambios incompatibles, estará disponible un MAJOR_VERSION nuevo para la API de Python de RaptorXML+XBRL Server. El usuario de la API no tiene que actualizar sus scripts cuando se publiquen versiones nuevas.
Sin embargo, recomendamos:
•Utilizar la marca --script-api-version=MAJOR_VERSION para invocar scripts de otras utilidades desde la línea de comandos de RaptorXML+XBRL Server (o desde la API web). Así se garantiza que los scripts sigan funcionando tras la instalación de actualizaciones de RaptorXML+XBRL Server (incluso si se publica una versión nueva de MAJOR_VERSION).
•Utilizar la versión más reciente de la API para proyectos nuevos, aunque las versiones nuevas de RaptorXML+XBRL Server sean compatibles con versiones antiguas de la API.
A continuación se enumeran las versiones de la API de Python que están disponibles actualmente. La documentación de estas API se puede consultar en el sitio web de Altova (ver enlaces más abajo).
Archivos de ejemplo
Puede encontrar ejemplos de scripts para las API de Python de RaptorXML en https://github.com/altova.
API de Python (versión 1)
Se introdujo con RaptorXML+XBRL Server v2014.
Marca de la línea de comandos: --script-api-version=1 |
Documentación: Referencia de la API de Python (versión 1) |
Se trata de la API de Python de RaptorXML+XBRL Server original. Ofrece funciones para acceder al modelo interno de RaptorXML+XBRL Server para:
•XML 1.0 y XML 1.1 (módulo API xml)
•XMLSchema 1.0 y XMLSchema 1.1 (módulo API xsd)
•XBRL 2.1 (módulo API xbrl)
La API se puede utilizar a través de varias funciones de devolución de llamada que se implementan en un archivo de script Python.
•on_xsi_valid
•on_xsd_valid
•on_dts_valid
•on_xbrl_valid
El script se especifica con la opción --script en la línea de comandos. Las funciones de devolución de llamada se invocan solamente si la validación finaliza correctamente. Para obtener más información sobre las funciones de devolución de llamada y la API, consulte la Referencia de la API de Python (versión 1) en el sitio web de Altova.
| Nota: | La versión 1 de la API de Python de Raptor está obsoleta. Use en su lugar la versión 2 de la API de Python. |
API de Python (versión 2)
Se introdujo con RaptorXML+XBRL Server v2015r3. La versión más reciente de la API es la versión 2.8.6.
Marca de la línea de comandos | Edición |
--script-api-version=2 | v 2015r3 |
--script-api-version=2.1 | v 2015r4 |
--script-api-version=2.2 | v 2016 |
--script-api-version=2.3 | v 2016r2 |
--script-api-version=2.4 | v 2017 |
--script-api-version=2.4.1 | v 2018 |
--script-api-version=2.5.0 | v 2018r2 |
--script-api-version=2.6.0 | v 2019 |
--script-api-version=2.7.0 | v2019r3 |
--script-api-version=2.8.0 | v2020 |
--script-api-version=2.8.1 | v2020r2 |
--script-api-version=2.8.2 | v2021 |
--script-api-version=2.8.3 | v2021r2 |
--script-api-version=2.8.4 | v2022r2 |
--script-api-version=2.8.5 | v2023r2sp1 |
--script-api-version=2.8.6 | v2024 |
Documentación: Referencia de la API de Python (versión 2) | |
En esta versión las funciones de devolución de llamada no solamente se invocan cuando la validación finaliza correctamente, sino también cuando se produce un error durante la validación. Por ello se ha modificado el nombre de las funciones de devolución de llamada:
•on_xsi_finished
•on_xsd_finished
•on_dts_finished
•on_xbrl_finished
Además, RaptorXML+XBRL Server ofrece varias opciones --script. Las devoluciones de llamada implementadas en los scripts Python se ejecutan en el orden indicado en la línea de comandos.