Configurer Eclipse pour le développement Python 2 et le débogage avec Google App Engine

Faites vos premiers pas avec le développement local et le débogage à l'aide d'Eclipse et des plug-ins PyDev. Cette configuration vous permet d'exécuter votre application App Engine localement en mode de débogage et d'utiliser la perspective Débogage d'Eclipse pour définir des points d'arrêt et parcourir votre code. Les plugins PyDev fournissent des fonctionnalités d'assistance pour utiliser App Engine, notamment la création de projets de démarrage et le déploiement d'applications.

Avant de commencer

  1. Installez Python 2.7 si Python n'est pas déjà installé. Un doute ?
  2. Dans la section Facultatif de la page de téléchargement du SDK, installez le SDK App Engine d'origine pour Python.

Vérifiez votre version de Python

Pour vérifier quelle version de Python est installée, exécutez la commande suivante :

python --version

Installer Eclipse

Les instructions suivantes supposent que vous allez installer Eclipse IDE pour JavaScript et les développeurs Web, qui est basé sur Eclipse Neon (4.6). Utilisez le programme d'installation Eclipse pour faciliter le processus d'installation.

  1. Installez le programme d'installation Eclipse.
  2. Dans le programme d'installation Eclipse, choisissez le package Eclipse IDE for JavaScript and Web Developers, puis cliquez sur Install (Installer).

    Installation d'Eclipse avec le programme d'installation Eclipse.Capture d'écran.

  3. Une fois l'installation terminée, cliquez sur Launch (Lancer).

  4. Lors du lancement d'Eclipse, spécifiez un emplacement pour l'espace de travail ou acceptez la valeur par défaut.

Installation de PyDev

Après avoir installé Eclipse, vous devez installer le plug-in PyDev qui vous permet d'utiliser Eclipse en tant qu'EDI Python.

  1. Dans Eclipse, cliquez sur Aide > Marketplace Eclipse.
  2. Dans le champ Find (Rechercher), spécifiez "PyDev".

    Recherchez PyDev sur le marché Eclipse et installez-le. Capture d'écran.

  3. Cliquez sur Install (Installer) et terminez l'assistant d'installation.

  4. Redémarrez Eclipse lorsque vous y êtes invité.

Configuration de votre projet

  1. Créer un nouveau projet : Cliquez sur Fichier > Nouveau> Projet.

  2. Sur la page Select a wizard (Sélectionner un assistant), sélectionnez PyDev Google App Engine Project (Projet PyDev Google App Engine).

    Sélectionnez l'assistant de projet PyDev.Capture d'écran.

  3. Sur la page Projet PyDev, nommez le projet. Ensuite, laissez Eclipse configurer l'interpréteur par défaut en cliquant sur Configurer un interprète avant de poursuivre.

    Si Eclipse n'a pas trouvé d'interpréteur Python 2.7, cliquez sur le lien Click here to configure an interpreter not listed (Cliquez ici pour configurer un interpréteur non répertorié) afin de configurer l'interpréteur.

  4. Sur la page Google App Engine, cliquez sur Browse (Parcourir) et localisez le répertoire dans lequel vous avez installé le SDK App Engine. Où est-ce ?

    Spécifiez l'emplacement du SDK App Engine lors de la création de votre projet.Capture d'écran.

  5. Cliquez sur Next (Suivant) pour continuer à configurer un projet de base ou sur Finish (Terminer) pour commencer avec un projet vierge.

  6. Si vous configurez un projet, spécifiez l'ID du projet. Pour afficher votre ID de projet, accédez à la console GCP. Si vous n'avez pas encore enregistré de projet, vous pouvez spécifier un nom temporaire à insérer dans le fichier app.yaml du projet. Vous pouvez modifier ce nom ultérieurement si nécessaire.

  7. Choisissez un modèle de départ. Recommandé : utilisez le modèle Hello World pour générer un fichier app.yaml et un script Python simple. Vous pouvez effectuer votre développement plus tard en utilisant le framework de votre choix, tel que Flask ou Django.

Emplacement par défaut du SDK

