Créer et gérer des environnements Python dans Visual Studio

Un environnement Python est un contexte dans lequel vous exécutez du code Python et inclut des environnements globaux, virtuels et conda. Un environnement se compose d’un interpréteur, d’une bibliothèque (généralement la bibliothèque Standard Python) et d’un ensemble de packages installés. Ces composants déterminent ensemble les constructions et la syntaxe du langage valides, les fonctionnalités du système d’exploitation auxquelles vous pouvez accéder et les packages que vous pouvez utiliser.

Dans Visual Studio sur Windows, vous utilisez la fenêtre Environnements Python , comme décrit dans cet article, pour gérer les environnements et en sélectionner un comme valeur par défaut pour les nouveaux projets.

Vous pouvez en savoir plus sur d’autres aspects des environnements dans les articles suivants :

• Pour un projet donné, vous pouvez sélectionner un environnement spécifique plutôt que d’utiliser la valeur par défaut.

• Pour plus d’informations sur la création et l’utilisation d’environnements virtuels pour les projets Python, consultez Utiliser des environnements virtuels.

• Si vous souhaitez installer des packages dans un environnement, reportez-vous à la référence de l’onglet Packages.

• Pour installer un autre interpréteur Python, consultez Installer des interpréteurs Python. En règle générale, si vous téléchargez et exécutez un programme d’installation pour une distribution Python principaleline, Visual Studio détecte que la nouvelle installation et l’environnement s’affichent dans la fenêtre Environnements Python et peuvent être sélectionnés pour les projets.

Note

Vous pouvez gérer des environnements pour le code Python qui s’ouvrent en tant que dossier en sélectionnant Fichier>ouvert>dossier. La barre d’outils Python vous permet de basculer entre tous les environnements détectés et d’ajouter un nouvel environnement. Les informations d’environnement sont stockées dans le fichier PythonSettings.json dans le dossier .vs de l’espace de travail.

Prerequisites

• Une charge de travail Python installée

Si vous débutez avec Python dans Visual Studio, consultez les articles suivants pour obtenir un arrière-plan général :

• Prise en charge de Python dans Visual Studio sur Windows
• Installer la prise en charge de Python dans Visual Studio

Fenêtre Environnements Python

Les environnements que Visual Studio connaît sont affichés dans la fenêtre Environnements Python . Pour ouvrir la fenêtre, utilisez l’une des méthodes suivantes :

• Sélectionnez Afficher>d’autres> Python.
• Cliquez avec le bouton droit sur le nœud Environnements Python pour un projet dans l’Explorateur de solutions , puis sélectionnez Afficher tous les environnements Python.

La fenêtre Environnements Python s’affiche en même temps que l’Explorateur de solutions dans Visual Studio :

Visual Studio recherche des environnements globaux installés à l’aide du Registre (après PEP 514), ainsi que des environnements virtuels et des environnements conda. Si vous ne voyez pas d’environnement attendu dans la liste, consultez Identifier manuellement un environnement existant.

Lorsque vous sélectionnez un environnement dans la liste, Visual Studio affiche différentes propriétés et commandes pour cet environnement sous l’onglet Vue d’ensemble de la fenêtre Environnements Python , comme l’emplacement de l’interpréteur. Les commandes situées en bas de l’onglet Vue d’ensemble ouvrent chacune une invite de commandes avec l’interpréteur en cours d’exécution. Pour plus d’informations, consultez la référence de l’onglet Fenêtre Environnements Python - Vue d’ensemble.

Utilisez la liste déroulante sous la liste des environnements pour basculer vers différents onglets tels que Packages et IntelliSense. Ces onglets sont également décrits dans la référence de l'onglet de la fenêtre Environnements Python.

La sélection d’un environnement ne modifie pas sa relation avec les projets. L’environnement par défaut, affiché en gras dans la liste, est celui que Visual Studio utilise pour les nouveaux projets. Pour utiliser un autre environnement avec de nouveaux projets, utilisez la commande Définir cet environnement comme environnement par défaut pour les nouveaux projets. Dans le contexte d’un projet, vous pouvez toujours sélectionner un environnement spécifique. Pour plus d’informations, consultez Sélectionner un environnement pour un projet.

À droite de chaque environnement répertorié, il s’agit d’un contrôle qui ouvre une fenêtre interactive pour cet environnement.

Note

Dans Visual Studio 2017 15.5 et versions antérieures, un autre contrôle apparaît qui actualise la base de données IntelliSense pour cet environnement. Pour plus d’informations sur la base de données, consultez la référence de l’onglet de la fenêtre des environnements Python.

Conseil / Astuce

