Initialisation de l'image Docker InterSystems IRIS avec Python

Lorsque nous démarrons le développement avec IRIS, nous disposons d'un kit de distribution ou, dans le cas de Docker, nous extrayons l'image Docker, puis nous devons souvent l'initialiser et configurer l'environnement de développement. Nous devrons peut-être créer des bases de données, des espaces de noms, activer/désactiver certains services, créer des ressources. Nous devons souvent importer du code et des données dans l'instance IRIS et exécuter du code personnalisé pour lancer la solution.

Il existe de nombreux modèles sur Open Exchange dans lesquels nous suggérons comment initialiser REST, l'interopérabilité, l'analytics, le développement Fullstack et bien d'autres modèles utilisant ObjectScript. Mais qu'en est-il si nous souhaitons utiliser uniquement Python pour configurer l'environnement de développement d'un projet Embedded Python avec IRIS ?

De fait, la récente sortie de Embedded Python template est devenu le passe-partout du pur Python qui pourrait être un point de départ pour les développeurs qui créent des projets Python sans avoir besoin d'utiliser et d'apprendre ObjectScript. Cet article explique comment ce modèle pourrait être utilisé pour initialiser IRIS. C'est parti!

Ok!

Création d'une base de données et d'un espace de nom

Nous devons souvent créer une base de données et un espace de noms. Cela pourrait être fait avec la fonctionnalité de fusion cpf d'IRIS, et voici le fichier de fusion qui fait la chose :

[Actions]

CreateResource:Name=%DB_IRISAPP_DATA,Description="IRISAPP_DATA database"

CreateDatabase:Name=IRISAPP_DATA,Directory=/usr/irissys/mgr/IRISAPP_DATA

CreateResource:Name=%DB_IRISAPP_CODE,Description="IRISAPP_CODE database"

CreateDatabase:Name=IRISAPP_CODE,Directory=/usr/irissys/mgr/IRISAPP_CODE

CreateNamespace:Name=IRISAPP,Globals=IRISAPP_DATA,Routines=IRISAPP_CODE,Interop=1

ModifyService:Name=%Service_CallIn,Enabled=1,AutheEnabled=48

ModifyUser:Name=SuperUser,PasswordHash=a31d24aecc0bfe560a7e45bd913ad27c667dc25a75cbfd358c451bb595b6bd52bd25c82cafaa23ca1dd30b3b4947d12d3bb0ffb2a717df29912b743a281f97c1,0a4c463a2fa1e7542b61aa48800091ab688eb0a14bebf536638f411f5454c9343b9aa6402b4694f0a89b624407a5f43f0a38fc35216bb18aab7dc41ef9f056b1,10000,SHA512

Merge cpf contient les Actions qui dans ce cas créent des base de données IRISAPP_DATA and IRISAPP_CODE respectivement pour les données et le code, l'espace de noms IRISAPP associé pour y accéder et les ressources associées %IRISAPP_DATA et %IRISAPP_CODE pour gérer les autorisations d'accès.

Ce Merge cpf permet également au service Callin de faire fonctionner Embedded Python via l'action ModifyService :

ModifyService:Name=%Service_CallIn,Enabled=1,AutheEnabled=48

La dernière action est un exemple de la façon dont vous pouvez définir en toute sécurité le mot de passe de l'utilisateur, à l'aide de l'action ModifyUser :

ModifyUser:Name=SuperUser,PasswordHash=a31d24aecc0bfe560a7e45bd913ad27c667dc25a75cbfd358c451bb595b6bd52bd25c82cafaa23ca1dd30b3b4947d12d3bb0ffb2a717df29912b743a281f97c1,0a4c463a2fa1e7542b61aa48800091ab688eb0a14bebf536638f411f5454c9343b9aa6402b4694f0a89b624407a5f43f0a38fc35216bb18aab7dc41ef9f056b1,10000,SHA512

Le hachage du mot de passe ici peut être généré via une autre image Docker d'InterSystems, par ex. avec la ligne suivante appelée dans un terminal (en savoir plus à propos de passwordhash):

docker run --rm -it containers.intersystems.com/intersystems/passwordhash:1.1 -algorithm SHA512 -workfactor 10000

La commande de fusion (merge) peut être appelée dans Dockerfile like this:

iris merge IRIS merge.cpf && \

D'autres types d'actions de fusion et différents paramètres sont disponibles dans la documentation IRIS.