macOS
Si vous avez installé le SDK avec le lanceur Google App Engine, vous êtes invité à créer des liens symboliques au démarrage du lanceur. Si vous avez créé des liens symboliques, l'emplacement par défaut est :
/usr/local/google_appengine
Si vous n'avez pas créé de lien symbolique, l'emplacement par défaut est le suivant :
/Applications/GoogleAppEngineLauncher.app/Contents/Resources/GoogleAppEngine-default.bundle/Contents/Resources/google_appengine
Linux
L'emplacement est l'endroit où vous avez extrait le fichier zip du SDK que vous avez téléchargé.
Windows
C:\Program Files (x86)\Google\google_appengine\

Importation de bibliothèques à reconnaître par Eclipse

Après avoir configuré un projet, vous pouvez choisir une bibliothèque sur laquelle votre code s'appuiera. Vous devrez importer la bibliothèque dans votre projet et le configurer pour charger cette bibliothèque, mais vous devrez également indiquer à Eclipse d'utiliser cette bibliothèque.

Pour qu'Eclipse reconnaisse votre bibliothèque importée :

  1. Importez la bibliothèque dans votre projet.
  2. Modifiez les propriétés de votre projet Eclipse : cliquez avec le bouton droit sur le projet et sélectionnez Properties (Propriétés).
  3. Sélectionnez PyDev - PYTHONPATH dans le volet de navigation de la boîte de dialogue.
  4. Si vous gérez vos bibliothèques dans un dossier enfant de votre projet, tel que lib\, cliquez sur Add source folder (Ajouter un dossier source).

Eclipse ajoute maintenant les bibliothèques que vous avez spécifiées au chemin Python pour résoudre les importations.

Lancer votre application en mode débogage

L'exécution de votre application en mode débogage dans Eclipse vous permet de définir des points d'arrêt dans votre code. Lorsque ces lignes sont exécutées, le traitement s'interrompt temporairement, ce qui vous permet d'inspecter votre code et de lancer l'exécution. Cette fonctionnalité est extrêmement utile lors du développement de votre application.

Mettre en place une configuration de débogage

La première fois que vous lancez votre application en mode de débogage, Eclipse crée une configuration de débogage que vous pourrez exécuter ultérieurement ou modifier pour ajouter des paramètres à votre construction.

  1. Cliquez avec le bouton droit sur le nom de votre projet dans l'explorateur de projets et sélectionnez Debug As > PyDev: Google App Run (Déboguer en tant que > PyDev : Exécuter Google App).

    La vue de la console doit s'ouvrir et afficher la sortie système du serveur de développement, qui comprend les URL que votre application est en train d'exécuter.

  2. Vérifiez que votre application est en cours d'exécution en accédant à l'URL affichée dans la console. Par défaut, l'application s'exécute à partir de http://localhost:8080. Si vous avez utilisé le modèle de départ Hello World, vous devriez voir "Hello, world!" s'afficher dans le navigateur.

Le mode de débogage est maintenant exécuté dans Eclipse. Vous avez également créé une configuration de débogage que vous pourrez réexécuter ultérieurement si vous quittez Eclipse ou si vous devez arrêter et redémarrer le débogueur.

Définir un point d'arrêt pour parcourir votre code