Lorsque vous développez la fenêtre Environnements Python suffisamment large, vous voyez une vue plus complète de vos environnements qui peuvent être plus pratiques à utiliser.

Note

Bien que Visual Studio respecte l’option system-site-packages, elle ne permet pas de la modifier à partir de Visual Studio.

Que se passe-t-il si aucun environnement n’apparaît ?

Si vous ne voyez aucun environnement dans la fenêtre Environnements Python , cela signifie que Visual Studio n’a pas détecté d’installations Python dans des emplacements standard. Vous avez peut-être installé Visual Studio 2017 ou version ultérieure, mais effacé toutes les options d’interpréteur dans les options du programme d’installation pour la charge de travail Python. De même, vous avez éventuellement installé Visual Studio 2015 ou une version antérieure, mais vous n’avez pas installé manuellement un interpréteur. Pour plus d’informations, consultez Installer des interpréteurs Python.

Si vous savez que vous disposez d’un interpréteur Python sur votre ordinateur, mais que Visual Studio (n’importe quelle version) ne l’a pas détecté, utilisez la commande + Personnalisée pour spécifier manuellement l’emplacement de l’interpréteur. Pour plus d’informations, consultez Identifier manuellement un environnement existant.

Types d’environnements

Visual Studio peut utiliser des environnements globaux, virtuels et conda.

Environnements globaux

Chaque installation de Python gère son propre environnement global. Par exemple, Python 2.7, Python 3.6, Python 3.7, Anaconda 4.4.0, et ainsi de suite. Pour plus d’informations, consultez Installer des interpréteurs Python.

Chaque environnement est composé de l’interpréteur Python spécifique, de sa bibliothèque standard et d’un ensemble de packages préinstallés. Il contient également les autres packages que vous installez pendant l’activation de l’environnement. L’installation d’un package dans un environnement global le rend disponible pour tous les projets utilisant cet environnement. Si l’environnement se trouve dans une zone protégée du système de fichiers (dans les fichiers c :\program, par exemple), l’installation de packages nécessite des privilèges d’administrateur.

Les environnements globaux sont disponibles pour tous les projets sur l’ordinateur. Dans Visual Studio, vous sélectionnez un environnement global comme environnement par défaut, qui est utilisé pour tous les projets, sauf si vous choisissez spécifiquement un autre environnement pour un projet. Pour plus d’informations, consultez Sélectionner un environnement pour un projet.

Environnements virtuels

Travailler dans un environnement global est un moyen simple de commencer. Au fil du temps, les environnements peuvent devenir encombrés avec de nombreux packages différents installés pour différents projets. L’encombrement peut compliquer le test approfondi de votre application sur un ensemble spécifique de packages avec des versions connues. Toutefois, ce type d’environnement est ce que vous vous attendez à configurer sur un serveur de build ou un serveur web. Les conflits peuvent également se produire lorsque deux projets nécessitent des packages incompatibles ou des versions différentes du même package.

Pour ces raisons, les développeurs créent souvent un environnement virtuel pour un projet. Un environnement virtuel est un sous-dossier dans un projet qui contient une copie d’un interpréteur spécifique. Si vous activez l’environnement virtuel, tous les packages que vous installez sont installés uniquement dans le sous-dossier de cet environnement. Lorsque vous exécutez un programme Python dans l’environnement virtuel, vous pouvez être sûr que le programme s’exécute uniquement sur ces packages spécifiques.

Visual Studio fournit une prise en charge directe de la création d’un environnement virtuel pour un projet. Si vous ouvrez un projet qui contient un fichier requirements.txt , Visual Studio vous invite automatiquement à créer un environnement virtuel et à installer ces dépendances. Vous voyez le même comportement lorsque vous créez un projet à partir d’un modèle qui inclut requirements.txt fichier.

À tout moment dans un projet ouvert, vous pouvez créer un environnement virtuel. Dans l’Explorateur de solutions, développez le nœud du projet, cliquez avec le bouton droit sur Environnements Python, puis choisissez Ajouter un environnement. Dans Ajouter un environnement, choisissez Environnement virtuel. Pour plus d’informations, consultez Créer un environnement virtuel.

Visual Studio fournit également une commande permettant de générer un fichier requirements.txt à partir d’un environnement virtuel, ce qui facilite la recréation de l’environnement sur d’autres ordinateurs. Pour plus d’informations, consultez Utiliser des environnements virtuels.

Environnements Conda

Vous pouvez créer un environnement conda à l’aide de l’outil conda ou avec la gestion conda intégrée dans Visual Studio 2017 version 15.7 et ultérieure. Un environnement conda nécessite Anaconda ou Miniconda. Ces plateformes sont disponibles via Visual Studio Installer. Pour plus d’informations, consultez Installer la prise en charge de Python dans Visual Studio.

