Haut

Utiliser les extraits de code

Dans cette rubrique

  1. Créer un extrait de code
  2. Insertion d’un extrait de code
  3. Extraits de code Esri

ArcGIS Notebooks permet de parcourir et d’insérer un code préécrit et réutilisable, appelé extrait de code, dans le notebook.

Créer un extrait de code

Vous pouvez créer un extrait de code à partir d’un notebook. Les extraits de code que vous créez peuvent être utilisés dans le même notebook ou dans des notebooks différents. Les extraits de code que vous créez sont stockés dans des éléments de bibliothèque d’extraits de code de notebook ; ces éléments permettent d’organiser les extraits de code et peuvent être partagés.

Pour créer un extrait de code, vous devez d’abord créer une bibliothèque d’extraits de code de notebook pour y stocker les extraits de code. Une bibliothèque d’extraits de code peut contenir au maximum 100 extraits de code.

Créer une bibliothèque d’extraits de code de notebook

Pour créer une bibliothèque d’extraits de code, procédez comme suit :

  1. Sur le ruban supérieur de l’éditeur de notebooks, cliquez sur Code snippets (Extraits de code).
  2. Cliquez sur le bouton Add (Ajouter) Add (Ajouter) et sélectionnez Create library item (Créer un élément de bibliothèque).
  3. Saisissez un titre et un résumé pour votre bibliothèque et ajoutez, si vous le souhaitez, des balises qui représentent les extraits de code stockés dans la bibliothèque.
  4. Vous pouvez éventuellement sélectionner un dossier dans My Content (Mon contenu) pour y enregistrer votre bibliothèque d’extraits de code.
  5. Cliquez sur Create (Créer).

Lorsque vous créez une bibliothèque d’extraits de code, elle est enregistrée dans votre organisation comme n’importe quel autre élément. Vous pouvez gérer vos bibliothèques d’extraits de code en cliquant sur le bouton More options (Autres options) More (Plus) dans la fenêtre Code snippets (Extraits de code), puis en cliquant sur Manage library items (Gérer les éléments de bibliothèque). Dans la fenêtre Manage code snippet library items (Gérer les éléments de bibliothèque d’extraits de code), vous pouvez créer une nouvelle bibliothèque d’extraits de code. Pour chaque bibliothèque d’extraits de code, vous pouvez partager, modifier et afficher la page des détails des éléments, et marquer la bibliothèque comme obsolète.

Ajouter un extrait de code

Une fois la bibliothèque créée, vous pouvez y ajouter des extraits de code. Pour ajouter un extrait de code, procédez comme suit :

  1. Sur le ruban supérieur de l’éditeur de notebooks, cliquez sur Code snippets (Extraits de code).
  2. Cliquez sur le bouton Add (Ajouter) Add (Ajouter) et sélectionnez Add code snippet (Ajouter un extrait de code).
  3. Saisissez un titre pour l’extrait de code, sélectionnez la bibliothèque à laquelle vous souhaitez l’ajouter et entrez une description.

    La liste déroulante Select a code snippet library item (Sélectionner un élément de bibliothèque d’extraits de code) affiche les bibliothèques dans lesquelles vous pouvez ajouter votre extrait de code. La liste indique également le nombre d’extraits de code dans cette bibliothèque.

  4. Ajoutez le code pour l’extrait de code en procédant d’une des manières suivantes :
    • Si le notebook utilise la version d’exécution 8.0 ou ultérieure, sélectionnez la cellule que vous voulez ajouter comme extrait de code et cliquez sur Copy from active cell (Copier à partir de la cellule active).
    • Si le notebook utilise la version d’exécution 7.0 ou antérieure, saisissez le code de l’extrait de code.
      Remarque :

      Copiez et collez le code depuis la cellule du notebook au lieu de le saisir directement dans le code afin d’éviter l’indentation ou toute autre erreur de syntaxe.

  5. Cliquez sur Save (Enregistrer).

Vous pouvez modifier les extraits de code en cliquant sur le bouton More options (Autres options) More (Plus) associé à l’extrait de code. Le menu déroulant More options (Autres options) contient des options permettant de edit (Mettre à jour), deprecate (Mettre en obsolescence) et delete (Supprimer) un extrait de code.

Insertion d’un extrait de code

