Versions d'API Python

www.altova.com Imprimer cette rubrique Page précédente Un niveau supérieur Page suivante

Accueil >  API de moteur : Python et .NET > Python API >

Versions d'API Python

RaptorXML Server prend en charge plusieurs versions d'API Python. Toute version d'API Python précédente est aussi prise en charge par la version actuelle de RaptorXML Server. La version d'API Python est sélectionnée par le flag de ligne de commande --script-api-version=MAJOR_VERSION. Le défaut de l'argument MAJOR_VERSION est toujours la version actuelle. Un nouveau API Python MAJOR_VERSION de RaptorXML Server est introduit lorsque des changements incompatibles ou des améliorations importantes sont introduites. Les utilisateurs de l'API ne doivent pas mettre à niveau leurs scripts existants lorsqu'une nouvelle version majeure est publiée.

 

Il est recommandé de :

 

utiliser le flag --script-api-version=MAJOR_VERSION pour invoquer des scripts utilitaires depuis la ligne de commande RaptorXML Server (ou l'API Web). Cela vous garantit que les scripts fonctionnent toujours comme prévu après les mises à jour de RaptorXML Server, même si une nouvelle MAJOR_VERSION d'API a été publiée.
utiliser la dernière version de l'API pour des nouveaux projets, même si des versions précédentes seront prises en charge par des publications de RaptorXML Server dans le futur.

 

Les versions d'API Python listées ci-dessous sont actuellement disponibles. La documentation des différents API est disponible en ligne dans les emplacements indiqués ci-dessous.

 

Fichiers d'exemple

Pour consulter des exemples de scripts qui utilisent des API Python de Raptor, se rendre sous https://github.com/altova.

 

API Python version 1

Introduit avec la version v2014 de RaptorXML Server

 

Flag de ligne de commande :

--script-api-version=1

Documentation :

Python API Version 1 Reference

 

 

Voici l'API Python de RaptorXML Server original. Il couvre la prise en charge pour accéder au modèle interne de RaptorXML Server pour :

 

XML 1.0 et XML 1.1 (module API xml)
Schéma XML 1.0 et Schéma XML 1.1 (module API xsd)
XBRL 2.1 (module API xbrl)

 

L'API peut être utilisé par le biais de fonctions de callback qui sont mises en place dans un fichier de script Python.

 

on_xsi_valid
on_xsd_valid
on_dts_valid
on_xbrl_valid

 

Un script est spécifié avec l'option --script sur la ligne de commande. Les fonctions de callback sont invoquées uniquement si la validation réussit. Les détails concernant les fonctions de rappel et l'API sont décrits dans la référence "Python API version 1" de RaptorXML Server.

 

Note :Python API v1 de Raptor est obsolète. Veuillez utiliser Python API v2.

 

API Python version 2

Introduit avec la version v2015r3 de RaptorXML Server. La dernière version API est 2.7.0.

 

Flag de ligne de commande :

--script-api-version=2
--script-api-version=2.1
--script-api-version=2.2
--script-api-version=2.3

--script-api-version=2.4
--script-api-version=2.4.1

--script-api-version=2.5.0

--script-api-version=2.6.0

--script-api-version=2.7.0

v 2015r3

v 2015r4

v 2016

v 2016r2

v 2017
v 2018

v 2018r2

v 2019

v 2019r3

Documentation :

Python API Version 2 Reference

 

 

Cette version API introduit plus de 300 nouvelles classes et réorganise les modules depuis l'API Python version 1 de RaptorXML Server de manière à ce que des informations utilisées fréquemment (par exemple des données PSVI) peuvent être accédées plus simplement et des API liés sont regroupés logiquement (par exemple, xbrl.taxonomy, xbrl.formula, xbrl.table). Dans cette version, les fonctions de callback sont invoquées non seulement si la validation réussit, mais aussi si la validation échoue. Pour illustrer ce comportement, le nom des fonctions de callback a été changé en :

 

on_xsi_finished
on_xsd_finished
on_dts_finished
on_xbrl_finished

 

Pour activer la modularisation, RaptorXML Server prend maintenant en charge plusieurs options --script. Les callbacks implémentés dans ces fichiers script Python sont exécutés dans l'ordre spécifié dans la ligne de commande.

 


© 2019 Altova GmbH