Exécuter un code d'initialisation arbitraire

Un autre cas d'utilisation populaire consiste à exécuter un code personnalisé arbitraire pour charger des données, des variables d'initialisation et charger du code à partir du référentiel, par exemple, sous forme de package IPM. Habituellement, dans les modèles IRIS, il existe un fichier spécial iris.script qui contient un tel code sous forme d'ObjectScript. J'ai gardé le fichier iris.script dans le référentiel juste pour montrer comment l'utiliser avec ObjectScript.

Dans ce modèle Python, vous pouvez trouver l'exemple d'un tel code d'initialisation dans un fichier iris_script.py. Voyons ce qu'il contient :

import glob

import os

import iris

import pandas as pd

from sqlalchemy import create_engine

from iris import ipm

# switch namespace to the %SYS namespace
iris.system.Process.SetNamespace("%SYS")

# set credentials to not expire
iris.cls('Security.Users').UnExpireUserPasswords("*")

# switch namespace to IRISAPP built by merge.cpf
iris.system.Process.SetNamespace("IRISAPP")

# load ipm package listed in module.xml
#iris.cls('%ZPM.PackageManager').Shell("load /home/irisowner/dev -v")
assert ipm('load /home/irisowner/dev -v')

# load demo data
engine = create_engine('iris+emb:///')

# list all csv files in the demo data folder
for files in glob.glob('/home/irisowner/dev/data/*.csv'):

# get the file name without the extension
table_name = os.path.splitext(os.path.basename(files))[0]

# load the csv file into a pandas dataframe
df = pd.read_csv(files)

# write the dataframe to IRIS
df.to_sql(table_name, engine, if_exists='replace', index=False, schema='dc_demo')

Le code est plutôt explicite et il contient la démonstration de la modification des espaces de noms, du chargement du code du dépôt sous la forme d'un module IPM, de l'importation de fichiers csv contenus dans le dossier /data du dépôt à l'aide de la bibliothèque sqlalchemy.

Que fait le modèle 

Fondamentalement, ce modèle fournit des exemples sur la façon dont Embedded Python peut être utilisé avec IRIS.

1. Appeler Python à partir d'ObjectScrip

Pour en faire la démonstration, nous avons plusieurs classes ObjectScript dans le référentiel.

Pour tester cette approche, ouvrez le terminal IRIS et exécutez :

IRISAPP>d ##class(dc.python.test).Hello()

World

ce test montre comment utiliser les fonctions dans le code sample.py dans IRIS en utilisant Embedded Python.

2. Reportez-vous à IRIS depuis pytho

Pour le tester, vous pouvez exécuter irisapp.py qui effectue différentes opérations avec la base de données IRIS. Pour exécuter toutes les sessions de test de démarrage du terminal dans Docker :

# attach to the running IRIS container

docker-compose exec iris bash

# run the script

$ irispython ./python/irisapp.py

3. Building Python Flask REST API that works with IRIS

Il existe également un exemple d'API REST en python réalisée avec Flask que vous pourriez utiliser dans vos applications et que vous pouvez trouver dans /python/flask/app.py. 

Pour démarrer l’API Flask REST, procédez :

$ docker-compose exec iris bash

# irispython /python/flask/app.py

Ensuite, vous pouvez tester le serveur sur http://localhost:55030/.

Et voici deux exemples sur la façon d'ajouter un nouvel enregistrement dans IRIS et de lire un enregistrement :

POST http://localhost:55030/persistentclass

Content-Type: application/json

Accept: application/json

{

"test": "toto"

}

Result:

json

{

"id": 1,

"test": "toto"

}


GET http://localhost:55030/persistentclass/1

Accept: application/json

Result:

json

{

"id": 1,

"test": "toto"

}

4. Déploiement

Le déploiement de la solution sur les systèmes IRIS peut être effectué via IPM. Pour cela nous avons un module.xml IPM qui fournira des fichiers ObjectScript et Python à un système IRIS cible à partir d'un registre IPM dans lequel vous publierez le module.

Merci beaucoup à @Guillaume Rongier et @Dmitry Maslennikov qui a beaucoup aidé à créer le modèle et à rendre possible l'approche "Pure Python" .

Il y a aussi des approches plus "radicales" pour organiser de tels modèles - voici les exemples "no dockerfile" et "no objectscript" de @Dmitry Maslennikov, et ici un modèle d'interopérabilité "embedded python" par @Guillaume Rongier.