À l’aide de la fenêtre Code snippets (Extraits de code), procédez comme suit pour insérer un extrait de code :

  1. Sur le ruban supérieur de l’éditeur de notebooks, cliquez sur Code snippets (Extraits de code).
  2. Accédez à la bibliothèque d’extraits de code contenant l’extrait de code que vous souhaitez insérer.
  3. Cliquez sur View details (Afficher les détails) pour l’extrait de code afin d’en afficher un aperçu.
  4. Une fois que vous avez trouvé l’extrait de code à insérer, cliquez sur le bouton Add (Ajouter) Add (Ajouter) dans la fenêtre des extraits de code ou sur Insert into notebook (Insérer dans le notebook) dans la fenêtre d’aperçu du code pour insérer l’extrait de code dans le notebook, sous la forme d’une nouvelle cellule.

Un exemple d’extrait de code ajouté au notebook est présenté ci-dessous :

# curated code snippet inserted from the Code snippets pane
from arcgis.gis import GIS
def check_org_credits_agol(gis: GIS):
    if "admin" in gis.__dict__:
        credits = gis.admin.credits.credits
        print(f"This ArcGIS Online organization has {credits} credits.")
    else:
        print("Please connect to the ArcGIS Online organization as an administrator to check credits.")

# create a GIS instance to pass to the code snippet function
gis_agol = GIS("https://www.arcgis.com/", "<admin_username>")

# call the code snippet function with your GIS instance
check_org_credits_agol(gis_agol)

Extraits de code Esri

Tous les extraits de code disponibles sont présentés par Esri. Ces extraits de code présentés permettent de mettre en œuvre des processus SIG communs dans les notebooks. Les extraits de code sont écrits sous la forme de fonctions Python qui peuvent être insérées dans le notebook et appelées à travers lui. Un extrait de code peut également être mis à jour dès qu’il a été ajouté au notebook.

Les extraits de code disponibles en vue d’une insertion dans un notebook sont les suivants :

  1. Administration SIG : extraits de code qui exécutent les tâches d’administration SIG habituelles.
    Remarque :

    La plupart de ces extraits de code requièrent une connexion administrateur.

    • Vérifier les crédits restants (ArcGIS Online uniquement)
    • Vérifier les crédits d’un utilisateur spécifique (ArcGIS Online uniquement)
    • Obtenir l’URL du service de base d’un élément de couche
    • Interroger les tâches de notebook ayant échoué
    • Interroger les journaux du portail et enregistrer au format CSV (ArcGIS Enterprise uniquement)
    • Se connecter au portail pour ArcPy
  2. Gestion du contenu : ces extraits de code permettent de gérer le contenu de votre SIG et vos fichiers dans le répertoire de l’espace de travail du notebook.
    • Copier une géodatabase dans le répertoire de l’espace de travail
    • Créer une géodatabase fichier avec une classe d’entités vide
    • Créer un dossier dans le répertoire de l’espace de travail
    • Télécharger un élément de fichier du portail vers le répertoire de l’espace de travail
    • Répertorier les jeux de données
    • Répertorier les fichiers
    • Supprimer une géodatabase fichier du répertoire de l’espace de travail
    • Supprimer un dossier du répertoire de l’espace de travail
    • Décompresser un fichier dans le répertoire de l’espace de travail
  3. Science des données et d’analyse : extraits de code qui peuvent être mis en œuvre dans vos processus de science de données et d’analyse à l’aide de ArcGIS API for Python, de ArcPy et d’autres bibliothèques Python.
    Remarque :

    Utilisez le runtime du notebook avancé pour exécuter les extraits de code qui requièrent ArcPy. Pour plus d’informations sur les runtimes de notebook, reportez-vous à la rubrique Spécifier le runtime d’un notebook.

    • Convertir une classe d’entités en couche d’entités
    • Convertir une classe d’entités en objet Spatially Enabled DataFrame
    • Convertir une couche d’entités en objet Spatially Enabled DataFrame
    • Convertir un objet Spatially Enabled DataFrame en classe d’entités
    • Afficher une image à partir d’une URL
    • Afficher une image à partir du répertoire de l’espace de travail
    • Remplacer les valeurs manquantes
    • Répertorier les champs d’une classe d’entités
    • Répertorier les champs d’une couche
    • Répertorier les couches d’un élément
    • Tracer un objet Spatially Enable DataFrame (démarrage rapide)
    • Tracer un objet Spatially Enabled DataFrame avec un moteur de rendu par interruptions de classe
    • Tracer un objet Spatially Enable DataFrame avec un moteur de rendu simple
    • Tracer un objet Spatially Enable DataFrame avec un moteur de rendu par valeurs uniques
    • Publier un objet Spatially Enabled DataFrame en tant que couche d’entités

Vous avez un commentaire à formuler concernant cette rubrique ?

Dans cette rubrique
  1. Créer un extrait de code
  2. Insertion d’un extrait de code
  3. Extraits de code Esri