RaptorXML+XBRL Server como paquete Python
A partir de la versión 2024 de RaptorXML+XBRL Server, la API de Python está disponible como paquete wheel nativo de Python para Python 3.11.8. El paquete wheel de Python puede instalarse como módulo de extensión en la distribución de 3.11.8 que usted prefiere (p. ej. la distribución de python.org). Algunas distribuciones de Python 3 (p. ej. las de jupyter.org, anaconda.org y SciPy.org) incluyen una amplia gama de módulos de extensión para datos masivos, matemáticas, ciencia, ingeniería y gráficos. Estos módulos ya pueden estar a disposición de RaptorXML+XBRL Server sin necesidad de generarlos para RaptorXML+XBRL Server específicamente. Por lo demás, el paquete wheel funciona igual que la aplicación RaptorXMLXBRL-python.exe que viene con RaptorXML+XBRL Server.
| Nota: | el paquete wheel de Python es un módulo de extensión de Python 3.11.8 y debe coincidir con la versión 3.11.8 de Python. |
| Nota: | el paquete wheel de Python no incluye la API de Python v1. |
| Nota: | si actualiza su versión de RaptorXML+XBRL Server, asegúrese de que actualiza el paquete wheel de Python en su entorno Python. |
En este apartado encontrará toda la información necesaria para instalar el paquete RaptorXML+XBRL Server correctamente:
•Instalar un archivo wheel con pip
•Resolución de problemas en la instalación
•El archivo de configuración JSON
Para más información sobre cómo usar la API de Python de RaptorXML+XBRL Server consulte la referencia de la API de Python y los ejemplos. También encontrará ejemplos de scripts que usan la API de Python en https://github.com/altova.
Nombre del archivo wheel
El nombre de los archivos wheel siguen este patrón:
raptorxmlserver-{versión}(-{marca compilación})?-{marca python}-{marca abi}-{marca plataforma}.whl
Ejemplo:
raptorxmlserver-2.10.0-cp35-cp35m-win_amd64.whl
Ubicación del archivo wheel
Con su instalación de RaptorXML+XBRL Server se incluye un archivo wheel. Se encuentra en la carpeta bin de la aplicación:
Windows | Archivos de programa\Altova\RaptorXMLXBRLServer2025\bin |
Linux | /opt/Altova/RaptorXMLXBRLServer2025/bin |
Mac | /usr/local/Altova/RaptorXMLXBRLServer2025/bin |
Instalar un archivo wheel con pip
Utilice el comando pip para instalar el paquete RaptorXML+XBRL Server como módulo de Python:
pip install <archivo-wheel>.whl
python -m pip install <archivo-wheel>.whl
Si instaló Python 3.11.8 o superior desde python.org, entonces también tendrá instalado pip. Si no es así, primero deberá instalar pip. Visite https://docs.python.org/3/installing/ para obtener más información.
Resolución de problemas en la instalación
Si está usando una versión antigua del intérprete de Python, puede que necesite realizar algunas modificaciones durante la instalación para usar las bibliotecas vcruntime más recientes o las bibliotecas C++ estándar en Unix. Estas bibliotecas vienen incluidas en el paquete de instalación de RaptorXML+XBRL Server y se pueden usar como explicamos a continuación.
Windows
Si falta el archivo vcruntime140_1.dll, cópielo desde la carpeta Archivos de programa\Altova\RaptorXMLXBRLServer2025\bin a la carpeta de instalación de Python (la carpeta que contiene python.exe). (Lo importante es que el intérprete de Python debe saber dónde encontrar los archivos DLL o las bibliotecas compartidas.)
Linux
Si la biblioteca C++ de su sistema está obsoleta, el intérprete de Python no sabrá cómo encontrar la biblioteca C++ más recuente que usa el paquete de Python que viene con RaptorXML+XBRL Server. Para solucionar este problema, $LD_LIBRARY_PATH debe apuntar a la biblioteca nueva de la carpeta de RaptorXML+XBRL Server: $ export LD_LIBRARY_PATH=/opt/Altova/RaptorXMLXBRLServer2025/lib.
macOS
Si la biblioteca C++ de su sistema está obsoleta, el intérprete de Python no sabrá cómo encontrar la biblioteca C++ más recuente que usa el paquete de Python que viene con RaptorXML+XBRL Server. Para solucionar este problema, $DYLD_LIBRARY_PATH debe apuntar a la biblioteca nueva de la carpeta de RaptorXML+XBRL Server: $ export DYLD_LIBRARY_PATH=/usr/local/Altova/RaptorXMLXBRLServer2025/lib.
El archivo de catálogo raíz
El módulo RaptorXMLXBRL para Python debe ser capaz de encontrar RootCatalog.xml, el archivo de catálogo raíz que está en la carpeta de instalación de RaptorXML+XBRL Server. El módulo RaptorXMLXBRL necesita el catálogo para encontrar los diferentes recursos (como esquemas y especificaciones) a los que hace referencia el módulo para llevar a cabo diferentes funciones, como validaciones y transformaciones, por ejemplo. El módulo RaptorXMLXBRL encontrará RootCatalog.xml automáticamente si la ubicación del catálogo no cambió desde que se instaló RaptorXML+XBRL Server.
En caso de que se modificara el entorno de RaptorXML+XBRL Server o de que se moviera RootCatalog.xml a otra ubicación, podrá especificar la ubicación del catálogo mediante variables de entorno y desde el archivo de configuración JSON del módulo RaptorXMLXBRL. En la lista que aparece a continuación puede ver varios métodos diferentes. El módulo RaptorXMLXBRL determina la ubicación de RootCatalog.xml buscando estos recursos en el orden especificado en la tabla.
1 | Variable de entorno ALTOVA_RAPTORXML_PYTHON_CATALOGPATH | Crear con un valor que sea la ruta de acceso de RootCatalog.xml |
2 | Registro HKLM: SOFTWARE\Altova\RaptorXML+XBRLServer\Installation_v2025_x64\Setup\CatalogPath | La clave de registro la añade el programa de instalación de RaptorXML+XBRL Server. Su valor es la ruta de acceso de RootCatalog.xml. Solo para Windows |
3 | Ubicación: /opt/Altova/RaptorXMLXBRLServer2025/etc/RootCatalog.xml | Solo para Linux |
4 | Ubicación: /usr/local/Altova/RaptorXMLXBRLServer2025/etc/RootCatalog.xml | Solo para Mac |
5 | Variable de entorno ALTOVA_RAPTORXML_PYTHON_CONFIG | Crear con un valor que sea la ruta de acceso del archivo de configuración JSON. |
6 | Ubicación: .altova/raptorxml-python.config | El archivo de configuración JSON que está en el directorio de trabajo actual |
7 | Ubicación: ~/.config/altova/raptorxml-python.config | El archivo de configuración JSON que está en el directorio de inicio del usuario |
8 | Ubicación: /etc/altova/altova/raptorxml-python.config | El archivo de configuración JSON Solo para Linux y Mac |
El archivo de configuración JSON
Puede crear una archivo de configuración JSON para el módulo RaptorXMLXBRLServer. Este archivo se usará en las opciones 5, 6, 7 y 8 de la tabla anterior para buscar el archivo de catálogo raíz. El archivo de configuración JSON debe contener un mapa con una clave "CatalogPath" cuyo valor sea la ruta de acceso del archivo de catálogo raíz.
Fragmento de un archivo de configuración JSON
{
"CatalogPath": "/path/to/RootCatalog.xml"
}