RaptorXML Server como paquete Python

www.altova.com Imprimir este apartado Página anterior Subir un nivel Página siguiente

Inicio >  APIs de motor: Python y .NET > API de Python >

RaptorXML Server como paquete Python

A partir de la versión 2017 de RaptorXML Server, la API de Python está disponible como paquete wheel nativo de Python para Python 3.5. El paquete wheel de Python puede instalarse como módulo de extensión en la distribución de Python 3.5 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 Server sin necesidad de generarlos para RaptorXML Server específicamente. Por lo demás, el paquete wheel funciona igual que la aplicación RaptorXMLXBRL-python.exe que viene con RaptorXML Server.

 

Nota:el paquete wheel de Python es un módulo de extensión de Python 3.5 y debe coincidir con la versión 3.5 de Python.

 

Nota: el paquete wheel de Python no incluye la API de Python v1.

 

Note:si actualiza su versión de RaptorXML 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 Server correctamente:

 

Nombre del archivo wheel
Ubicación del archivo wheel
Instalar un archivo wheel con pip
El archivo de catálogo raíz
El archivo de configuración JSON

 

Para más información sobre cómo usar la API de Python de RaptorXML 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

 

Ejemplos:

raptorxmlserver-2.6.0-cp35-cp35m-win_amd64.whl

raptorxmlserver-2.6.0-cp35-cp35m-win_amd64.whl

 

Ubicación del archivo wheel

La instalación de RaptorXML Server viene con un archivo wheel, ubicado en la carpeta bin de la aplicación:

 

Windows

Archivos de programa\Altova\RaptorXMLServer2019\bin

Linux

/opt/Altova/RaptorXMLServer2019/bin

Mac

/usr/local/Altova/RaptorXMLServer2019/bin

 

Instalar un archivo wheel con pip

Utilice el comando pip para instalar el paquete RaptorXML Server como módulo de Python:

 

pip install <archivo-wheel>.whl

python -m pip install <archivo-wheel>.whl  

 

Si instaló Python 3.5 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.

 

El archivo de catálogo raíz

El módulo RaptorXML 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 Server. El módulo RaptorXML 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 RaptorXML encontrará RootCatalog.xml automáticamente si la ubicación del catálogo no cambió desde que se instaló RaptorXML Server.

 

En caso de que se modificara el entorno de RaptorXML 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 RaptorXML. En la lista que aparece a continuación puede ver varios métodos diferentes. El módulo RaptorXML 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\RaptorXMLServer\Installation_v2019_x64\Setup\CatalogPath

La clave de registro la añade el programa de instalación de RaptorXML Server. Su valor es la ruta de acceso de RootCatalog.xml. (Sólo para Windows.)

3

Ubicación: /opt/Altova/RaptorXMLServer2019/etc/RootCatalog.xml

Sólo para Linux.

4

Ubicación: /usr/local/Altova/RaptorXMLServer2019/etc/RootCatalog.xml

Sólo 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. (Sólo para Linux y Mac.)

 

El archivo de configuración JSON

Puede crear una archivo de configuración JSON para el módulo RaptorXMLServer. 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"

}

 


© 2019 Altova GmbH