API de Python
La API de Python de RaptorXML permite acceder y gestionar datos de documentos XML, XSD, instancias XBRL y taxonomías XBRL mediante scripts de Python. Estos son algunos de los usos típicos de la API de Python:
•implementar reglas de validación y mensajes de error personalizados
•exportar contenido de documentos XML y XBRL a una BD
•exportar contenido de documentos XML y XBRL a formatos de datos personalizados
•explorar y recuperar datos de forma interactiva del modelo de datos de documentos XML y XBRL desde una shell de Python o un notebook de Jupyter (https://jupyter.org/)
Interfaces API de Python
Las API de Python (para XML, XSD y XBRL) ofrecen acceso a metadatos, información estructural y datos incluidos en documentos XML, XSD, instancias XBRL y taxonomías XBRL. Como resultado, puede crear scripts Python que utilicen las API para acceder y procesar los datos de estos documentos. Por ejemplo, se puede enviar un script Python a RaptorXML+XBRL Server que escriba datos desde un documento XML o de instancia XBRL en una base de datos o en un archivo CSV.
Puede encontrar ejemplos de scripts para las API de Python de RaptorXML en https://github.com/altova
También puede consultar la referencia de las API de Python en el sitio web de Altova:
•Referencia de la API de Python (versión 1)
•Referencia de la API de Python (versión 2)
| 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. |
Paquete de RaptorXML+XBRL Server para Python
En la instalación de RaptorXML+XBRL Server también encontrará un paquete Python en formato wheel. Puede usar el comando pip de Python para instalar este paquete como módulo de la instalación Python. Tras instalar el módulo RaptorXMLXBRL, podrá usar sus funciones dentro del código. De este modo, las características y funciones de RaptorXMLXBRL se pueden usar fácilmente en cualquier programa Python junto con bibliotecas Python de otros autores, como bibliotecas gráficas, por ejemplo.
Para más información sobre cómo utilizar el paquete de RaptorXML+XBRL Server para Python consulte la sección RaptorXML+XBRL Server como paquete Python.
| Nota: | La versión 2024 y versiones posteriores del archivo wheel de Python son compatibles con la versión 3.11.5 y versiones posteriores de Python. |
Scripts Python
Los scripts Python creados por el usuario se pueden enviar a RaptorXML con el parámetro --script de estos comandos:
Estos comandos que invocan a scripts Python se pueden usar tanto en la interfaz de la línea de comandos (ILC) como en la interfaz HTTP. El uso de scripts Python dentro de las API de Python de RaptorXML+XBRL Server se documenta en https://github.com/altova.
Trabajar con scripts Python seguros
Cuando se especifica un script Python por HTTP para RaptorXML+XBRL Server, el script solo funciona si está ubicado en el directorio de confianza. El script se ejecuta desde el directorio de confianza. Si especifica un script de cualquier otro directorio, se produce un error. El directorio de confianza se define en la opción server.script-root-dir del archivo de configuración del servidor y es obligatorio especificar un directorio de confianza si quiere usar scripts Python. Por tanto, asegúrese de guardar en este directorio todos los scripts Python que desea usar.
Aunque todos los resultados generados por el servidor para solicitudes de trabajo HTTP se escriben en el directorio de salida de trabajos (que es un subdirectorio de output-root-directory), esta limitación no afecta a los scripts Python, que pueden escribir en cualquier ubicación. El administrador del servidor debería revisar los scripts Python del directorio de confianza para evitar problemas de seguridad.