Python API
L'API Python de RaptorXML+XBRL Server permet aux données contenues dans des documents XML, des documents de Schéma XML, des documents d'instance XBRL, et des documents de taxonomie XBRL d'être accédés et manipulés dans des scripts Python. Voici quelques exemples types d'une utilisation des API Python :
•mettre en place des règles de validation et de messages d'erreur personnalisés
•exporter du contenu depuis des documents XML et XBRL vers une base de données
•exporter du contenu depuis des documents XML et XBRL vers des formats de données personnalisés
•naviguer et interroger de manière interactive le modèle de données des documents XML et XBRL dans un shell Python ou un notebook Jupyter (http://jupyter.org/)
Les API Python
Les API Python (pour XML, XSD et XBRL) fournissent un accès à la méta-information, à l'information structurelle et aux données contenues dans des documents XML, XSD, et d'instance et de taxonomie XBRL. Ainsi, les scripts Python peuvent être créés permettant d'utiliser les API pour accéder et traiter l'information du document. Par exemple, un script Python peut être passé sur RaptorXML+XBRL Server qui écrit des données depuis un document XML ou un document d'instance XBRL pour une base de données ou sur un fichier CSV.
Des scripts d'exemple pour les API Python de Raptor sont disponibles sous : https://github.com/altova
Les API Python sont décrits dans leurs références API :
| Note : | Python API v1 de Raptor est obsolète. Veuillez utiliser Python API v2. |
Package RaptorXML+XBRL Server pour Python
Dans votre installation de RaptorXML+XBRL Server, vous trouverez aussi un package Python en format wheel. Vous pouvez utiliser la commande pip de Python pour installer ce package en tant que module de votre installation Python. Une fois que le module RaptorXMLXBRL a été installé, vous pouvez utiliser les fonctions du module dans votre code. De cette manière, les fonctions de RaptorXMLXBRL peuvent être utilisées aisément dans tout programme Python que vous écrivez, avec d'autres bibliothèques Python tierces comme des librairies de graphique.
Pour plus d'information concernant l'utilisation du package Python de RaptorXML+XBRL Server, voir la section RaptorXML+XBRL Server en tant que package Python.
| Note: | La roue Python est uniquement compatible avec la version Python 3.7. |
Scripts Python
Un script Python utilisé par l'utilisateur est soumis avec le paramètre --script des commandes suivantes :
Ces commandes invoquant des scripts Python peuvent être utilisées aussi bien sur l'Interface de ligne de commande (CLI) qu'avec l'interface HTTP. L'utilisation des scripts Python avec les API Python de RaptorXML+XBRL Server est décrite sous : https://github.com/altova.
Rendre les scripts Python sûrs
Lorsqu'un script Python est spécifié dans une commande via HTTP pour RaptorXML+XBRL Server, le script fonctionnera uniquement s'il est situé dans le répertoire de confiance. Le script est exécuté depuis le répertoire de confiance. La spécification d'un script Python provenant d'un autre répertoire quelconque résultera en une erreur. Le répertoire de confiance est spécifié dans le paramètre server.script-root-dir du fichier de configuration de serveur, et un répertoire de confiance doit être spécifié si vous souhaitez utiliser des scripts Python. Veuillez vous assurer que tous les scripts Python à utiliser soient sauvegardés dans ce répertoire.
Bien que toutes les sorties générées par le serveur pour les requêtes de tâche HTTP soient écrites dans le répertoire de sortie de tâche (qui est un sous-répertoire de output-root-directory), cette limitation ne s'applique pas aux scripts Python, qui peuvent écrire dans n'importe quel emplacement. L'administrateur de serveur doit revoir les scripts Python dans le répertoire de confiance en ce qui concerne des problèmes de vulnérabilité potentiels.