Maintenant que le débogueur est en cours d'exécution, vous pouvez définir des points d'arrêt et les utiliser pour exécuter votre code.

  1. Ouvrez un fichier dans votre projet Eclipse, tel que le fichier helloworld.py si vous utilisez le modèle de départ.

  2. Cliquez avec le bouton droit sur le numéro de ligne situé à côté du code où vous souhaitez définir un point d'arrêt et sélectionnez Add Breakpoint (Ajouter un point d'arrêt).

    Menu contextuel qui s'affiche lorsque vous cliquez avec le bouton droit sur le numéro de ligne dans Eclipse.Capture d'écran.

    Un cercle vert apparaît sur la ligne où vous définissez le point d'arrêt.

  3. Revenez au navigateur et ouvrez l'URL qui exécutera la ligne où vous définissez le point d'arrêt. Eclipse vous demande de basculer vers la perspective "Debug" (Débogage) lorsque le point d'arrêt est déclenché.

  4. Si vous êtes invité à basculer vers la perspective "Debug" (Débogage), cliquez sur Yes (Oui). Cette perspective fournit une vue spécifique au débogage de votre code, y compris la vue Variables.

    Capture d'écran complète de l'IDE Eclipse en mode de débogage avec les différentes vues de débogage.

    Dans l'afficheur Variables, vous pouvez inspecter les objets et les variables actuellement définis dans votre code.

    Les boutons de la barre de menus fournissent les contrôles suivants :

    • Icône de poursuite de l'exécution Continuer l'exécution jusqu'à ce que le prochain point d'arrêt soit rencontré ou que l'exécution se termine.
    • Icône de poursuite de l'exécution Entrer dans le code de niveau inférieur, comme dans une méthode.
    • Icône de progression ligne par ligne Entrer ligne par ligne dans le code actuel plutôt que d'entrer dans le code de niveau inférieur.
    • Icône pour revenir au code supérieur Revenir au code de niveau supérieur. Vous pouvez choisir de revenir au code de niveau supérieur à partir du code de niveau inférieur avant que ce dernier ne termine son exécution pour vous ramener au code appelant.
    • Icône de fin d'exécution Terminer l'exécution.
    • Icône pour ignorer les points d'arrêt restants Ignorer les points d'arrêt restants.
  5. Cliquez sur l'icône icône de poursuite pour continuer le processus et autoriser le serveur de développement à envoyer un simple message "Hello, World!" en réponse au navigateur.

Pour revenir à la perspective PyDev une fois le débogage terminé, sélectionnez Window > Perspective > Open Perspective (Fenêtre > Perspective > Ouvrir la perspective), puis choisissez PyDev, ou cliquez sur l'icône PyDev dans le coin supérieur droit d'Eclipse :

Affiche les icônes permettant de changer rapidement de perspective dans Eclipse.

Déployer votre application depuis Eclipse

Le plugin PyDev pour Eclipse vous permet de déployer votre application depuis votre espace de travail.

  1. Utilisez la console Google Cloud Platform pour configurer votre projet Google Cloud Platform :

    Sélectionnez ou créez un projet GCP et assurez-vous qu'il inclut une application App Engine :

    Accéder à App Engine

    Le tableau de bord s'ouvre si une application App Engine existe déjà dans votre projet. Sinon, vous êtes invité à choisir la région dans laquelle vous souhaitez placer votre application App Engine.

    Conseil : L'ID de votre projet devient partie intégrante de l'URL de votre application, par exemple, http://[YOUR_PROJECT_ID].appspot.com.

  2. Dans Eclipse, modifiez votre fichier app.yaml et remplacez la valeur de l'élément d'application par votre ID de projet GCP.

  3. Dans la vue "Package Explorer" (Explorateur de packages PyDev) ou "Project Explorer" (Explorateur de projets) de PyDev, cliquez avec le bouton droit sur le dossier du projet et choisissez PyDev: Google App Engine > Upload (Importer).

    Image du menu contextuel lorsque vous cliquez avec le bouton droit sur le projet pour afficher l'option de téléchargement PyDev pour App Engine

    S'il s'agit de la première fois que vous exécutez les commandes de gestion du SDK App Engine, vous serez invité à autoriser le SDK à accorder l'accès à l'outil pour modifier vos applications App Engine. Cliquez sur Autoriser.

    Vous pouvez fermer la fenêtre du navigateur quand elle affiche "The authentication flow has completed" (Le flux d'authentification est terminé) et revenir à Eclipse.

  4. Vérifiez que votre application a bien été importée dans la boîte de dialogue Manage Google App Engine (Gérer Google App Engine) :

    Capture d'écran de la boîte de dialogue confirmant les étapes de téléchargement et le succès

  5. Accédez à http://[YOUR_PROJECT_ID].appspot.com. Vous devriez voir votre application diffuser du trafic.

Étapes suivantes

Maintenant que votre environnement de développement est configuré, les rubriques suivantes peuvent vous aider à démarrer avec App Engine :

Cette page vous a-t-elle été utile ? Évaluez-la :

Envoyer des commentaires concernant…

Environnement standard App Engine pour Python 2