Hello, Siril!

Il est de tradition de commencer avec un exemple Hello, World!, donc voici le "Hello, Siril!"

import sirilpy as s
from sirilpy import SirilConnectionError

siril = s.SirilInterface()

try:
   siril.connect()
   siril.log("Hello, Siril!")

except SirilConnectionError as e:
   print(f"An error occurred: {e}")

C'est tout. Tous les scripts Python Siril doivent importer le module siril : celui-ci est fourni automatiquement par Siril et ne nécessite aucune installation.

Cela permet la connexion à Siril via la classe SirilInterface et donne accès aux méthodes de Siril : dans ce cas, la fonction log() effectue un petit ajustement (ajout d'un caractère de retour à la ligne \n) et appelle la fonction interne siril_log_message() pour afficher le résultat dans l'onglet journal de Siril. Notez que log() peut prendre un argument facultatif spécifiant la couleur : si vous vouliez que « Hello, Siril! » s'affiche en vert, vous modifieriez la ligne en siril.log("Hello, Siril!", s.LogColor.GREEN).

Notez qu'il n'est généralement pas nécessaire d'appeler la méthode siril.disconnect() car cela n'est pas vraiment indispensable : à la fin d'un script, cette méthode sera appelée automatiquement dans un gestionnaire de fin.

Notez également que, bien que vous puissiez initialiser plusieurs objets SirilInterface(), un script ne peut se connecter que via un seul à la fois (bien que plusieurs scripts puissent être connectés à Siril simultanément). Il n'y a généralement pas besoin de créer plus d'un SirilInterface().