Python API-Versionen
RaptorXML Server unterstützt mehrere Python API-Versionen. Alle früheren Python API-Versionen werden auch von der aktuellen Version von RaptorXML Server unterstützt. Die Python API-Version wird vom Befehlszeilen-Flag --script-api-version=MAJOR_VERSION ausgewählt. Die Standardeinstellung des Arguments MAJOR_VERSION ist immer die aktuelle Version. Wenn nicht kompatible Änderungen oder größere Verbesserungen erfolgt sind, wird eine neue RaptorXML Server Python API MAJOR_VERSION verwendet. Benutzer, die die API verwenden, müssen Ihre vorhandenen Skripts nicht aktualisieren, wenn eine neue Hauptversion herauskommt.
Es wird empfohlen,
•dass Sie das Flag --script-api-version=MAJOR_VERSION verwenden, um Utility Skripts aus der RaptorXML Server Befehlszeile (oder Web API) aufzurufen. Damit stellen Sie sicher, dass Ihre Skripts nach RaptorXML Server Aktualisierungen weiterhin funktionieren, selbst wenn eine neue API MAJOR_VERSION herausgekommen ist.
•dass Sie für neue Projekte die neueste API-Version verwenden, auch wenn frühere Versionen in zukünftigen RaptorXML Server Versionen weiterhin unterstützt werden.
Die unten aufgelisteten Python API-Versionen stehen derzeit zur Verfügung. Sie finden die Dokumentation zu den verschiedenen APIs online unter den weiter unten angegebenen Adressen.
Beispieldateien
Beispiele für Skripts, in denen die Python API von Raptor verwendet wird, finden Sie unter https://github.com/altova.
Python API Version 1
Wird ab RaptorXML Server v2014 verwendet.
Befehlszeilen-Flag: --script-api-version=1 |
Dokumentation: Python API Version 1 Reference |
Dies ist die Original-RaptorXML Server-Python API. Sie bietet Unterstützung zum Aufrufen des internen Modells von RaptorXML Server für:
•XML 1.0 und XML 1.1 (API-Modul xml)
•XMLSchema 1.0 und XMLSchema 1.1 (API-Modul xsd)
•XBRL 2.1 (API-Modul xbrl)
Die API kann über in einer Python-Skript-Datei implementierte Callback-Funktionen verwendet werden.
•on_xsi_valid
•on_xsd_valid
•on_dts_valid
•on_xbrl_valid
Mit der Option --script wird in der Befehlszeile ein Skript definiert. Die Callback-Funktionen werden nur aufgerufen, wenn die Validierung erfolgreich ist. Nähere Informationen zu Callback-Funktionen und der API finden Sie in der Referenz zur RaptorXML Server Python API Version 1.
| Anmerkung: | Die Python API v1 von Raptor ist veraltet. Verwenden Sie stattdessen bitte Python API v2. |
Python API Version 2
Wird ab RaptorXML Server v2015r3 verwendet. Die neueste API-Version ist 2.8.6.
Befehlszeilen-Flag | Release |
--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 |
Dokumentation: Python API Version 2 Reference | |
Diese API-Version enthält über 300 neue Klassen. Die Module aus der RaptorXML Server Python API Version 1 sind so gegliedert, dass häufig verwendete Informationen (z.B. PSVI-Daten) einfacher aufgerufen und miteinander in Zusammenhang stehende APIs logisch zusammen gruppiert werden (z.B. xbrl.taxonomy, xbrl.formula, xbrl.table). In dieser Version werden die Callback-Funktionen nicht nur bei erfolgreicher Validierung aufgerufen, sondern auch, wenn die Validierung fehlschlägt. Dies sehen Sie daran, dass der Name der Callback-Funktion folgendermaßen geändert wird:
•on_xsi_finished
•on_xsd_finished
•on_dts_finished
•on_xbrl_finished
Um die Verwendung von Modulen zu ermöglichen, unterstützt RaptorXML Server nun mehrere --script Optionen. Die in diesen Python Skript-Dateien implementierten Callbacks werden in der in der Befehlszeile angegebenen Reihenfolge ausgeführt.