RaptorXML Server als Python-Paket
Ab RaptorXML Server 2024 steht die Python API als natives Python Wheel-Paket für Python 3.11.5 zur Verfügung. Das Python Wheel-Paket kann als Erweiterungsmodul in der Python 3.11.5 Distribution Ihrer Wahl (z.B. von python.org) installiert werden. Einige Python 3 Distributions (z.B. von jupyter.org, anaconda.org und SciPy.org) enthalten eine breite Palette an Erweiterungsmodulen für große Datenmengen, mathematische, wissenschaftliche, technische und grafische Anwendungen. Diese Module stehen RaptorXML Server nun zur Verfügung, ohne dass diese speziell für RaptorXML Server erstellt werden müssen. Das Wheel-Paket funktioniert auf dieselbe Art wie die mit RaptorXML Server inkludierte RaptorXMLXBRL-python.exe Applikation.
| Anmerkung: | Das Python Wheel-Paket ist ein natives Python 3.11.5-Erweiterungsmodul und mit der Python-Version 3.11.5 kompatibel. |
| Anmerkung: | Das Python Wheel-Paket enthält die Python API v1 nicht. |
| Anmerkung: | Stellen Sie bei einer Aktualisierung von RaptorXML Server sicher, dass Sie auch das Python Wheel-Paket in Ihrer Python-Umgebung aktualisieren. |
In den nachstehenden Abschnitten finden Sie Informationen zur Installation des RaptorXML Server-Pakets:
•Installation einer Wheel-Datei mit pip
•Behebung von Fehlern bei der Installation
Informationen zur Verwendung der Python API von RaptorXML Server finden Sie in der Python API-Referenz sowie den Beispielen. Beispiel-Skripts zur Verwendung der Python API von Raptor finden Sie auch unter https://github.com/altova.
Name der Wheel-Datei
Wheel-Dateien werden nach dem folgenden Muster benannt:
raptorxmlserver-{version}(-{build tag})?-{python tag}-{abi tag}-{platform tag}.whl
Beispiel:
raptorxmlserver-2.8.1-cp35-cp35m-win_amd64.whl
Pfad der Wheel-Datei
Im Installationspaket von RaptorXML Server ist eine Wheel-Datei enthalten. Sie befindet sich im bin-Ordner Ihrer Applikation:
Windows | Programme\Altova\RaptorXMLServer2024\bin |
Linux | /opt/Altova/RaptorXMLServer2024/bin |
Mac | /usr/local/Altova/RaptorXMLServer2024/bin |
Installation einer Wheel-Datei mit pip
Um das RaptorXML Server-Paket als Python-Modul zu installieren, verwenden Sie den pip-Befehl:
pip install <wheel-file>.whl
python -m pip install <wheel-file>.whl
Wenn Sie Python 3.11.5 oder höher von python.org installiert haben, so ist pip bereits auf Ihrem Rechner installiert. Andernfalls müssen Sie zuerst pip installieren. Nähere Informationen dazu finden Sie unter https://docs.python.org/3/installing/.
Behebung von Fehlern bei der Installation
Falls Sie ältere Versionen des Python Interpreters verwenden, müssen Sie Ihre Installation eventuell anpassen, damit unter Windows die neuesten vcruntime-Bibliotheken oder unter Unix die C++-Standardbibliotheken verwendet werden. Diese Bibliotheken werden mit RaptorXML Server bereitgestellt und können wie unten beschrieben verwendet werden.
Windows
Falls die vcruntime140_1.dll fehlt, kopieren Sie sie aus dem Ordner Programme\Altova\RaptorXMLServer2024\bin in den Python-Installationsordner (den Ordner, der die python.exe-Datei enthält). (D.h. der Python Interpreter muss wissen, wo sich die DLLs oder die gemeinsam verwendeten Bibliotheken befinden).
Linux
Wenn die C++-Bibliothek Ihres Systems veraltet ist, muss Ihr Python Interpreter wissen, wo er die neuere, von dem mit RaptorXML Server bereitgestellten RaptorXML Server-Python-Paket verwendete C++-Bibliothek findet. Verwenden Sie dazu \$LD_LIBRARY_PATH, um auf die neuere Bibliothek im RaptorXML Server-Ordner zu verweisen: \$ export LD_LIBRARY_PATH=/opt/Altova/RaptorXMLServer2024/lib.
macOS
Wenn die C++-Bibliothek Ihres Systems veraltet ist, muss Ihr Python Interpreter wissen, wo er die neuere, von dem mit RaptorXML Server bereitgestellten RaptorXML Server-Python-Paket verwendete C++-Bibliothek findet. Verwenden Sie dazu \$DYLD_LIBRARY_PATH, um auf die neuere Bibliothek im RaptorXML Server-Ordner zu verweisen: \$ export DYLD_LIBRARY_PATH=/usr/local/Altova/RaptorXMLServer2024/lib.
Die Root-Katalogdatei
Das RaptorXML-Modul Für Python muss in der Lage sein, RootCatalog.xml, die in Ihrem RaptorXML Server-Installationsordner gespeicherte Root-Katalogdatei, zu finden, damit das RaptorXML-Modul die verschiedenen Ressourcen wie Schemas und andere Spezifikationen, die das Modul zur Ausführung von Funktionen wie Validierung und Transformation referenziert, anhand des Katalogs findet. Wenn der Pfad der Katalogdatei nach der Installation von RaptorXML Server nicht geändert wurde, findet das RaptorXML-Modul die Datei RootCatalog.xml automatisch.
Wenn Sie Ihre RaptorXML Server-Umgebung verschieben oder ändern oder wenn Sie RootCatalog.xml aus dem ursprünglichen Installationsordner verschieben, können Sie den Pfad zur Katalogdatei mit Hilfe von Umgebungsvariablen und der JSON-Konfigurationsdatei des RaptorXML-Moduls definieren. Die verschiedenen Methoden, wie Sie dies tun können, sehen Sie in der Liste unten. Mit dem RaptorXML-Modul wird der Pfad zur RootCatalog.xml durch Überprüfung der folgenden Ressourcen in der angegebenen Reihenfolge ermittelt.
1 | Umgebungsvariable ALTOVA_RAPTORXML_PYTHON_CATALOGPATH | Wird mit einem Wert erstellt, der der Pfad zu RootCatalog.xml ist |
2 | HKLM Registry: SOFTWARE\Altova\RaptorXMLServer\Installation_v2024_x64\Setup\CatalogPath | Der Registrierungsschlüssel wird vom RaptorXML Server Installer hinzugefügt. Der Wert ist der Pfad zu RootCatalog.xml. Nur Windows |
3 | Pfad: /opt/Altova/RaptorXMLServer2024/etc/RootCatalog.xml | Nur Linux |
4 | Pfad: /usr/local/Altova/RaptorXMLServer2024/etc/RootCatalog.xml | Nur Mac |
5 | Umgebungsvariable ALTOVA_RAPTORXML_PYTHON_CONFIG | Wird mit einem Wert erstellt, der der Pfad zur JSON-Konfigurationsdatei ist. |
6 | Pfad: .altova/raptorxml-python.config | Die JSON-Konfigurationsdatei im aktuellen Arbeitsverzeichnis |
7 | Pfad: ~/.config/altova/raptorxml-python.config | Die JSON-Konfigurationsdatei im Startverzeichnis des Benutzers |
8 | Pfad: /etc/altova/altova/raptorxml-python.config | Die JSON-Konfigurationsdatei. Nur Linux und Mac |
Die JSON-Konfigurationsdatei
Sie können eine JSON-Konfigurationsdatei für das RaptorXMLServer-Modul erstellen. Diese Datei wird von den Optionen 5 bis 8 in der obigen Tabelle verwendet, um die Root-Katalogdatei zu finden. Die JSON-Konfigurationsdatei muss eine Zuordnung mit dem Schlüssel "CatalogPath" enthalten, der einen Wert hat, der dem Pfad zur Root-Katalogdatei entspricht.
Codefragment der JSON-Konfigurationsdatei
{
"CatalogPath": "/path/to/RootCatalog.xml"
}