1. Dans la fenêtre Environnements Python ou dans la barre d’outils Python, sélectionnez Ajouter un environnement pour ouvrir la boîte de dialogue Ajouter un environnement .

2. Dans la boîte de dialogue Ajouter un environnement , sélectionnez l’onglet Environnement Conda :

   

3. Configurez les champs suivants :

   Terrain	Descriptif
   Projet	Identifie le projet dans lequel créer l’environnement.
   Nom	Fournit le nom de l’environnement conda.
   Ajouter des packages à partir de	Spécifie comment ajouter des packages à l’environnement conda. - Fichier d’environnement : sélectionnez cette option si vous disposez d’un fichier environment.yml qui décrit vos dépendances. Entrez le nom du fichier ou parcourez (...) vers l’emplacement du fichier, puis sélectionnez le fichier. - Un ou plusieurs noms de package Anaconda : sélectionnez cette option si vous souhaitez répertorier un ou plusieurs packages Python ou versions python. La liste des packages indique à conda de créer un environnement Python. Pour installer la dernière version de Python, utilisez la python commande. Pour installer une version spécifique, utilisez la commande python=,major>.<minor> comme dans python=3.7. Vous pouvez également utiliser le bouton package pour sélectionner des versions de Python et des packages courants dans une série de menus.
   Définir comme environnement actuel	Active le nouvel environnement dans le projet sélectionné une fois l’environnement créé.
   Définir comme environnement par défaut pour les nouveaux projets	Définit et active automatiquement l’environnement conda dans tous les nouveaux projets créés dans Visual Studio. Cette option est identique à l'option Définir cet environnement comme celui par défaut pour les nouveaux projets dans la fenêtre Python Environments.
   Affichage dans la fenêtre Environnements Python	Spécifie s’il faut afficher la fenêtre Environnements Python après avoir créé l’environnement.

   Important

   Lorsque vous créez un environnement conda, veillez à spécifier au moins une version de Python ou un package Python pour vous assurer que l’environnement contient un runtime Python. Vous pouvez utiliser un fichier environments.yml ou la liste des packages. Si vous ne fournissez pas cette spécification, Visual Studio ignore l’environnement. L’environnement n’apparaît nulle part dans la fenêtre Environnements Python , il n’est pas défini comme environnement actuel pour un projet, et il n’est pas disponible en tant qu’environnement global.

   Si vous créez un environnement conda sans version de Python, utilisez la conda info commande pour afficher les emplacements des dossiers d’environnement conda. Vous pouvez ensuite supprimer manuellement le sous-dossier de l’environnement à partir de cet emplacement.

4. Cliquez sur Créer.

Vous pouvez surveiller la création de l’environnement conda dans la fenêtre Sortie . Une fois la création terminée, la sortie affiche des instructions d’interface de ligne de commande (CLI), telles que conda activate env:

1. Dans Visual Studio, vous pouvez activer un environnement conda pour votre projet de la même façon que tout autre environnement. Pour plus d’informations, consultez Sélectionner un environnement pour un projet.

2. Pour installer d’autres packages dans l’environnement, utilisez l’onglet Packages dans la fenêtre Environnements Python .

Note

Pour obtenir de meilleurs résultats avec des environnements conda, utilisez conda 4.4.8 ou version ultérieure. N’oubliez pas que les versions conda sont différentes des versions d’Anaconda. Vous pouvez installer les versions appropriées de Miniconda (Visual Studio 2019 et Visual Studio 2022) et Anaconda (Visual Studio 2017) via Visual Studio Installer.

Pour afficher la version conda, où les environnements conda sont stockés et d’autres informations, exécutez la conda info commande à l’invite de commandes Anaconda (une invite de commandes où Anaconda se trouve dans le chemin) :

conda info

Vos dossiers d’environnement conda apparaissent comme suit :

       envs directories : C:\Users\user\.conda\envs
                          c:\anaconda3\envs
                          C:\Users\user\AppData\Local\conda\conda\envs

Étant donné que les environnements conda ne sont pas stockés avec un projet, ils se comportent de la même façon que les environnements globaux. Par exemple, l’installation d’un nouveau package dans un environnement conda rend ce package disponible pour tous les projets qui utilisent l’environnement.

Pour Visual Studio 2017 version 15.6 et versions antérieures, vous pouvez utiliser des environnements conda en les pointant manuellement comme décrit dans l’identification manuelle d’un environnement existant.

Visual Studio 2017 version 15.7 et versions ultérieures détecte automatiquement les environnements conda et les affiche dans la fenêtre Environnements Python , comme décrit dans la section suivante.

