Configuration d’un IDE pour l’utilisation des points de contrôle Snowpark¶

L”extension Snowflake pour Visual Studio Code offre un support pour la bibliothèque Snowpark Checkpoints afin d’améliorer l’expérience d’utilisation du cadre. Elle vous permet de contrôler finement les instructions collect et validate insérées dans votre code, ainsi que de vérifier le statut des assertions d’équivalence comportementale de votre code converti.

Mise en place de points de contrôle Snowparks¶

Pour activer les points de contrôle Snowpark, allez dans les paramètres d’extension de Snowflake et cochez Snowpark Checkpoints: Enabled.

Vue¶

En définissant la propriété des points de contrôle Snowpark sur Enabled, comme expliqué précédemment, vous ouvrirez un nouvel onglet dans l’extension appelé SNOWPARK CHECKPOINTS. Il affiche tous les points de contrôle dans l’espace de travail et permet d’effectuer plusieurs actions, telles que l’activation/désactivation de tous les points de contrôle ou d’un seul d’entre eux, l’effacement de tous les fichiers et, en double-cliquant sur chaque point de contrôle, la navigation vers le fichier et la ligne de code où il est défini.

Basculer tous les points de contrôle¶

Située en haut à droite de l’onglet Snowpark Checkpoints, cette option permet d’activer la propriété dans tous les points de contrôle.

Points de contrôle activés :

La désactivation d’un point de contrôle a pour effet de l’ignorer lors de l’environnement d’exécution.

Nettoyage de tous les points de contrôle¶

Situé dans le coin supérieur droit de l’onglet Snowpark Checkpoints. Cela supprime les points de contrôle de tous les fichiers Python, y compris les Notebooks Jupyter, dans votre espace de travail, mais cela ne les supprime pas du contrat et du panneau. Cela signifie qu’ils peuvent être restaurés à l’aide de la commande Snowflake: Restore All Checkpoints.

Insertion de points de contrôle dans un fichier¶

En cliquant avec le bouton droit de la souris à l’intérieur d’un fichier, vous ferez apparaître un menu contextuel contenant l’option Snowpark Checkpoints, qui permet d’ajouter des points de contrôle Collection et Validation.

Option des points de contrôle Snowpark dans le menu contextuel :

Ajout d’un collecteur/validateur :

Points de contrôle du collecteur et du validateur

Exécution d’un seul point de contrôle¶

Un seul point de contrôle peut être exécuté en cliquant sur l’option de lentille de code affichée au-dessus de chaque point de contrôle. Son exécution fait apparaître une console de sortie montrant la progression et, une fois qu’elle est terminée, la vue des résultats. Même si le point de contrôle est désactivé dans le fichier de contrat, il sera activé juste pour son exécution.

Si un point d’entrée n’est pas déclaré dans le fichier des contrats, le message d’erreur : Point d’entrée non trouvé pour le point de contrôle. s’affiche.

Exécution de tous les points de contrôle Snowpark activés dans un fichier¶

Dans le coin supérieur droit de chaque fichier, le bouton Run all checkpoints from the current file est présent.

En cliquant dessus, vous ferez apparaître un canal de sortie affichant la progression de l’exécution.

Vue de la ligne du temps¶

Affiche une chronologie des résultats de l’exécution des points de contrôle.

Commandes¶

Les commandes suivantes sont disponibles pour les points de contrôle Snowpark. Pour les utiliser, entrez Snowflake: [command name] dans la palette de commandes.

Commandes des points de contrôle Snowpark¶
Commande	Description
Snowflake : basculer les points de contrôle	Bascule la propriété activée de tous les points de contrôle.
Snowflake : initialisation du projet de points de contrôle Snowpark	Déclenche l’initialisation du projet, en créant un fichier de contrat s’il n’existe pas. Dans le cas où il existe, une fenêtre contextuelle s’affiche, vous demandant si vous souhaitez charger le point de contrôle dans le fichier du contrat.
Snowflake : effacer tous les points de contrôle	Supprime tous les points de contrôle de tous les fichiers de l’espace de travail.
Snowflake : restaurer tous les points de contrôle	Restaure les points de contrôle précédemment supprimés des fichiers qui sont toujours présents dans le fichier de contrat.
Snowflake : ajouter un point de contrôle de validation/collecte	Ajoute un validateur ou un collecteur avec ses paramètres obligatoires à la position du curseur.
Snowflake : focus sur la vue des points de contrôle Snowpark	L’accent est mis sur le panneau SNOWPARK CHECKPOINTS.
Snowflake : calendrier des points de contrôle ouverts	Affiche une chronologie des exécutions des points de contrôle.
Snowflake : exécuter tous les points de contrôle à partir du fichier actuel	Exécute tous les points de contrôle activés dans le fichier actuel.
Snowflake : exécuter tous les points de contrôle dans l’espace de travail	Exécute tous les points de contrôle activés à partir de l’espace de travail.
Snowflake : afficher tous les résultats des points de contrôle Snowpark	Affiche un onglet avec tous les résultats des points de contrôle.

Avertissements¶

Dupliquer : dans un projet de collecte, si deux points de contrôle portent le même nom, un avertissement s’affiche : « Un autre point de contrôle portant un nom identique a été détecté et sera écrasé. » Les projets de validation peuvent avoir plusieurs points de contrôle partageant le même nom, aucun avertissement ne sera affiché.
Mauvais type : l’ajout d’un point de contrôle d’un type différent de celui du projet le soulignera avec le message d’erreur suivant : « Veuillez vous assurer que vous utilisez la bonne instruction pour les points de contrôle Snowpark. Cette instruction de point de contrôle particulière est différente des autres utilisées dans ce projet, les instructions qui ne correspondent pas au type de projet seront ignorées lors de leur exécution. »
Nom de point de contrôle non valide : il existe des façons non valides d’ajouter un paramètre de nom de point de contrôle. Dans ce cas, un message d’avertissement s’affiche : « Nom de point de contrôle non valide. Les noms des points de contrôle doivent commencer par une lettre et ne peuvent contenir que des lettres, des chiffres, des traits d’union et des traits de soulignement ».