Configurer un environnement de développement Python

Ce tutoriel explique comment préparer votre machine locale pour le développement Python, y compris le développement d'applications Python s'exécutant sur Google Cloud.

Si vous avez déjà configuré un environnement de développement, consultez la section Python et Google Cloud pour avoir un aperçu de la procédure d'exécution d'applications Python sur Google Cloud.

Conseil : Si vous souhaitez démarrer rapidement, l'éditeur Cloud Shell fournit une compatibilité IDE pour le cycle de développement complet des applications Google Kubernetes Engine et Cloud Run. L'éditeur Cloud Shell est basé sur Code OSS et est préinstallé avec les outils Google Cloud CLI et Cloud Code.

Objectifs

  • Installer une version de Python prise en charge compatible avec Google Cloud.
  • Isoler les dépendances à l'aide de venv
  • Installer un éditeur (facultatif)
  • Installer Google Cloud CLI (facultatif)
  • Installer les bibliothèques du client Cloud pour Python (facultatif)
  • Installer d'autres outils utiles
  • Configurer l'authentification (facultatif)

Installer Python

Les instructions d'installation de Python varient en fonction du système d'exploitation. Suivez le guide du système d'exploitation utilisé dans votre environnement de développement, macOS, Windows ou Linux.

macOS

macOS inclut une version de Python par défaut et l’utilise à ses propres fins. Pour éviter toute interférence avec macOS, nous vous recommandons de créer un environnement de développement séparé et d'installer une version de Python compatible avec Google Cloud. Pour installer Python, utilisez homebrew.

  1. Un compilateur, que vous pouvez obtenir en installant les outils de ligne de commande de Xcode sera nécessaire pour utiliser homebrew afin d'installer les packages Python.

    xcode-select --install

  2. Installez homebrew en suivant les instructions de la page d'accueil homebrew, puis installez Python à l'aide de homebrew en utilisant la commande suivante :

    brew install pyenv
pyenv install PYTHON_VERSION

    Le numéro de version de Python doit être au format x.y. Exemple :

    pyenv install 3.12

  3. Une fois les installations terminées, vérifiez que Python 3 est disponible en tant que python et python3, et que pip est également installé.

    Pour vérifier que Python est disponible, exécutez la commande suivante :

    python3 --version

    La sortie indique la version. Pour en savoir plus sur Python homebrew, consultez la page Python sur le site Homebrew Formulae , puis vérifiez votre version.

    Pour vérifier que pip3 est disponible, exécutez la commande suivante :

    pip3 --version

    Si l'installation a réussi, la sortie affiche la version de pip3. Pour en savoir plus sur la dernière version de pip3, consultez les pip notes de version.

    Si la commande précédente n'affiche pas la version de pip3, assurez-vous que pip3 est correctement installé. Si pip3 est installé, mais ne fonctionne pas, passez à la dernière version à l'aide de la commande suivante :

    python -m pip install --upgrade pip

    Homebrew installe sur votre plate-forme les dernières versions de Python disponibles. Les numéros de version indiqués dans les résultats peuvent différer des dernières versions officielles de Python.

Windows

  1. Pour installer Python dans un environnement Windows, téléchargez le programme d'installation de la version de Python dont vous avez besoin à partir du site Web de Python. Pour en savoir plus, consultez les versions de Python compatibles avec Google Cloud.

  2. Pour accéder à votre version de Python, utilisez le programme de lancement Python pour Windows.

    Pour démarrer la version de Python que vous avez installée, exécutez la commande suivante :

    py

    Pour démarrer la version de Python 3 que vous avez installée, exécutez la commande suivante :

    py -3

    Pour vérifier la version de pip disponible, exécutez la commande suivante :

    py -m pip --version

    La sortie affiche la version de C:\users\[USERNAME]\appdata\local\programs\python\python38-32\lib\site-packages.

    Pour en savoir plus sur la dernière version de pip, consultez les notes de version de pip.

Linux

La plupart des distributions Linux incluent des versions récentes de Python.

  1. Pour installer Python dans un environnement Linux, installez les packages correspondant à votre distribution. Pour Debian et Ubuntu, ces packages sont python3, python3-dev, python3-venv et python3-pip.

    Installez ces paquets en utilisant les commandes suivantes :

    sudo apt update
sudo apt install python3 python3-dev python3-venv python3-pip

  2. Une fois les installations terminées, vérifiez que pip est installé :

    pip3 --version

    Pour en savoir plus sur la dernière version de pip, consultez les notes de version de pip.

Isoler les dépendances à l'aide de venv

venv est un outil permettant de créer des environnements Python isolés. Ces environnements isolés peuvent avoir des versions distinctes des packages Python, ce qui vous permet d'isoler les dépendances d'un projet des dépendances d'autres projets. Nous vous recommandons de toujours utiliser un environnement virtuel par projet lors du développement local avec Python.

  1. Exécutez la commande venv pour créer une copie virtuelle de l'ensemble de l'installation Python. Ce tutoriel crée une copie virtuelle dans un dossier nommé env, mais vous pouvez lui attribuer le nom de votre choix.

    macOS

    cd your-project
python -m venv env

    Windows

    cd your-project
py -m venv env

    Linux

    cd your-project
python3 -m venv env

  2. Pour configurez l'interface système afin qu'elle utilise les chemins d'accès venv pour Python, activez l'environnement virtuel :

    macOS

    source env/bin/activate

    Windows

    .\env\Scripts\activate

    Linux

    source env/bin/activate

  3. Vous pouvez désormais installer des packages sans affecter les autres projets ni votre installation globale de Python :

    pip install google-cloud-storage

    Si vous souhaitez cesser d'utiliser l'environnement virtuel et revenir à votre Python global, vous pouvez le désactiver :

    deactivate

Pour en savoir plus sur venv, consultez la documentation de venv.

Installer un éditeur

Pour développer des applications en Python, vous avez besoin d'un éditeur. Voici quelques-uns des éditeurs les plus populaires (sans ordre particulier) :

Installation des bibliothèques du client Cloud pour Python

Les bibliothèques clientes Cloud pour Python permettent aux développeurs Python d'intégrer des Google Cloud services tels que Datastore et Cloud Storage. Pour installer le package pour une API individuelle telle que Cloud Storage, utilisez une commande semblable à celle-ci :

pip install --upgrade google-cloud-storage

Installer gcloud CLI

Le gcloud CLI est un ensemble d'outils de ligne de commande pour Google Cloud. Il contient gcloud et bq, que vous pouvez utiliser pour accéder à Compute Engine, Cloud Storage, BigQuery et à d'autres produits et services à partir de la ligne de commande. Vous pouvez exécuter ces outils de façon interactive ou dans des scripts automatisés.

Configurer l'authentification

Pour utiliser la bibliothèque cliente, vous devez d'abord configurer l'authentification.

Si vous utilisez un shell local, créez des identifiants d'authentification locaux pour votre compte utilisateur : 

gcloud auth application-default login

Vous n'avez pas besoin de le faire si vous utilisez Cloud Shell.

Si une erreur d'authentification est renvoyée et que vous utilisez un fournisseur d'identité (IdP) externe, vérifiez que vous vous êtes connecté à la gcloud CLI avec votre identité fédérée.

Pour en savoir plus, consultez la section S'authentifier à l'aide des bibliothèques clientes.

Étape suivante