Identifier manuellement un environnement existant

Utilisez les étapes suivantes pour identifier un environnement installé dans un emplacement non standard.

1. Dans la fenêtre Environnements Python ou dans la barre d’outils Python, sélectionnez Ajouter un environnement pour ouvrir la boîte de dialogue Ajouter un environnement .

2. Dans la boîte de dialogue Ajouter un environnement , sous l’onglet Environnement existant , définissez le champ Environnement sur <Personnalisé> :

Après avoir sélectionné la <valeur personnalisée> , d’autres champs sont ajoutés à la boîte de dialogue.

3. Définissez le champ Chemin de Préfixe sur le chemin d’accès de l’interpréteur. Vous pouvez renseigner le champ en naviguant vers le chemin d’accès (...).

4. Après avoir sélectionné le chemin d’accès, les champs restants sont renseignés. Passez en revue les valeurs et modifiez si nécessaire. Lorsque vous êtes prêt, sélectionnez Ajouter.

Vous pouvez également consulter et modifier les détails de l’environnement à tout moment dans la fenêtre Environnements Python .

1. Dans la fenêtre Environnements Python , sélectionnez l’environnement, puis sélectionnez l’onglet Configurer .

2. Après avoir apporté des modifications, sélectionnez la commande Appliquer .

Vous pouvez également supprimer l’environnement à l’aide de la commande Remove . Pour plus d’informations, consultez l’onglet Configurer. Cette commande n’est pas disponible pour les environnements détectés automatiquement.

Corriger ou supprimer des environnements non valides

Si Visual Studio trouve des entrées de Registre pour un environnement, mais que le chemin d’accès à l’interpréteur n’est pas valide, la fenêtre Environnements Python affiche le nom de l’environnement dans un format de police barré, comme illustré dans l’image suivante :

Pour corriger un environnement que vous souhaitez conserver, essayez d’abord d’utiliser le processus de réparation du programme d’installation de l’environnement. La plupart des programmes d’installation incluent une option de réparation.

Modifier le Registre pour corriger un environnement

Si l’environnement Python n’a pas d’option de réparation ou si vous souhaitez supprimer un environnement non valide, vous pouvez utiliser les étapes suivantes pour modifier le Registre directement. Visual Studio met automatiquement à jour la fenêtre Environnements Python lorsque vous apportez des modifications au Registre.

1. Exécutez l’exécutable regedit.exe pour ouvrir l’éditeur de Registre.

2. Accédez au dossier d’environnement correspondant à votre configuration :

   Version Python	Dossier
   Version 64 bits	HKEY_LOCAL_MACHINE\SOFTWARE\Python ou HKEY_CURRENT_USER\Software\Python
   Version 32 bits	HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Python
   IronPython	IronPython

3. Développez la structure des nœuds de distribution et de version pour votre environnement :

   Répartition	Nœud
   CPython	PythonCore><Nœud de versionnement>
   Anaconda	ContinuumAnalytics><Nœud> de version
   IronPython	<Nœud de version>

4. Inspectez les valeurs sous le nœud InstallPath :

   

   • Si l’environnement existe toujours sur votre ordinateur, remplacez la valeur de l’entrée ExécutablePath par l’emplacement approprié. Corrigez également les valeurs des entrées (Default) et WindowedExecutablePath , si nécessaire.
   • Si l’environnement n’existe plus sur votre ordinateur et que vous souhaitez le supprimer de la fenêtre Environnements Python , supprimez le nœud parent du numéro de version du nœud InstallPath . Vous pouvez voir un exemple de ce nœud dans l’image précédente. Dans l’exemple, ce nœud est 3.6.

   Caution

   Les paramètres non valides de la clé HKEY_CURRENT_USER\SOFTWARE\Python remplacent les paramètres de la clé HKEY_LOCAL_MACHINE\SOFTWARE\Python .

Supprimer ou enlever un environnement Python

Pour supprimer un projet Python, accédez à l’environnement Python dans l’Explorateur de solutions. Cliquez avec le bouton droit sur l’environnement Python à supprimer, puis sélectionnez Supprimer.

Si vous souhaitez conserver l’environnement Python, mais le supprimer de votre projet, sélectionnez Supprimer. Si vous souhaitez supprimer définitivement l’environnement, sélectionnez Supprimer.

Contenu connexe

• Installer des interpréteurs Python
• Sélectionner un environnement Python pour un projet dans Visual Studio
• Gérer les packages Python requis avec requirements.txt
• Utiliser des dossiers Python dans des chemins de recherche Visual Studio
• Référence de la fenêtre des environnements Python